A particle tracer for vector fields. More...

#include <vtkParticleTracerBase.h>

Inheritance diagram for vtkParticleTracerBase:

Collaboration diagram for vtkParticleTracerBase:

Public Types
enum	Solvers { RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE, UNKNOWN }
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkParticleTracerBase *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	PrintParticleHistories ()
void	SetIntegrator (vtkInitialValueProblemSolver *)
virtual vtkInitialValueProblemSolver *	GetIntegrator ()
void	SetIntegratorType (int type)
int	GetIntegratorType ()

virtual bool	GetComputeVorticity ()
void	SetComputeVorticity (bool)

virtual double	GetTerminalSpeed ()
void	SetTerminalSpeed (double)

void	SetRotationScale (double)
virtual double	GetRotationScale ()

virtual void	SetIgnorePipelineTime (int)
virtual int	GetIgnorePipelineTime ()
virtual void	IgnorePipelineTimeOn ()
virtual void	IgnorePipelineTimeOff ()

void	SetForceReinjectionEveryNSteps (int)
virtual int	GetForceReinjectionEveryNSteps ()

void	SetTerminationTime (double t)
virtual double	GetTerminationTime ()

void	SetStartTime (double t)
virtual double	GetStartTime ()

virtual int	GetStaticSeeds ()

virtual int	GetStaticMesh ()

virtual void	SetParticleWriter (vtkAbstractParticleWriter *pw)
virtual vtkAbstractParticleWriter *	GetParticleWriter ()

virtual void	SetParticleFileName (const char *)
virtual char *	GetParticleFileName ()

virtual void	SetEnableParticleWriting (int)
virtual int	GetEnableParticleWriting ()
virtual void	EnableParticleWritingOn ()
virtual void	EnableParticleWritingOff ()

virtual void	SetDisableResetCache (int)
virtual int	GetDisableResetCache ()
virtual void	DisableResetCacheOn ()
virtual void	DisableResetCacheOff ()

void	AddSourceConnection (vtkAlgorithmOutput *input)
void	RemoveAllSources ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkParticleTracerBase *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkParticleTracerBase ()
virtual	~vtkParticleTracerBase ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	ProcessInput (vtkInformationVector **inputVector)
virtual vtkPolyData *	Execute (vtkInformationVector **inputVector)
virtual void	Initialize ()
virtual int	OutputParticles (vtkPolyData *poly)=0
virtual void	Finalize ()
int	InitializeInterpolator ()
int	UpdateDataCache (vtkDataObject *td)
void	TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, std::vector< int > &passed)
virtual void	UpdateParticleListFromOtherProcesses ()
virtual bool	SendParticleToAnotherProcess (vtkParticleTracerBaseNamespace::ParticleInformation &, vtkParticleTracerBaseNamespace::ParticleInformation &, vtkPointData *)
void	CreateProtoPD (vtkDataObject *input)
vtkFloatArray *	GetParticleAge (vtkPointData *)
vtkIntArray *	GetParticleIds (vtkPointData *)
vtkCharArray *	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	AddParticle (vtkParticleTracerBaseNamespace::ParticleInformation &info, double *velocity)

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

virtual void	AssignSeedsToProcessors (double time, vtkDataSet *source, int sourceID, int ptId, vtkParticleTracerBaseNamespace::ParticleVector &LocalSeedPoints, int &LocalAssignedCount)

virtual void	AssignUniqueIds (vtkParticleTracerBaseNamespace::ParticleVector &LocalSeedPoints)

void	UpdateParticleList (vtkParticleTracerBaseNamespace::ParticleVector &candidates)

void	IntegrateParticle (vtkParticleTracerBaseNamespace::ParticleListIterator &it, double currenttime, double terminationtime, vtkInitialValueProblemSolver *integrator)

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

virtual bool	IsPointDataValid (vtkDataObject *input)
bool	IsPointDataValid (vtkCompositeDataSet *input, std::vector< std::string > &arrayNames)
void	GetPointDataArrayNames (vtkDataSet *input, std::vector< std::string > &names)
Protected Attributes
vtkSmartPointer< vtkPolyData >	Output
vtkSmartPointer< vtkPointData >	ProtoPD
vtkIdType	UniqueIdCounter
vtkParticleTracerBaseNamespace::ParticleDataList	ParticleHistories
vtkSmartPointer< vtkPointData >	ParticlePointData
int	ReinjectionCounter
int	IgnorePipelineTime
int	DisableResetCache
Friends
class	ParticlePathFilterInternal
class	StreaklineFilterInternal

