A particle tracer for vector fields. More...

#include <vtkLegacyParticleTracerBase.h>

Inheritance diagram for vtkLegacyParticleTracerBase:

[legend]

Collaboration diagram for vtkLegacyParticleTracerBase:

[legend]

Public Types
enum	Solvers { RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE, UNKNOWN }

enum	MeshOverTimeTypes { DIFFERENT = 0, STATIC = 1, LINEAR_TRANSFORMATION = 2, SAME_TOPOLOGY = 3 }
	Types of Variance of Mesh over time. More...

enum	{ INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }

typedef vtkPolyDataAlgorithm	Superclass

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	PrintParticleHistories ()

void	SetIntegrator (vtkInitialValueProblemSolver *)

virtual vtkInitialValueProblemSolver *	GetIntegrator ()

void	SetIntegratorType (int type)

int	GetIntegratorType ()

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

void	SetInterpolatorTypeToDataSetPointLocator ()
	Set the velocity field interpolator type to one that uses a point locator to perform local spatial searching. More...

void	SetInterpolatorTypeToCellLocator ()
	Set the velocity field interpolator type to one that uses a cell locator to perform spatial searching. More...


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 (vtkTypeBool)
	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 vtkTypeBool	GetStaticSeeds ()
	if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use the same injection information. More...


virtual void	SetMeshOverTime (int meshOverTime)

virtual int	GetMeshOverTimeMinValue ()

virtual int	GetMeshOverTimeMaxValue ()

void	SetMeshOverTimeToDifferent ()

void	SetMeshOverTimeToStatic ()

void	SetMeshOverTimeToLinearTransformation ()

void	SetMeshOverTimeToSameTopology ()

virtual int	GetMeshOverTime ()


virtual void	SetStaticMesh (vtkTypeBool staticMesh)
	if StaticMesh is set, many optimizations for cell caching can be assumed. More...

virtual vtkTypeBool	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 vtkAbstractParticleWriter *	GetParticleWriter ()
	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...


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

	vtkGetFilePathMacro (ParticleFileName)
	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...


virtual bool	GetForceSerialExecution ()
	Force the filter to run particle tracer in serial. More...

virtual void	SetForceSerialExecution (bool)
	Force the filter to run particle tracer in serial. More...

virtual void	ForceSerialExecutionOn ()
	Force the filter to run particle tracer in serial. More...

virtual void	ForceSerialExecutionOff ()
	Force the filter to run particle tracer in serial. More...

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

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()

vtkPolyData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

vtkPolyData *	GetOutput ()

vtkPolyData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

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

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

