VTK
|
Streamline generator. More...
#include <vtkGenericStreamTracer.h>
Classes | |
struct | IntervalInformation |
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 |
![]() | |
typedef vtkAlgorithm | Superclass |
![]() | |
typedef vtkObject | Superclass |
enum | DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION } |
![]() | |
typedef vtkObjectBase | Superclass |
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) |
![]() | |
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
Protected Attributes | |
int | GenerateNormalsInIntegrate |
char * | InputVectorsSelection |
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 |
vtkGenericInterpolatedVelocityField * | InterpolatorPrototype |
![]() | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
vtkProgressObserver * | ProgressObserver |
unsigned long | ErrorCode |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Static Protected Attributes | |
static const double | EPSILON |
![]() | |
static vtkExecutive * | DefaultExecutivePrototype |
Additional Inherited Members | |
![]() | |
int | AbortExecute |
Streamline generator.
vtkGenericStreamTracer 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.
vtkGenericStreamTracer 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 vtkGenericStreamTracer 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.
vtkGenericStreamTracer 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.
Definition at line 85 of file vtkGenericStreamTracer.h.
Definition at line 88 of file vtkGenericStreamTracer.h.
Enumerator | |
---|---|
TIME_UNIT | |
LENGTH_UNIT | |
CELL_LENGTH_UNIT |
Definition at line 118 of file vtkGenericStreamTracer.h.
Enumerator | |
---|---|
RUNGE_KUTTA2 | |
RUNGE_KUTTA4 | |
RUNGE_KUTTA45 | |
NONE | |
UNKNOWN |
Definition at line 125 of file vtkGenericStreamTracer.h.
Enumerator | |
---|---|
OUT_OF_DOMAIN | |
NOT_INITIALIZED | |
UNEXPECTED_VALUE | |
OUT_OF_TIME | |
OUT_OF_STEPS | |
STAGNATION |
Definition at line 134 of file vtkGenericStreamTracer.h.
anonymous enum |
Enumerator | |
---|---|
FORWARD | |
BACKWARD | |
BOTH |
Definition at line 264 of file vtkGenericStreamTracer.h.
|
protected |
|
protected |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkPolyDataAlgorithm.
vtkGenericStreamTracer* vtkGenericStreamTracer::NewInstance | ( | ) | const |
|
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.
|
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).
Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.
|
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 |
Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.
Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.
|
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 vtkGenericStreamTracer::SetSourceData | ( | vtkDataSet * | source | ) |
Specify the source object used to generate starting points.
vtkDataSet* vtkGenericStreamTracer::GetSource | ( | ) |
Specify the source object used to generate starting points.
void vtkGenericStreamTracer::SetSourceConnection | ( | vtkAlgorithmOutput * | algOutput | ) |
Specify the source object used to generate starting points (seeds). New style.
|
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.
void vtkGenericStreamTracer::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 |
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 vtkGenericStreamTracer::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 vtkGenericStreamTracer::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
|
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 vtkGenericStreamTracer.h.
|
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 vtkGenericStreamTracer.h.
|
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 160 of file vtkGenericStreamTracer.h.
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
void vtkGenericStreamTracer::SetMaximumPropagation | ( | double | max | ) |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
void vtkGenericStreamTracer::SetMaximumPropagationUnit | ( | int | unit | ) |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
int vtkGenericStreamTracer::GetMaximumPropagationUnit | ( | ) |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
double vtkGenericStreamTracer::GetMaximumPropagation | ( | ) |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
|
inline |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
Definition at line 172 of file vtkGenericStreamTracer.h.
|
inline |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
Definition at line 174 of file vtkGenericStreamTracer.h.
|
inline |
Specify the maximum length of the streamlines expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2
Definition at line 176 of file vtkGenericStreamTracer.h.
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
void vtkGenericStreamTracer::SetMinimumIntegrationStepUnit | ( | int | unit | ) |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
void vtkGenericStreamTracer::SetMinimumIntegrationStep | ( | double | step | ) |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
int vtkGenericStreamTracer::GetMinimumIntegrationStepUnit | ( | ) |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
double vtkGenericStreamTracer::GetMinimumIntegrationStep | ( | ) |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
|
inline |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 189 of file vtkGenericStreamTracer.h.
|
inline |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 191 of file vtkGenericStreamTracer.h.
|
inline |
Specify the minimum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 193 of file vtkGenericStreamTracer.h.
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
void vtkGenericStreamTracer::SetMaximumIntegrationStepUnit | ( | int | unit | ) |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
void vtkGenericStreamTracer::SetMaximumIntegrationStep | ( | double | step | ) |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
int vtkGenericStreamTracer::GetMaximumIntegrationStepUnit | ( | ) |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
double vtkGenericStreamTracer::GetMaximumIntegrationStep | ( | ) |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
|
inline |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 206 of file vtkGenericStreamTracer.h.
|
inline |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 208 of file vtkGenericStreamTracer.h.
|
inline |
Specify the maximum step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 Only valid when using adaptive integrators.
Definition at line 210 of file vtkGenericStreamTracer.h.
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
void vtkGenericStreamTracer::SetInitialIntegrationStepUnit | ( | int | unit | ) |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
void vtkGenericStreamTracer::SetInitialIntegrationStep | ( | double | step | ) |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
int vtkGenericStreamTracer::GetInitialIntegrationStepUnit | ( | ) |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
double vtkGenericStreamTracer::GetInitialIntegrationStep | ( | ) |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
|
inline |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
Definition at line 223 of file vtkGenericStreamTracer.h.
|
inline |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
Definition at line 225 of file vtkGenericStreamTracer.h.
|
inline |
Specify the initial step used in the integration expressed in one of the: TIME_UNIT = 0 LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 If the integrator is not adaptive, this is the actual step used.
Definition at line 227 of file vtkGenericStreamTracer.h.
|
virtual |
Specify the maximum error in the integration. This value is passed to the integrator. Therefore, it's meaning depends on the integrator used.
|
virtual |
Specify the maximum error in the integration. This value is passed to the integrator. Therefore, it's meaning depends on the integrator used.
|
virtual |
Specify the maximum number of steps used in the integration.
|
virtual |
Specify the maximum number of steps used in the integration.
|
virtual |
If at any point, the speed is below this value, the integration is terminated.
|
virtual |
If at any point, the speed is below this value, the integration is terminated.
|
inline |
Simplified API to set an homogeneous unit across Min/Max/Init IntegrationStepUnit
Definition at line 255 of file vtkGenericStreamTracer.h.
|
virtual |
Specify whether the streamtrace will be generated in the upstream or downstream direction.
|
virtual |
Specify whether the streamtrace will be generated in the upstream or downstream direction.
|
inline |
Specify whether the streamtrace will be generated in the upstream or downstream direction.
Definition at line 277 of file vtkGenericStreamTracer.h.
|
inline |
Specify whether the streamtrace will be generated in the upstream or downstream direction.
Definition at line 279 of file vtkGenericStreamTracer.h.
|
inline |
Specify whether the streamtrace will be generated in the upstream or downstream direction.
Definition at line 281 of file vtkGenericStreamTracer.h.
|
virtual |
Turn on/off calculation of vorticity at streamline points (necessary for generating proper streamribbons using the vtkRibbonFilter.
|
virtual |
Turn on/off calculation of vorticity at streamline points (necessary for generating proper streamribbons using the vtkRibbonFilter.
|
virtual |
Turn on/off calculation of vorticity at streamline points (necessary for generating proper streamribbons using the vtkRibbonFilter.
|
virtual |
Turn on/off calculation of vorticity at streamline points (necessary for generating proper streamribbons using the vtkRibbonFilter.
|
virtual |
This can be used to scale the rate with which the streamribbons twist. The default is 1.
|
virtual |
This can be used to scale the rate with which the streamribbons twist. The default is 1.
|
virtual |
If you want to generate traces using an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.
|
inline |
If you want to generate traces using an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.
Definition at line 305 of file vtkGenericStreamTracer.h.
void vtkGenericStreamTracer::AddInputData | ( | vtkGenericDataSet * | in | ) |
Add a dataset to the list inputs
void vtkGenericStreamTracer::SetInterpolatorPrototype | ( | vtkGenericInterpolatedVelocityField * | ivf | ) |
The object used to interpolate the velocity field during integration is of the same class as this prototype.
|
inlineprotected |
Definition at line 321 of file vtkGenericStreamTracer.h.
|
protectedvirtual |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkPolyDataAlgorithm.
|
protected |
Compute the vorticity at point `pcoords' in cell `cell' for the vector attribute `attribute'.
|
protected |
|
protected |
|
protected |
|
protected |
|
protectedvirtual |
|
protected |
|
protected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
|
protected |
|
protected |
Definition at line 353 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 355 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 360 of file vtkGenericStreamTracer.h.
|
staticprotected |
Definition at line 362 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 363 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 365 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 374 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 375 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 376 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 377 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 398 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 401 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 403 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 404 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 406 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 407 of file vtkGenericStreamTracer.h.
|
protected |
Definition at line 409 of file vtkGenericStreamTracer.h.