A particle tracer for vector fields. More...

#include <vtkParticleTracerBase.h>

Inheritance diagram for vtkParticleTracerBase:

Collaboration diagram for vtkParticleTracerBase:

Classes
struct	bounds_t

Public Types
enum	Solvers { RUNGE_KUTTA2 , RUNGE_KUTTA4 , RUNGE_KUTTA45 , NONE , UNKNOWN }
enum	MeshOverTimeTypes { DIFFERENT = 0 , STATIC = 1 , LINEAR_TRANSFORMATION = 2 , SAME_TOPOLOGY = 3 }
	Types of Variance of Mesh over time. More...
enum	{ INTERPOLATOR_WITH_DATASET_POINT_LOCATOR , INTERPOLATOR_WITH_CELL_LOCATOR }
typedef vtkPolyDataAlgorithm	Superclass
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
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.
vtkParticleTracerBase *	NewInstance () const
void	PrintParticleHistories ()
void	SetIntegrator (vtkInitialValueProblemSolver *)
virtual vtkInitialValueProblemSolver *	GetIntegrator ()
void	SetIntegratorType (int type)
int	GetIntegratorType ()
void	SetInterpolatorType (int interpolatorType)
	Set the type of the velocity field interpolator to determine whether INTERPOLATOR_WITH_DATASET_POINT_LOCATOR or INTERPOLATOR_WITH_CELL_LOCATOR is employed for locating cells during streamline integration.
void	SetInterpolatorTypeToDataSetPointLocator ()
	Set the velocity field interpolator type to one that uses a point locator to perform local spatial searching.
void	SetInterpolatorTypeToCellLocator ()
	Set the velocity field interpolator type to one that uses a cell locator to perform spatial searching.

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

virtual void	SetController (vtkMultiProcessController *)
	Get/Set the controller to use.
virtual vtkMultiProcessController *	GetController ()
	Get/Set the controller to use.

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

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

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

virtual void	SetIgnorePipelineTime (vtkTypeBool)
	To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.
virtual vtkTypeBool	GetIgnorePipelineTime ()
	To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.
virtual void	IgnorePipelineTimeOn ()
	To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.
virtual void	IgnorePipelineTimeOff ()
	To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.

virtual int	GetForceReinjectionEveryNSteps ()
	When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow.
void	SetForceReinjectionEveryNSteps (int)
	When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow.

virtual void	SetStaticSeeds (vtkTypeBool)
	if StaticSeeds is set and the mesh is static, then every time particles are injected we can reuse the same injection information.
virtual vtkTypeBool	GetStaticSeeds ()
	if StaticSeeds is set and the mesh is static, then every time particles are injected we can reuse the same injection information.

virtual void	SetMeshOverTime (int meshOverTime)
virtual int	GetMeshOverTimeMinValue ()
virtual int	GetMeshOverTimeMaxValue ()
void	SetMeshOverTimeToDifferent ()
void	SetMeshOverTimeToStatic ()
void	SetMeshOverTimeToLinearTransformation ()
void	SetMeshOverTimeToSameTopology ()
virtual int	GetMeshOverTime ()

virtual void	SetParticleWriter (vtkAbstractParticleWriter *pw)
	Set/Get the Writer associated with this Particle Tracer Ideally a parallel IO capable particler writer should be used which will collect particles from all parallel processes and write them to a single HDF5 file.
virtual vtkAbstractParticleWriter *	GetParticleWriter ()
	Set/Get the Writer associated with this Particle Tracer Ideally a parallel IO capable particler writer should be used which will collect particles from all parallel processes and write them to a single HDF5 file.

	vtkSetFilePathMacro (ParticleFileName)
	Set/Get the filename to be used with the particle writer when dumping particles to disk.
	vtkGetFilePathMacro (ParticleFileName)
	Set/Get the filename to be used with the particle writer when dumping particles to disk.

virtual void	SetEnableParticleWriting (vtkTypeBool)
	Set/Get the filename to be used with the particle writer when dumping particles to disk.
virtual vtkTypeBool	GetEnableParticleWriting ()
	Set/Get the filename to be used with the particle writer when dumping particles to disk.
virtual void	EnableParticleWritingOn ()
	Set/Get the filename to be used with the particle writer when dumping particles to disk.
virtual void	EnableParticleWritingOff ()
	Set/Get the filename to be used with the particle writer when dumping particles to disk.

