Filter to inject and track particles in a flow. More...

#include <vtkLagrangianParticleTracker.h>

Inheritance diagram for vtkLagrangianParticleTracker:

Collaboration diagram for vtkLagrangianParticleTracker:

Public Types
enum	CellLengthComputation { STEP_CUR_CELL_LENGTH = 1 , STEP_CUR_CELL_VEL_DIR = 3 , STEP_CUR_CELL_DIV_THEO = 5 }

typedef vtkDataObjectAlgorithm	Superclass

typedef enum vtkLagrangianParticleTracker::CellLengthComputation	CellLengthComputation

Public Types inherited from vtkDataObjectAlgorithm
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...

vtkLagrangianParticleTracker *	NewInstance () const

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

void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify the source object used to generate particle initial position (seeds). More...

void	SetSurfaceConnection (vtkAlgorithmOutput *algOutput)
	Specify the object used to compute surface interaction with. More...

int	FillInputPortInformation (int port, vtkInformation *info) override
	Declare input port type. More...

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Declare output port type. More...

int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	Create outputs objects. More...

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	Process inputs to integrate particle and generate output. More...

vtkMTimeType	GetMTime () override
	Get the tracker modified time taking into account the integration model and the integrator. More...

virtual vtkIdType	GetNewParticleId ()
	Get an unique id for a particle This method is thread safe. More...


void	SetIntegrationModel (vtkLagrangianBasicIntegrationModel *integrationModel)
	Set/Get the integration model. More...

virtual vtkLagrangianBasicIntegrationModel *	GetIntegrationModel ()
	Set/Get the integration model. More...


void	SetIntegrator (vtkInitialValueProblemSolver *integrator)
	Set/Get the integrator. More...

virtual vtkInitialValueProblemSolver *	GetIntegrator ()
	Set/Get the integrator. More...


virtual void	SetGeneratePolyVertexInteractionOutput (bool)
	Set/Get whether or not to use PolyVertex cell type for the interaction output Default is false. More...

virtual bool	GetGeneratePolyVertexInteractionOutput ()
	Set/Get whether or not to use PolyVertex cell type for the interaction output Default is false. More...


virtual void	SetCellLengthComputationMode (int)
	Set/Get the cell length computation mode. More...

virtual int	GetCellLengthComputationMode ()
	Set/Get the cell length computation mode. More...


virtual void	SetStepFactor (double)
	Set/Get the integration step factor. More...

virtual double	GetStepFactor ()
	Set/Get the integration step factor. More...


virtual void	SetStepFactorMin (double)
	Set/Get the integration step factor min. More...

virtual double	GetStepFactorMin ()
	Set/Get the integration step factor min. More...


virtual void	SetStepFactorMax (double)
	Set/Get the integration step factor max. More...

virtual double	GetStepFactorMax ()
	Set/Get the integration step factor max. More...


virtual void	SetMaximumNumberOfSteps (int)
	Set/Get the maximum number of steps. More...

virtual int	GetMaximumNumberOfSteps ()
	Set/Get the maximum number of steps. More...


virtual void	SetMaximumIntegrationTime (double)
	Set/Get the maximum integration time. More...

virtual double	GetMaximumIntegrationTime ()
	Set/Get the maximum integration time. More...


virtual void	SetAdaptiveStepReintegration (bool)
	Set/Get the Adaptive Step Reintegration feature. More...

virtual bool	GetAdaptiveStepReintegration ()
	Set/Get the Adaptive Step Reintegration feature. More...

virtual void	AdaptiveStepReintegrationOn ()
	Set/Get the Adaptive Step Reintegration feature. More...

virtual void	AdaptiveStepReintegrationOff ()
	Set/Get the Adaptive Step Reintegration feature. More...


virtual void	SetGenerateParticlePathsOutput (bool)
	Set/Get the generation of the particle path output, Default is true. More...

virtual bool	GetGenerateParticlePathsOutput ()
	Set/Get the generation of the particle path output, Default is true. More...

virtual void	GenerateParticlePathsOutputOn ()
	Set/Get the generation of the particle path output, Default is true. More...

virtual void	GenerateParticlePathsOutputOff ()
	Set/Get the generation of the particle path output, Default is true. More...


void	SetSourceData (vtkDataObject *source)
	Specify the source object used to generate particle initial position (seeds). More...

vtkDataObject *	GetSource ()
	Specify the source object used to generate particle initial position (seeds). More...


void	SetSurfaceData (vtkDataObject *source)
	Specify the source object used to compute surface interaction with Note that this method does not connect the pipeline. More...

vtkDataObject *	GetSurface ()
	Specify the source object used to compute surface interaction with Note that this method does not connect the pipeline. More...

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

vtkDataObjectAlgorithm *	NewInstance () const

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

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

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

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

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

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

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

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

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

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

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

vtkAlgorithm *	NewInstance () const

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

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

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

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

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

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

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

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

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

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

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

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

void	SetProgress (double)
	`SetProgress` is deprecated. More...

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

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

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

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

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

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

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkLagrangianParticleTracker *	SafeDownCast (vtkObjectBase *o)

static vtkLagrangianParticleTracker *	New ()

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

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

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

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

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

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

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

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

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

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

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

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLagrangianParticleTracker ()

	~vtkLagrangianParticleTracker () override

virtual bool	InitializeFlow (vtkDataObject flow, vtkBoundingBox bounds)

virtual bool	InitializeParticles (const vtkBoundingBox bounds, vtkDataSet seeds, std::queue< vtkLagrangianParticle * > &particles, vtkPointData *seedData)

virtual void	GenerateParticles (const vtkBoundingBox bounds, vtkDataSet seeds, vtkDataArray initialVelocities, vtkDataArray initialIntegrationTimes, vtkPointData seedData, int nVar, std::queue< vtkLagrangianParticle > &particles)

virtual bool	UpdateSurfaceCacheIfNeeded (vtkDataObject *&surfaces)

virtual void	InitializeSurface (vtkDataObject *&surfaces)

virtual bool	InitializePathsOutput (vtkPointData seedData, vtkIdType numberOfSeeds, vtkPolyData &particlePathsOutput)
	This method is thread safe. More...

virtual bool	InitializeInteractionOutput (vtkPointData seedData, vtkDataObject surfaces, vtkDataObject *&interractionOutput)
	This method is thread safe. More...

virtual bool	FinalizeOutputs (vtkPolyData particlePathsOutput, vtkDataObject interactionOutput)

virtual void	GetParticleFeed (std::queue< vtkLagrangianParticle * > &particleQueue)

virtual int	Integrate (vtkInitialValueProblemSolver integrator, vtkLagrangianParticle , std::queue< vtkLagrangianParticle * > &, vtkPolyData particlePathsOutput, vtkPolyLine particlePath, vtkDataObject *interactionOutput)
	This method is thread safe. More...

void	InsertPathOutputPoint (vtkLagrangianParticle particle, vtkPolyData particlePathsOutput, vtkIdList *particlePathPointId, bool prev=false)
	This method is thread safe. More...

void	InsertInteractionOutputPoint (vtkLagrangianParticle particle, unsigned int interactedSurfaceFlatIndex, vtkDataObject interactionOutput)
	This method is thread safe. More...

double	ComputeCellLength (vtkLagrangianParticle *particle)
	Computes the cell length for the next step using the method set by CellLengthComputationMode. More...

bool	ComputeNextStep (vtkInitialValueProblemSolver integrator, double xprev, double xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double cellLength, int &integrationRes, vtkLagrangianParticle particle)
	This method is thread safe. More...

virtual void	DeleteParticle (vtkLagrangianParticle *particle)
	This method is thread safe Call the ParticleAboutToBeDeleted model method and delete the particle. More...

Protected Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm () override

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

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

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

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

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

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

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

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

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

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

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

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

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

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	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...

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	InsertPolyVertexCell (vtkPolyData *polydata)

static void	InsertVertexCells (vtkPolyData *polydata)

Static Protected Member Functions inherited from vtkDataObjectAlgorithm
static bool	SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
	A helper method that can be used by subclasses in `RequestDataObject` to create an output data object of the given type if not already present. More...

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkLagrangianBasicIntegrationModel *	IntegrationModel

vtkInitialValueProblemSolver *	Integrator

int	CellLengthComputationMode

double	StepFactor

double	StepFactorMin

double	StepFactorMax

int	MaximumNumberOfSteps

double	MaximumIntegrationTime

bool	AdaptiveStepReintegration

bool	GenerateParticlePathsOutput = true

