VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkStreamTracer Class Reference

Streamline generator. More...

#include <vtkStreamTracer.h>

Inheritance diagram for vtkStreamTracer:
[legend]
Collaboration diagram for vtkStreamTracer:
[legend]

Classes

struct  IntervalInformation
 

Public Types

enum  Units { LENGTH_UNIT = 1, CELL_LENGTH_UNIT = 2 }
 
enum  Solvers {
  RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE,
  UNKNOWN
}
 
enum  ReasonForTermination {
  OUT_OF_DOMAIN = vtkInitialValueProblemSolver::OUT_OF_DOMAIN, NOT_INITIALIZED = vtkInitialValueProblemSolver::NOT_INITIALIZED, UNEXPECTED_VALUE = vtkInitialValueProblemSolver::UNEXPECTED_VALUE, OUT_OF_LENGTH = 4,
  OUT_OF_STEPS = 5, STAGNATION = 6
}
 
enum  { FORWARD, BACKWARD, BOTH }
 
enum  { INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }
 
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkStreamTracerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
void SetInterpolatorTypeToDataSetPointLocator ()
 
void SetInterpolatorTypeToCellLocator ()
 
void SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField *ivf)
 
void SetInterpolatorType (int interpType)
 
virtual void SetStartPosition (double, double, double)
 
virtual void SetStartPosition (double[3])
 
virtual double * GetStartPosition ()
 
virtual void GetStartPosition (double &, double &, double &)
 
virtual void GetStartPosition (double[3])
 
void SetSourceData (vtkDataSet *source)
 
vtkDataSet * GetSource ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 
virtual
vtkInitialValueProblemSolver
GetIntegrator ()
 
void SetIntegratorType (int type)
 
int GetIntegratorType ()
 
void SetIntegratorTypeToRungeKutta2 ()
 
void SetIntegratorTypeToRungeKutta4 ()
 
void SetIntegratorTypeToRungeKutta45 ()
 
virtual void SetMaximumPropagation (double)
 
virtual double GetMaximumPropagation ()
 
void SetIntegrationStepUnit (int unit)
 
int GetIntegrationStepUnit ()
 
virtual void SetInitialIntegrationStep (double)
 
virtual double GetInitialIntegrationStep ()
 
virtual void SetMinimumIntegrationStep (double)
 
virtual double GetMinimumIntegrationStep ()
 
virtual void SetMaximumIntegrationStep (double)
 
virtual double GetMaximumIntegrationStep ()
 
virtual void SetMaximumError (double)
 
virtual double GetMaximumError ()
 
virtual void SetMaximumNumberOfSteps (vtkIdType)
 
virtual vtkIdType GetMaximumNumberOfSteps ()
 
virtual void SetTerminalSpeed (double)
 
virtual double GetTerminalSpeed ()
 
virtual void SetIntegrationDirection (int)
 
virtual int GetIntegrationDirection ()
 
void SetIntegrationDirectionToForward ()
 
void SetIntegrationDirectionToBackward ()
 
void SetIntegrationDirectionToBoth ()
 
virtual void SetComputeVorticity (bool)
 
virtual bool GetComputeVorticity ()
 
virtual void SetRotationScale (double)
 
virtual double GetRotationScale ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStreamTracerSafeDownCast (vtkObjectBase *o)
 
static vtkStreamTracerNew ()
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkStreamTracer ()
 
 ~vtkStreamTracer ()
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
void AddInput (vtkDataObject *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int, vtkInformation *)
 
void CalculateVorticity (vtkGenericCell *cell, double pcoords[3], vtkDoubleArray *cellVectors, double vorticity[3])
 
void Integrate (vtkPointData *inputData, vtkPolyData *output, vtkDataArray *seedSource, vtkIdList *seedIds, vtkIntArray *integrationDirections, double lastPoint[3], vtkAbstractInterpolatedVelocityField *func, int maxCellSize, int vecType, const char *vecFieldName, double &propagation, vtkIdType &numSteps)
 
void SimpleIntegrate (double seed[3], double lastPoint[3], double stepSize, vtkAbstractInterpolatedVelocityField *func)
 