void	SetUpdateExtent (int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

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

static vtkLegacyParticleTracerBase *	SafeDownCast (vtkObject *o)

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

static int	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

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

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

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

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkLegacyParticleTracerBase ()

	~vtkLegacyParticleTracerBase () override

int	FillInputPortInformation (int port, vtkInformation *info) override

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

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

int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

virtual int	ProcessInput (vtkInformationVector **inputVector)

virtual vtkPolyData *	Execute (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 (vtkLegacyParticleTracerBaseNamespace::ParticleVector &candidates, vtkLegacyParticleTracerBaseNamespace::ParticleVector &passed, int &count)
	inside our data. More...

void	TestParticles (vtkLegacyParticleTracerBaseNamespace::ParticleVector &candidates, std::vector< int > &passed)

virtual void	AssignSeedsToProcessors (double time, vtkDataSet *source, int sourceID, int ptId, vtkLegacyParticleTracerBaseNamespace::ParticleVector &localSeedPoints, int &localAssignedCount)
	all the injection/seed points according to which processor they belong to. More...

virtual void	AssignUniqueIds (vtkLegacyParticleTracerBaseNamespace::ParticleVector &localSeedPoints)
	give each one a unique ID. More...

void	UpdateParticleList (vtkLegacyParticleTracerBaseNamespace::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 (vtkLegacyParticleTracerBaseNamespace::ParticleListIterator &it, double currentTime, double targetTime, vtkInitialValueProblemSolver integrator, vtkTemporalInterpolatedVelocityField interpolator, vtkDoubleArray *cellVectors, std::atomic< vtkIdType > &particleCount, std::mutex &eraseMutex, bool sequential)
	particle between the two times supplied. More...

virtual bool	SendParticleToAnotherProcess (vtkLegacyParticleTracerBaseNamespace::ParticleInformation &, vtkLegacyParticleTracerBaseNamespace::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)

vtkFloatArray *	GetParticleAge (vtkPointData *)

vtkIntArray *	GetParticleIds (vtkPointData *)

vtkSignedCharArray *	GetParticleSourceIds (vtkPointData *)

vtkIntArray *	GetInjectedPointIds (vtkPointData *)

vtkIntArray *	GetInjectedStepIds (vtkPointData *)

vtkIntArray *	GetErrorCodeArr (vtkPointData *)

vtkFloatArray *	GetParticleVorticity (vtkPointData *)

vtkFloatArray *	GetParticleRotation (vtkPointData *)

vtkFloatArray *	GetParticleAngularVel (vtkPointData *)

bool	InsideBounds (double point[])

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

double	GetCacheDataTime (int i)

double	GetCacheDataTime ()

virtual void	ResetCache ()

void	SetParticle (vtkLegacyParticleTracerBaseNamespace::ParticleInformation &info, double velocity, vtkTemporalInterpolatedVelocityField interpolator, vtkIdType particleId, vtkDoubleArray *cellVectors)

virtual int	GetReinjectionCounter ()

virtual double	GetCurrentTimeValue ()

void	ResizeArrays (vtkIdType numTuples)

virtual void	InitializeExtraPointDataArrays (vtkPointData *vtkNotUsed(outputPD))
	Methods to append values to existing point data arrays that may only be desired on specific concrete derived classes. More...

virtual void	SetToExtraPointDataArrays (vtkIdType, vtkLegacyParticleTracerBaseNamespace::ParticleInformation &)

vtkTemporalInterpolatedVelocityField *	GetInterpolator ()

virtual void	AddRestartSeeds (vtkInformationVector **)
	For restarts of particle paths, we add in the ability to add in particles from a previous computation that we will still advect. More...

virtual void	RenameGhostArray (vtkPointData *pd)
	Recover the ghost array in provided point data and rename it by adding "Original_" in front of it, if available. 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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetErrorCode (unsigned long)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkPolyData >	Output

bool	ForceSerialExecution


vtkSmartPointer< vtkPointData >	ProtoPD
	ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored. 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...

vtkLegacyParticleTracerBaseNamespace::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< vtkPointData >	ParticlePointData
	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
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
struct	vtkLegacyParticleTracerBaseNamespace::ParticleTracerFunctor

class	vtkLegacyPParticlePathFilter

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

int	AbortExecute

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

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

A particle tracer for vector fields.

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

See also: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

Definition at line 97 of file vtkLegacyParticleTracerBase.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPolyDataAlgorithm vtkLegacyParticleTracerBase::Superclass

Definition at line 111 of file vtkLegacyParticleTracerBase.h.

Member Enumeration Documentation

◆ Solvers

enum vtkLegacyParticleTracerBase::Solvers

Enumerator
RUNGE_KUTTA2
RUNGE_KUTTA4
RUNGE_KUTTA45
NONE
UNKNOWN

Definition at line 102 of file vtkLegacyParticleTracerBase.h.

◆ MeshOverTimeTypes

enum vtkLegacyParticleTracerBase::MeshOverTimeTypes

Types of Variance of Mesh over time.

Enumerator
DIFFERENT
STATIC
LINEAR_TRANSFORMATION
SAME_TOPOLOGY

Definition at line 209 of file vtkLegacyParticleTracerBase.h.

◆ anonymous enum

anonymous enum

Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR
INTERPOLATOR_WITH_CELL_LOCATOR

Definition at line 255 of file vtkLegacyParticleTracerBase.h.

Constructor & Destructor Documentation

◆ vtkLegacyParticleTracerBase()

vtkLegacyParticleTracerBase::vtkLegacyParticleTracerBase ( )

protected

◆ ~vtkLegacyParticleTracerBase()

vtkLegacyParticleTracerBase::~vtkLegacyParticleTracerBase ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkLegacyParticleTracerBase::GetClassName ( )

virtual

Reimplemented in vtkLegacyPParticleTracerBase, vtkLegacyPParticlePathFilter, and vtkInSituPParticlePathFilter.

◆ IsTypeOf()

static int vtkLegacyParticleTracerBase::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkLegacyParticleTracerBase::IsA ( const char * type )

virtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkLegacyPParticleTracerBase, vtkLegacyPParticlePathFilter, and vtkInSituPParticlePathFilter.

◆ SafeDownCast()

static vtkLegacyParticleTracerBase* vtkLegacyParticleTracerBase::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkLegacyPParticleTracerBase, and vtkLegacyPParticlePathFilter.

◆ PrintParticleHistories()

void vtkLegacyParticleTracerBase::PrintParticleHistories ( )

◆ GetComputeVorticity()

virtual bool vtkLegacyParticleTracerBase::GetComputeVorticity ( )

virtual

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

◆ SetComputeVorticity()

void vtkLegacyParticleTracerBase::SetComputeVorticity ( bool )

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

◆ GetTerminalSpeed()

virtual double vtkLegacyParticleTracerBase::GetTerminalSpeed ( )

virtual

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

◆ SetTerminalSpeed()

void vtkLegacyParticleTracerBase::SetTerminalSpeed ( double )

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

◆ GetRotationScale()

virtual double vtkLegacyParticleTracerBase::GetRotationScale ( )

virtual

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

The default is 1.

◆ SetRotationScale()

void vtkLegacyParticleTracerBase::SetRotationScale ( double )

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

The default is 1.

◆ SetIgnorePipelineTime()

virtual void vtkLegacyParticleTracerBase::SetIgnorePipelineTime ( vtkTypeBool )

virtual

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

◆ GetIgnorePipelineTime()

virtual vtkTypeBool vtkLegacyParticleTracerBase::GetIgnorePipelineTime ( )

virtual

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

◆ IgnorePipelineTimeOn()

virtual void vtkLegacyParticleTracerBase::IgnorePipelineTimeOn ( )

virtual

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

◆ IgnorePipelineTimeOff()

virtual void vtkLegacyParticleTracerBase::IgnorePipelineTimeOff ( )

virtual

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

◆ GetForceReinjectionEveryNSteps()

virtual int vtkLegacyParticleTracerBase::GetForceReinjectionEveryNSteps ( )

virtual

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

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

◆ SetForceReinjectionEveryNSteps()

void vtkLegacyParticleTracerBase::SetForceReinjectionEveryNSteps ( int )

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

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

◆ SetTerminationTime()

void vtkLegacyParticleTracerBase::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.

◆ GetTerminationTime()

virtual double vtkLegacyParticleTracerBase::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.

◆ SetIntegrator()

void vtkLegacyParticleTracerBase::SetIntegrator ( vtkInitialValueProblemSolver * )

◆ GetIntegrator()

virtual vtkInitialValueProblemSolver* vtkLegacyParticleTracerBase::GetIntegrator ( )

virtual

◆ SetIntegratorType()

void vtkLegacyParticleTracerBase::SetIntegratorType ( int type )

◆ GetIntegratorType()

int vtkLegacyParticleTracerBase::GetIntegratorType ( )

◆ GetStartTime()

virtual double vtkLegacyParticleTracerBase::GetStartTime ( )

virtual

Set the time value for particle tracing to begin.

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

◆ SetStartTime()

void vtkLegacyParticleTracerBase::SetStartTime ( double t )

Set the time value for particle tracing to begin.

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

◆ SetStaticSeeds()

virtual void vtkLegacyParticleTracerBase::SetStaticSeeds ( vtkTypeBool )

virtual

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

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

◆ GetStaticSeeds()

virtual vtkTypeBool vtkLegacyParticleTracerBase::GetStaticSeeds ( )

virtual

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

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

◆ SetMeshOverTime()

virtual void vtkLegacyParticleTracerBase::SetMeshOverTime ( int meshOverTime )

virtual

◆ GetMeshOverTimeMinValue()

virtual int vtkLegacyParticleTracerBase::GetMeshOverTimeMinValue ( )

inlinevirtual

Definition at line 227 of file vtkLegacyParticleTracerBase.h.

◆ GetMeshOverTimeMaxValue()

virtual int vtkLegacyParticleTracerBase::GetMeshOverTimeMaxValue ( )

inlinevirtual

Definition at line 228 of file vtkLegacyParticleTracerBase.h.

◆ SetMeshOverTimeToDifferent()

void vtkLegacyParticleTracerBase::SetMeshOverTimeToDifferent ( )

inline

Definition at line 229 of file vtkLegacyParticleTracerBase.h.

◆ SetMeshOverTimeToStatic()

void vtkLegacyParticleTracerBase::SetMeshOverTimeToStatic ( )

inline

Definition at line 230 of file vtkLegacyParticleTracerBase.h.

◆ SetMeshOverTimeToLinearTransformation()

void vtkLegacyParticleTracerBase::SetMeshOverTimeToLinearTransformation ( )

inline

Definition at line 231 of file vtkLegacyParticleTracerBase.h.

◆ SetMeshOverTimeToSameTopology()

void vtkLegacyParticleTracerBase::SetMeshOverTimeToSameTopology ( )

inline

Definition at line 232 of file vtkLegacyParticleTracerBase.h.

◆ GetMeshOverTime()

virtual int vtkLegacyParticleTracerBase::GetMeshOverTime ( )

virtual

◆ SetStaticMesh()

virtual void vtkLegacyParticleTracerBase::SetStaticMesh ( vtkTypeBool staticMesh )

inlinevirtual

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.

Definition at line 247 of file vtkLegacyParticleTracerBase.h.

◆ GetStaticMesh()

virtual vtkTypeBool vtkLegacyParticleTracerBase::GetStaticMesh ( )

inlinevirtual

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.

Definition at line 252 of file vtkLegacyParticleTracerBase.h.

◆ SetInterpolatorType()

void vtkLegacyParticleTracerBase::SetInterpolatorType ( int interpolatorType )

Set the type of the velocity field interpolator to determine whether INTERPOLATOR_WITH_DATASET_POINT_LOCATOR or INTERPOLATOR_WITH_CELL_LOCATOR is employed for locating cells during streamline integration.

The latter (adopting vtkAbstractCellLocator sub-classes such as vtkCellLocator and vtkModifiedBSPTree) is more robust than the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator). However the former can be much faster and produce adequate results.

Default is INTERPOLATOR_WITH_CELL_LOCATOR (to maintain backwards compatibility).

◆ SetInterpolatorTypeToDataSetPointLocator()

void vtkLegacyParticleTracerBase::SetInterpolatorTypeToDataSetPointLocator ( )

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

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

◆ SetInterpolatorTypeToCellLocator()

void vtkLegacyParticleTracerBase::SetInterpolatorTypeToCellLocator ( )

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

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

◆ SetParticleWriter()

virtual void vtkLegacyParticleTracerBase::SetParticleWriter ( vtkAbstractParticleWriter * pw )

virtual

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

◆ GetParticleWriter()

virtual vtkAbstractParticleWriter* vtkLegacyParticleTracerBase::GetParticleWriter ( )

virtual

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

◆ vtkSetFilePathMacro()

vtkLegacyParticleTracerBase::vtkSetFilePathMacro ( ParticleFileName )

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

◆ vtkGetFilePathMacro()

vtkLegacyParticleTracerBase::vtkGetFilePathMacro ( ParticleFileName )

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

◆ SetEnableParticleWriting()

virtual void vtkLegacyParticleTracerBase::SetEnableParticleWriting ( vtkTypeBool )

virtual

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

◆ GetEnableParticleWriting()

virtual vtkTypeBool vtkLegacyParticleTracerBase::GetEnableParticleWriting ( )

virtual

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

◆ EnableParticleWritingOn()

virtual void vtkLegacyParticleTracerBase::EnableParticleWritingOn ( )

virtual

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

◆ EnableParticleWritingOff()

virtual void vtkLegacyParticleTracerBase::EnableParticleWritingOff ( )

virtual

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

◆ SetDisableResetCache()

virtual void vtkLegacyParticleTracerBase::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.

◆ GetDisableResetCache()

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

◆ DisableResetCacheOn()

virtual void vtkLegacyParticleTracerBase::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.

◆ DisableResetCacheOff()

virtual void vtkLegacyParticleTracerBase::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.

◆ AddSourceConnection()

void vtkLegacyParticleTracerBase::AddSourceConnection ( vtkAlgorithmOutput * input )

Provide support for multiple seed sources.

◆ RemoveAllSources()

void vtkLegacyParticleTracerBase::RemoveAllSources ( )

Provide support for multiple seed sources.

◆ GetForceSerialExecution()

virtual bool vtkLegacyParticleTracerBase::GetForceSerialExecution ( )

virtual

Force the filter to run particle tracer in serial.

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

◆ SetForceSerialExecution()

virtual void vtkLegacyParticleTracerBase::SetForceSerialExecution ( bool )

virtual

Force the filter to run particle tracer in serial.

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

◆ ForceSerialExecutionOn()

virtual void vtkLegacyParticleTracerBase::ForceSerialExecutionOn ( )

virtual

Force the filter to run particle tracer in serial.

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

◆ ForceSerialExecutionOff()

virtual void vtkLegacyParticleTracerBase::ForceSerialExecutionOff ( )

virtual

Force the filter to run particle tracer in serial.

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

◆ FillInputPortInformation()

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

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ ProcessRequest()

vtkTypeBool vtkLegacyParticleTracerBase::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestInformation()

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

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkLegacyPParticlePathFilter.

◆ RequestUpdateExtent()

int vtkLegacyParticleTracerBase::RequestUpdateExtent	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkLegacyPParticleTracerBase.

◆ RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ ProcessInput()

virtual int vtkLegacyParticleTracerBase::ProcessInput ( vtkInformationVector ** inputVector )

protectedvirtual

◆ Execute()

virtual vtkPolyData* vtkLegacyParticleTracerBase::Execute ( vtkInformationVector ** inputVector )

protectedvirtual

Reimplemented in vtkLegacyPParticleTracerBase.

◆ Initialize()

virtual void vtkLegacyParticleTracerBase::Initialize ( void )

inlineprotectedvirtual

Definition at line 417 of file vtkLegacyParticleTracerBase.h.

◆ OutputParticles()

virtual int vtkLegacyParticleTracerBase::OutputParticles ( vtkPolyData * poly )

protectedpure virtual

Implemented in vtkLegacyPParticlePathFilter.

◆ Finalize()

virtual void vtkLegacyParticleTracerBase::Finalize ( void )

inlineprotectedvirtual

Reimplemented in vtkLegacyPParticlePathFilter.

Definition at line 419 of file vtkLegacyParticleTracerBase.h.

◆ GetSeedSources()

virtual std::vector<vtkDataSet*> vtkLegacyParticleTracerBase::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.

Reimplemented in vtkInSituPParticlePathFilter.

◆ InitializeInterpolator()

int vtkLegacyParticleTracerBase::InitializeInterpolator ( )

protected

◆ UpdateDataCache()

int vtkLegacyParticleTracerBase::UpdateDataCache ( vtkDataObject * td )

protected

◆ TestParticles() [1/2]

void vtkLegacyParticleTracerBase::TestParticles	(	vtkLegacyParticleTracerBaseNamespace::ParticleVector &	candidates,
		vtkLegacyParticleTracerBaseNamespace::ParticleVector &	passed,
		int &	count
	)

protected

inside our data.

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

◆ TestParticles() [2/2]

void vtkLegacyParticleTracerBase::TestParticles	(	vtkLegacyParticleTracerBaseNamespace::ParticleVector &	candidates,
		std::vector< int > &	passed
	)

protected

◆ AssignSeedsToProcessors()

virtual void vtkLegacyParticleTracerBase::AssignSeedsToProcessors	(	double	time,
		vtkDataSet *	source,
		int	sourceID,
		int	ptId,
		vtkLegacyParticleTracerBaseNamespace::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 vtkInSituPParticlePathFilter, and vtkLegacyPParticleTracerBase.

◆ AssignUniqueIds()

virtual void vtkLegacyParticleTracerBase::AssignUniqueIds ( vtkLegacyParticleTracerBaseNamespace::ParticleVector & localSeedPoints )

protectedvirtual

give each one a unique ID.

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

Reimplemented in vtkLegacyPParticleTracerBase.

◆ UpdateParticleList()

void vtkLegacyParticleTracerBase::UpdateParticleList ( vtkLegacyParticleTracerBaseNamespace::ParticleVector & candidates )

protected

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

◆ UpdateParticleListFromOtherProcesses()

virtual bool vtkLegacyParticleTracerBase::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 vtkLegacyPParticleTracerBase.

Definition at line 468 of file vtkLegacyParticleTracerBase.h.

◆ IntegrateParticle()

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

protected

particle between the two times supplied.

◆ SendParticleToAnotherProcess()

virtual bool vtkLegacyParticleTracerBase::SendParticleToAnotherProcess	(	vtkLegacyParticleTracerBaseNamespace::ParticleInformation &	,
		vtkLegacyParticleTracerBaseNamespace::ParticleInformation &	,
		vtkPointData *
	)

inlineprotectedvirtual

Reimplemented in vtkLegacyPParticleTracerBase.

Definition at line 480 of file vtkLegacyParticleTracerBase.h.

◆ ComputeDomainExitLocation()

bool vtkLegacyParticleTracerBase::ComputeDomainExitLocation	(	double	pos[4],
		double	p2[4],
		double	intersection[4],
		vtkGenericCell *	cell
	)

protected

This is an old routine kept for possible future use.

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

◆ CreateProtoPD()

void vtkLegacyParticleTracerBase::CreateProtoPD ( vtkDataObject * input )

protected

◆ GetParticleAge()

vtkFloatArray* vtkLegacyParticleTracerBase::GetParticleAge ( vtkPointData * )

protected

◆ GetParticleIds()

vtkIntArray* vtkLegacyParticleTracerBase::GetParticleIds ( vtkPointData * )

protected

◆ GetParticleSourceIds()

vtkSignedCharArray* vtkLegacyParticleTracerBase::GetParticleSourceIds ( vtkPointData * )

protected

◆ GetInjectedPointIds()

vtkIntArray* vtkLegacyParticleTracerBase::GetInjectedPointIds ( vtkPointData * )

protected

◆ GetInjectedStepIds()

vtkIntArray* vtkLegacyParticleTracerBase::GetInjectedStepIds ( vtkPointData * )

protected

◆ GetErrorCodeArr()

vtkIntArray* vtkLegacyParticleTracerBase::GetErrorCodeArr ( vtkPointData * )

protected

◆ GetParticleVorticity()

vtkFloatArray* vtkLegacyParticleTracerBase::GetParticleVorticity ( vtkPointData * )

protected

◆ GetParticleRotation()

vtkFloatArray* vtkLegacyParticleTracerBase::GetParticleRotation ( vtkPointData * )

protected

◆ GetParticleAngularVel()

vtkFloatArray* vtkLegacyParticleTracerBase::GetParticleAngularVel ( vtkPointData * )

protected

◆ InsideBounds()

bool vtkLegacyParticleTracerBase::InsideBounds ( double point[] )

protected

◆ CalculateVorticity()

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

protected

◆ GetCacheDataTime() [1/2]

double vtkLegacyParticleTracerBase::GetCacheDataTime ( int i )

protected

◆ GetCacheDataTime() [2/2]

double vtkLegacyParticleTracerBase::GetCacheDataTime ( )

protected

◆ ResetCache()

virtual void vtkLegacyParticleTracerBase::ResetCache ( )

protectedvirtual

Reimplemented in vtkLegacyPParticlePathFilter.

◆ SetParticle()

void vtkLegacyParticleTracerBase::SetParticle	(	vtkLegacyParticleTracerBaseNamespace::ParticleInformation &	info,
		double *	velocity,
		vtkTemporalInterpolatedVelocityField *	interpolator,
		vtkIdType	particleId,
		vtkDoubleArray *	cellVectors
	)

protected

◆ IsPointDataValid() [1/2]

virtual bool vtkLegacyParticleTracerBase::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 vtkLegacyPParticleTracerBase.

◆ IsPointDataValid() [2/2]

bool vtkLegacyParticleTracerBase::IsPointDataValid	(	vtkCompositeDataSet *	input,
		std::vector< std::string > &	arrayNames
	)

protected

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

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

◆ GetPointDataArrayNames()

void vtkLegacyParticleTracerBase::GetPointDataArrayNames	(	vtkDataSet *	input,
		std::vector< std::string > &	names
	)

protected

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

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

◆ GetReinjectionCounter()

virtual int vtkLegacyParticleTracerBase::GetReinjectionCounter ( )

protectedvirtual

◆ GetCurrentTimeValue()

virtual double vtkLegacyParticleTracerBase::GetCurrentTimeValue ( )

protectedvirtual

◆ ResizeArrays()

void vtkLegacyParticleTracerBase::ResizeArrays ( vtkIdType numTuples )

protected

◆ InitializeExtraPointDataArrays()

virtual void vtkLegacyParticleTracerBase::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 547 of file vtkLegacyParticleTracerBase.h.

◆ SetToExtraPointDataArrays()

virtual void vtkLegacyParticleTracerBase::SetToExtraPointDataArrays	(	vtkIdType	,
		vtkLegacyParticleTracerBaseNamespace::ParticleInformation &
	)

inlineprotectedvirtual

Reimplemented in vtkLegacyPParticlePathFilter.

Definition at line 549 of file vtkLegacyParticleTracerBase.h.

◆ GetInterpolator()

vtkTemporalInterpolatedVelocityField* vtkLegacyParticleTracerBase::GetInterpolator ( )

protected

◆ AddRestartSeeds()

virtual void vtkLegacyParticleTracerBase::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.

Reimplemented in vtkInSituPParticlePathFilter.

Definition at line 560 of file vtkLegacyParticleTracerBase.h.

◆ RenameGhostArray()

virtual void vtkLegacyParticleTracerBase::RenameGhostArray ( vtkPointData * pd )

protectedvirtual

Recover the ghost array in provided point data and rename it by adding "Original_" in front of it, if available.

Friends And Related Function Documentation

◆ vtkLegacyParticleTracerBaseNamespace::ParticleTracerFunctor

friend struct vtkLegacyParticleTracerBaseNamespace::ParticleTracerFunctor

friend

Definition at line 101 of file vtkLegacyParticleTracerBase.h.

◆ vtkLegacyPParticlePathFilter

friend class vtkLegacyPParticlePathFilter

friend

Definition at line 666 of file vtkLegacyParticleTracerBase.h.

Member Data Documentation

◆ Output

vtkSmartPointer<vtkPolyData> vtkLegacyParticleTracerBase::Output

protected

Definition at line 347 of file vtkLegacyParticleTracerBase.h.