bool	GeneratePolyVertexInteractionOutput

std::atomic< vtkIdType >	ParticleCounter

std::atomic< vtkIdType >	IntegratedParticleCounter

vtkIdType	IntegratedParticleCounterIncrement

vtkPointData *	SeedData

double	MinimumVelocityMagnitude

double	MinimumReductionFactor

vtkDataObject *	FlowCache

vtkMTimeType	FlowTime

vtkBoundingBox	FlowBoundsCache

vtkDataObject *	SurfacesCache

vtkMTimeType	SurfacesTime

std::mutex	ProgressMutex

vtkLagrangianThreadedData *	SerialThreadedData

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
struct	IntegratingFunctor

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Filter to inject and track particles in a flow.

Introduce LagrangianParticleTracker

This is a very flexible and adaptive filter to inject and track particles in a flow. It takes three inputs :

port 0 : Flow Input, a volumic dataset containing data to integrate with, any kind of data object, support distributed input.
port 1 : Seed (source) Input, a dataset containing point to generate particles with, any kind of data object, support distributed input. Only first leaf of composite dataset is used.
port 2 : Optional Surface Input, containing dataset to interact with, any kind of data object, support distributed input.

It has two outputs :

port 0 : ParticlePaths : a multipiece of polyData (one per thread) of polyLines showing the paths of particles in the flow
port 1 : ParticleInteractions : empty if no surface input, contains a a multiblock with as many children as the number of threads, each children containing a multiblock with the same structure as the surfaces. The leafs of these structures contain a polydata of vertexes corresponding to the interactions. with the same composite layout of surface input if any, showing all interactions between particles and the surface input.

It has a parallel implementation which streams particle between domains.

The most important parameters of this filter is it's integrationModel. Only one integration model implementation exist currently in ParaView ,vtkLagrangianMatidaIntegrationModel but the design enables plugin developers to expand this tracker by creating new models. A model can define :

The number of integration variable and new user defined integration variable
the way the particle are integrated
the way particles intersect and interact with the surface
the way freeFlight termination is handled
PreProcess and PostProcess methods
Manual Integration, Manual partichle shifting see vtkLagrangianBasicIntegrationModel and vtkLagrangianMatidaIntegrationModel for more information

It also let the user choose the Locator to use when integrating in the flow, as well as the Integrator to use. Integration steps are also highly configurable, step, step min and step max are passed down to the integrator (hence min and max does not matter with a non adaptive integrator like RK4/5)

An IntegrationModel is a very specific vtkFunctionSet with a lot of features allowing inherited classes to concentrate on the mathematical part of the code. a Particle is basically a class wrapper around three table containing variables about the particle at previous, current and next position. The particle is passed to the integrator, which use the integration model to integrate the particle in the flow.

It has other features also, including :

Adaptative Step Reintegration, to retry the step with different time step when the next position is too far
Different kind of cell length computation, including a divergence theorem based computation
Optional lines rendering controlled by a threshold
Ghost cell support
Non planar quad interaction support
Built-in support for surface interaction including, terminate, bounce, break-up and pass-through surface The serial and parallel filters are fully tested.

See also: vtkLagrangianMatidaIntegrationModel vtkLagrangianParticle vtkLagrangianBasicIntegrationModel

Definition at line 117 of file vtkLagrangianParticleTracker.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkLagrangianParticleTracker::Superclass

Definition at line 120 of file vtkLagrangianParticleTracker.h.

◆ CellLengthComputation

typedef enum vtkLagrangianParticleTracker::CellLengthComputation vtkLagrangianParticleTracker::CellLengthComputation

Member Enumeration Documentation

◆ CellLengthComputation

enum vtkLagrangianParticleTracker::CellLengthComputation

Enumerator
STEP_CUR_CELL_LENGTH
STEP_CUR_CELL_VEL_DIR
STEP_CUR_CELL_DIV_THEO

Definition at line 124 of file vtkLagrangianParticleTracker.h.

Constructor & Destructor Documentation

◆ vtkLagrangianParticleTracker()

vtkLagrangianParticleTracker::vtkLagrangianParticleTracker ( )

protected

◆ ~vtkLagrangianParticleTracker()

vtkLagrangianParticleTracker::~vtkLagrangianParticleTracker ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkLagrangianParticleTracker::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 vtkDataObjectAlgorithm.

