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

A particle tracer for vector fields. More...

#include <vtkParticleTracerBase.h>

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

Public Types

enum  Solvers {
  RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE,
  UNKNOWN
}
 
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkParticleTracerBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void PrintParticleHistories ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
void SetIntegratorType (int type)
 
int GetIntegratorType ()
 
virtual bool GetComputeVorticity ()
 
void SetComputeVorticity (bool)
 
virtual double GetTerminalSpeed ()
 
void SetTerminalSpeed (double)
 
virtual double GetRotationScale ()
 
void SetRotationScale (double)
 
virtual void SetIgnorePipelineTime (int)
 
virtual int GetIgnorePipelineTime ()
 
virtual void IgnorePipelineTimeOn ()
 
virtual void IgnorePipelineTimeOff ()
 
virtual int GetForceReinjectionEveryNSteps ()
 
void SetForceReinjectionEveryNSteps (int)
 
void SetTerminationTime (double t)
 
virtual double GetTerminationTime ()
 
virtual double GetStartTime ()
 
void SetStartTime (double t)
 
virtual void SetStaticSeeds (int)
 
virtual int GetStaticSeeds ()
 
virtual void SetStaticMesh (int)
 
virtual int GetStaticMesh ()
 
virtual void SetParticleWriter (vtkAbstractParticleWriter *pw)
 
virtual vtkAbstractParticleWriterGetParticleWriter ()
 
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 ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (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
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (int port)
 
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])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
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)
 
void SetUpdateExtent (int extent[6])
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkParticleTracerBaseSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 vtkPolyDataExecute (vtkInformationVector **inputVector)
 
virtual void Initialize ()
 
virtual int OutputParticles (vtkPolyData *poly)=0
 
virtual void Finalize ()
 
virtual std::vector< vtkDataSet * > GetSeedSources (vtkInformationVector *inputVector, int timeStep)
 
int InitializeInterpolator ()
 
int UpdateDataCache (vtkDataObject *td)
 
void TestParticles (vtkParticleTracerBaseNamespace::ParticleVector &candidates, std::vector< int > &passed)
 
virtual bool UpdateParticleListFromOtherProcesses ()
 
virtual bool SendParticleToAnotherProcess (vtkParticleTracerBaseNamespace::ParticleInformation &, vtkParticleTracerBaseNamespace::ParticleInformation &, vtkPointData *)
 
void CreateProtoPD (vtkDataObject *input)
 
vtkFloatArrayGetParticleAge (vtkPointData *)
 
vtkIntArrayGetParticleIds (vtkPointData *)
 
vtkCharArrayGetParticleSourceIds (vtkPointData *)
 
vtkIntArrayGetInjectedPointIds (vtkPointData *)
 
vtkIntArrayGetInjectedStepIds (vtkPointData *)
 
vtkIntArrayGetErrorCodeArr (vtkPointData *)
 
vtkFloatArrayGetParticleVorticity (vtkPointData *)
 
vtkFloatArrayGetParticleRotation (vtkPointData *)
 
vtkFloatArrayGetParticleAngularVel (vtkPointData *)
 
bool InsideBounds (double point[])
 
void CalculateVorticity (vtkGenericCell *cell, double pcoords[3], vtkDoubleArray *cellVectors, double vorticity[3])
 
double GetCacheDataTime (int i)
 
double GetCacheDataTime ()
 
virtual void ResetCache ()
 
void AddParticle (vtkParticleTracerBaseNamespace::ParticleInformation &info, double *velocity)
 
virtual int GetReinjectionCounter ()
 
virtual double GetCurrentTimeValue ()
 
virtual void InitializeExtraPointDataArrays (vtkPointData *vtkNotUsed(outputPD))
 
virtual void AppendToExtraPointDataArrays (vtkParticleTracerBaseNamespace::ParticleInformation &)
 
vtkTemporalInterpolatedVelocityFieldGetInterpolator ()
 
virtual void AddRestartSeeds (vtkInformationVector **)
 
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 Member Functions inherited from vtkPolyDataAlgorithm
 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 vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (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)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
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< vtkPolyDataOutput
 
vtkSmartPointer< vtkPointDataProtoPD
 
vtkIdType UniqueIdCounter
 
vtkParticleTracerBaseNamespace::ParticleDataList ParticleHistories
 
vtkSmartPointer< vtkPointDataParticlePointData
 
int IgnorePipelineTime
 
int DisableResetCache
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class ParticlePathFilterInternal
 