Detailed Description

A particle tracer for vector fields.

A parallel particle tracer for vector fields.

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

See also:: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

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

See also:: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

Definition at line 92 of file vtkParticleTracerBase.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkParticleTracerBase::Superclass

Reimplemented from vtkPolyDataAlgorithm.

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

Definition at line 104 of file vtkParticleTracerBase.h.

Member Enumeration Documentation

enum vtkParticleTracerBase::Solvers

Enumerator:

RUNGE_KUTTA2
RUNGE_KUTTA4
RUNGE_KUTTA45
NONE
UNKNOWN

Definition at line 95 of file vtkParticleTracerBase.h.

Constructor & Destructor Documentation

vtkParticleTracerBase::vtkParticleTracerBase ( ) [protected]

virtual vtkParticleTracerBase::~vtkParticleTracerBase ( ) [protected, virtual]

Member Function Documentation

static int vtkParticleTracerBase::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

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

virtual int vtkParticleTracerBase::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

virtual vtkObjectBase* vtkParticleTracerBase::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

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

vtkParticleTracerBase* vtkParticleTracerBase::NewInstance ( ) const

Reimplemented from vtkPolyDataAlgorithm.

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

void vtkParticleTracerBase::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

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

void vtkParticleTracerBase::PrintParticleHistories ( )

virtual bool vtkParticleTracerBase::GetComputeVorticity ( ) [virtual]

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

void vtkParticleTracerBase::SetComputeVorticity ( bool )

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

virtual double vtkParticleTracerBase::GetTerminalSpeed ( ) [virtual]

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

void vtkParticleTracerBase::SetTerminalSpeed ( double )

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

void vtkParticleTracerBase::SetRotationScale ( double )

This can be used to scale the rate with which the streamribbons twist. The default is 1.

virtual double vtkParticleTracerBase::GetRotationScale ( ) [virtual]

This can be used to scale the rate with which the streamribbons twist. The default is 1.

virtual void vtkParticleTracerBase::SetIgnorePipelineTime ( int ) [virtual]

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

virtual int vtkParticleTracerBase::GetIgnorePipelineTime ( ) [virtual]

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

virtual void vtkParticleTracerBase::IgnorePipelineTimeOn ( ) [virtual]

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

virtual void vtkParticleTracerBase::IgnorePipelineTimeOff ( ) [virtual]

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

void vtkParticleTracerBase::SetForceReinjectionEveryNSteps ( int )

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

virtual int vtkParticleTracerBase::GetForceReinjectionEveryNSteps ( ) [virtual]

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

void vtkParticleTracerBase::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 diable termination. The units of time should be consistent with the primary time variable.

virtual double vtkParticleTracerBase::GetTerminationTime ( ) [virtual]

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. Use a vlue of zero to diable termination. The units of time should be consistent with the primary time variable.

void vtkParticleTracerBase::SetIntegrator ( vtkInitialValueProblemSolver * )

virtual vtkInitialValueProblemSolver* vtkParticleTracerBase::GetIntegrator ( ) [virtual]

void vtkParticleTracerBase::SetIntegratorType ( int type )

int vtkParticleTracerBase::GetIntegratorType ( )

void vtkParticleTracerBase::SetStartTime ( double t )

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. Use a vlue of zero to diable termination. The units of time should be consistent with the primary time variable.

virtual double vtkParticleTracerBase::GetStartTime ( ) [virtual]

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. Use a vlue of zero to diable termination. The units of time should be consistent with the primary time variable.

virtual int vtkParticleTracerBase::GetStaticSeeds ( ) [virtual]

if StaticSeeds is set and the mesh is static, then every time particles are injected we can re-use the same injection information. We classify particles according to processor just once before start. If StaticSeeds is set and a moving seed source is specified the motion will be ignored and results will not be as expected. vtkSetMacro(StaticSeeds,int);

virtual int vtkParticleTracerBase::GetStaticMesh ( ) [virtual]

if StaticMesh is set, many optimizations for cell caching can be assumed. if StaticMesh is not set, the algorithm will attempt to find out if optimizations can be used, but setting it to true will force all optimizations. Do not Set StaticMesh to true if a dynamic mesh is being used as this will invalidate all results. vtkSetMacro(StaticMesh,int);

virtual void vtkParticleTracerBase::SetParticleWriter ( vtkAbstractParticleWriter * pw ) [virtual]

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

virtual vtkAbstractParticleWriter* vtkParticleTracerBase::GetParticleWriter ( ) [virtual]

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

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