Reimplemented in vtkPLagrangianParticleTracker.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLagrangianParticleTracker::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkPLagrangianParticleTracker.

◆ NewInstance()

vtkLagrangianParticleTracker * vtkLagrangianParticleTracker::NewInstance ( ) const

◆ PrintSelf()

void vtkLagrangianParticleTracker::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 vtkDataObjectAlgorithm.

Reimplemented in vtkPLagrangianParticleTracker.

◆ New()

static vtkLagrangianParticleTracker * vtkLagrangianParticleTracker::New ( )

static

◆ SetIntegrationModel()

void vtkLagrangianParticleTracker::SetIntegrationModel ( vtkLagrangianBasicIntegrationModel * integrationModel )

Set/Get the integration model.

Default is vtkLagrangianMatidaIntegrationModel

◆ GetIntegrationModel()

virtual vtkLagrangianBasicIntegrationModel * vtkLagrangianParticleTracker::GetIntegrationModel ( )

virtual

Set/Get the integration model.

Default is vtkLagrangianMatidaIntegrationModel

◆ SetIntegrator()

void vtkLagrangianParticleTracker::SetIntegrator ( vtkInitialValueProblemSolver * integrator )

Set/Get the integrator.

Default is vtkRungeKutta2

◆ GetIntegrator()

virtual vtkInitialValueProblemSolver * vtkLagrangianParticleTracker::GetIntegrator ( )

virtual

Set/Get the integrator.

Default is vtkRungeKutta2

◆ SetGeneratePolyVertexInteractionOutput()

virtual void vtkLagrangianParticleTracker::SetGeneratePolyVertexInteractionOutput ( bool )

virtual

Set/Get whether or not to use PolyVertex cell type for the interaction output Default is false.

◆ GetGeneratePolyVertexInteractionOutput()

virtual bool vtkLagrangianParticleTracker::GetGeneratePolyVertexInteractionOutput ( )

virtual

Set/Get whether or not to use PolyVertex cell type for the interaction output Default is false.

◆ SetCellLengthComputationMode()

virtual void vtkLagrangianParticleTracker::SetCellLengthComputationMode ( int )

virtual

Set/Get the cell length computation mode.

Available modes are :

STEP_CUR_CELL_LENGTH : Compute cell length using getLength method on the current cell the particle is in
STEP_CUR_CELL_VEL_DIR : Compute cell length using the particle velocity and the edges of the last cell the particle was in.
STEP_CUR_CELL_DIV_THEO : Compute cell length using the particle velocity and the divergence theorem.

◆ GetCellLengthComputationMode()

virtual int vtkLagrangianParticleTracker::GetCellLengthComputationMode ( )

virtual

Set/Get the cell length computation mode.

Available modes are :

STEP_CUR_CELL_LENGTH : Compute cell length using getLength method on the current cell the particle is in
STEP_CUR_CELL_VEL_DIR : Compute cell length using the particle velocity and the edges of the last cell the particle was in.
STEP_CUR_CELL_DIV_THEO : Compute cell length using the particle velocity and the divergence theorem.

◆ SetStepFactor()

virtual void vtkLagrangianParticleTracker::SetStepFactor ( double )

virtual

Set/Get the integration step factor.

Default is 1.0.

◆ GetStepFactor()

virtual double vtkLagrangianParticleTracker::GetStepFactor ( )

virtual

Set/Get the integration step factor.

Default is 1.0.

◆ SetStepFactorMin()

virtual void vtkLagrangianParticleTracker::SetStepFactorMin ( double )

virtual

Set/Get the integration step factor min.

Default is 0.5.

◆ GetStepFactorMin()

virtual double vtkLagrangianParticleTracker::GetStepFactorMin ( )

virtual

Set/Get the integration step factor min.

Default is 0.5.

◆ SetStepFactorMax()

virtual void vtkLagrangianParticleTracker::SetStepFactorMax ( double )

virtual

Set/Get the integration step factor max.

Default is 1.5.

◆ GetStepFactorMax()

virtual double vtkLagrangianParticleTracker::GetStepFactorMax ( )

virtual

Set/Get the integration step factor max.

Default is 1.5.

◆ SetMaximumNumberOfSteps()

virtual void vtkLagrangianParticleTracker::SetMaximumNumberOfSteps ( int )

