VTK  9.4.20241014
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkParticleTracerBase Class Reference

A particle tracer for vector fields. More...

#include <vtkParticleTracerBase.h>

Inheritance diagram for vtkParticleTracerBase:
[legend]
Collaboration diagram for vtkParticleTracerBase:
[legend]

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.
 
vtkParticleTracerBaseNewInstance () const
 
void PrintParticleHistories ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
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 vtkMultiProcessControllerGetController ()
 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 SetTerminationTime (double)
 
virtual double GetTerminationTime ()
 
virtual void SetStartTime (double)
 
virtual double GetStartTime ()
 
virtual void SetDisableResetCache (bool)
 
virtual bool GetDisableResetCache ()
 
virtual void DisableResetCacheOn ()
 
virtual void DisableResetCacheOff ()
 
virtual void SetStaticSeeds (vtkTypeBool)
 if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use the same injection information.
 
virtual vtkTypeBool GetStaticSeeds ()
 if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use 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 vtkH5PartWriter should be used which will collect particles from all parallel processes and write them to a single HDF5 file.
 
virtual vtkAbstractParticleWriterGetParticleWriter ()
 Set/Get the Writer associated with this Particle Tracer Ideally a parallel IO capable vtkH5PartWriter 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
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPolyDataAlgorithmNewInstance () 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
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetOutput (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
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (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, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
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.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (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 VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS 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.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 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.
 
vtkAlgorithmGetContainerAlgorithm ()
 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.
 
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, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 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 VTK_UNBLOCKTHREADS void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual VTK_UNBLOCKTHREADS 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 vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- 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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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.
 
vtkCommandGetCommand (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 std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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 vtkParticleTracerBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 = bounds_t
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
void EnqueueParticleToAnotherProcess (vtkParticleTracerBaseNamespace::ParticleInformation &)
 
 vtkParticleTracerBase ()
 
 ~vtkParticleTracerBase () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
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)
 
vtkFloatArrayGetParticleAge (vtkPointData *)
 
vtkIntArrayGetParticleIds (vtkPointData *)
 
vtkSignedCharArrayGetParticleSourceIds (vtkPointData *)
 
vtkIntArrayGetInjectedPointIds (vtkPointData *)
 
vtkIntArrayGetInjectedStepIds (vtkPointData *)
 
vtkIntArrayGetErrorCodeArr (vtkPointData *)
 
vtkFloatArrayGetParticleVorticity (vtkPointData *)
 
vtkFloatArrayGetParticleRotation (vtkPointData *)
 
vtkFloatArrayGetParticleAngularVel (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 *vtkNotUsed(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 &)
 
vtkTemporalInterpolatedVelocityFieldGetInterpolator ()
 
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
virtual vtkObjectBaseNewInstanceInternal () const
 
 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
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
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.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- 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 RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool ForceSerialExecution
 
vtkSmartPointer< vtkDataSetSeeds
 All ranks have the same representation of the seeds.
 
std::unordered_map< vtkIdType, int > InjectedPointIdToProcessId
 
double CachedTimeStep
 
vtkInitialValueProblemSolverIntegrator
 
double IntegrationStep
 
double MaximumError
 
bool ComputeVorticity
 
double RotationScale
 
double TerminalSpeed
 
int ReinjectionCounter
 
vtkTypeBool AllFixedGeometry
 
int MeshOverTime
 
vtkTypeBool StaticSeeds
 
int ForceReinjectionEveryNSteps
 
vtkTimeStamp ParticleInjectionTime
 
bool HasCache
 
vtkAbstractParticleWriterParticleWriter
 
char * ParticleFileName
 
vtkTypeBool EnableParticleWriting
 
vtkParticleTracerBaseNamespace::ParticleVector LocalSeeds
 
vtkSmartPointer< vtkTemporalInterpolatedVelocityFieldInterpolator
 
vtkSmartPointer< vtkCompositeDataSetCachedData [2]
 
vtkSmartPointer< vtkMultiProcessControllerController
 
vtkParticleTracerBaseNamespace::ParticleVector MPISendList
 Storage of the particles we want to send to another rank.
 
std::unordered_map< vtkIdType, vtkParticleTracerBaseNamespace::ParticleInformationMPIRecvList
 Storage of the particles we received.
 
std::vector< boundsCachedBounds [2]
 
vtkSmartPointer< vtkDataSetDataReferenceT [2]
 
vtkNew< vtkPointsOutputCoordinates
 
vtkNew< vtkIdTypeArrayParticleCellsConnectivity
 
vtkNew< vtkFloatArrayParticleAge
 
vtkNew< vtkIntArrayParticleIds
 
vtkNew< vtkSignedCharArrayParticleSourceIds
 
vtkNew< vtkIdTypeArrayInjectedPointIds
 
vtkNew< vtkIntArrayInjectedStepIds
 
vtkNew< vtkIntArrayErrorCodeArray
 
vtkNew< vtkFloatArrayParticleVorticity
 
vtkNew< vtkFloatArrayParticleRotation
 
vtkNew< vtkFloatArrayParticleAngularVel
 
vtkNew< vtkPointDataOutputPointData
 
vtkNew< vtkDoubleArrayCellVectors
 
vtkTimeStamp ExecuteTime
 
vtkSmartPointer< vtkPointDataProtoPD
 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 vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- 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
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Friends

struct vtkParticleTracerBaseNamespace::ParticleTracerFunctor
 
class ParticlePathFilterInternal
 
class StreaklineFilterInternal
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- 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.

A parallel 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

vtkPParticleTracerBase is the base class for parallel 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

Definition at line 115 of file vtkParticleTracerBase.h.

◆ bounds

Definition at line 608 of file vtkParticleTracerBase.h.

Member Enumeration Documentation

◆ Solvers

Enumerator
RUNGE_KUTTA2 
RUNGE_KUTTA4 
RUNGE_KUTTA45 
NONE 
UNKNOWN 

Definition at line 106 of file vtkParticleTracerBase.h.

◆ MeshOverTimeTypes

Types of Variance of Mesh over time.

Enumerator
DIFFERENT 
STATIC 
LINEAR_TRANSFORMATION 
SAME_TOPOLOGY 

Definition at line 247 of file vtkParticleTracerBase.h.

◆ anonymous enum

anonymous enum
Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR 
INTERPOLATOR_WITH_CELL_LOCATOR 

Definition at line 274 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()

static 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, vtkStreaklineFilter, vtkPParticlePathFilter, vtkPParticleTracer, vtkPParticleTracerBase, and vtkPStreaklineFilter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkParticleTracerBase::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented in vtkPParticlePathFilter, vtkPParticleTracer, vtkPParticleTracerBase, and vtkPStreaklineFilter.

◆ 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

◆ SetTerminationTime()

virtual void vtkParticleTracerBase::SetTerminationTime ( double  )
inlinevirtual
Deprecated:
This does not do anything. Someone wanting to amend the time series early should select a subset of the time steps by propagating upstream the information key TIME_STEPS in vtkAlgorithm::RequestUpdateExtent.

Definition at line 198 of file vtkParticleTracerBase.h.

◆ GetTerminationTime()

virtual double vtkParticleTracerBase::GetTerminationTime ( )
inlinevirtual
Deprecated:
This does not do anything. Someone wanting to amend the time series early should select a subset of the time steps by propagating upstream the information key TIME_STEPS in vtkAlgorithm::RequestUpdateExtent.

Definition at line 201 of file vtkParticleTracerBase.h.

◆ SetStartTime()

virtual void vtkParticleTracerBase::SetStartTime ( double  )
inlinevirtual
Deprecated:
This does not do anything. Someone wanting to amend the time series early should select a subset of the time steps by propagating upstream the information key TIME_STEPS in vtkAlgorithm::RequestUpdateExtent.

Definition at line 204 of file vtkParticleTracerBase.h.

◆ GetStartTime()

virtual double vtkParticleTracerBase::GetStartTime ( )
inlinevirtual
Deprecated:
This does not do anything. Someone wanting to amend the time series early should select a subset of the time steps by propagating upstream the information key TIME_STEPS in vtkAlgorithm::RequestUpdateExtent.

Definition at line 207 of file vtkParticleTracerBase.h.

◆ SetDisableResetCache()

virtual void vtkParticleTracerBase::SetDisableResetCache ( bool  )
inlinevirtual
Deprecated:
Caching is now automated.

Definition at line 215 of file vtkParticleTracerBase.h.

◆ GetDisableResetCache()

virtual bool vtkParticleTracerBase::GetDisableResetCache ( )
inlinevirtual
Deprecated:
Caching is now automated.

Definition at line 217 of file vtkParticleTracerBase.h.

◆ DisableResetCacheOn()

virtual void vtkParticleTracerBase::DisableResetCacheOn ( )
inlinevirtual
Deprecated:
Caching is now automated.

Definition at line 219 of file vtkParticleTracerBase.h.

◆ DisableResetCacheOff()

virtual void vtkParticleTracerBase::DisableResetCacheOff ( )
inlinevirtual
Deprecated:
Caching is now automated.

Definition at line 221 of file vtkParticleTracerBase.h.

◆ 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 re-use 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 re-use 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 265 of file vtkParticleTracerBase.h.

◆ GetMeshOverTimeMaxValue()

virtual int vtkParticleTracerBase::GetMeshOverTimeMaxValue ( )
inlinevirtual

Definition at line 266 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToDifferent()

void vtkParticleTracerBase::SetMeshOverTimeToDifferent ( )
inline

Definition at line 267 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToStatic()

void vtkParticleTracerBase::SetMeshOverTimeToStatic ( )
inline

Definition at line 268 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToLinearTransformation()

void vtkParticleTracerBase::SetMeshOverTimeToLinearTransformation ( )
inline

Definition at line 269 of file vtkParticleTracerBase.h.

◆ SetMeshOverTimeToSameTopology()

void vtkParticleTracerBase::SetMeshOverTimeToSameTopology ( )
inline

Definition at line 270 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 vtkH5PartWriter 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 vtkH5PartWriter should be used which will collect particles from all parallel processes and write them to a single HDF5 file.

◆ vtkSetFilePathMacro()

vtkParticleTracerBase::vtkSetFilePathMacro ( ParticleFileName  )

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ vtkGetFilePathMacro()

vtkParticleTracerBase::vtkGetFilePathMacro ( ParticleFileName  )

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ SetEnableParticleWriting()

virtual void vtkParticleTracerBase::SetEnableParticleWriting ( vtkTypeBool  )
virtual

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ GetEnableParticleWriting()

virtual vtkTypeBool vtkParticleTracerBase::GetEnableParticleWriting ( )
virtual

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ EnableParticleWritingOn()

virtual void vtkParticleTracerBase::EnableParticleWritingOn ( )
virtual

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ EnableParticleWritingOff()

virtual void vtkParticleTracerBase::EnableParticleWritingOff ( )
virtual

Set/Get the filename to be used with the particle writer when dumping particles to disk.

◆ AddSourceConnection()

void vtkParticleTracerBase::AddSourceConnection ( vtkAlgorithmOutput input)

Provide support for multiple seed sources.

◆ RemoveAllSources()

void vtkParticleTracerBase::RemoveAllSources ( )

Provide support for multiple seed sources.

◆ GetForceSerialExecution()

virtual bool vtkParticleTracerBase::GetForceSerialExecution ( )
virtual

Force the filter to run particle tracer in serial.

This affects the filter only if more than 100 particles is to be generated.

◆ SetForceSerialExecution()

virtual void vtkParticleTracerBase::SetForceSerialExecution ( bool  )
virtual

Force the filter to run particle tracer in serial.

This affects the filter only if more than 100 particles is to be generated.

◆ ForceSerialExecutionOn()

virtual void vtkParticleTracerBase::ForceSerialExecutionOn ( )
virtual

Force the filter to run particle tracer in serial.

This affects the filter only if more than 100 particles is to be generated.

◆ ForceSerialExecutionOff()

virtual void vtkParticleTracerBase::ForceSerialExecutionOff ( )
virtual

Force the filter to run particle tracer in serial.

This affects the filter only if more than 100 particles is to be generated.

◆ EnqueueParticleToAnotherProcess()

void vtkParticleTracerBase::EnqueueParticleToAnotherProcess ( vtkParticleTracerBaseNamespace::ParticleInformation )
protected

◆ FillInputPortInformation()

int vtkParticleTracerBase::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

◆ Initialize()

int vtkParticleTracerBase::Initialize ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotected

Resets internal cache for a clean start.

◆ Execute()

int vtkParticleTracerBase::Execute ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotected

Moves the particles one time step further.

When this routine has finished, OutputPointData, OutputCoordinates and ParticleHistories represent the location / point data / meta data of all particles present in the local rank. MPIRecvList represents, at this stage, the list of particles that were received during this time step.

◆ Finalize()

int vtkParticleTracerBase::Finalize ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotected

Generates an output using the data provided after Execute was ran.

◆ GetSeedSources()

virtual std::vector< vtkDataSet * > vtkParticleTracerBase::GetSeedSources ( vtkInformationVector inputVector)
protectedvirtual

Method to get the data set seed sources.

For in situ we want to override how the seed sources are made available.

◆ InitializeInterpolator()

int vtkParticleTracerBase::InitializeInterpolator ( )
protected

◆ TestParticles() [1/2]

void vtkParticleTracerBase::TestParticles ( vtkParticleTracerBaseNamespace::ParticleVector candidates,
vtkParticleTracerBaseNamespace::ParticleVector passed 
)
protected

inside our data.

Add good ones to passed list and set count to the number that passed

◆ TestParticles() [2/2]

void vtkParticleTracerBase::TestParticles ( vtkParticleTracerBaseNamespace::ParticleVector candidates,
std::vector< int > &  passed 
)
protected

◆ AssignSeedsToProcessors()

virtual void vtkParticleTracerBase::AssignSeedsToProcessors ( double  time,
vtkDataSet source,
vtkParticleTracerBaseNamespace::ParticleVector localSeedPoints 
)
protectedvirtual

all the injection/seed points according to which processor they belong to.

This saves us retesting at every injection time providing 1) The volumes are static, 2) the seed points are static If either are non static, then this step is skipped.

◆ SendReceiveParticles()

bool vtkParticleTracerBase::SendReceiveParticles ( std::vector< vtkIdType > &  )
protected

this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain.

Returns true if particles were migrated to any new process.

◆ UpdateParticleList()

void vtkParticleTracerBase::UpdateParticleList ( vtkParticleTracerBaseNamespace::ParticleVector candidates)
protected

and sending between processors, into a list, which is used as the master list on this processor

◆ UpdateParticleListFromOtherProcesses()

virtual bool vtkParticleTracerBase::UpdateParticleListFromOtherProcesses ( )
protectedvirtual

this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain.

Returns true if particles moved between processes and false otherwise.

◆ IntegrateParticle()

void vtkParticleTracerBase::IntegrateParticle ( vtkParticleTracerBaseNamespace::ParticleListIterator it,
double  currentTime,
double  targetTime,
vtkInitialValueProblemSolver integrator,
vtkTemporalInterpolatedVelocityField interpolator,
vtkDoubleArray cellVectors,
std::atomic< vtkIdType > &  particleCount,
std::mutex &  eraseMutex,
bool  sequential 
)
protected

particle between the two times supplied.

◆ ComputeDomainExitLocation()

bool vtkParticleTracerBase::ComputeDomainExitLocation ( double  pos[4],
double  p2[4],
double  intersection[4],
vtkGenericCell cell 
)
protected

This is an old routine kept for possible future use.

In dynamic meshes, particles might leave the domain and need to be extrapolated across a gap between the meshes before they re-renter another domain dodgy rotating meshes need special care....

◆ CreateProtoPD()

void vtkParticleTracerBase::CreateProtoPD ( vtkDataObject input)
protected

◆ GetParticleAge()

vtkFloatArray * vtkParticleTracerBase::GetParticleAge ( vtkPointData )
protected

◆ GetParticleIds()

vtkIntArray * vtkParticleTracerBase::GetParticleIds ( vtkPointData )
protected

◆ GetParticleSourceIds()

vtkSignedCharArray * vtkParticleTracerBase::GetParticleSourceIds ( vtkPointData )
protected

◆ GetInjectedPointIds()

vtkIntArray * vtkParticleTracerBase::GetInjectedPointIds ( vtkPointData )
protected

◆ GetInjectedStepIds()

vtkIntArray * vtkParticleTracerBase::GetInjectedStepIds ( vtkPointData )
protected

◆ GetErrorCodeArr()

vtkIntArray * vtkParticleTracerBase::GetErrorCodeArr ( vtkPointData )
protected

◆ GetParticleVorticity()

vtkFloatArray * vtkParticleTracerBase::GetParticleVorticity ( vtkPointData )
protected

◆ GetParticleRotation()

vtkFloatArray * vtkParticleTracerBase::GetParticleRotation ( vtkPointData )
protected

◆ GetParticleAngularVel()

vtkFloatArray * vtkParticleTracerBase::GetParticleAngularVel ( vtkPointData )
protected

◆ InsideBounds()

bool vtkParticleTracerBase::InsideBounds ( double  point[])
protected

◆ CalculateVorticity()

void vtkParticleTracerBase::CalculateVorticity ( vtkGenericCell cell,
double  pcoords[3],
vtkDoubleArray cellVectors,
double  vorticity[3] 
)
protected

◆ SetParticle()

void vtkParticleTracerBase::SetParticle ( vtkParticleTracerBaseNamespace::ParticleInformation info,
vtkTemporalInterpolatedVelocityField interpolator,
vtkDoubleArray cellVectors 
)
protected

◆ IsPointDataValid() [1/2]

virtual bool vtkParticleTracerBase::IsPointDataValid ( vtkDataObject input)
protectedvirtual

Methods that check that the input arrays are ordered the same on all data sets.

This needs to be true for all blocks in a composite data set as well as across all processes.

◆ IsPointDataValid() [2/2]

bool vtkParticleTracerBase::IsPointDataValid ( vtkCompositeDataSet input,
std::vector< std::string > &  arrayNames 
)
protected

Methods that check that the input arrays are ordered the same on all data sets.

This needs to be true for all blocks in a composite data set as well as across all processes.

◆ GetPointDataArrayNames()

void vtkParticleTracerBase::GetPointDataArrayNames ( vtkDataSet input,
std::vector< std::string > &  names 
)
protected

Methods that check that the input arrays are ordered the same on all data sets.

This needs to be true for all blocks in a composite data set as well as across all processes.

◆ GetReinjectionCounter()

virtual int vtkParticleTracerBase::GetReinjectionCounter ( )
protectedvirtual

◆ ResizeArrays()

void vtkParticleTracerBase::ResizeArrays ( vtkIdType  numTuples)
protected

◆ InitializeExtraPointDataArrays()

virtual void vtkParticleTracerBase::InitializeExtraPointDataArrays ( vtkPointData vtkNotUsedoutputPD)
inlineprotectedvirtual

Methods to append values to existing point data arrays that may only be desired on specific concrete derived classes.

Definition at line 520 of file vtkParticleTracerBase.h.

◆ SetToExtraPointDataArrays()

virtual void vtkParticleTracerBase::SetToExtraPointDataArrays ( vtkIdType  ,
vtkParticleTracerBaseNamespace::ParticleInformation  
)
inlineprotectedvirtual

Definition at line 522 of file vtkParticleTracerBase.h.

◆ GetInterpolator()

vtkTemporalInterpolatedVelocityField * vtkParticleTracerBase::GetInterpolator ( )
protected

◆ AddRestartSeeds()

virtual void vtkParticleTracerBase::AddRestartSeeds ( vtkInformationVector **  )
inlineprotectedvirtual

For restarts of particle paths, we add in the ability to add in particles from a previous computation that we will still advect.

Definition at line 533 of file vtkParticleTracerBase.h.

◆ RetryWithPush()

bool vtkParticleTracerBase::RetryWithPush ( vtkParticleTracerBaseNamespace::ParticleInformation info,
double *  point1,
double  delT,
int  subSteps,
vtkTemporalInterpolatedVelocityField interpolator 
)
protected

When particles leave the domain, they must be collected and sent to the other processes for possible continuation.

These routines manage the collection and sending after each main iteration. RetryWithPush adds a small push to a particle along it's current velocity vector, this helps get over cracks in dynamic/rotating meshes. This is a first order integration though so it may introduce a bit extra error compared to the integrator that is used.

◆ SetTerminationTimeNoModify()

bool vtkParticleTracerBase::SetTerminationTimeNoModify ( double  t)
protected

◆ operator=()

void vtkParticleTracerBase::operator= ( const vtkParticleTracerBase )
protecteddelete

◆ NumberOfParticles()

unsigned int vtkParticleTracerBase::NumberOfParticles ( )
protected

Friends And Related Symbol Documentation

◆ vtkParticleTracerBaseNamespace::ParticleTracerFunctor

friend struct vtkParticleTracerBaseNamespace::ParticleTracerFunctor
friend

Definition at line 105 of file vtkParticleTracerBase.h.

◆ ParticlePathFilterInternal

friend class ParticlePathFilterInternal
friend

Definition at line 638 of file vtkParticleTracerBase.h.

◆ StreaklineFilterInternal

friend class StreaklineFilterInternal
friend

Definition at line 639 of file vtkParticleTracerBase.h.

Member Data Documentation

◆ ProtoPD

vtkSmartPointer<vtkPointData> vtkParticleTracerBase::ProtoPD
protected

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.

Definition at line 363 of file vtkParticleTracerBase.h.

◆ ParticleHistories

vtkParticleTracerBaseNamespace::ParticleDataList vtkParticleTracerBase::ParticleHistories
protected

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.

Definition at line 364 of file vtkParticleTracerBase.h.

◆ IgnorePipelineTime

vtkTypeBool vtkParticleTracerBase::IgnorePipelineTime
protected

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.

Definition at line 365 of file vtkParticleTracerBase.h.

◆ ForceSerialExecution

bool vtkParticleTracerBase::ForceSerialExecution
protected

Definition at line 369 of file vtkParticleTracerBase.h.

◆ Seeds

vtkSmartPointer<vtkDataSet> vtkParticleTracerBase::Seeds
protected

All ranks have the same representation of the seeds.

They are gathered to all processes in the same order.

Definition at line 415 of file vtkParticleTracerBase.h.

◆ InjectedPointIdToProcessId

std::unordered_map<vtkIdType, int> vtkParticleTracerBase::InjectedPointIdToProcessId
protected

Definition at line 499 of file vtkParticleTracerBase.h.

◆ CachedTimeStep

double vtkParticleTracerBase::CachedTimeStep
protected

Definition at line 549 of file vtkParticleTracerBase.h.

◆ Integrator

vtkInitialValueProblemSolver* vtkParticleTracerBase::Integrator
protected

Definition at line 552 of file vtkParticleTracerBase.h.

◆ IntegrationStep

double vtkParticleTracerBase::IntegrationStep
protected

Definition at line 553 of file vtkParticleTracerBase.h.

◆ MaximumError

double vtkParticleTracerBase::MaximumError
protected

Definition at line 554 of file vtkParticleTracerBase.h.

◆ ComputeVorticity

bool vtkParticleTracerBase::ComputeVorticity
protected

Definition at line 555 of file vtkParticleTracerBase.h.

◆ RotationScale

double vtkParticleTracerBase::RotationScale
protected

Definition at line 556 of file vtkParticleTracerBase.h.

◆ TerminalSpeed

double vtkParticleTracerBase::TerminalSpeed
protected

Definition at line 557 of file vtkParticleTracerBase.h.

◆ ReinjectionCounter

int vtkParticleTracerBase::ReinjectionCounter
protected

Definition at line 560 of file vtkParticleTracerBase.h.

◆ AllFixedGeometry

vtkTypeBool vtkParticleTracerBase::AllFixedGeometry
protected

Definition at line 563 of file vtkParticleTracerBase.h.

◆ MeshOverTime

int vtkParticleTracerBase::MeshOverTime
protected

Definition at line 564 of file vtkParticleTracerBase.h.

◆ StaticSeeds

vtkTypeBool vtkParticleTracerBase::StaticSeeds
protected

Definition at line 565 of file vtkParticleTracerBase.h.

◆ ForceReinjectionEveryNSteps

int vtkParticleTracerBase::ForceReinjectionEveryNSteps
protected

Definition at line 568 of file vtkParticleTracerBase.h.

◆ ParticleInjectionTime

vtkTimeStamp vtkParticleTracerBase::ParticleInjectionTime
protected

Definition at line 569 of file vtkParticleTracerBase.h.

◆ HasCache

bool vtkParticleTracerBase::HasCache
protected

Definition at line 570 of file vtkParticleTracerBase.h.

◆ ParticleWriter

vtkAbstractParticleWriter* vtkParticleTracerBase::ParticleWriter
protected

Definition at line 573 of file vtkParticleTracerBase.h.

◆ ParticleFileName

char* vtkParticleTracerBase::ParticleFileName
protected

Definition at line 574 of file vtkParticleTracerBase.h.

◆ EnableParticleWriting

vtkTypeBool vtkParticleTracerBase::EnableParticleWriting
protected

Definition at line 575 of file vtkParticleTracerBase.h.

◆ LocalSeeds

vtkParticleTracerBaseNamespace::ParticleVector vtkParticleTracerBase::LocalSeeds
protected

Definition at line 577 of file vtkParticleTracerBase.h.

◆ Interpolator

vtkSmartPointer<vtkTemporalInterpolatedVelocityField> vtkParticleTracerBase::Interpolator
protected

Definition at line 580 of file vtkParticleTracerBase.h.

◆ CachedData

vtkSmartPointer<vtkCompositeDataSet> vtkParticleTracerBase::CachedData[2]
protected

Definition at line 583 of file vtkParticleTracerBase.h.

◆ Controller

vtkSmartPointer<vtkMultiProcessController> vtkParticleTracerBase::Controller
protected

Definition at line 586 of file vtkParticleTracerBase.h.

◆ MPISendList

vtkParticleTracerBaseNamespace::ParticleVector vtkParticleTracerBase::MPISendList
protected

Storage of the particles we want to send to another rank.

This storage is deleted upon exiting Execute.

Definition at line 592 of file vtkParticleTracerBase.h.

◆ MPIRecvList

std::unordered_map<vtkIdType, vtkParticleTracerBaseNamespace::ParticleInformation> vtkParticleTracerBase::MPIRecvList
protected

Storage of the particles we received.

After Execute terminates, it stores the set of particles that were not present at the beginning of the execution. The received particles are indexed using InjectedPointId, which is a unique identifier. There are no 2 particles across ranks that have the same InjectedPointId.

Definition at line 601 of file vtkParticleTracerBase.h.

◆ CachedBounds

std::vector<bounds> vtkParticleTracerBase::CachedBounds[2]
protected

Definition at line 609 of file vtkParticleTracerBase.h.

◆ DataReferenceT

vtkSmartPointer<vtkDataSet> vtkParticleTracerBase::DataReferenceT[2]
protected

Definition at line 613 of file vtkParticleTracerBase.h.

◆ OutputCoordinates

vtkNew<vtkPoints> vtkParticleTracerBase::OutputCoordinates
protected

Definition at line 615 of file vtkParticleTracerBase.h.

◆ ParticleCellsConnectivity

vtkNew<vtkIdTypeArray> vtkParticleTracerBase::ParticleCellsConnectivity
protected

Definition at line 616 of file vtkParticleTracerBase.h.

◆ ParticleAge

vtkNew<vtkFloatArray> vtkParticleTracerBase::ParticleAge
protected

Definition at line 618 of file vtkParticleTracerBase.h.

◆ ParticleIds

vtkNew<vtkIntArray> vtkParticleTracerBase::ParticleIds
protected

Definition at line 619 of file vtkParticleTracerBase.h.

◆ ParticleSourceIds

vtkNew<vtkSignedCharArray> vtkParticleTracerBase::ParticleSourceIds
protected

Definition at line 620 of file vtkParticleTracerBase.h.

◆ InjectedPointIds

vtkNew<vtkIdTypeArray> vtkParticleTracerBase::InjectedPointIds
protected

Definition at line 621 of file vtkParticleTracerBase.h.

◆ InjectedStepIds

vtkNew<vtkIntArray> vtkParticleTracerBase::InjectedStepIds
protected

Definition at line 622 of file vtkParticleTracerBase.h.

◆ ErrorCodeArray

vtkNew<vtkIntArray> vtkParticleTracerBase::ErrorCodeArray
protected

Definition at line 623 of file vtkParticleTracerBase.h.

◆ ParticleVorticity

vtkNew<vtkFloatArray> vtkParticleTracerBase::ParticleVorticity
protected

Definition at line 624 of file vtkParticleTracerBase.h.

◆ ParticleRotation

vtkNew<vtkFloatArray> vtkParticleTracerBase::ParticleRotation
protected

Definition at line 625 of file vtkParticleTracerBase.h.

◆ ParticleAngularVel

vtkNew<vtkFloatArray> vtkParticleTracerBase::ParticleAngularVel
protected

Definition at line 626 of file vtkParticleTracerBase.h.

◆ OutputPointData

vtkNew<vtkPointData> vtkParticleTracerBase::OutputPointData
protected

Definition at line 627 of file vtkParticleTracerBase.h.

◆ CellVectors

vtkNew<vtkDoubleArray> vtkParticleTracerBase::CellVectors
protected

Definition at line 630 of file vtkParticleTracerBase.h.

◆ ExecuteTime

vtkTimeStamp vtkParticleTracerBase::ExecuteTime
protected

Definition at line 634 of file vtkParticleTracerBase.h.

◆ Epsilon

const double vtkParticleTracerBase::Epsilon
staticprotected

Definition at line 641 of file vtkParticleTracerBase.h.


The documentation for this class was generated from the following file: