vtkStreamTracer Class Reference

#include <vtkStreamTracer.h>

Inheritance diagram for vtkStreamTracer:

[legend]

Collaboration diagram for vtkStreamTracer:

[legend]

List of all members.

Detailed Description

Streamline generator.

vtkStreamTracer is a filter that integrates a vector field to generate streamlines. The integration is performed using the provided integrator. The default is second order Runge-Kutta.

vtkStreamTracer generate polylines as output. Each cell (polyline) corresponds to one streamline. The values associated with each streamline are stored in the cell data whereas the values associated with points are stored in point data.

Note that vtkStreamTracer can integrate both forward and backward. The length of the streamline is controlled by specifying either a maximum value in the units of length, cell length or elapsed time (the elapsed time is the time each particle would have traveled if flow were steady). Otherwise, the integration terminates after exiting the dataset or if the particle speed is reduced to a value less than the terminal speed or when a maximum number of steps is reached. The reason for the termination is stored in a cell array named ReasonForTermination.

The quality of integration can be controlled by setting integration step (InitialIntegrationStep) and in the case of adaptive solvers the maximum error, the minimum integration step and the maximum integration step. All of these can have units of length, cell length or elapsed time.

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

vtkStreamTracer integrates through any type of dataset. As a result, if the dataset contains 2D cells such as polygons or triangles, the integration is constrained to lie on the surface defined by the 2D cells.

The starting point of traces may be defined 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, a trace will be generated for each point in the source that is inside the dataset.

See also:: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45

Tests:: vtkStreamTracer (Tests)

Definition at line 84 of file vtkStreamTracer.h.


Public Types
enum	Units { TIME_UNIT, LENGTH_UNIT, CELL_LENGTH_UNIT }
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_TIME = 4, OUT_OF_STEPS = 5, STAGNATION = 6 }
enum	{ FORWARD, BACKWARD, BOTH }
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
void	SetInterpolatorPrototype (vtkInterpolatedVelocityField *ivf)

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	SetSource (vtkDataSet *source)
vtkDataSet *	GetSource ()

void	SetIntegrator (vtkInitialValueProblemSolver *)
virtual vtkInitialValueProblemSolver *	GetIntegrator ()
void	SetIntegratorType (int type)
int	GetIntegratorType ()
void	SetIntegratorTypeToRungeKutta2 ()
void	SetIntegratorTypeToRungeKutta4 ()
void	SetIntegratorTypeToRungeKutta45 ()

void	SetMaximumPropagation (int unit, double max)
void	SetMaximumPropagation (double max)
void	SetMaximumPropagationUnit (int unit)
int	GetMaximumPropagationUnit ()
double	GetMaximumPropagation ()
void	SetMaximumPropagationUnitToTimeUnit ()
void	SetMaximumPropagationUnitToLengthUnit ()
void	SetMaximumPropagationUnitToCellLengthUnit ()

void	SetMinimumIntegrationStep (int unit, double step)
void	SetMinimumIntegrationStepUnit (int unit)
void	SetMinimumIntegrationStep (double step)
int	GetMinimumIntegrationStepUnit ()
double	GetMinimumIntegrationStep ()
void	SetMinimumIntegrationStepUnitToTimeUnit ()
void	SetMinimumIntegrationStepUnitToLengthUnit ()
void	SetMinimumIntegrationStepUnitToCellLengthUnit ()

void	SetMaximumIntegrationStep (int unit, double step)
void	SetMaximumIntegrationStepUnit (int unit)
void	SetMaximumIntegrationStep (double step)
int	GetMaximumIntegrationStepUnit ()
double	GetMaximumIntegrationStep ()
void	SetMaximumIntegrationStepUnitToTimeUnit ()
void	SetMaximumIntegrationStepUnitToLengthUnit ()
void	SetMaximumIntegrationStepUnitToCellLengthUnit ()

void	SetInitialIntegrationStep (int unit, double step)
void	SetInitialIntegrationStepUnit (int unit)
void	SetInitialIntegrationStep (double step)
int	GetInitialIntegrationStepUnit ()
double	GetInitialIntegrationStep ()
void	SetInitialIntegrationStepUnitToTimeUnit ()
void	SetInitialIntegrationStepUnitToLengthUnit ()
void	SetInitialIntegrationStepUnitToCellLengthUnit ()

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 (int)
virtual int	GetComputeVorticity ()
virtual void	ComputeVorticityOn ()
virtual void	ComputeVorticityOff ()

virtual void	SetRotationScale (double)
virtual double	GetRotationScale ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkStreamTracer *	SafeDownCast (vtkObject *o)
static vtkStreamTracer *	New ()
Protected Member Functions
	vtkStreamTracer ()
	~vtkStreamTracer ()
virtual vtkExecutive *	CreateDefaultExecutive ()
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 (vtkDataSet input, vtkPolyData output, vtkDataArray seedSource, vtkIdList seedIds, vtkIntArray integrationDirections, double lastPoint[3], vtkInterpolatedVelocityField func, int maxCellSize, const char *vecFieldName, double &propagation, vtkIdType &numSteps)
void	SimpleIntegrate (double seed[3], double lastPoint[3], double delt, vtkInterpolatedVelocityField *func)
int	CheckInputs (vtkInterpolatedVelocityField &func, int maxCellSize)
void	GenerateNormals (vtkPolyData output, double firstNormal, const char *vecName)
void	SetIntervalInformation (int unit, double interval, IntervalInformation &currentValues)
void	SetIntervalInformation (int unit, IntervalInformation &currentValues)
void	ConvertIntervals (double &step, double &minStep, double &maxStep, int direction, double cellLength, double speed)
int	SetupOutput (vtkInformation inInfo, vtkInformation outInfo)
void	InitializeSeeds (vtkDataArray &seeds, vtkIdList &seedIds, vtkIntArray &integrationDirections, vtkDataSet source)
Static Protected Member Functions
static double	ConvertToTime (IntervalInformation &interval, double cellLength, double speed)
static double	ConvertToLength (IntervalInformation &interval, double cellLength, double speed)
static double	ConvertToCellLength (IntervalInformation &interval, double cellLength, double speed)
static double	ConvertToUnit (IntervalInformation &interval, int unit, double cellLength, double speed)
Protected Attributes
int	GenerateNormalsInIntegrate
double	StartPosition [3]
double	TerminalSpeed
double	LastUsedTimeStep
IntervalInformation	MaximumPropagation
IntervalInformation	MinimumIntegrationStep
IntervalInformation	MaximumIntegrationStep
IntervalInformation	InitialIntegrationStep
int	IntegrationDirection
vtkInitialValueProblemSolver *	Integrator
double	MaximumError
vtkIdType	MaximumNumberOfSteps
int	ComputeVorticity
double	RotationScale
vtkInterpolatedVelocityField *	InterpolatorPrototype
vtkCompositeDataSet *	InputData
Static Protected Attributes
static const double	EPSILON
Classes
struct	IntervalInformation

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkStreamTracer::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

Definition at line 87 of file vtkStreamTracer.h.

Member Enumeration Documentation

enum vtkStreamTracer::Units

Enumerator:

TIME_UNIT
LENGTH_UNIT
CELL_LENGTH_UNIT

Reimplemented in vtkTemporalStreamTracer.

Definition at line 116 of file vtkStreamTracer.h.

enum vtkStreamTracer::Solvers

Enumerator:

RUNGE_KUTTA2
RUNGE_KUTTA4
RUNGE_KUTTA45
NONE
UNKNOWN

Definition at line 123 of file vtkStreamTracer.h.

enum vtkStreamTracer::ReasonForTermination

Enumerator:

OUT_OF_DOMAIN
NOT_INITIALIZED
UNEXPECTED_VALUE
OUT_OF_TIME
OUT_OF_STEPS
STAGNATION

Definition at line 132 of file vtkStreamTracer.h.

anonymous enum

Enumerator:

FORWARD
BACKWARD
BOTH

Definition at line 252 of file vtkStreamTracer.h.

Constructor & Destructor Documentation

vtkStreamTracer::vtkStreamTracer ( ) [protected]

vtkStreamTracer::~vtkStreamTracer ( ) [protected]

Member Function Documentation

virtual const char* vtkStreamTracer::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

static int vtkStreamTracer::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

virtual int vtkStreamTracer::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

static vtkStreamTracer* vtkStreamTracer::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

void vtkStreamTracer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.

static vtkStreamTracer* vtkStreamTracer::New ( ) [static]

Construct object to start from position (0,0,0), integrate forward, terminal speed 1.0E-12, vorticity computation on, integration step length 0.5 (unit cell length), maximum number of steps 2000, using 2nd order Runge Kutta and maximum propagation 1.0 (unit length).

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDistributedStreamTracer, and vtkTemporalStreamTracer.

virtual void vtkStreamTracer::SetStartPosition	(	double	,
		double	,
		double
	)			`[virtual]`

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

virtual void vtkStreamTracer::SetStartPosition ( double [3] ) [virtual]

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

virtual double* vtkStreamTracer::GetStartPosition ( ) [virtual]

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

virtual void vtkStreamTracer::GetStartPosition	(	double &	,
		double &	,
		double &
	)			`[virtual]`

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

virtual void vtkStreamTracer::GetStartPosition ( double [3] ) [virtual]

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

void vtkStreamTracer::SetSource ( vtkDataSet * source )

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

vtkDataSet* vtkStreamTracer::GetSource ( )

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

void vtkStreamTracer::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

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

void vtkStreamTracer::SetIntegrator ( vtkInitialValueProblemSolver * )

Set/get the integrator type to be used in the stream line calculation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is 2nd order Runge Kutta. 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 in the stream line calculation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is 2nd order Runge Kutta. 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 in the stream line calculation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is 2nd order Runge Kutta. 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 in the stream line calculation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is 2nd order Runge Kutta. 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 in the stream line calculation. The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is 2nd order Runge Kutta. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2

Definition at line 154 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegratorTypeToRungeKutta4 ( ) [inline]

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

Definition at line 156 of file vtkStreamTracer.h.

void vtkStreamTracer::SetIntegratorTypeToRungeKutta45 ( ) [inline]

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

Definition at line 158 of file vtkStreamTracer.h.

void vtkStreamTracer::SetMaximumPropagation	(	int	unit,
		double	max
	)