virtual

Set/Get the maximum number of steps.

-1 means no limit. Default is 100.

◆ GetMaximumNumberOfSteps()

virtual int vtkLagrangianParticleTracker::GetMaximumNumberOfSteps ( )

virtual

Set/Get the maximum number of steps.

-1 means no limit. Default is 100.

◆ SetMaximumIntegrationTime()

virtual void vtkLagrangianParticleTracker::SetMaximumIntegrationTime ( double )

virtual

Set/Get the maximum integration time.

A negative value means no limit. Default is -1.

◆ GetMaximumIntegrationTime()

virtual double vtkLagrangianParticleTracker::GetMaximumIntegrationTime ( )

virtual

Set/Get the maximum integration time.

A negative value means no limit. Default is -1.

◆ SetAdaptiveStepReintegration()

virtual void vtkLagrangianParticleTracker::SetAdaptiveStepReintegration ( bool )

virtual

Set/Get the Adaptive Step Reintegration feature.

it checks the step size after the integration and if it is too big will retry with a smaller step Default is false.

◆ GetAdaptiveStepReintegration()

virtual bool vtkLagrangianParticleTracker::GetAdaptiveStepReintegration ( )

virtual

Set/Get the Adaptive Step Reintegration feature.

it checks the step size after the integration and if it is too big will retry with a smaller step Default is false.

◆ AdaptiveStepReintegrationOn()

virtual void vtkLagrangianParticleTracker::AdaptiveStepReintegrationOn ( )

virtual

Set/Get the Adaptive Step Reintegration feature.

it checks the step size after the integration and if it is too big will retry with a smaller step Default is false.

◆ AdaptiveStepReintegrationOff()

virtual void vtkLagrangianParticleTracker::AdaptiveStepReintegrationOff ( )

virtual

Set/Get the Adaptive Step Reintegration feature.

it checks the step size after the integration and if it is too big will retry with a smaller step Default is false.

◆ SetGenerateParticlePathsOutput()

virtual void vtkLagrangianParticleTracker::SetGenerateParticlePathsOutput ( bool )

virtual

Set/Get the generation of the particle path output, Default is true.

◆ GetGenerateParticlePathsOutput()

virtual bool vtkLagrangianParticleTracker::GetGenerateParticlePathsOutput ( )

virtual

Set/Get the generation of the particle path output, Default is true.

◆ GenerateParticlePathsOutputOn()

virtual void vtkLagrangianParticleTracker::GenerateParticlePathsOutputOn ( )

virtual

Set/Get the generation of the particle path output, Default is true.

◆ GenerateParticlePathsOutputOff()

virtual void vtkLagrangianParticleTracker::GenerateParticlePathsOutputOff ( )

virtual

Set/Get the generation of the particle path output, Default is true.

◆ SetSourceData()

void vtkLagrangianParticleTracker::SetSourceData ( vtkDataObject * source )

Specify the source object used to generate particle initial position (seeds).

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

◆ GetSource()

vtkDataObject * vtkLagrangianParticleTracker::GetSource ( )

Specify the source object used to generate particle initial position (seeds).

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

◆ SetSourceConnection()

void vtkLagrangianParticleTracker::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

Specify the source object used to generate particle initial position (seeds).

◆ SetSurfaceData()

void vtkLagrangianParticleTracker::SetSurfaceData ( vtkDataObject * source )

Specify the source object used to compute surface interaction with Note that this method does not connect the pipeline.

The algorithm will work on the input data as it is without updating the producer of the data. See SetSurfaceConnection for connecting the pipeline.

◆ GetSurface()

vtkDataObject * vtkLagrangianParticleTracker::GetSurface ( )

Specify the source object used to compute surface interaction with Note that this method does not connect the pipeline.

The algorithm will work on the input data as it is without updating the producer of the data. See SetSurfaceConnection for connecting the pipeline.

◆ SetSurfaceConnection()

void vtkLagrangianParticleTracker::SetSurfaceConnection ( vtkAlgorithmOutput * algOutput )

Specify the object used to compute surface interaction with.

◆ FillInputPortInformation()

int vtkLagrangianParticleTracker::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overridevirtual

Declare input port type.

Reimplemented from vtkDataObjectAlgorithm.

◆ FillOutputPortInformation()

