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

A particle tracer for vector fields. More...

#include <vtkParticleTracerBase.h>

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

Public Types

enum  Solvers {
  RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE,
  UNKNOWN
}
 
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. More...
 
vtkParticleTracerBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void PrintParticleHistories ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
void SetIntegratorType (int type)
 
int GetIntegratorType ()
 
virtual bool GetComputeVorticity ()
 Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter. More...
 
void SetComputeVorticity (bool)
 Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter. More...
 
virtual double GetTerminalSpeed ()
 Specify the terminal speed value, below which integration is terminated. More...
 
void SetTerminalSpeed (double)
 Specify the terminal speed value, below which integration is terminated. More...
 
virtual double GetRotationScale ()
 This can be used to scale the rate with which the streamribbons twist. More...
 
void SetRotationScale (double)
 This can be used to scale the rate with which the streamribbons twist. More...
 
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. More...
 
virtual vtkTypeBool GetIgnorePipelineTime ()
 To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests. More...
 
virtual void IgnorePipelineTimeOn ()
 To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests. More...
 
virtual void IgnorePipelineTimeOff ()
 To get around problems with the Paraview Animation controls we can just animate the time step and ignore the TIME_ requests. More...
 
virtual int GetForceReinjectionEveryNSteps ()
 When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. More...
 
void SetForceReinjectionEveryNSteps (int)
 When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. More...
 
void SetTerminationTime (double t)
 Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. More...
 
virtual double GetTerminationTime ()
 Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. More...
 
virtual double GetStartTime ()
 Set the time value for particle tracing to begin. More...
 
void SetStartTime (double t)
 Set the time value for particle tracing to begin. More...
 
virtual void SetStaticSeeds (int)
 if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use the same injection information. More...
 
virtual int GetStaticSeeds ()
 if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use the same injection information. More...
 
virtual void SetStaticMesh (int)
 if StaticMesh is set, many optimizations for cell caching can be assumed. More...
 
virtual int GetStaticMesh ()
 if StaticMesh is set, many optimizations for cell caching can be assumed. More...
 
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. More...
 
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. More...
 
virtual void SetParticleFileName (const char *)
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual char * GetParticleFileName ()
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual void SetEnableParticleWriting (vtkTypeBool)
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual vtkTypeBool GetEnableParticleWriting ()
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual void EnableParticleWritingOn ()
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual void EnableParticleWritingOff ()
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual void SetDisableResetCache (vtkTypeBool)
 Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow. More...
 
virtual vtkTypeBool GetDisableResetCache ()
 Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow. More...
 
virtual void DisableResetCacheOn ()
 Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow. More...
 
virtual void DisableResetCacheOff ()
 Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow. More...
 
void AddSourceConnection (vtkAlgorithmOutput *input)
 Provide support for multiple seed sources. More...
 
void RemoveAllSources ()
 Provide support for multiple seed sources. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static 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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkParticleTracerBase ()
 
 ~vtkParticleTracerBase () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
virtual int ProcessInput (vtkInformationVector **inputVector)
 
virtual vtkPolyDataExecute (vtkInformationVector **inputVector)
 
virtual void Initialize ()
 
virtual int OutputParticles (vtkPolyData *poly)=0
 
virtual void Finalize ()
 
virtual std::vector< vtkDataSet * > GetSeedSources (vtkInformationVector *inputVector, int timeStep)
 Method to get the data set seed sources. More...
 
int InitializeInterpolator ()
 
int UpdateDataCache (vtkDataObject *td)
 
void TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, vtkParticleTracerBaseNamespace::ParticleVector &passed, int &count)
 inside our data. More...
 
void TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, std::vector< int > &passed)
 
virtual void AssignSeedsToProcessors (double time, vtkDataSet *source, int sourceID, int ptId, vtkParticleTracerBaseNamespace::ParticleVector &localSeedPoints, int &localAssignedCount)
 all the injection/seed points according to which processor they belong to. More...
 
virtual void AssignUniqueIds (vtkParticleTracerBaseNamespace::ParticleVector &localSeedPoints)
 give each one a uniqu ID. More...
 
void UpdateParticleList (vtkParticleTracerBaseNamespace::ParticleVector &candidates)
 and sending between processors, into a list, which is used as the master list on this processor More...
 
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. More...
 
void IntegrateParticle (vtkParticleTracerBaseNamespace::ParticleListIterator &it, double currenttime, double terminationtime, vtkInitialValueProblemSolver *integrator)
 particle between the two times supplied. More...
 