int CheckInputs (vtkAbstractInterpolatedVelocityField *&func, int *maxCellSize)
 
void GenerateNormals (vtkPolyData *output, double *firstNormal, const char *vecName)
 
void ConvertIntervals (double &step, double &minStep, double &maxStep, int direction, double cellLength)
 
int SetupOutput (vtkInformation *inInfo, vtkInformation *outInfo)
 
void InitializeSeeds (vtkDataArray *&seeds, vtkIdList *&seedIds, vtkIntArray *&integrationDirections, vtkDataSet *source)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Static Protected Member Functions

static double ConvertToLength (double interval, int unit, double cellLength)
 
static double ConvertToLength (IntervalInformation &interval, double cellLength)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

bool GenerateNormalsInIntegrate
 
double StartPosition [3]
 
double TerminalSpeed
 
double LastUsedStepSize
 
double MaximumPropagation
 
double MinimumIntegrationStep
 
double MaximumIntegrationStep
 
double InitialIntegrationStep
 
int IntegrationStepUnit
 
int IntegrationDirection
 
vtkInitialValueProblemSolverIntegrator
 
double MaximumError
 
vtkIdType MaximumNumberOfSteps
 
bool ComputeVorticity
 
double RotationScale
 
vtkAbstractInterpolatedVelocityFieldInterpolatorPrototype
 
vtkCompositeDataSetInputData
 
bool HasMatchingPointAttributes
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Static Protected Attributes

static const double EPSILON
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Friends

class PStreamTracerUtils
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 

Detailed Description

Streamline generator.

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 guaranteed 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.

See Also
vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkTemporalStreamTracer vtkAbstractInterpolatedVelocityField vtkInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField
Examples:
vtkStreamTracer (Examples)
Tests:
vtkStreamTracer (Tests)

Definition at line 102 of file vtkStreamTracer.h.

Member Typedef Documentation

Definition at line 105 of file vtkStreamTracer.h.

Member Enumeration Documentation

Enumerator
LENGTH_UNIT 
CELL_LENGTH_UNIT 

Definition at line 144 of file vtkStreamTracer.h.

Enumerator
RUNGE_KUTTA2 
RUNGE_KUTTA4 
RUNGE_KUTTA45 
NONE 
UNKNOWN 

Definition at line 150 of file vtkStreamTracer.h.

Enumerator
OUT_OF_DOMAIN 
NOT_INITIALIZED 
UNEXPECTED_VALUE 
OUT_OF_LENGTH 
OUT_OF_STEPS 
STAGNATION 

Definition at line 159 of file vtkStreamTracer.h.

anonymous enum
Enumerator
FORWARD 
BACKWARD 
BOTH 

Definition at line 258 of file vtkStreamTracer.h.

anonymous enum
Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR 
INTERPOLATOR_WITH_CELL_LOCATOR 

Definition at line 265 of file vtkStreamTracer.h.

Constructor & Destructor Documentation

vtkStreamTracer::vtkStreamTracer ( )
protected
vtkStreamTracer::~vtkStreamTracer ( )
protected

Member Function Documentation

static int vtkStreamTracer::IsTypeOf ( const char *  type)
static
virtual int vtkStreamTracer::IsA ( const char *  type)
virtual
static vtkStreamTracer* vtkStreamTracer::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkStreamTracer::NewInstanceInternal ( ) const
protectedvirtual
vtkStreamTracer* vtkStreamTracer::NewInstance ( ) const
void vtkStreamTracer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkStreamTracer* vtkStreamTracer::New ( )
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).

virtual void vtkStreamTracer::SetStartPosition ( double  ,
double  ,
double   
)
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 vtkStreamTracer::SetStartPosition ( double  [3])
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* 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 vtkStreamTracer::GetStartPosition ( double &  ,
double &  ,
double &   
)
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 vtkStreamTracer::GetStartPosition ( double  [3])
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.

void vtkStreamTracer::SetSourceData ( vtkDataSet *  source)

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

vtkDataSet* vtkStreamTracer::GetSource ( )

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

void vtkStreamTracer::SetSourceConnection ( vtkAlgorithmOutput algOutput)

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