class StreaklineFilterInternal
 

Additional Inherited Members

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

Detailed Description

A particle tracer for vector fields.

A parallel particle tracer for vector fields.

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

See also
vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

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

See also
vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkStreamTracer

Definition at line 97 of file vtkParticleTracerBase.h.

Member Typedef Documentation

Definition at line 109 of file vtkParticleTracerBase.h.

Member Enumeration Documentation

Enumerator
RUNGE_KUTTA2 
RUNGE_KUTTA4 
RUNGE_KUTTA45 
NONE 
UNKNOWN 

Definition at line 100 of file vtkParticleTracerBase.h.

Constructor & Destructor Documentation

vtkParticleTracerBase::vtkParticleTracerBase ( )
protected
virtual vtkParticleTracerBase::~vtkParticleTracerBase ( )
protectedvirtual

Member Function Documentation

static int vtkParticleTracerBase::IsTypeOf ( const char *  type)
static
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
virtual vtkObjectBase* vtkParticleTracerBase::NewInstanceInternal ( ) const
protectedvirtual
vtkParticleTracerBase* vtkParticleTracerBase::NewInstance ( ) const
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 vtkStreaklineFilter, vtkPParticleTracerBase, vtkPParticleTracer, vtkPStreaklineFilter, and vtkPParticlePathFilter.

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

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

void vtkParticleTracerBase::SetComputeVorticity ( bool  )

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

virtual double vtkParticleTracerBase::GetTerminalSpeed ( )
virtual

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

void vtkParticleTracerBase::SetTerminalSpeed ( double  )

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

virtual double vtkParticleTracerBase::GetRotationScale ( )
virtual

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

void vtkParticleTracerBase::SetRotationScale ( double  )

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

virtual void vtkParticleTracerBase::SetIgnorePipelineTime ( 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

virtual int vtkParticleTracerBase::GetForceReinjectionEveryNSteps ( )
virtual

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

void vtkParticleTracerBase::SetForceReinjectionEveryNSteps ( int  )

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

void vtkParticleTracerBase::SetTerminationTime ( double  t)

Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. Use a vlue of zero to 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 ( )
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.

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

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

virtual int vtkParticleTracerBase::GetStaticSeeds ( )
virtual

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

virtual void vtkParticleTracerBase::SetStaticMesh ( int  )
virtual

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

virtual int vtkParticleTracerBase::GetStaticMesh ( )
virtual

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

virtual void vtkParticleTracerBase::SetParticleWriter ( vtkAbstractParticleWriter pw)
virtual

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

virtual vtkAbstractParticleWriter* vtkParticleTracerBase::GetParticleWriter ( )
virtual

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

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

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

virtual char* vtkParticleTracerBase::GetParticleFileName ( )
virtual

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

virtual void vtkParticleTracerBase::SetEnableParticleWriting ( int  )
virtual

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

virtual int vtkParticleTracerBase::GetEnableParticleWriting ( )
virtual

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

virtual void vtkParticleTracerBase::EnableParticleWritingOn ( )
virtual

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

virtual void vtkParticleTracerBase::EnableParticleWritingOff ( )
virtual

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

virtual void vtkParticleTracerBase::SetDisableResetCache ( int  )
virtual

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

virtual int vtkParticleTracerBase::GetDisableResetCache ( )
virtual

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

virtual void vtkParticleTracerBase::DisableResetCacheOn ( )
virtual

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

virtual void vtkParticleTracerBase::DisableResetCacheOff ( )
virtual

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

void vtkParticleTracerBase::AddSourceConnection ( vtkAlgorithmOutput input)

Provide support for multiple seed sources

void vtkParticleTracerBase::RemoveAllSources ( )

Provide support for multiple seed sources

virtual int vtkParticleTracerBase::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkParticleTracerBase::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

see vtkAlgorithm for details

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkParticleTracerBase::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkPParticleTracerBase.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented in vtkPParticleTracerBase.

virtual void vtkParticleTracerBase::Initialize ( )
inlineprotectedvirtual

Definition at line 305 of file vtkParticleTracerBase.h.

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

Method to get the data set seed sources. For in situ we want to override how the seed sources are made available.

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

inside our data. Add good ones to passed list and set count to the number that passed

void vtkParticleTracerBase::TestParticles ( vtkParticleTracerBaseNamespace::ParticleVector candidates,
std::vector< int > &  passed 
)
protected
virtual void vtkParticleTracerBase::AssignSeedsToProcessors ( double  time,
vtkDataSet source,
int  sourceID,
int  ptId,
vtkParticleTracerBaseNamespace::ParticleVector localSeedPoints,
int localAssignedCount 
)
protectedvirtual

all the injection/seed points according to which processor they belong to. This saves us retesting at every injection time providing 1) The volumes are static, 2) the seed points are static If either are non static, then this step is skipped.