void	AddSourceConnection (vtkAlgorithmOutput *input)
	Provide support for multiple seed sources.
void	RemoveAllSources ()
	Provide support for multiple seed sources.

virtual bool	GetForceSerialExecution ()
	Force the filter to run particle tracer in serial.
virtual void	SetForceSerialExecution (bool)
	Force the filter to run particle tracer in serial.
virtual void	ForceSerialExecutionOn ()
	Force the filter to run particle tracer in serial.
virtual void	ForceSerialExecutionOff ()
	Force the filter to run particle tracer in serial.
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	see vtkAlgorithm for details
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkPolyData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
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.
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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
int	GetNumberOfInputArraySpecifications ()
	Get the number of input array indices that have already been set.
bool	ResetInputArraySpecifications ()
	Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
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.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0).
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0).
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	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).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
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.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name, int component)
	This method variant also accepts a component to consider rather than the entire tuple.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
	This method variant also accepts a component to consider rather than the entire tuple.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName, const char *component)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
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.
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.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
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.
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.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkParticleTracerBase *	SafeDownCast (vtkObjectBase *o)
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.
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.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Types
using	bounds = struct bounds_t

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
void	EnqueueParticleToAnotherProcess (vtkParticleTracerBaseNamespace::ParticleInformation &)
	vtkParticleTracerBase ()
	~vtkParticleTracerBase () override