void vtkStreamTracer::SetIntegrator ( vtkInitialValueProblemSolver )

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 vtkInitialValueProblemSolver* vtkStreamTracer::GetIntegrator ( )
virtual

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 vtkStreamTracer::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

int vtkStreamTracer::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

void vtkStreamTracer::SetIntegratorTypeToRungeKutta2 ( )
inline

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

Definition at line 181 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegratorTypeToRungeKutta4 ( )
inline

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

Definition at line 183 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegratorTypeToRungeKutta45 ( )
inline

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

Definition at line 185 of file vtkStreamTracer.h.

void vtkStreamTracer::SetInterpolatorTypeToDataSetPointLocator ( )

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

void vtkStreamTracer::SetInterpolatorTypeToCellLocator ( )

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

virtual void vtkStreamTracer::SetMaximumPropagation ( double  )
virtual

Specify the maximum length of a streamline expressed in LENGTH_UNIT.

virtual double vtkStreamTracer::GetMaximumPropagation ( )
virtual

Specify the maximum length of a streamline expressed in LENGTH_UNIT.

void vtkStreamTracer::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.

int vtkStreamTracer::GetIntegrationStepUnit ( )
inline

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.

Definition at line 209 of file vtkStreamTracer.h.

virtual void vtkStreamTracer::SetInitialIntegrationStep ( double  )
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 double vtkStreamTracer::GetInitialIntegrationStep ( )
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 vtkStreamTracer::SetMinimumIntegrationStep ( double  )
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 double vtkStreamTracer::GetMinimumIntegrationStep ( )
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 vtkStreamTracer::SetMaximumIntegrationStep ( double  )
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 double vtkStreamTracer::GetMaximumIntegrationStep ( )
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 vtkStreamTracer::SetMaximumError ( double  )
virtual

Specify the maximum error tolerated throughout streamline integration.

virtual double vtkStreamTracer::GetMaximumError ( )
virtual

Specify the maximum error tolerated throughout streamline integration.

virtual void vtkStreamTracer::SetMaximumNumberOfSteps ( vtkIdType  )
virtual

Specify the maximum number of steps for integrating a streamline.

virtual vtkIdType vtkStreamTracer::GetMaximumNumberOfSteps ( )
virtual

Specify the maximum number of steps for integrating a streamline.

virtual void vtkStreamTracer::SetTerminalSpeed ( double  )
virtual

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

virtual double vtkStreamTracer::GetTerminalSpeed ( )
virtual

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

virtual void vtkStreamTracer::SetIntegrationDirection ( int  )
virtual

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

virtual int vtkStreamTracer::GetIntegrationDirection ( )
virtual

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

void vtkStreamTracer::SetIntegrationDirectionToForward ( )
inline

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

Definition at line 277 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegrationDirectionToBackward ( )
inline

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

Definition at line 279 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegrationDirectionToBoth ( )
inline

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

Definition at line 281 of file vtkStreamTracer.h.

virtual void vtkStreamTracer::SetComputeVorticity ( bool  )
virtual

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

virtual bool vtkStreamTracer::GetComputeVorticity ( )
virtual

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

virtual void vtkStreamTracer::SetRotationScale ( double  )
virtual

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

virtual double vtkStreamTracer::GetRotationScale ( )
virtual

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

void vtkStreamTracer::SetInterpolatorPrototype ( vtkAbstractInterpolatedVelocityField ivf)

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

void vtkStreamTracer::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).

virtual vtkExecutive* vtkStreamTracer::CreateDefaultExecutive ( )
protectedvirtual

Create a default executive. If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). Otherwise, vtkStreamingDemandDrivenPipeline is created.

Reimplemented from vtkAlgorithm.

void vtkStreamTracer::AddInput ( vtkDataObject )
inlineprotected

Definition at line 323 of file vtkStreamTracer.h.

virtual int vtkStreamTracer::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

virtual int vtkStreamTracer::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkTemporalStreamTracer.

