ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkStreamTracer Class Reference

vtkStreamTracer - Streamline generator More...

Inheritance diagram for Kitware.VTK.vtkStreamTracer:
[legend]
Collaboration diagram for Kitware.VTK.vtkStreamTracer:
[legend]

List of all members.

Public Types

enum  BACKWARD_WrapperEnum { BACKWARD = 1, BOTH = 2, FORWARD = 0 }
 Description Specify the terminal speed value, below which integration is terminated. More...
enum  INTERPOLATOR_WITH_CELL_LOCATOR_WrapperEnum { INTERPOLATOR_WITH_CELL_LOCATOR = 1, INTERPOLATOR_WITH_DATASET_POINT_LOCATOR = 0 }
 Description Specify the terminal speed value, below which integration is terminated. More...
enum  ReasonForTermination {
  NOT_INITIALIZED = 2, OUT_OF_DOMAIN = 1, OUT_OF_LENGTH = 4, OUT_OF_STEPS = 5,
  STAGNATION = 6, UNEXPECTED_VALUE = 3
}
 Specify the source object used to generate starting points (seeds). New style. More...
enum  Solvers {
  NONE = 3, RUNGE_KUTTA2 = 0, RUNGE_KUTTA4 = 1, RUNGE_KUTTA45 = 2,
  UNKNOWN = 4
}
 Specify the source object used to generate starting points (seeds). New style. More...
enum  Units { CELL_LENGTH_UNIT = 2, LENGTH_UNIT = 1 }
 Specify the source object used to generate starting points (seeds). New style. More...

Public Member Functions

 vtkStreamTracer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkStreamTracer ()
 Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit).
virtual bool GetComputeVorticity ()
 Description Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter.
virtual double GetInitialIntegrationStep ()
 Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4)
virtual int GetIntegrationDirection ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
virtual int GetIntegrationDirectionMaxValue ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
virtual int GetIntegrationDirectionMinValue ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
int GetIntegrationStepUnit ()
 Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. NOTE: The valid unit is now limited to only LENGTH_UNIT (1) and CELL_LENGTH_UNIT (2), EXCLUDING the previously-supported TIME_UNIT.
virtual
vtkInitialValueProblemSolver 
GetIntegrator ()
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
int GetIntegratorType ()
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
virtual double GetMaximumError ()
 Description Specify the maximum error tolerated throughout streamline integration.
virtual double GetMaximumIntegrationStep ()
 Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)
virtual int GetMaximumNumberOfSteps ()
 Description Specify the maximum number of steps for integrating a streamline.
virtual double GetMaximumPropagation ()
 Specify the maximum length of a streamline expressed in LENGTH_UNIT.
virtual double GetMinimumIntegrationStep ()
 Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)
virtual double GetRotationScale ()
 Description This can be used to scale the rate with which the streamribbons twist. The default is 1.
vtkDataSet GetSource ()
 Specify the source object used to generate starting points (seeds). Old style. Do not use.
virtual double[] GetStartPosition ()
 Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.
virtual void GetStartPosition (ref double _arg1, ref double _arg2, ref double _arg3)
 Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.
virtual void GetStartPosition (IntPtr _arg)
 Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.
virtual double GetTerminalSpeed ()
 Description Specify the terminal speed value, below which integration is terminated.
override int IsA (string type)
 Undocumented Block.
new vtkStreamTracer NewInstance ()
 Undocumented Block.
virtual void SetComputeVorticity (bool _arg)
 Description Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter.
virtual void SetInitialIntegrationStep (double _arg)
 Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4)
virtual void SetIntegrationDirection (int _arg)
 Specify whether the streamline is integrated in the upstream or downstream direction.
void SetIntegrationDirectionToBackward ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
void SetIntegrationDirectionToBoth ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
void SetIntegrationDirectionToForward ()
 Specify whether the streamline is integrated in the upstream or downstream direction.
void SetIntegrationStepUnit (int unit)
 Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. NOTE: The valid unit is now limited to only LENGTH_UNIT (1) and CELL_LENGTH_UNIT (2), EXCLUDING the previously-supported TIME_UNIT.
void SetIntegrator (vtkInitialValueProblemSolver arg0)
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
void SetIntegratorType (int type)
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
void SetIntegratorTypeToRungeKutta2 ()
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
void SetIntegratorTypeToRungeKutta4 ()
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
void SetIntegratorTypeToRungeKutta45 ()
 Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.
void SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField ivf)
 The object used to interpolate the velocity field during integration is of the same class as this prototype.
void SetInterpolatorType (int interpType)
 Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration. The latter (adopting vtkAbstractCellLocator sub-classes such as vtkCellLocator and vtkModifiedBSPTree) is more robust then the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator).
void SetInterpolatorTypeToCellLocator ()
 Set the velocity field interpolator type to the one involving a cell locator.
void SetInterpolatorTypeToDataSetPointLocator ()
 Set the velocity field interpolator type to the one involving a dataset point locator.
virtual void SetMaximumError (double _arg)
 Description Specify the maximum error tolerated throughout streamline integration.
virtual void SetMaximumIntegrationStep (double _arg)
 Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)
virtual void SetMaximumNumberOfSteps (int _arg)
 Description Specify the maximum number of steps for integrating a streamline.
virtual void SetMaximumPropagation (double _arg)
 Specify the maximum length of a streamline expressed in LENGTH_UNIT.
virtual void SetMinimumIntegrationStep (double _arg)
 Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)
virtual void SetRotationScale (double _arg)
 Description This can be used to scale the rate with which the streamribbons twist. The default is 1.
void SetSource (vtkDataSet source)
 Specify the source object used to generate starting points (seeds). Old style. Do not use.
void SetSourceConnection (vtkAlgorithmOutput algOutput)
 Specify the source object used to generate starting points (seeds). New style.
virtual void SetStartPosition (double _arg1, double _arg2, double _arg3)
 Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.
virtual void SetStartPosition (IntPtr _arg)
 Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.
virtual void SetTerminalSpeed (double _arg)
 Description Specify the terminal speed value, below which integration is terminated.

Static Public Member Functions

static new vtkStreamTracer New ()
 Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit).
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkStreamTracer SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkStreamTracer"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkStreamTracer"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkStreamTracer_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkStreamTracer_GetComputeVorticity_01 (HandleRef pThis)
static internal double vtkStreamTracer_GetInitialIntegrationStep_02 (HandleRef pThis)
static internal int vtkStreamTracer_GetIntegrationDirection_03 (HandleRef pThis)
static internal int vtkStreamTracer_GetIntegrationDirectionMaxValue_04 (HandleRef pThis)
static internal int vtkStreamTracer_GetIntegrationDirectionMinValue_05 (HandleRef pThis)
static internal int vtkStreamTracer_GetIntegrationStepUnit_06 (HandleRef pThis)
static internal IntPtr vtkStreamTracer_GetIntegrator_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkStreamTracer_GetIntegratorType_08 (HandleRef pThis)
static internal double vtkStreamTracer_GetMaximumError_09 (HandleRef pThis)
static internal double vtkStreamTracer_GetMaximumIntegrationStep_10 (HandleRef pThis)
static internal int vtkStreamTracer_GetMaximumNumberOfSteps_11 (HandleRef pThis)
static internal double vtkStreamTracer_GetMaximumPropagation_12 (HandleRef pThis)
static internal double vtkStreamTracer_GetMinimumIntegrationStep_13 (HandleRef pThis)
static internal double vtkStreamTracer_GetRotationScale_14 (HandleRef pThis)
static internal IntPtr vtkStreamTracer_GetSource_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkStreamTracer_GetStartPosition_16 (HandleRef pThis)
static internal void vtkStreamTracer_GetStartPosition_17 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkStreamTracer_GetStartPosition_18 (HandleRef pThis, IntPtr _arg)
static internal double vtkStreamTracer_GetTerminalSpeed_19 (HandleRef pThis)
static internal int vtkStreamTracer_IsA_20 (HandleRef pThis, string type)
static internal int vtkStreamTracer_IsTypeOf_21 (string type)
static internal IntPtr vtkStreamTracer_NewInstance_23 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkStreamTracer_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkStreamTracer_SetComputeVorticity_25 (HandleRef pThis, byte _arg)
static internal void vtkStreamTracer_SetInitialIntegrationStep_26 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetIntegrationDirection_27 (HandleRef pThis, int _arg)
static internal void vtkStreamTracer_SetIntegrationDirectionToBackward_28 (HandleRef pThis)
static internal void vtkStreamTracer_SetIntegrationDirectionToBoth_29 (HandleRef pThis)
static internal void vtkStreamTracer_SetIntegrationDirectionToForward_30 (HandleRef pThis)
static internal void vtkStreamTracer_SetIntegrationStepUnit_31 (HandleRef pThis, int unit)
static internal void vtkStreamTracer_SetIntegrator_32 (HandleRef pThis, HandleRef arg0)
static internal void vtkStreamTracer_SetIntegratorType_33 (HandleRef pThis, int type)
static internal void vtkStreamTracer_SetIntegratorTypeToRungeKutta2_34 (HandleRef pThis)
static internal void vtkStreamTracer_SetIntegratorTypeToRungeKutta4_35 (HandleRef pThis)
static internal void vtkStreamTracer_SetIntegratorTypeToRungeKutta45_36 (HandleRef pThis)
static internal void vtkStreamTracer_SetInterpolatorPrototype_37 (HandleRef pThis, HandleRef ivf)
static internal void vtkStreamTracer_SetInterpolatorType_38 (HandleRef pThis, int interpType)
static internal void vtkStreamTracer_SetInterpolatorTypeToCellLocator_39 (HandleRef pThis)
static internal void vtkStreamTracer_SetInterpolatorTypeToDataSetPointLocator_40 (HandleRef pThis)
static internal void vtkStreamTracer_SetMaximumError_41 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetMaximumIntegrationStep_42 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetMaximumNumberOfSteps_43 (HandleRef pThis, int _arg)
static internal void vtkStreamTracer_SetMaximumPropagation_44 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetMinimumIntegrationStep_45 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetRotationScale_46 (HandleRef pThis, double _arg)
static internal void vtkStreamTracer_SetSource_47 (HandleRef pThis, HandleRef source)
static internal void vtkStreamTracer_SetSourceConnection_48 (HandleRef pThis, HandleRef algOutput)
static internal void vtkStreamTracer_SetStartPosition_49 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkStreamTracer_SetStartPosition_50 (HandleRef pThis, IntPtr _arg)
static internal void vtkStreamTracer_SetTerminalSpeed_51 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkStreamTracer ()
 Automatically generated type registration mechanics.