int	FillInputPortInformation (int port, vtkInformation *info) override
int	Initialize (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Resets internal cache for a clean start.
int	Execute (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Moves the particles one time step further.
int	Finalize (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	Generates an output using the data provided after Execute was ran.
virtual std::vector< vtkDataSet * >	GetSeedSources (vtkInformationVector *inputVector)
	Method to get the data set seed sources.
int	InitializeInterpolator ()
void	TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, vtkParticleTracerBaseNamespace::ParticleVector &passed)
	inside our data.
void	TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, std::vector< int > &passed)
virtual void	AssignSeedsToProcessors (double time, vtkDataSet *source, vtkParticleTracerBaseNamespace::ParticleVector &localSeedPoints)
	all the injection/seed points according to which processor they belong to.
bool	SendReceiveParticles (std::vector< vtkIdType > &)
	this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain.
void	UpdateParticleList (vtkParticleTracerBaseNamespace::ParticleVector &candidates)
	and sending between processors, into a list, which is used as the master list on this processor
virtual bool	UpdateParticleListFromOtherProcesses ()
	this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain.
void	IntegrateParticle (vtkParticleTracerBaseNamespace::ParticleListIterator &it, double currentTime, double targetTime, vtkInitialValueProblemSolver integrator, vtkTemporalInterpolatedVelocityField interpolator, vtkDoubleArray *cellVectors, std::atomic< vtkIdType > &particleCount, std::mutex &eraseMutex, bool sequential)
	particle between the two times supplied.
bool	ComputeDomainExitLocation (double pos[4], double p2[4], double intersection[4], vtkGenericCell *cell)
	This is an old routine kept for possible future use.
void	CreateProtoPD (vtkDataObject *input)
vtkFloatArray *	GetParticleAge (vtkPointData *)
vtkIntArray *	GetParticleIds (vtkPointData *)
vtkSignedCharArray *	GetParticleSourceIds (vtkPointData *)
vtkIntArray *	GetInjectedPointIds (vtkPointData *)
vtkIntArray *	GetInjectedStepIds (vtkPointData *)
vtkIntArray *	GetErrorCodeArr (vtkPointData *)
vtkFloatArray *	GetParticleVorticity (vtkPointData *)
vtkFloatArray *	GetParticleRotation (vtkPointData *)
vtkFloatArray *	GetParticleAngularVel (vtkPointData *)
bool	InsideBounds (double point[])
void	CalculateVorticity (vtkGenericCell cell, double pcoords[3], vtkDoubleArray cellVectors, double vorticity[3])
void	SetParticle (vtkParticleTracerBaseNamespace::ParticleInformation &info, vtkTemporalInterpolatedVelocityField interpolator, vtkDoubleArray cellVectors)
virtual int	GetReinjectionCounter ()
void	ResizeArrays (vtkIdType numTuples)
virtual void	InitializeExtraPointDataArrays (vtkPointData *outputPD)
	Methods to append values to existing point data arrays that may only be desired on specific concrete derived classes.
virtual void	SetToExtraPointDataArrays (vtkIdType, vtkParticleTracerBaseNamespace::ParticleInformation &)
vtkTemporalInterpolatedVelocityField *	GetInterpolator ()
virtual void	AddRestartSeeds (vtkInformationVector **)
	For restarts of particle paths, we add in the ability to add in particles from a previous computation that we will still advect.
bool	RetryWithPush (vtkParticleTracerBaseNamespace::ParticleInformation &info, double point1, double delT, int subSteps, vtkTemporalInterpolatedVelocityField interpolator)
	When particles leave the domain, they must be collected and sent to the other processes for possible continuation.
bool	SetTerminationTimeNoModify (double t)
	vtkParticleTracerBase (const vtkParticleTracerBase &)=delete
void	operator= (const vtkParticleTracerBase &)=delete
unsigned int	NumberOfParticles ()

virtual bool	IsPointDataValid (vtkDataObject *input)
	Methods that check that the input arrays are ordered the same on all data sets.
bool	IsPointDataValid (vtkCompositeDataSet *input, std::vector< std::string > &arrayNames)
	Methods that check that the input arrays are ordered the same on all data sets.
void	GetPointDataArrayNames (vtkDataSet *input, std::vector< std::string > &names)
	Methods that check that the input arrays are ordered the same on all data sets.
Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm () override
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called by the superclass.
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
int	FillOutputPortInformation (int port, vtkInformation *info) override
int	FillInputPortInformation (int port, vtkInformation *info) override
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
bool	ForceSerialExecution
vtkSmartPointer< vtkDataSet >	Seeds
	All ranks have the same representation of the seeds.
std::unordered_map< vtkIdType, int >	InjectedPointIdToProcessId
double	CachedTimeStep
vtkInitialValueProblemSolver *	Integrator
double	IntegrationStep
double	MaximumError
bool	ComputeVorticity
double	RotationScale
double	TerminalSpeed
int	ReinjectionCounter
vtkTypeBool	AllFixedGeometry
int	MeshOverTime
vtkTypeBool	StaticSeeds
int	ForceReinjectionEveryNSteps
vtkTimeStamp	ParticleInjectionTime
bool	HasCache
vtkAbstractParticleWriter *	ParticleWriter
char *	ParticleFileName
vtkTypeBool	EnableParticleWriting
vtkParticleTracerBaseNamespace::ParticleVector	LocalSeeds
vtkSmartPointer< vtkTemporalInterpolatedVelocityField >	Interpolator
vtkSmartPointer< vtkMultiProcessController >	Controller
vtkParticleTracerBaseNamespace::ParticleVector	MPISendList
	Storage of the particles we want to send to another rank.
std::unordered_map< vtkIdType, vtkParticleTracerBaseNamespace::ParticleInformation >	MPIRecvList
	Storage of the particles we received.
std::vector< bounds >	CachedBounds [2]
vtkSmartPointer< vtkDataSet >	DataReferenceT [2]
vtkNew< vtkPoints >	OutputCoordinates
vtkNew< vtkIdTypeArray >	ParticleCellsConnectivity
vtkNew< vtkFloatArray >	ParticleAge
vtkNew< vtkIntArray >	ParticleIds
vtkNew< vtkSignedCharArray >	ParticleSourceIds
vtkNew< vtkIdTypeArray >	InjectedPointIds
vtkNew< vtkIntArray >	InjectedStepIds
vtkNew< vtkIntArray >	ErrorCodeArray
vtkNew< vtkFloatArray >	ParticleVorticity
vtkNew< vtkFloatArray >	ParticleRotation
vtkNew< vtkFloatArray >	ParticleAngularVel
vtkNew< vtkPointData >	OutputPointData
vtkNew< vtkDoubleArray >	CellVectors
vtkTimeStamp	ExecuteTime

vtkSmartPointer< vtkPointData >	ProtoPD
	ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored.
vtkParticleTracerBaseNamespace::ParticleDataList	ParticleHistories
	ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored.
vtkTypeBool	IgnorePipelineTime
	ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static const double	Epsilon

Friends
struct	vtkParticleTracerBaseNamespace::ParticleTracerFunctor
class	ParticlePathFilterInternal
class	StreaklineFilterInternal

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
enum vtkAlgorithm::DesiredOutputPrecision	RemoveNoPriorTemporalAccessInformationKey
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A particle tracer for vector fields.

vtkParticleTracerBase is the base class for filters that advect particles in a vector field. Note that the input vtkPointData structure must be identical on all datasets.

See also: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

Definition at line 102 of file vtkParticleTracerBase.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkParticleTracerBase::Superclass

Definition at line 115 of file vtkParticleTracerBase.h.

◆ bounds

using vtkParticleTracerBase::bounds = struct bounds_t

protected

Definition at line 570 of file vtkParticleTracerBase.h.

Member Enumeration Documentation

◆ Solvers

enum vtkParticleTracerBase::Solvers

Enumerator
RUNGE_KUTTA2
RUNGE_KUTTA4
RUNGE_KUTTA45
NONE
UNKNOWN

Definition at line 106 of file vtkParticleTracerBase.h.

◆ MeshOverTimeTypes

enum vtkParticleTracerBase::MeshOverTimeTypes

Types of Variance of Mesh over time.

Enumerator
DIFFERENT
STATIC
LINEAR_TRANSFORMATION
SAME_TOPOLOGY

Definition at line 212 of file vtkParticleTracerBase.h.

◆ anonymous enum

anonymous enum

Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR
INTERPOLATOR_WITH_CELL_LOCATOR

Definition at line 239 of file vtkParticleTracerBase.h.

Constructor & Destructor Documentation

◆ vtkParticleTracerBase() [1/2]

vtkParticleTracerBase::vtkParticleTracerBase ( )

protected

◆ ~vtkParticleTracerBase()

vtkParticleTracerBase::~vtkParticleTracerBase ( )

overrideprotected

◆ vtkParticleTracerBase() [2/2]

vtkParticleTracerBase::vtkParticleTracerBase ( const vtkParticleTracerBase & )

protecteddelete

Member Function Documentation

◆ IsTypeOf()

vtkTypeBool vtkParticleTracerBase::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkParticleTracerBase::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 vtkParticlePathFilter, vtkParticleTracer, and vtkStreaklineFilter.

◆ SafeDownCast()

vtkParticleTracerBase * vtkParticleTracerBase::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkParticleTracerBase::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkParticlePathFilter, vtkParticleTracer, and vtkStreaklineFilter.

◆ NewInstance()

vtkParticleTracerBase * vtkParticleTracerBase::NewInstance ( ) const

◆ PrintParticleHistories()

void vtkParticleTracerBase::PrintParticleHistories ( )

◆ PrintSelf()

void vtkParticleTracerBase::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 vtkAlgorithm.

◆ SetController()

virtual void vtkParticleTracerBase::SetController ( vtkMultiProcessController * )

virtual

Get/Set the controller to use.

By default vtkMultiProcessController::GlobalController will be used.

◆ GetController()

virtual vtkMultiProcessController * vtkParticleTracerBase::GetController ( )

virtual

Get/Set the controller to use.

By default vtkMultiProcessController::GlobalController will be used.

◆ GetComputeVorticity()

virtual bool vtkParticleTracerBase::GetComputeVorticity ( )

virtual

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

◆ SetComputeVorticity()

void vtkParticleTracerBase::SetComputeVorticity ( bool )

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

◆ GetTerminalSpeed()

virtual double vtkParticleTracerBase::GetTerminalSpeed ( )

virtual

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

◆ SetTerminalSpeed()

void vtkParticleTracerBase::SetTerminalSpeed ( double )

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

◆ GetRotationScale()

virtual double vtkParticleTracerBase::GetRotationScale ( )

virtual

This can be used to scale the rate with which the streamribbons twist.

The default is 1.

◆ SetRotationScale()

void vtkParticleTracerBase::SetRotationScale ( double )

This can be used to scale the rate with which the streamribbons twist.

The default is 1.

◆ SetIgnorePipelineTime()

virtual void vtkParticleTracerBase::SetIgnorePipelineTime ( vtkTypeBool )

virtual

To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.

◆ GetIgnorePipelineTime()

virtual vtkTypeBool vtkParticleTracerBase::GetIgnorePipelineTime ( )

virtual

To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.

◆ IgnorePipelineTimeOn()

virtual void vtkParticleTracerBase::IgnorePipelineTimeOn ( )

virtual

To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.

◆ IgnorePipelineTimeOff()

virtual void vtkParticleTracerBase::IgnorePipelineTimeOff ( )

virtual

To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests.

◆ GetForceReinjectionEveryNSteps()

virtual int vtkParticleTracerBase::GetForceReinjectionEveryNSteps ( )

virtual

When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow.

Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway

◆ SetForceReinjectionEveryNSteps()

void vtkParticleTracerBase::SetForceReinjectionEveryNSteps ( int )

When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow.

Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway

◆ SetIntegrator()

void vtkParticleTracerBase::SetIntegrator ( vtkInitialValueProblemSolver * )

◆ GetIntegrator()

virtual vtkInitialValueProblemSolver * vtkParticleTracerBase::GetIntegrator ( )

virtual

◆ SetIntegratorType()

void vtkParticleTracerBase::SetIntegratorType ( int type )

◆ GetIntegratorType()

int vtkParticleTracerBase::GetIntegratorType ( )

◆ SetStaticSeeds()

virtual void vtkParticleTracerBase::SetStaticSeeds ( vtkTypeBool )

virtual

if StaticSeeds is set and the mesh is static, then every time particles are injected we can reuse the same injection information.

We classify particles according to processor just once before start. If StaticSeeds is set and a moving seed source is specified the motion will be ignored and results will not be as expected. The default is that StaticSeeds is 0.

◆ GetStaticSeeds()

virtual vtkTypeBool vtkParticleTracerBase::GetStaticSeeds ( )

virtual

if StaticSeeds is set and the mesh is static, then every time particles are injected we can reuse the same injection information.

We classify particles according to processor just once before start. If StaticSeeds is set and a moving seed source is specified the motion will be ignored and results will not be as expected. The default is that StaticSeeds is 0.

◆ SetMeshOverTime()

virtual void vtkParticleTracerBase::SetMeshOverTime ( int meshOverTime )

virtual

◆ GetMeshOverTimeMinValue()

virtual int vtkParticleTracerBase::GetMeshOverTimeMinValue ( )

inlinevirtual

Definition at line 230 of file vtkParticleTracerBase.h.

◆ GetMeshOverTimeMaxValue()

virtual int vtkParticleTracerBase::GetMeshOverTimeMaxValue ( )

inlinevirtual

Definition at line 231 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToDifferent()

void vtkParticleTracerBase::SetMeshOverTimeToDifferent ( )

inline

Definition at line 232 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToStatic()

void vtkParticleTracerBase::SetMeshOverTimeToStatic ( )

inline

Definition at line 233 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToLinearTransformation()

void vtkParticleTracerBase::SetMeshOverTimeToLinearTransformation ( )

inline

Definition at line 234 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToSameTopology()

void vtkParticleTracerBase::SetMeshOverTimeToSameTopology ( )

inline

Definition at line 235 of file vtkParticleTracerBase.h.

◆ GetMeshOverTime()

virtual int vtkParticleTracerBase::GetMeshOverTime ( )

virtual

◆ SetInterpolatorType()

void vtkParticleTracerBase::SetInterpolatorType ( int interpolatorType )

Set the type of the velocity field interpolator to determine whether INTERPOLATOR_WITH_DATASET_POINT_LOCATOR or 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 than the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator). However the former can be much faster and produce adequate results.