void vtkStreamTracer::CalculateVorticity ( vtkGenericCell cell,
double  pcoords[3],
vtkDoubleArray *  cellVectors,
double  vorticity[3] 
)
protected
void vtkStreamTracer::Integrate ( vtkPointData *  inputData,
vtkPolyData output,
vtkDataArray *  seedSource,
vtkIdList *  seedIds,
vtkIntArray *  integrationDirections,
double  lastPoint[3],
vtkAbstractInterpolatedVelocityField func,
int  maxCellSize,
int  vecType,
const char *  vecFieldName,
double &  propagation,
vtkIdType &  numSteps 
)
protected
void vtkStreamTracer::SimpleIntegrate ( double  seed[3],
double  lastPoint[3],
double  stepSize,
vtkAbstractInterpolatedVelocityField func 
)
protected
int vtkStreamTracer::CheckInputs ( vtkAbstractInterpolatedVelocityField *&  func,
int *  maxCellSize 
)
protected
void vtkStreamTracer::GenerateNormals ( vtkPolyData output,
double *  firstNormal,
const char *  vecName 
)
protected
void vtkStreamTracer::ConvertIntervals ( double &  step,
double &  minStep,
double &  maxStep,
int  direction,
double  cellLength 
)
protected
static double vtkStreamTracer::ConvertToLength ( double  interval,
int  unit,
double  cellLength 
)
staticprotected
static double vtkStreamTracer::ConvertToLength ( IntervalInformation interval,
double  cellLength 
)
staticprotected
int vtkStreamTracer::SetupOutput ( vtkInformation *  inInfo,
vtkInformation *  outInfo 
)
protected
void vtkStreamTracer::InitializeSeeds ( vtkDataArray *&  seeds,
vtkIdList *&  seedIds,
vtkIntArray *&  integrationDirections,
vtkDataSet *  source 
)
protected

Friends And Related Function Documentation

friend class PStreamTracerUtils
friend

Definition at line 404 of file vtkStreamTracer.h.

Member Data Documentation

bool vtkStreamTracer::GenerateNormalsInIntegrate
protected

Definition at line 351 of file vtkStreamTracer.h.

double vtkStreamTracer::StartPosition[3]
protected

Definition at line 354 of file vtkStreamTracer.h.

const double vtkStreamTracer::EPSILON
staticprotected

Definition at line 356 of file vtkStreamTracer.h.

double vtkStreamTracer::TerminalSpeed
protected

Definition at line 357 of file vtkStreamTracer.h.

double vtkStreamTracer::LastUsedStepSize
protected

Definition at line 359 of file vtkStreamTracer.h.

double vtkStreamTracer::MaximumPropagation
protected

Definition at line 368 of file vtkStreamTracer.h.

double vtkStreamTracer::MinimumIntegrationStep
protected

Definition at line 369 of file vtkStreamTracer.h.

double vtkStreamTracer::MaximumIntegrationStep
protected

Definition at line 370 of file vtkStreamTracer.h.

double vtkStreamTracer::InitialIntegrationStep
protected

Definition at line 371 of file vtkStreamTracer.h.

int vtkStreamTracer::IntegrationStepUnit
protected

Definition at line 387 of file vtkStreamTracer.h.

int vtkStreamTracer::IntegrationDirection
protected

Definition at line 388 of file vtkStreamTracer.h.

vtkInitialValueProblemSolver* vtkStreamTracer::Integrator
protected

Definition at line 391 of file vtkStreamTracer.h.

double vtkStreamTracer::MaximumError
protected

Definition at line 393 of file vtkStreamTracer.h.

vtkIdType vtkStreamTracer::MaximumNumberOfSteps
protected

Definition at line 394 of file vtkStreamTracer.h.

bool vtkStreamTracer::ComputeVorticity
protected

Definition at line 396 of file vtkStreamTracer.h.

double vtkStreamTracer::RotationScale
protected

Definition at line 397 of file vtkStreamTracer.h.

vtkAbstractInterpolatedVelocityField* vtkStreamTracer::InterpolatorPrototype
protected

Definition at line 399 of file vtkStreamTracer.h.

vtkCompositeDataSet* vtkStreamTracer::InputData
protected

Definition at line 401 of file vtkStreamTracer.h.

bool vtkStreamTracer::HasMatchingPointAttributes
protected

Definition at line 402 of file vtkStreamTracer.h.


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