Detailed Description

vtkStreamTracer - Streamline generator

Description vtkStreamTracer is a filter that integrates a vector field to generate streamlines. The integration is performed using a specified integrator, by default Runge-Kutta2.

vtkStreamTracer produces polylines as the output, with each cell (i.e., polyline) representing a streamline. The attribute values associated with each streamline are stored in the cell data, whereas those associated with streamline-points are stored in the point data.

vtkStreamTracer supports forward (the default), backward, and combined (i.e., BOTH) integration. The length of a streamline is governed by specifying a maximum value either in physical arc length or in (local) cell length. Otherwise, the integration terminates upon exiting the flow field domain, or if the particle speed is reduced to a value less than a specified terminal speed, or when a maximum number of steps is completed. The specific reason for the termination is stored in a cell array named ReasonForTermination.

Note that normalized vectors are adopted in streamline integration, which achieves high numerical accuracy/smoothness of flow lines that is particularly guranteed for Runge-Kutta45 with adaptive step size and error control). In support of this feature, the underlying step size is ALWAYS in arc length unit (LENGTH_UNIT) while the 'real' time interval (virtual for steady flows) that a particle actually takes to trave in a single step is obtained by dividing the arc length by the LOCAL speed. The overall elapsed time (i.e., the life span) of the particle is the sum of those individual step-wise time intervals.

The quality of streamline integration can be controlled by setting the initial integration step (InitialIntegrationStep), particularly for Runge-Kutta2 and Runge-Kutta4 (with a fixed step size), and in the case of Runge-Kutta45 (with an adaptive step size and error control) the minimum integration step, the maximum integration step, and the maximum error. These steps are in either LENGTH_UNIT or CELL_LENGTH_UNIT while the error is in physical arc length. For the former two integrators, there is a trade-off between integration speed and streamline quality.

The integration time, vorticity, rotation and angular velocity are stored in point data arrays named "IntegrationTime", "Vorticity", "Rotation" and "AngularVelocity", respectively (vorticity, rotation and angular velocity are computed only when ComputeVorticity is on). All point data attributes in the source dataset are interpolated on the new streamline points.

vtkStreamTracer supports integration through any type of dataset. Thus if the dataset contains 2D cells like polygons or triangles, the integration is constrained to lie on the surface defined by 2D cells.

The starting point, or the so-called 'seed', of a streamline may be set in two different ways. Starting from global x-y-z "position" allows you to start a single trace at a specified x-y-z coordinate. If you specify a source object, traces will be generated from each point in the source that is inside the dataset.

vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkTemporalStreamTracer vtkAbstractInterpolatedVelocityField vtkInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField


Member Enumeration Documentation

Description Specify the terminal speed value, below which integration is terminated.

Enumerator:
BACKWARD 

enum member

BOTH 

enum member

FORWARD 

enum member

Description Specify the terminal speed value, below which integration is terminated.

Enumerator:
INTERPOLATOR_WITH_CELL_LOCATOR 

enum member

INTERPOLATOR_WITH_DATASET_POINT_LOCATOR 

enum member

Specify the source object used to generate starting points (seeds). New style.

Enumerator:
NOT_INITIALIZED 

enum member

OUT_OF_DOMAIN 

enum member

OUT_OF_LENGTH 

enum member

OUT_OF_STEPS 

enum member

STAGNATION 

enum member

UNEXPECTED_VALUE 

enum member

Specify the source object used to generate starting points (seeds). New style.

Enumerator:
NONE 

enum member

RUNGE_KUTTA2 

enum member

RUNGE_KUTTA4 

enum member

RUNGE_KUTTA45 

enum member

UNKNOWN 

enum member

Specify the source object used to generate starting points (seeds). New style.

Enumerator:
CELL_LENGTH_UNIT 

enum member

LENGTH_UNIT 

enum member

Reimplemented in Kitware.VTK.vtkTemporalStreamTracer.


Constructor & Destructor Documentation

static Kitware.VTK.vtkStreamTracer.vtkStreamTracer ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkStreamTracer.vtkStreamTracer ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit).


Member Function Documentation

override void Kitware.VTK.vtkStreamTracer.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Reimplemented in Kitware.VTK.vtkDistributedStreamTracer, Kitware.VTK.vtkTemporalStreamTracer, and Kitware.VTK.vtkPStreamTracer.

Description Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter.

Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4)

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. NOTE: The valid unit is now limited to only LENGTH_UNIT (1) and CELL_LENGTH_UNIT (2), EXCLUDING the previously-supported TIME_UNIT.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

Here is the call graph for this function:

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

virtual double Kitware.VTK.vtkStreamTracer.GetMaximumError ( ) [virtual]

Description Specify the maximum error tolerated throughout streamline integration.

Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

Description Specify the maximum number of steps for integrating a streamline.

Specify the maximum length of a streamline expressed in LENGTH_UNIT.

Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

virtual double Kitware.VTK.vtkStreamTracer.GetRotationScale ( ) [virtual]

Description This can be used to scale the rate with which the streamribbons twist. The default is 1.

Specify the source object used to generate starting points (seeds). Old style. Do not use.

Here is the call graph for this function:

virtual double [] Kitware.VTK.vtkStreamTracer.GetStartPosition ( ) [virtual]

Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.

virtual void Kitware.VTK.vtkStreamTracer.GetStartPosition ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.

virtual void Kitware.VTK.vtkStreamTracer.GetStartPosition ( IntPtr  _arg) [virtual]

Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.

virtual double Kitware.VTK.vtkStreamTracer.GetTerminalSpeed ( ) [virtual]

Description Specify the terminal speed value, below which integration is terminated.

override int Kitware.VTK.vtkStreamTracer.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkStreamTracer.IsTypeOf ( string  type) [static]

Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit).

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Reimplemented in Kitware.VTK.vtkDistributedStreamTracer, and Kitware.VTK.vtkTemporalStreamTracer.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Reimplemented in Kitware.VTK.vtkTemporalStreamTracer, Kitware.VTK.vtkDistributedStreamTracer, and Kitware.VTK.vtkPStreamTracer.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkStreamTracer.SetComputeVorticity ( bool  _arg) [virtual]

Description Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter.

virtual void Kitware.VTK.vtkStreamTracer.SetInitialIntegrationStep ( double  _arg) [virtual]

Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4)

virtual void Kitware.VTK.vtkStreamTracer.SetIntegrationDirection ( int  _arg) [virtual]

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify whether the streamline is integrated in the upstream or downstream direction.

Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. NOTE: The valid unit is now limited to only LENGTH_UNIT (1) and CELL_LENGTH_UNIT (2), EXCLUDING the previously-supported TIME_UNIT.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

Set/get the integrator type to be used for streamline generation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2.

The object used to interpolate the velocity field during integration is of the same class as this prototype.

Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration. The latter (adopting vtkAbstractCellLocator sub-classes such as vtkCellLocator and vtkModifiedBSPTree) is more robust then the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator).

