Streamline generator. More...

#include <vtkStreamTracer.h>

Inheritance diagram for vtkStreamTracer:

Collaboration diagram for vtkStreamTracer:

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, FIXED_REASONS_FOR_TERMINATION_COUNT }

enum	{ FORWARD, BACKWARD, BOTH }

enum	{ INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }

typedef vtkPolyDataAlgorithm	Superclass

typedef bool(*	CustomTerminationCallbackType) (void clientdata, vtkPoints points, vtkDataArray *velocity, int integrationDirection)
	Asks the user if the current streamline should be terminated. More...

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkStreamTracer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify the source object used to generate starting points (seeds). More...

void	SetInterpolatorTypeToDataSetPointLocator ()
	Set the velocity field interpolator type to the one involving a dataset point locator. More...

void	SetInterpolatorTypeToCellLocator ()
	Set the velocity field interpolator type to the one involving a cell locator. More...

void	SetIntegrationStepUnit (int unit)
	Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. More...

int	GetIntegrationStepUnit ()

void	SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField *ivf)
	The object used to interpolate the velocity field during integration is of the same class as this prototype. More...

void	SetInterpolatorType (int interpType)
	Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration. More...

void	AddCustomTerminationCallback (CustomTerminationCallbackType callback, void *clientdata, int reasonForTermination)
	Adds a custom termination callback. More...


virtual void	SetStartPosition (double, double, double)
	Specify the starting point (seed) of a streamline in the global coordinate system. More...

virtual void	SetStartPosition (double[3])
	Specify the starting point (seed) of a streamline in the global coordinate system. More...

virtual double *	GetStartPosition ()
	Specify the starting point (seed) of a streamline in the global coordinate system. More...

virtual void	GetStartPosition (double &, double &, double &)
	Specify the starting point (seed) of a streamline in the global coordinate system. More...

virtual void	GetStartPosition (double[3])
	Specify the starting point (seed) of a streamline in the global coordinate system. More...


void	SetSourceData (vtkDataSet *source)
	Specify the source object used to generate starting points (seeds). More...

vtkDataSet *	GetSource ()
	Specify the source object used to generate starting points (seeds). More...


void	SetIntegrator (vtkInitialValueProblemSolver *)
	Set/get the integrator type to be used for streamline generation. More...

virtual vtkInitialValueProblemSolver *	GetIntegrator ()
	Set/get the integrator type to be used for streamline generation. More...

void	SetIntegratorType (int type)
	Set/get the integrator type to be used for streamline generation. More...

int	GetIntegratorType ()
	Set/get the integrator type to be used for streamline generation. More...

void	SetIntegratorTypeToRungeKutta2 ()
	Set/get the integrator type to be used for streamline generation. More...

void	SetIntegratorTypeToRungeKutta4 ()
	Set/get the integrator type to be used for streamline generation. More...

void	SetIntegratorTypeToRungeKutta45 ()
	Set/get the integrator type to be used for streamline generation. More...


virtual void	SetMaximumPropagation (double)
	Specify the maximum length of a streamline expressed in LENGTH_UNIT. More...

virtual double	GetMaximumPropagation ()
	Specify the maximum length of a streamline expressed in LENGTH_UNIT. More...


virtual void	SetInitialIntegrationStep (double)
	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) More...

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


virtual void	SetMinimumIntegrationStep (double)
	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) More...

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


virtual void	SetMaximumIntegrationStep (double)
	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) More...

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


virtual void	SetMaximumError (double)
	Specify the maximum error tolerated throughout streamline integration. More...

virtual double	GetMaximumError ()
	Specify the maximum error tolerated throughout streamline integration. More...


virtual void	SetMaximumNumberOfSteps (vtkIdType)
	Specify the maximum number of steps for integrating a streamline. More...

virtual vtkIdType	GetMaximumNumberOfSteps ()
	Specify the maximum number of steps for integrating a streamline. More...


virtual void	SetTerminalSpeed (double)
	Specify the terminal speed value, below which integration is terminated. More...

virtual double	GetTerminalSpeed ()
	Specify the terminal speed value, below which integration is terminated. More...


virtual bool	GetSurfaceStreamlines ()
	Set/Unset the streamlines to be computed on a surface. More...

virtual void	SetSurfaceStreamlines (bool)
	Set/Unset the streamlines to be computed on a surface. More...