int vtkLagrangianParticleTracker::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

overridevirtual

Declare output port type.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestDataObject()

int vtkLagrangianParticleTracker::RequestDataObject	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overridevirtual

Create outputs objects.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

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

overridevirtual

Process inputs to integrate particle and generate output.

Reimplemented from vtkDataObjectAlgorithm.

◆ GetMTime()

vtkMTimeType vtkLagrangianParticleTracker::GetMTime ( )

overridevirtual

Get the tracker modified time taking into account the integration model and the integrator.

Reimplemented from vtkObject.

◆ GetNewParticleId()

virtual vtkIdType vtkLagrangianParticleTracker::GetNewParticleId ( )

virtual

Get an unique id for a particle This method is thread safe.

Reimplemented in vtkPLagrangianParticleTracker.

◆ InitializeFlow()

virtual bool vtkLagrangianParticleTracker::InitializeFlow	(	vtkDataObject *	flow,
		vtkBoundingBox *	bounds
	)

protectedvirtual

◆ InitializeParticles()

virtual bool vtkLagrangianParticleTracker::InitializeParticles	(	const vtkBoundingBox *	bounds,
		vtkDataSet *	seeds,
		std::queue< vtkLagrangianParticle * > &	particles,
		vtkPointData *	seedData
	)

protectedvirtual

◆ GenerateParticles()

virtual void vtkLagrangianParticleTracker::GenerateParticles	(	const vtkBoundingBox *	bounds,
		vtkDataSet *	seeds,
		vtkDataArray *	initialVelocities,
		vtkDataArray *	initialIntegrationTimes,
		vtkPointData *	seedData,
		int	nVar,
		std::queue< vtkLagrangianParticle * > &	particles
	)

protectedvirtual

Reimplemented in vtkPLagrangianParticleTracker.

◆ UpdateSurfaceCacheIfNeeded()

virtual bool vtkLagrangianParticleTracker::UpdateSurfaceCacheIfNeeded ( vtkDataObject *& surfaces )

protectedvirtual

Reimplemented in vtkPLagrangianParticleTracker.

◆ InitializeSurface()

virtual void vtkLagrangianParticleTracker::InitializeSurface ( vtkDataObject *& surfaces )

protectedvirtual

◆ InitializePathsOutput()

virtual bool vtkLagrangianParticleTracker::InitializePathsOutput	(	vtkPointData *	seedData,
		vtkIdType	numberOfSeeds,
		vtkPolyData *&	particlePathsOutput
	)

protectedvirtual

This method is thread safe.

◆ InitializeInteractionOutput()

virtual bool vtkLagrangianParticleTracker::InitializeInteractionOutput	(	vtkPointData *	seedData,
		vtkDataObject *	surfaces,
		vtkDataObject *&	interractionOutput
	)

protectedvirtual

This method is thread safe.

◆ FinalizeOutputs()

virtual bool vtkLagrangianParticleTracker::FinalizeOutputs	(	vtkPolyData *	particlePathsOutput,
		vtkDataObject *	interactionOutput
	)

protectedvirtual

Reimplemented in vtkPLagrangianParticleTracker.

◆ InsertPolyVertexCell()

static void vtkLagrangianParticleTracker::InsertPolyVertexCell ( vtkPolyData * polydata )

staticprotected

◆ InsertVertexCells()

static void vtkLagrangianParticleTracker::InsertVertexCells ( vtkPolyData * polydata )

staticprotected

◆ GetParticleFeed()

virtual void vtkLagrangianParticleTracker::GetParticleFeed ( std::queue< vtkLagrangianParticle * > & particleQueue )

protectedvirtual

Reimplemented in vtkPLagrangianParticleTracker.

◆ Integrate()

virtual int vtkLagrangianParticleTracker::Integrate	(	vtkInitialValueProblemSolver *	integrator,
		vtkLagrangianParticle *	,
		std::queue< vtkLagrangianParticle * > &	,
		vtkPolyData *	particlePathsOutput,
		vtkPolyLine *	particlePath,
		vtkDataObject *	interactionOutput
	)

protectedvirtual

This method is thread safe.

Reimplemented in vtkPLagrangianParticleTracker.

◆ InsertPathOutputPoint()

