#include <vtkStreamTracer.h>
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.
Definition at line 101 of file vtkStreamTracer.h.
Reimplemented from vtkPolyDataAlgorithm.
Reimplemented in vtkDistributedStreamTracer, vtkPStreamTracer, and vtkTemporalStreamTracer.
Definition at line 104 of file vtkStreamTracer.h.
Definition at line 149 of file vtkStreamTracer.h.
Definition at line 158 of file vtkStreamTracer.h.
anonymous enum |
anonymous enum |
Definition at line 264 of file vtkStreamTracer.h.
vtkStreamTracer::vtkStreamTracer | ( | ) | [protected] |
vtkStreamTracer::~vtkStreamTracer | ( | ) | [protected] |
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 vtkTypeMacro 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 vtkTypeMacro 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), 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 vtkPolyDataAlgorithm.
Reimplemented in vtkDistributedStreamTracer, and vtkTemporalStreamTracer.
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::SetSource | ( | 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 180 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 182 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 184 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 208 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 276 of file vtkStreamTracer.h.
void vtkStreamTracer::SetIntegrationDirectionToBackward | ( | ) | [inline] |
Specify whether the streamline is integrated in the upstream or downstream direction.
Definition at line 278 of file vtkStreamTracer.h.
void vtkStreamTracer::SetIntegrationDirectionToBoth | ( | ) | [inline] |
Specify whether the streamline is integrated in the upstream or downstream direction.
Definition at line 280 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 | ( | ) | [protected, virtual] |
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 * | ) | [inline, protected] |
Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
Reimplemented from vtkPolyDataAlgorithm.
Definition at line 322 of file vtkStreamTracer.h.
virtual int vtkStreamTracer::RequestData | ( | vtkInformation * | request, | |
vtkInformationVector ** | inputVector, | |||
vtkInformationVector * | outputVector | |||
) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkPolyDataAlgorithm.
Reimplemented in vtkPStreamTracer, and vtkTemporalStreamTracer.
virtual int vtkStreamTracer::FillInputPortInformation | ( | int | port, | |
vtkInformation * | info | |||
) | [protected, virtual] |
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 | ( | vtkDataSet * | input, | |
vtkPolyData * | output, | |||
vtkDataArray * | seedSource, | |||
vtkIdList * | seedIds, | |||
vtkIntArray * | integrationDirections, | |||
double | lastPoint[3], | |||
vtkAbstractInterpolatedVelocityField * | func, | |||
int | maxCellSize, | |||
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 | |||
) | [static, protected] |
static double vtkStreamTracer::ConvertToLength | ( | IntervalInformation & | interval, | |
double | cellLength | |||
) | [static, protected] |
int vtkStreamTracer::SetupOutput | ( | vtkInformation * | inInfo, | |
vtkInformation * | outInfo | |||
) | [protected] |
void vtkStreamTracer::InitializeSeeds | ( | vtkDataArray *& | seeds, | |
vtkIdList *& | seedIds, | |||
vtkIntArray *& | integrationDirections, | |||
vtkDataSet * | source | |||
) | [protected] |
bool vtkStreamTracer::GenerateNormalsInIntegrate [protected] |
Definition at line 349 of file vtkStreamTracer.h.
double vtkStreamTracer::StartPosition[3] [protected] |
Definition at line 352 of file vtkStreamTracer.h.
const double vtkStreamTracer::EPSILON [static, protected] |
Definition at line 354 of file vtkStreamTracer.h.
double vtkStreamTracer::TerminalSpeed [protected] |
Definition at line 355 of file vtkStreamTracer.h.
double vtkStreamTracer::LastUsedStepSize [protected] |
Definition at line 357 of file vtkStreamTracer.h.
double vtkStreamTracer::MaximumPropagation [protected] |
Definition at line 366 of file vtkStreamTracer.h.
double vtkStreamTracer::MinimumIntegrationStep [protected] |
Definition at line 367 of file vtkStreamTracer.h.
double vtkStreamTracer::MaximumIntegrationStep [protected] |
Definition at line 368 of file vtkStreamTracer.h.
double vtkStreamTracer::InitialIntegrationStep [protected] |
Definition at line 369 of file vtkStreamTracer.h.
int vtkStreamTracer::IntegrationStepUnit [protected] |
Definition at line 385 of file vtkStreamTracer.h.
int vtkStreamTracer::IntegrationDirection [protected] |
Definition at line 386 of file vtkStreamTracer.h.
vtkInitialValueProblemSolver* vtkStreamTracer::Integrator [protected] |
Definition at line 389 of file vtkStreamTracer.h.
double vtkStreamTracer::MaximumError [protected] |
Definition at line 391 of file vtkStreamTracer.h.
vtkIdType vtkStreamTracer::MaximumNumberOfSteps [protected] |
Definition at line 392 of file vtkStreamTracer.h.
bool vtkStreamTracer::ComputeVorticity [protected] |
Definition at line 394 of file vtkStreamTracer.h.
double vtkStreamTracer::RotationScale [protected] |
Definition at line 395 of file vtkStreamTracer.h.
Definition at line 397 of file vtkStreamTracer.h.
vtkCompositeDataSet* vtkStreamTracer::InputData [protected] |
Definition at line 399 of file vtkStreamTracer.h.