virtual bool SendParticleToAnotherProcess (vtkParticleTracerBaseNamespace::ParticleInformation &, vtkParticleTracerBaseNamespace::ParticleInformation &, vtkPointData *)
 
bool ComputeDomainExitLocation (double pos[4], double p2[4], double intersection[4], vtkGenericCell *cell)
 This is an old routine kept for possible future use. More...
 
void CreateProtoPD (vtkDataObject *input)
 
vtkFloatArrayGetParticleAge (vtkPointData *)
 
vtkIntArrayGetParticleIds (vtkPointData *)
 
vtkCharArrayGetParticleSourceIds (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])
 
double GetCacheDataTime (int i)
 
double GetCacheDataTime ()
 
virtual void ResetCache ()
 
void AddParticle (vtkParticleTracerBaseNamespace::ParticleInformation &info, double *velocity)
 
virtual int GetReinjectionCounter ()
 
virtual double GetCurrentTimeValue ()
 
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. More...
 
virtual void AppendToExtraPointDataArrays (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. More...
 
virtual bool IsPointDataValid (vtkDataObject *input)
 Methods that check that the input arrays are ordered the same on all data sets. More...
 
bool IsPointDataValid (vtkCompositeDataSet *input, std::vector< std::string > &arrayNames)
 Methods that check that the input arrays are ordered the same on all data sets. More...
 
void GetPointDataArrayNames (vtkDataSet *input, std::vector< std::string > &names)
 Methods that check that the input arrays are ordered the same on all data sets. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkPolyDataOutput
 
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. More...
 
vtkIdType UniqueIdCounter
 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. More...
 
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. More...
 
vtkSmartPointer< vtkPointDataParticlePointData
 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. More...
 
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. More...
 
vtkTypeBool DisableResetCache
 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. More...
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class ParticlePathFilterInternal
 
class StreaklineFilterInternal
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 95 of file vtkParticleTracerBase.h.

Member Typedef Documentation

Definition at line 107 of file vtkParticleTracerBase.h.

Member Enumeration Documentation

Enumerator
RUNGE_KUTTA2 
RUNGE_KUTTA4 
RUNGE_KUTTA45 
NONE 
UNKNOWN 

Definition at line 98 of file vtkParticleTracerBase.h.

Constructor & Destructor Documentation

vtkParticleTracerBase::vtkParticleTracerBase ( )
protected
vtkParticleTracerBase::~vtkParticleTracerBase ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkParticleTracerBase::IsTypeOf ( const char *  type)
static
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, vtkStreaklineFilter, vtkPParticleTracer, vtkPParticleTracerBase, vtkPStreaklineFilter, vtkParticleTracer, and vtkPParticlePathFilter.

static vtkParticleTracerBase* vtkParticleTracerBase::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkParticleTracerBase::NewInstanceInternal ( ) const
protectedvirtual
vtkParticleTracerBase* vtkParticleTracerBase::NewInstance ( ) const
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 vtkPolyDataAlgorithm.

Reimplemented in vtkStreaklineFilter, vtkPParticleTracer, vtkPParticleTracerBase, vtkPStreaklineFilter, and vtkPParticlePathFilter.

void vtkParticleTracerBase::PrintParticleHistories ( )
virtual bool vtkParticleTracerBase::GetComputeVorticity ( )
virtual

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

void vtkParticleTracerBase::SetComputeVorticity ( bool  )

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

virtual double vtkParticleTracerBase::GetTerminalSpeed ( )
virtual

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

void vtkParticleTracerBase::SetTerminalSpeed ( double  )

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

virtual double vtkParticleTracerBase::GetRotationScale ( )
virtual

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

The default is 1.

void vtkParticleTracerBase::SetRotationScale ( double  )

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

The default is 1.

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.

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.

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.

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.

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

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

void vtkParticleTracerBase::SetTerminationTime ( double  t)

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached.

Use a vlue of zero to disable termination. The units of time should be consistent with the primary time variable.

virtual double vtkParticleTracerBase::GetTerminationTime ( )
virtual

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached.

Use a vlue of zero to disable termination. The units of time should be consistent with the primary time variable.

void vtkParticleTracerBase::SetIntegrator ( vtkInitialValueProblemSolver )
virtual vtkInitialValueProblemSolver* vtkParticleTracerBase::GetIntegrator ( )
virtual
void vtkParticleTracerBase::SetIntegratorType ( int  type)
int vtkParticleTracerBase::GetIntegratorType ( )
virtual double vtkParticleTracerBase::GetStartTime ( )
virtual

Set the time value for particle tracing to begin.

The units of time should be consistent with the primary time variable.

void vtkParticleTracerBase::SetStartTime ( double  t)

Set the time value for particle tracing to begin.

The units of time should be consistent with the primary time variable.

virtual void vtkParticleTracerBase::SetStaticSeeds ( int  )
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.

virtual int 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.

virtual void vtkParticleTracerBase::SetStaticMesh ( int  )
virtual

if StaticMesh is set, many optimizations for cell caching can be assumed.

if StaticMesh is not set, the algorithm will attempt to find out if optimizations can be used, but setting it to true will force all optimizations. Do not Set StaticMesh to true if a dynamic mesh is being used as this will invalidate all results. The default is that StaticMesh is 0.

virtual int vtkParticleTracerBase::GetStaticMesh ( )
virtual

if StaticMesh is set, many optimizations for cell caching can be assumed.

if StaticMesh is not set, the algorithm will attempt to find out if optimizations can be used, but setting it to true will force all optimizations. Do not Set StaticMesh to true if a dynamic mesh is being used as this will invalidate all results. The default is that StaticMesh is 0.

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.

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.

virtual void vtkParticleTracerBase::SetParticleFileName ( const char *  )
virtual

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

virtual char* vtkParticleTracerBase::GetParticleFileName ( )
virtual

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

virtual void vtkParticleTracerBase::SetEnableParticleWriting ( vtkTypeBool  )
virtual

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

virtual vtkTypeBool vtkParticleTracerBase::GetEnableParticleWriting ( )
virtual

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

virtual void vtkParticleTracerBase::EnableParticleWritingOn ( )
virtual

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

virtual void vtkParticleTracerBase::EnableParticleWritingOff ( )
virtual

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

virtual void vtkParticleTracerBase::SetDisableResetCache ( vtkTypeBool  )
virtual

Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow.

virtual vtkTypeBool vtkParticleTracerBase::GetDisableResetCache ( )
virtual

Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow.

virtual void vtkParticleTracerBase::DisableResetCacheOn ( )
virtual

Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow.

virtual void vtkParticleTracerBase::DisableResetCacheOff ( )
virtual

Set/Get the flag to disable cache This is off by default and turned on in special circumstances such as in a coprocessing workflow.

void vtkParticleTracerBase::AddSourceConnection ( vtkAlgorithmOutput input)

Provide support for multiple seed sources.

void vtkParticleTracerBase::RemoveAllSources ( )

Provide support for multiple seed sources.

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

int vtkParticleTracerBase::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

see vtkAlgorithm for details

Reimplemented from vtkPolyDataAlgorithm.

int vtkParticleTracerBase::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

int vtkParticleTracerBase::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkPParticleTracerBase.

int vtkParticleTracerBase::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkParticleTracerBase::ProcessInput ( vtkInformationVector **  inputVector)
protectedvirtual
virtual vtkPolyData* vtkParticleTracerBase::Execute ( vtkInformationVector **  inputVector)
protectedvirtual

Reimplemented in vtkPParticleTracerBase.

virtual void vtkParticleTracerBase::Initialize ( )
inlineprotectedvirtual

Definition at line 333 of file vtkParticleTracerBase.h.

virtual int vtkParticleTracerBase::OutputParticles ( vtkPolyData poly)
protectedpure virtual
virtual void vtkParticleTracerBase::Finalize ( )
inlineprotectedvirtual
virtual std::vector<vtkDataSet*> vtkParticleTracerBase::GetSeedSources ( vtkInformationVector inputVector,
int  timeStep 
)
protectedvirtual

Method to get the data set seed sources.

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

int vtkParticleTracerBase::InitializeInterpolator ( )
protected
int vtkParticleTracerBase::UpdateDataCache ( vtkDataObject td)
protected
void vtkParticleTracerBase::TestParticles ( vtkParticleTracerBaseNamespace::ParticleVector candidates,
vtkParticleTracerBaseNamespace::ParticleVector passed,
int count 
)
protected

inside our data.

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

void vtkParticleTracerBase::TestParticles ( vtkParticleTracerBaseNamespace::ParticleVector candidates,
std::vector< int > &  passed 
)
protected
virtual void vtkParticleTracerBase::AssignSeedsToProcessors ( double  time,
vtkDataSet source,
int  sourceID,
int  ptId,
vtkParticleTracerBaseNamespace::ParticleVector localSeedPoints,
int localAssignedCount 
)
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.

Reimplemented in vtkPParticleTracerBase.

virtual void vtkParticleTracerBase::AssignUniqueIds ( vtkParticleTracerBaseNamespace::ParticleVector localSeedPoints)
protectedvirtual

give each one a uniqu ID.

We need to use MPI to find out who is using which numbers.

Reimplemented in vtkPParticleTracerBase.

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

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

virtual bool vtkParticleTracerBase::UpdateParticleListFromOtherProcesses ( )
inlineprotectedvirtual

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.

Reimplemented in vtkPParticleTracerBase.

Definition at line 391 of file vtkParticleTracerBase.h.

void vtkParticleTracerBase::IntegrateParticle ( vtkParticleTracerBaseNamespace::ParticleListIterator it,
double  currenttime,
double  terminationtime,
vtkInitialValueProblemSolver integrator 
)
protected

particle between the two times supplied.

virtual bool vtkParticleTracerBase::SendParticleToAnotherProcess ( vtkParticleTracerBaseNamespace::ParticleInformation ,
vtkParticleTracerBaseNamespace::ParticleInformation ,
vtkPointData  
)
inlineprotectedvirtual

Reimplemented in vtkPParticleTracerBase.

Definition at line 403 of file vtkParticleTracerBase.h.

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

void vtkParticleTracerBase::CreateProtoPD ( vtkDataObject input)
protected
vtkFloatArray* vtkParticleTracerBase::GetParticleAge ( vtkPointData )
protected
vtkIntArray* vtkParticleTracerBase::GetParticleIds ( vtkPointData )
protected
vtkCharArray* vtkParticleTracerBase::GetParticleSourceIds ( vtkPointData )
protected
vtkIntArray* vtkParticleTracerBase::GetInjectedPointIds ( vtkPointData )
protected
vtkIntArray* vtkParticleTracerBase::GetInjectedStepIds ( vtkPointData )
protected
vtkIntArray* vtkParticleTracerBase::GetErrorCodeArr ( vtkPointData )
protected
vtkFloatArray* vtkParticleTracerBase::GetParticleVorticity ( vtkPointData )
protected
vtkFloatArray* vtkParticleTracerBase::GetParticleRotation ( vtkPointData )
protected
vtkFloatArray* vtkParticleTracerBase::GetParticleAngularVel ( vtkPointData )
protected
bool vtkParticleTracerBase::InsideBounds ( double  point[])
protected
void vtkParticleTracerBase::CalculateVorticity ( vtkGenericCell cell,
double  pcoords[3],
vtkDoubleArray cellVectors,
double  vorticity[3] 
)
protected
double vtkParticleTracerBase::GetCacheDataTime ( int  i)
protected
double vtkParticleTracerBase::GetCacheDataTime ( )
protected
virtual void vtkParticleTracerBase::ResetCache ( )
protectedvirtual
void vtkParticleTracerBase::AddParticle ( vtkParticleTracerBaseNamespace::ParticleInformation info,
double velocity 
)
protected
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.

Reimplemented in vtkPParticleTracerBase.

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.

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.

virtual int vtkParticleTracerBase::GetReinjectionCounter ( )
protectedvirtual
virtual double vtkParticleTracerBase::GetCurrentTimeValue ( )
protectedvirtual
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 468 of file vtkParticleTracerBase.h.

virtual void vtkParticleTracerBase::AppendToExtraPointDataArrays ( vtkParticleTracerBaseNamespace::ParticleInformation )
inlineprotectedvirtual

Reimplemented in vtkParticlePathFilter, and vtkPParticlePathFilter.

Definition at line 470 of file vtkParticleTracerBase.h.

vtkTemporalInterpolatedVelocityField* vtkParticleTracerBase::GetInterpolator ( )
protected
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 478 of file vtkParticleTracerBase.h.

Friends And Related Function Documentation

friend class ParticlePathFilterInternal
friend

Definition at line 576 of file vtkParticleTracerBase.h.

friend class StreaklineFilterInternal
friend

Definition at line 577 of file vtkParticleTracerBase.h.

Member Data Documentation

vtkSmartPointer<vtkPolyData> vtkParticleTracerBase::Output
protected

Definition at line 266 of file vtkParticleTracerBase.h.

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 272 of file vtkParticleTracerBase.h.

vtkIdType vtkParticleTracerBase::UniqueIdCounter
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 273 of file vtkParticleTracerBase.h.

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 274 of file vtkParticleTracerBase.h.

vtkSmartPointer<vtkPointData> vtkParticleTracerBase::ParticlePointData
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 275 of file vtkParticleTracerBase.h.

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 278 of file vtkParticleTracerBase.h.

vtkTypeBool vtkParticleTracerBase::DisableResetCache
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 279 of file vtkParticleTracerBase.h.


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