void vtkLagrangianParticleTracker::InsertPathOutputPoint	(	vtkLagrangianParticle *	particle,
		vtkPolyData *	particlePathsOutput,
		vtkIdList *	particlePathPointId,
		bool	prev = `false`
	)

protected

This method is thread safe.

◆ InsertInteractionOutputPoint()

void vtkLagrangianParticleTracker::InsertInteractionOutputPoint	(	vtkLagrangianParticle *	particle,
		unsigned int	interactedSurfaceFlatIndex,
		vtkDataObject *	interactionOutput
	)

protected

This method is thread safe.

◆ ComputeCellLength()

double vtkLagrangianParticleTracker::ComputeCellLength ( vtkLagrangianParticle * particle )

protected

Computes the cell length for the next step using the method set by CellLengthComputationMode.

Returns -1 if particle is out the of domain.

◆ ComputeNextStep()

bool vtkLagrangianParticleTracker::ComputeNextStep	(	vtkInitialValueProblemSolver *	integrator,
		double *	xprev,
		double *	xnext,
		double	t,
		double &	delT,
		double &	delTActual,
		double	minStep,
		double	maxStep,
		double	cellLength,
		int &	integrationRes,
		vtkLagrangianParticle *	particle
	)

protected

This method is thread safe.

◆ DeleteParticle()

virtual void vtkLagrangianParticleTracker::DeleteParticle ( vtkLagrangianParticle * particle )

protectedvirtual

This method is thread safe Call the ParticleAboutToBeDeleted model method and delete the particle.

Reimplemented in vtkPLagrangianParticleTracker.

Friends And Related Function Documentation

◆ IntegratingFunctor

friend struct IntegratingFunctor

friend

Definition at line 404 of file vtkLagrangianParticleTracker.h.

Member Data Documentation

◆ IntegrationModel

vtkLagrangianBasicIntegrationModel* vtkLagrangianParticleTracker::IntegrationModel

protected

Definition at line 375 of file vtkLagrangianParticleTracker.h.

◆ Integrator

vtkInitialValueProblemSolver* vtkLagrangianParticleTracker::Integrator

protected

Definition at line 376 of file vtkLagrangianParticleTracker.h.

◆ CellLengthComputationMode

int vtkLagrangianParticleTracker::CellLengthComputationMode

protected

Definition at line 378 of file vtkLagrangianParticleTracker.h.

◆ StepFactor

double vtkLagrangianParticleTracker::StepFactor

protected

Definition at line 379 of file vtkLagrangianParticleTracker.h.

◆ StepFactorMin

double vtkLagrangianParticleTracker::StepFactorMin

protected

Definition at line 380 of file vtkLagrangianParticleTracker.h.

◆ StepFactorMax

double vtkLagrangianParticleTracker::StepFactorMax

protected

Definition at line 381 of file vtkLagrangianParticleTracker.h.

◆ MaximumNumberOfSteps

int vtkLagrangianParticleTracker::MaximumNumberOfSteps

protected

Definition at line 382 of file vtkLagrangianParticleTracker.h.

◆ MaximumIntegrationTime

double vtkLagrangianParticleTracker::MaximumIntegrationTime

protected

Definition at line 383 of file vtkLagrangianParticleTracker.h.

◆ AdaptiveStepReintegration

bool vtkLagrangianParticleTracker::AdaptiveStepReintegration

protected

Definition at line 384 of file vtkLagrangianParticleTracker.h.

◆ GenerateParticlePathsOutput

bool vtkLagrangianParticleTracker::GenerateParticlePathsOutput = true

protected

Definition at line 385 of file vtkLagrangianParticleTracker.h.

◆ GeneratePolyVertexInteractionOutput

bool vtkLagrangianParticleTracker::GeneratePolyVertexInteractionOutput

protected

Definition at line 386 of file vtkLagrangianParticleTracker.h.

◆ ParticleCounter

std::atomic<vtkIdType> vtkLagrangianParticleTracker::ParticleCounter

protected

Definition at line 387 of file vtkLagrangianParticleTracker.h.

◆ IntegratedParticleCounter

std::atomic<vtkIdType> vtkLagrangianParticleTracker::IntegratedParticleCounter

protected

Definition at line 388 of file vtkLagrangianParticleTracker.h.

◆ IntegratedParticleCounterIncrement

vtkIdType vtkLagrangianParticleTracker::IntegratedParticleCounterIncrement