Default is INTERPOLATOR_WITH_CELL_LOCATOR (to maintain backwards compatibility).

◆ SetInterpolatorTypeToDataSetPointLocator()

void vtkParticleTracerBase::SetInterpolatorTypeToDataSetPointLocator ( )

Set the velocity field interpolator type to one that uses a point locator to perform local spatial searching.

Typically a point locator is faster than searches with a cell locator, but it may not always find the correct cells enclosing a point. This is particularly true with meshes that are disjoint at seams, or abut meshes in an incompatible manner.

◆ SetInterpolatorTypeToCellLocator()

void vtkParticleTracerBase::SetInterpolatorTypeToCellLocator ( )

Set the velocity field interpolator type to one that uses a cell locator to perform spatial searching.

Using a cell locator should always return the correct results, but it can be much slower that point locator-based searches. * By default a cell locator is used.

◆ SetParticleWriter()

virtual void vtkParticleTracerBase::SetParticleWriter ( vtkAbstractParticleWriter * pw )

virtual

Set/Get the Writer associated with this Particle Tracer Ideally a parallel IO capable particler writer should be used which will collect particles from all parallel processes and write them to a single HDF5 file.

◆ GetParticleWriter()

virtual vtkAbstractParticleWriter * vtkParticleTracerBase::GetParticleWriter ( )

virtual

Set/Get the Writer associated with this Particle Tracer Ideally a parallel IO capable particler writer should be used which will collect particles from all parallel processes and write them to a single HDF5 file.