Reimplemented in vtkPParticleTracerBase.

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

give each one a uniqu ID. We need to use MPI to find out who is using which numbers.

Reimplemented in vtkPParticleTracerBase.

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

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

virtual bool vtkParticleTracerBase::UpdateParticleListFromOtherProcesses ( )
inlineprotectedvirtual

this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain. Returns true if particles moved between processes and false otherwise.

Reimplemented in vtkPParticleTracerBase.

Definition at line 360 of file vtkParticleTracerBase.h.

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

particle between the two times supplied.

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

Reimplemented in vtkPParticleTracerBase.

Definition at line 372 of file vtkParticleTracerBase.h.

bool vtkParticleTracerBase::ComputeDomainExitLocation ( double  pos[4],
double  p2[4],
double  intersection[4],
vtkGenericCell cell 
)
protected

This is an old routine kept for possible future use. In dynamic meshes, particles might leave the domain and need to be extrapolated across a gap between the meshes before they re-renter another domain dodgy rotating meshes need special care....

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

Methods that check that the input arrays are ordered the same on all data sets. This needs to be true for all blocks in a composite data set as well as across all processes.

Reimplemented in vtkPParticleTracerBase.

bool vtkParticleTracerBase::IsPointDataValid ( vtkCompositeDataSet input,
std::vector< std::string > &  arrayNames 
)
protected

Methods that check that the input arrays are ordered the same on all data sets. This needs to be true for all blocks in a composite data set as well as across all processes.

void vtkParticleTracerBase::GetPointDataArrayNames ( vtkDataSet input,
std::vector< std::string > &  names 
)
protected

Methods that check that the input arrays are ordered the same on all data sets. This needs to be true for all blocks in a composite data set as well as across all processes.

virtual int vtkParticleTracerBase::GetReinjectionCounter ( )
protectedvirtual
virtual double vtkParticleTracerBase::GetCurrentTimeValue ( )
protectedvirtual
virtual void vtkParticleTracerBase::InitializeExtraPointDataArrays ( vtkPointData vtkNotUsedoutputPD)
inlineprotectedvirtual

Methods to append values to existing point data arrays that may only be desired on specific concrete derived classes.

Definition at line 433 of file vtkParticleTracerBase.h.

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

Reimplemented in vtkParticlePathFilter, and vtkPParticlePathFilter.

Definition at line 435 of file vtkParticleTracerBase.h.

vtkTemporalInterpolatedVelocityField* vtkParticleTracerBase::GetInterpolator ( )
protected
virtual void vtkParticleTracerBase::AddRestartSeeds ( vtkInformationVector **  )
inlineprotectedvirtual

For restarts of particle paths, we add in the ability to add in particles from a previous computation that we will still advect.

Definition at line 441 of file vtkParticleTracerBase.h.

Friends And Related Function Documentation

friend class ParticlePathFilterInternal
friend

Definition at line 537 of file vtkParticleTracerBase.h.

friend class StreaklineFilterInternal
friend

Definition at line 538 of file vtkParticleTracerBase.h.

Member Data Documentation

vtkSmartPointer<vtkPolyData> vtkParticleTracerBase::Output
protected

Definition at line 239 of file vtkParticleTracerBase.h.

vtkSmartPointer<vtkPointData> vtkParticleTracerBase::ProtoPD
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 244 of file vtkParticleTracerBase.h.

vtkIdType vtkParticleTracerBase::UniqueIdCounter
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 245 of file vtkParticleTracerBase.h.

vtkParticleTracerBaseNamespace::ParticleDataList vtkParticleTracerBase::ParticleHistories
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 246 of file vtkParticleTracerBase.h.

vtkSmartPointer<vtkPointData> vtkParticleTracerBase::ParticlePointData
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 247 of file vtkParticleTracerBase.h.

int vtkParticleTracerBase::IgnorePipelineTime
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 250 of file vtkParticleTracerBase.h.

int vtkParticleTracerBase::DisableResetCache
protected

ProtoPD is used just to keep track of the input array names and number of components for copy allocating from other vtkPointDatas where the data is really stored

Definition at line 251 of file vtkParticleTracerBase.h.


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