protected

Definition at line 389 of file vtkLagrangianParticleTracker.h.

◆ SeedData

vtkPointData* vtkLagrangianParticleTracker::SeedData

protected

Definition at line 390 of file vtkLagrangianParticleTracker.h.

◆ MinimumVelocityMagnitude

double vtkLagrangianParticleTracker::MinimumVelocityMagnitude

protected

Definition at line 393 of file vtkLagrangianParticleTracker.h.

◆ MinimumReductionFactor

double vtkLagrangianParticleTracker::MinimumReductionFactor

protected

Definition at line 394 of file vtkLagrangianParticleTracker.h.

◆ FlowCache

vtkDataObject* vtkLagrangianParticleTracker::FlowCache

protected

Definition at line 397 of file vtkLagrangianParticleTracker.h.

◆ FlowTime

vtkMTimeType vtkLagrangianParticleTracker::FlowTime

protected

Definition at line 398 of file vtkLagrangianParticleTracker.h.

◆ FlowBoundsCache

vtkBoundingBox vtkLagrangianParticleTracker::FlowBoundsCache

protected

Definition at line 399 of file vtkLagrangianParticleTracker.h.

◆ SurfacesCache

vtkDataObject* vtkLagrangianParticleTracker::SurfacesCache

protected

Definition at line 400 of file vtkLagrangianParticleTracker.h.

◆ SurfacesTime

vtkMTimeType vtkLagrangianParticleTracker::SurfacesTime

protected

Definition at line 401 of file vtkLagrangianParticleTracker.h.

◆ ProgressMutex

std::mutex vtkLagrangianParticleTracker::ProgressMutex

protected

Definition at line 403 of file vtkLagrangianParticleTracker.h.

◆ SerialThreadedData

vtkLagrangianThreadedData* vtkLagrangianParticleTracker::SerialThreadedData

protected

Definition at line 406 of file vtkLagrangianParticleTracker.h.

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

Filters/FlowPaths/vtkLagrangianParticleTracker.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ CellLengthComputation

Member Enumeration Documentation

◆ CellLengthComputation

Constructor & Destructor Documentation

◆ vtkLagrangianParticleTracker()

◆ ~vtkLagrangianParticleTracker()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetIntegrationModel()

◆ GetIntegrationModel()

◆ SetIntegrator()

◆ GetIntegrator()

◆ SetGeneratePolyVertexInteractionOutput()

◆ GetGeneratePolyVertexInteractionOutput()

◆ SetCellLengthComputationMode()

◆ GetCellLengthComputationMode()

◆ SetStepFactor()

◆ GetStepFactor()

◆ SetStepFactorMin()

◆ GetStepFactorMin()

◆ SetStepFactorMax()

◆ GetStepFactorMax()

◆ SetMaximumNumberOfSteps()

◆ GetMaximumNumberOfSteps()

◆ SetMaximumIntegrationTime()

◆ GetMaximumIntegrationTime()

◆ SetAdaptiveStepReintegration()

◆ GetAdaptiveStepReintegration()

◆ AdaptiveStepReintegrationOn()

◆ AdaptiveStepReintegrationOff()

◆ SetGenerateParticlePathsOutput()

◆ GetGenerateParticlePathsOutput()

◆ GenerateParticlePathsOutputOn()

◆ GenerateParticlePathsOutputOff()

◆ SetSourceData()

◆ GetSource()

◆ SetSourceConnection()

◆ SetSurfaceData()

◆ GetSurface()

◆ SetSurfaceConnection()

◆ FillInputPortInformation()

◆ FillOutputPortInformation()

◆ RequestDataObject()

◆ RequestData()

◆ GetMTime()

◆ GetNewParticleId()

◆ InitializeFlow()

◆ InitializeParticles()

◆ GenerateParticles()

◆ UpdateSurfaceCacheIfNeeded()

◆ InitializeSurface()

◆ InitializePathsOutput()

◆ InitializeInteractionOutput()

◆ FinalizeOutputs()

◆ InsertPolyVertexCell()

◆ InsertVertexCells()

◆ GetParticleFeed()

◆ Integrate()

◆ InsertPathOutputPoint()

◆ InsertInteractionOutputPoint()

◆ ComputeCellLength()

◆ ComputeNextStep()

◆ DeleteParticle()