Set the velocity field interpolator type to the one involving a cell locator.

Set the velocity field interpolator type to the one involving a dataset point locator.

virtual void Kitware.VTK.vtkStreamTracer.SetMaximumError ( double  _arg) [virtual]

Description Specify the maximum error tolerated throughout streamline integration.

virtual void Kitware.VTK.vtkStreamTracer.SetMaximumIntegrationStep ( double  _arg) [virtual]

Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

virtual void Kitware.VTK.vtkStreamTracer.SetMaximumNumberOfSteps ( int  _arg) [virtual]

Description Specify the maximum number of steps for integrating a streamline.

virtual void Kitware.VTK.vtkStreamTracer.SetMaximumPropagation ( double  _arg) [virtual]

Specify the maximum length of a streamline expressed in LENGTH_UNIT.

virtual void Kitware.VTK.vtkStreamTracer.SetMinimumIntegrationStep ( double  _arg) [virtual]

Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

virtual void Kitware.VTK.vtkStreamTracer.SetRotationScale ( double  _arg) [virtual]

Description This can be used to scale the rate with which the streamribbons twist. The default is 1.

Specify the source object used to generate starting points (seeds). Old style. Do not use.

Specify the source object used to generate starting points (seeds). New style.

virtual void Kitware.VTK.vtkStreamTracer.SetStartPosition ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.

virtual void Kitware.VTK.vtkStreamTracer.SetStartPosition ( IntPtr  _arg) [virtual]

Specify the starting point (seed) of a streamline in the global coordinate system. Search must be performed to find the initial cell from which to start integration.

virtual void Kitware.VTK.vtkStreamTracer.SetTerminalSpeed ( double  _arg) [virtual]

Description Specify the terminal speed value, below which integration is terminated.

static internal byte Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetComputeVorticity_01 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetInitialIntegrationStep_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegrationDirection_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegrationDirectionMaxValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegrationDirectionMinValue_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegrationStepUnit_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegrator_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetIntegratorType_08 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetMaximumError_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetMaximumIntegrationStep_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetMaximumNumberOfSteps_11 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetMaximumPropagation_12 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetMinimumIntegrationStep_13 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetRotationScale_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetSource_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetStartPosition_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetStartPosition_17 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetStartPosition_18 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal double Kitware.VTK.vtkStreamTracer.vtkStreamTracer_GetTerminalSpeed_19 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_IsA_20 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkStreamTracer.vtkStreamTracer_IsTypeOf_21 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_NewInstance_23 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetComputeVorticity_25 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetInitialIntegrationStep_26 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrationDirection_27 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrationDirectionToBackward_28 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrationDirectionToBoth_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrationDirectionToForward_30 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrationStepUnit_31 ( HandleRef  pThis,
int  unit 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegrator_32 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegratorType_33 ( HandleRef  pThis,
int  type 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegratorTypeToRungeKutta2_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegratorTypeToRungeKutta45_36 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetIntegratorTypeToRungeKutta4_35 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetInterpolatorPrototype_37 ( HandleRef  pThis,
HandleRef  ivf 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetInterpolatorType_38 ( HandleRef  pThis,
int  interpType 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetInterpolatorTypeToCellLocator_39 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetMaximumError_41 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetMaximumIntegrationStep_42 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetMaximumNumberOfSteps_43 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetMaximumPropagation_44 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetMinimumIntegrationStep_45 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetRotationScale_46 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetSource_47 ( HandleRef  pThis,
HandleRef  source 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetSourceConnection_48 ( HandleRef  pThis,
HandleRef  algOutput 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetStartPosition_49 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetStartPosition_50 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkStreamTracer.vtkStreamTracer_SetTerminalSpeed_51 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkStreamTracer.MRClassNameKey = "15vtkStreamTracer" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Reimplemented in Kitware.VTK.vtkDistributedStreamTracer, Kitware.VTK.vtkPStreamTracer, and Kitware.VTK.vtkTemporalStreamTracer.

new const string Kitware.VTK.vtkStreamTracer.MRFullTypeName = "Kitware.VTK.vtkStreamTracer"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Reimplemented in Kitware.VTK.vtkDistributedStreamTracer, Kitware.VTK.vtkPStreamTracer, and Kitware.VTK.vtkTemporalStreamTracer.


The documentation for this class was generated from the following file: