vtkTemporalStreamTracer Class Reference

#include <vtkTemporalStreamTracer.h>

Inheritance diagram for vtkTemporalStreamTracer:

[legend]

Collaboration diagram for vtkTemporalStreamTracer:

[legend]

List of all members.

Detailed Description

A Parallel Particle tracer for unsteady vector fields.

vtkTemporalStreamTracer is a filter that integrates a vector field to generate

See also:: vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

Definition at line 87 of file vtkTemporalStreamTracer.h.


Public Types
enum	Units { TERMINATION_TIME_UNIT, TERMINATION_STEP_UNIT }
typedef vtkStreamTracer	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetTimeStep (unsigned int)
virtual unsigned int	GetTimeStep ()

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

virtual void	SetTimeStepResolution (double)
virtual double	GetTimeStepResolution ()

virtual void	SetForceReinjectionEveryNSteps (int)
virtual int	GetForceReinjectionEveryNSteps ()

virtual void	SetTerminationTime (double)
virtual double	GetTerminationTime ()

virtual void	SetTerminationTimeUnit (int)
virtual int	GetTerminationTimeUnit ()
void	SetTerminationTimeUnitToTimeUnit ()
void	SetTerminationTimeUnitToStepUnit ()

virtual void	SetStaticSeeds (int)
virtual int	GetStaticSeeds ()
virtual void	StaticSeedsOn ()
virtual void	StaticSeedsOff ()

virtual void	SetStaticMesh (int)
virtual int	GetStaticMesh ()
virtual void	StaticMeshOn ()
virtual void	StaticMeshOff ()

virtual void	SetController (vtkMultiProcessController *controller)
virtual vtkMultiProcessController *	GetController ()

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

void	AddSourceConnection (vtkAlgorithmOutput *input)
void	RemoveAllSources ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTemporalStreamTracer *	SafeDownCast (vtkObject *o)
static vtkTemporalStreamTracer *	New ()
Protected Member Functions
	vtkTemporalStreamTracer ()
	~vtkTemporalStreamTracer ()
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)
int	InitializeInterpolator ()
int	AddTemporalInput (vtkTemporalDataSet *td)
bool	SendParticleToAnotherProcess (vtkTemporalStreamTracerNamespace::ParticleInformation &info, double point1[4], double delT)
void	AddParticleToMPISendList (vtkTemporalStreamTracerNamespace::ParticleInformation &info)
bool	InsideBounds (double point[])

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

void	AssignSeedsToProcessors (vtkDataSet *source, int sourceID, int ptId, vtkTemporalStreamTracerNamespace::ParticleVector &LocalSeedPoints, int &LocalAssignedCount)

void	AssignUniqueIds (vtkTemporalStreamTracerNamespace::ParticleVector &LocalSeedPoints)

void	UpdateParticleList (vtkTemporalStreamTracerNamespace::ParticleVector &candidates)

void	TransmitReceiveParticles (vtkTemporalStreamTracerNamespace::ParticleVector &outofdomain, vtkTemporalStreamTracerNamespace::ParticleVector &received, bool removeself)

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

bool	RetryWithPush (vtkTemporalStreamTracerNamespace::ParticleInformation &info, double velocity[3], double delT)

bool	ComputeDomainExitLocation (double pos[4], double p2[4], double intersection[4], vtkGenericCell *cell)
Protected Attributes
int	UpdatePiece
int	UpdateNumPieces
int	AllFixedGeometry
int	StaticMesh
int	StaticSeeds
unsigned int	TimeStep
unsigned int	ActualTimeStep
int	IgnorePipelineTime
unsigned int	NumberOfInputTimeSteps
vtkstd::vector< double >	InputTimeValues
vtkstd::vector< double >	OutputTimeValues
double	EarliestTime
double	CurrentTimeSteps [2]
double	TimeStepResolution
double	TerminationTime
int	TerminationTimeUnit
int	ForceReinjectionEveryNSteps
bool	ReinjectionFlag
int	ReinjectionCounter
vtkTimeStamp	ParticleInjectionTime
vtkAbstractParticleWriter *	ParticleWriter
char *	ParticleFileName
int	EnableParticleWriting
unsigned int	NumberOfParticles
vtkTemporalStreamTracerNamespace::ParticleDataList	ParticleHistories
vtkTemporalStreamTracerNamespace::ParticleVector	LocalSeeds
vtkSmartPointer< vtkFloatArray >	ParticleAge
vtkSmartPointer< vtkIntArray >	ParticleIds
vtkSmartPointer< vtkCharArray >	ParticleSourceIds
vtkSmartPointer< vtkIntArray >	InjectedPointIds
vtkSmartPointer< vtkIntArray >	InjectedStepIds
vtkSmartPointer< vtkIntArray >	ErrorCode
vtkSmartPointer< vtkFloatArray >	ParticleVorticity
vtkSmartPointer< vtkFloatArray >	ParticleRotation
vtkSmartPointer< vtkFloatArray >	ParticleAngularVel
vtkSmartPointer< vtkDoubleArray >	cellVectors
vtkSmartPointer< vtkPointData >	OutputPointData
int	InterpolationCount
vtkSmartPointer< vtkCellArray >	ParticleCells
vtkSmartPointer< vtkPoints >	OutputCoordinates
vtkTemporalStreamTracerNamespace::ParticleVector	MPISendList
vtkSmartPointer < vtkTemporalInterpolatedVelocityField >	Interpolator
vtkSmartPointer < vtkMultiBlockDataSet >	InputDataT [2]
vtkSmartPointer< vtkDataSet >	DataReferenceT [2]
vtkstd::vector< bounds >	CachedBounds [2]
vtkMultiProcessController *	Controller
vtkIdType	UniqueIdCounter
vtkIdType	UniqueIdCounterMPI
int	substeps
Classes
struct	bounds