virtual void	SurfaceStreamlinesOn ()
	Set/Unset the streamlines to be computed on a surface. More...

virtual void	SurfaceStreamlinesOff ()
	Set/Unset the streamlines to be computed on a surface. More...


virtual void	SetIntegrationDirection (int)
	Specify whether the streamline is integrated in the upstream or downstream direction. More...

virtual int	GetIntegrationDirection ()
	Specify whether the streamline is integrated in the upstream or downstream direction. More...

void	SetIntegrationDirectionToForward ()
	Specify whether the streamline is integrated in the upstream or downstream direction. More...

void	SetIntegrationDirectionToBackward ()
	Specify whether the streamline is integrated in the upstream or downstream direction. More...

void	SetIntegrationDirectionToBoth ()
	Specify whether the streamline is integrated in the upstream or downstream direction. More...


virtual void	SetComputeVorticity (bool)
	Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter. More...

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


virtual void	SetRotationScale (double)
	This can be used to scale the rate with which the streamribbons twist. More...

virtual double	GetRotationScale ()
	This can be used to scale the rate with which the streamribbons twist. More...

Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details More...

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...

vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm. More...

virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm. More...

void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkStreamTracer *	SafeDownCast (vtkObjectBase *o)

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

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

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 *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStreamTracer ()

	~vtkStreamTracer () override

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive. More...

void	AddInput (vtkDataObject *)

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass. More...

int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm. More...

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, double &integrationTime)

double	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 () override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

vtkInitialValueProblemSolver *	Integrator

double	MaximumError

vtkIdType	MaximumNumberOfSteps

bool	ComputeVorticity

double	RotationScale

bool	SurfaceStreamlines

vtkAbstractInterpolatedVelocityField *	InterpolatorPrototype

vtkCompositeDataSet *	InputData

bool	HasMatchingPointAttributes

std::vector< CustomTerminationCallbackType >	CustomTerminationCallback

std::vector< void * >	CustomTerminationClientData

std::vector< int >	CustomReasonForTermination

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static const double	EPSILON

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Friends
class	PStreamTracerUtils

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	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 107 of file vtkStreamTracer.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkStreamTracer::Superclass

Definition at line 110 of file vtkStreamTracer.h.

typedef bool(* vtkStreamTracer::CustomTerminationCallbackType) (void *clientdata, vtkPoints *points, vtkDataArray *velocity, int integrationDirection)

Asks the user if the current streamline should be terminated.

clientdata is set by the client when setting up the callback. points is the array of points integrated so far velocity velocity vector integrated to produce the streamline integrationDirection FORWARD of BACKWARD The function returns true if the streamline should be terminated and false otherwise.

Definition at line 376 of file vtkStreamTracer.h.

Member Enumeration Documentation

enum vtkStreamTracer::Units

Enumerator
LENGTH_UNIT
CELL_LENGTH_UNIT

Definition at line 158 of file vtkStreamTracer.h.

enum vtkStreamTracer::Solvers

Enumerator
RUNGE_KUTTA2
RUNGE_KUTTA4
RUNGE_KUTTA45
NONE
UNKNOWN

Definition at line 164 of file vtkStreamTracer.h.

enum vtkStreamTracer::ReasonForTermination

Enumerator
OUT_OF_DOMAIN
NOT_INITIALIZED
UNEXPECTED_VALUE
OUT_OF_LENGTH
OUT_OF_STEPS
STAGNATION
FIXED_REASONS_FOR_TERMINATION_COUNT

Definition at line 173 of file vtkStreamTracer.h.

anonymous enum

Enumerator
FORWARD
BACKWARD
BOTH

Definition at line 303 of file vtkStreamTracer.h.

anonymous enum

Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR
INTERPOLATOR_WITH_CELL_LOCATOR

Definition at line 310 of file vtkStreamTracer.h.

Constructor & Destructor Documentation

vtkStreamTracer::vtkStreamTracer ( )

protected

vtkStreamTracer::~vtkStreamTracer ( )

overrideprotected

Member Function Documentation

static vtkTypeBool vtkStreamTracer::IsTypeOf ( const char * type )

static

virtual vtkTypeBool 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 vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

static vtkStreamTracer* vtkStreamTracer::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkStreamTracer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

vtkStreamTracer* vtkStreamTracer::NewInstance ( ) const

void vtkStreamTracer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

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

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

vtkDataSet* vtkStreamTracer::GetSource ( )

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

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

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.