Member Typedef Documentation

typedef vtkStreamTracer vtkTemporalStreamTracer::Superclass

Reimplemented from vtkStreamTracer.

Definition at line 91 of file vtkTemporalStreamTracer.h.

Member Enumeration Documentation

enum vtkTemporalStreamTracer::Units

Enumerator:

TERMINATION_TIME_UNIT
TERMINATION_STEP_UNIT

Reimplemented from vtkStreamTracer.

Definition at line 136 of file vtkTemporalStreamTracer.h.

Constructor & Destructor Documentation

vtkTemporalStreamTracer::vtkTemporalStreamTracer ( ) [protected]

vtkTemporalStreamTracer::~vtkTemporalStreamTracer ( ) [protected]

Member Function Documentation

virtual const char* vtkTemporalStreamTracer::GetClassName ( ) [virtual]

Reimplemented from vtkStreamTracer.

static int vtkTemporalStreamTracer::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStreamTracer.

virtual int vtkTemporalStreamTracer::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkStreamTracer.

static vtkTemporalStreamTracer* vtkTemporalStreamTracer::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkStreamTracer.

void vtkTemporalStreamTracer::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 vtkStreamTracer.

static vtkTemporalStreamTracer* vtkTemporalStreamTracer::New ( ) [static]

Construct object using 2nd order Runge Kutta

Reimplemented from vtkStreamTracer.

virtual void vtkTemporalStreamTracer::SetTimeStep ( unsigned int ) [virtual]

Set/Get the TimeStep. This is the primary means of advancing the particles. The TimeStep should be animated and this will drive the pipeline forcing timesteps to be fetched from upstream.

virtual unsigned int vtkTemporalStreamTracer::GetTimeStep ( ) [virtual]

Set/Get the TimeStep. This is the primary means of advancing the particles. The TimeStep should be animated and this will drive the pipeline forcing timesteps to be fetched from upstream.

virtual void vtkTemporalStreamTracer::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 vtkTemporalStreamTracer::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 vtkTemporalStreamTracer::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 vtkTemporalStreamTracer::IgnorePipelineTimeOff ( ) [virtual]

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

virtual void vtkTemporalStreamTracer::SetTimeStepResolution ( double ) [virtual]

If the data source does not have the correct time values present on each time step - setting this value to non unity can be used to adjust the time step size from 1s pre step to 1x_TimeStepResolution : Not functional in this version. Broke it

Todo:: , put back time scaling

virtual double vtkTemporalStreamTracer::GetTimeStepResolution ( ) [virtual]

If the data source does not have the correct time values present on each time step - setting this value to non unity can be used to adjust the time step size from 1s pre step to 1x_TimeStepResolution : Not functional in this version. Broke it

Todo:: , put back time scaling

virtual void vtkTemporalStreamTracer::SetForceReinjectionEveryNSteps ( int ) [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

virtual int vtkTemporalStreamTracer::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

virtual void vtkTemporalStreamTracer::SetTerminationTime ( double ) [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 double vtkTemporalStreamTracer::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.

virtual void vtkTemporalStreamTracer::SetTerminationTimeUnit ( int ) [virtual]

The units of TerminationTime may be actual 'Time' units as described by the data, or just TimeSteps of iteration.

virtual int vtkTemporalStreamTracer::GetTerminationTimeUnit ( ) [virtual]

The units of TerminationTime may be actual 'Time' units as described by the data, or just TimeSteps of iteration.

void vtkTemporalStreamTracer::SetTerminationTimeUnitToTimeUnit ( ) [inline]

The units of TerminationTime may be actual 'Time' units as described by the data, or just TimeSteps of iteration.

Definition at line 157 of file vtkTemporalStreamTracer.h.

void vtkTemporalStreamTracer::SetTerminationTimeUnitToStepUnit ( ) [inline]

The units of TerminationTime may be actual 'Time' units as described by the data, or just TimeSteps of iteration.

Definition at line 159 of file vtkTemporalStreamTracer.h.

virtual void vtkTemporalStreamTracer::SetStaticSeeds ( int ) [virtual]

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

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

virtual void vtkTemporalStreamTracer::StaticSeedsOn ( ) [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.

virtual void vtkTemporalStreamTracer::StaticSeedsOff ( ) [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.

virtual void vtkTemporalStreamTracer::SetStaticMesh ( int ) [virtual]

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

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

virtual void vtkTemporalStreamTracer::StaticMeshOn ( ) [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.

virtual void vtkTemporalStreamTracer::StaticMeshOff ( ) [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.

virtual void vtkTemporalStreamTracer::SetController ( vtkMultiProcessController * controller ) [virtual]

Set/Get the controller used when sending particles between processes The controller must be an instance of vtkMPIController. If VTK was compiled without VTK_USE_MPI on, then the Controller is simply ignored.

virtual vtkMultiProcessController* vtkTemporalStreamTracer::GetController ( ) [virtual]

Set/Get the controller used when sending particles between processes The controller must be an instance of vtkMPIController. If VTK was compiled without VTK_USE_MPI on, then the Controller is simply ignored.

virtual void vtkTemporalStreamTracer::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* vtkTemporalStreamTracer::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 vtkTemporalStreamTracer::SetParticleFileName ( const char * ) [virtual]