VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTemporalStreamTracer Class Reference

A Parallel Particle tracer for unsteady vector fields. More...

#include <vtkTemporalStreamTracer.h>

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

Classes

struct  bounds
 

Public Types

enum  Units { TERMINATION_TIME_UNIT, TERMINATION_STEP_UNIT }
 
typedef vtkStreamTracer Superclass
 
- Public Types inherited from vtkStreamTracer
enum  Units { LENGTH_UNIT = 1, CELL_LENGTH_UNIT = 2 }
 
enum  Solvers {
  RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE,
  UNKNOWN
}
 
enum  ReasonForTermination {
  OUT_OF_DOMAIN = vtkInitialValueProblemSolver::OUT_OF_DOMAIN, NOT_INITIALIZED = vtkInitialValueProblemSolver::NOT_INITIALIZED, UNEXPECTED_VALUE = vtkInitialValueProblemSolver::UNEXPECTED_VALUE, OUT_OF_LENGTH = 4,
  OUT_OF_STEPS = 5, STAGNATION = 6, FIXED_REASONS_FOR_TERMINATION_COUNT
}
 
enum  { FORWARD, BACKWARD, BOTH }
 
enum  { INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }
 
typedef vtkPolyDataAlgorithm Superclass
 
typedef bool(* CustomTerminationCallbackType) (void *clientdata, vtkPoints *points, vtkDataArray *velocity, int integrationDirection)
 Asks the user if the current streamline should be terminated. More...
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkTemporalStreamTracerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetTimeStep (unsigned int)
 Set/Get the TimeStep. More...
 
virtual unsigned int GetTimeStep ()
 
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 ()
 
virtual void IgnorePipelineTimeOn ()
 
virtual void IgnorePipelineTimeOff ()
 
virtual void SetTimeStepResolution (double)
 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. More...
 
virtual double GetTimeStepResolution ()
 
virtual void SetForceReinjectionEveryNSteps (int)
 When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. More...
 
virtual int GetForceReinjectionEveryNSteps ()
 
virtual void SetTerminationTime (double)
 Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. More...
 
virtual double GetTerminationTime ()
 
virtual void SetTerminationTimeUnit (int)
 The units of TerminationTime may be actual 'Time' units as described by the data, or just TimeSteps of iteration. More...
 
virtual int GetTerminationTimeUnit ()
 
void SetTerminationTimeUnitToTimeUnit ()
 
void SetTerminationTimeUnitToStepUnit ()
 
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 ()
 
virtual void StaticSeedsOn ()
 
virtual void StaticSeedsOff ()
 
virtual void SetStaticMesh (vtkTypeBool)
 if StaticMesh is set, many optimizations for cell caching can be assumed. More...
 
virtual vtkTypeBool GetStaticMesh ()
 
virtual void StaticMeshOn ()
 
virtual void StaticMeshOff ()
 
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 vtkAbstractParticleWriterGetParticleWriter ()
 
virtual void SetParticleFileName (const char *)
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual char * GetParticleFileName ()
 
virtual void SetEnableParticleWriting (vtkTypeBool)
 Set/Get the filename to be used with the particle writer when dumping particles to disk. More...
 
virtual vtkTypeBool GetEnableParticleWriting ()
 
virtual void EnableParticleWritingOn ()
 
virtual void EnableParticleWritingOff ()
 
void AddSourceConnection (vtkAlgorithmOutput *input)
 Provide support for multiple see sources. More...
 
void RemoveAllSources ()
 
- Public Member Functions inherited from vtkStreamTracer
vtkStreamTracerNewInstance () const
 
virtual void SetStartPosition (double, double, double)
 Specify the starting point (seed) of a streamline in the global coordinate system. More...
 
virtual void SetStartPosition (double[3])
 
virtual doubleGetStartPosition ()
 
virtual void GetStartPosition (double &, double &, double &)
 
virtual void GetStartPosition (double[3])
 
void SetSourceData (vtkDataSet *source)
 Specify the source object used to generate starting points (seeds). More...
 
vtkDataSetGetSource ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the source object used to generate starting points (seeds). More...
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 Set/get the integrator type to be used for streamline generation. More...
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
void SetIntegratorType (int type)
 
int GetIntegratorType ()
 
void SetIntegratorTypeToRungeKutta2 ()
 
void SetIntegratorTypeToRungeKutta4 ()
 
void SetIntegratorTypeToRungeKutta45 ()
 
void SetInterpolatorTypeToDataSetPointLocator ()
 Set the velocity field interpolator type to the one involving a dataset point locator. More...
 
void SetInterpolatorTypeToCellLocator ()
 Set the velocity field interpolator type to the one involving a cell locator. More...
 
virtual void SetMaximumPropagation (double)
 Specify the maximum length of a streamline expressed in LENGTH_UNIT. More...
 
virtual double GetMaximumPropagation ()
 
void SetIntegrationStepUnit (int unit)
 Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. More...
 
int GetIntegrationStepUnit ()
 
virtual void SetInitialIntegrationStep (double)
 Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4) More...
 
virtual double GetInitialIntegrationStep ()
 
virtual void SetMinimumIntegrationStep (double)
 Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45) More...
 
virtual double GetMinimumIntegrationStep ()
 
virtual void SetMaximumIntegrationStep (double)
 Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45) More...
 
virtual double GetMaximumIntegrationStep ()
 
virtual void SetMaximumError (double)
 Specify the maximum error tolerated throughout streamline integration. More...
 
virtual double GetMaximumError ()
 
virtual void SetMaximumNumberOfSteps (vtkIdType)
 Specify the maximum number of steps for integrating a streamline. More...
 
virtual vtkIdType GetMaximumNumberOfSteps ()
 
virtual void SetTerminalSpeed (double)
 Specify the terminal speed value, below which integration is terminated. More...
 
virtual double GetTerminalSpeed ()
 
virtual bool GetSurfaceStreamlines ()
 Set/Unset the streamlines to be computed on a surface. More...
 
virtual void SetSurfaceStreamlines (bool)
 
virtual void SurfaceStreamlinesOn ()
 
virtual void SurfaceStreamlinesOff ()
 
virtual void SetIntegrationDirection (int)
 Specify whether the streamline is integrated in the upstream or downstream direction. More...
 
virtual int GetIntegrationDirection ()
 
void SetIntegrationDirectionToForward ()
 
void SetIntegrationDirectionToBackward ()
 
void SetIntegrationDirectionToBoth ()
 
virtual void SetComputeVorticity (bool)
 Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter. More...
 
virtual bool GetComputeVorticity ()
 
virtual void SetRotationScale (double)
 This can be used to scale the rate with which the streamribbons twist. More...
 
virtual double GetRotationScale ()
 
void SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField *ivf)
 The object used to interpolate the velocity field during integration is of the same class as this prototype. More...
 
void SetInterpolatorType (int interpType)
 Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration. More...
 
void AddCustomTerminationCallback (CustomTerminationCallbackType callback, void *clientdata, int reasonForTermination)
 Adds a custom termination callback. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTemporalStreamTracerSafeDownCast (vtkObjectBase *o)
 
static vtkTemporalStreamTracerNew ()
 Construct object using 2nd order Runge Kutta. More...
 
- Static Public Member Functions inherited from vtkStreamTracer
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStreamTracerSafeDownCast (vtkObjectBase *o)
 
static vtkStreamTracerNew ()
 Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit). More...
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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 ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTemporalStreamTracer ()
 
 ~vtkTemporalStreamTracer () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
virtual int ProcessInput (vtkInformationVector **inputVector)
 
virtual int GenerateOutput (vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int InitializeInterpolator ()
 
int SetTemporalInput (vtkDataObject *td, int index)
 
void TestParticles (vtkTemporalStreamTracerNamespace::ParticleVector &candidates, vtkTemporalStreamTracerNamespace::ParticleVector &passed, int &count)
 inside our data. More...
 
virtual void AssignSeedsToProcessors (vtkDataSet *source, int sourceID, int ptId, vtkTemporalStreamTracerNamespace::ParticleVector &LocalSeedPoints, int &LocalAssignedCount)
 all the injection/seed points according to which processor they belong to. More...
 
virtual void AssignUniqueIds (vtkTemporalStreamTracerNamespace::ParticleVector &LocalSeedPoints)
 give each one a unique ID. More...
 
void UpdateParticleList (vtkTemporalStreamTracerNamespace::ParticleVector &candidates)
 and sending between processors, into a list, which is used as the master list on this processor More...
 
virtual void TransmitReceiveParticles (vtkTemporalStreamTracerNamespace::ParticleVector &outofdomain, vtkTemporalStreamTracerNamespace::ParticleVector &received, bool removeself)
 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 (vtkTemporalStreamTracerNamespace::ParticleListIterator &it, double currenttime, double terminationtime, vtkInitialValueProblemSolver *integrator)
 particle between the two times supplied. More...
 
bool RetryWithPush (vtkTemporalStreamTracerNamespace::ParticleInformation &info, double velocity[3], double delT)
 and sent to the other processors for possible continuation. More...
 
bool SendParticleToAnotherProcess (vtkTemporalStreamTracerNamespace::ParticleInformation &info, double point1[4], double delT)
 
void AddParticleToMPISendList (vtkTemporalStreamTracerNamespace::ParticleInformation &info)
 
bool ComputeDomainExitLocation (double pos[4], double p2[4], double intersection[4], vtkGenericCell *cell)
 In dnamic 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.... More...
 
bool InsideBounds (double point[])
 
- Protected Member Functions inherited from vtkStreamTracer
 vtkStreamTracer ()
 
 ~vtkStreamTracer () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
void AddInput (vtkDataObject *)
 
void CalculateVorticity (vtkGenericCell *cell, double pcoords[3], vtkDoubleArray *cellVectors, double vorticity[3])
 
void Integrate (vtkPointData *inputData, vtkPolyData *output, vtkDataArray *seedSource, vtkIdList *seedIds, vtkIntArray *integrationDirections, double lastPoint[3], vtkAbstractInterpolatedVelocityField *func, int maxCellSize, int vecType, const char *vecFieldName, double &propagation, vtkIdType &numSteps, double &integrationTime)
 
double SimpleIntegrate (double seed[3], double lastPoint[3], double stepSize, vtkAbstractInterpolatedVelocityField *func)
 
int CheckInputs (vtkAbstractInterpolatedVelocityField *&func, int *maxCellSize)
 
void GenerateNormals (vtkPolyData *output, double *firstNormal, const char *vecName)
 
void ConvertIntervals (double &step, double &minStep, double &maxStep, int direction, double cellLength)
 
int SetupOutput (vtkInformation *inInfo, vtkInformation *outInfo)
 
void InitializeSeeds (vtkDataArray *&seeds, vtkIdList *&seedIds, vtkIntArray *&integrationDirections, vtkDataSet *source)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int RequestIndex
 
int UpdatePieceId
 
int UpdateNumPieces
 
int AllFixedGeometry
 
vtkTypeBool StaticMesh
 
vtkTypeBool StaticSeeds
 
unsigned int TimeStep
 
unsigned int ActualTimeStep
 
vtkTypeBool IgnorePipelineTime
 
unsigned int NumberOfInputTimeSteps
 
std::vector< doubleInputTimeValues
 
std::vector< doubleOutputTimeValues
 
double EarliestTime
 
double CurrentTimeSteps [2]
 
double TimeStepResolution
 
double TerminationTime
 
int TerminationTimeUnit
 
int ForceReinjectionEveryNSteps
 
bool ReinjectionFlag
 
int ReinjectionCounter
 
vtkTimeStamp ParticleInjectionTime
 
vtkAbstractParticleWriterParticleWriter
 
char * ParticleFileName
 
vtkTypeBool EnableParticleWriting
 
unsigned int NumberOfParticles
 
vtkTemporalStreamTracerNamespace::ParticleDataList ParticleHistories
 
vtkTemporalStreamTracerNamespace::ParticleVector LocalSeeds
 
vtkSmartPointer< vtkFloatArrayParticleAge
 
vtkSmartPointer< vtkIntArrayParticleIds
 
vtkSmartPointer< vtkCharArrayParticleSourceIds
 
vtkSmartPointer< vtkIntArrayInjectedPointIds
 
vtkSmartPointer< vtkIntArrayInjectedStepIds
 
vtkSmartPointer< vtkIntArrayErrorCodeArray
 
vtkSmartPointer< vtkFloatArrayParticleVorticity
 
vtkSmartPointer< vtkFloatArrayParticleRotation
 
vtkSmartPointer< vtkFloatArrayParticleAngularVel
 
vtkSmartPointer< vtkDoubleArraycellVectors
 
vtkSmartPointer< vtkPointDataOutputPointData
 
int InterpolationCount
 
vtkSmartPointer< vtkCellArrayParticleCells
 
vtkSmartPointer< vtkPointsOutputCoordinates
 
vtkTemporalStreamTracerNamespace::ParticleVector MPISendList
 
vtkSmartPointer< vtkTemporalInterpolatedVelocityFieldInterpolator
 
vtkSmartPointer< vtkMultiBlockDataSetInputDataT [2]
 
vtkSmartPointer< vtkDataSetDataReferenceT [2]
 
std::vector< boundsCachedBounds [2]
 
vtkIdType UniqueIdCounter
 
vtkIdType UniqueIdCounterMPI
 
int substeps
 
- Protected Attributes inherited from vtkStreamTracer
bool GenerateNormalsInIntegrate
 
double StartPosition [3]
 
double TerminalSpeed
 
double LastUsedStepSize
 
double MaximumPropagation
 
double MinimumIntegrationStep
 
double MaximumIntegrationStep
 
double InitialIntegrationStep
 
int IntegrationStepUnit
 
int IntegrationDirection
 
vtkInitialValueProblemSolverIntegrator
 
double MaximumError
 
vtkIdType MaximumNumberOfSteps
 
bool ComputeVorticity
 
double RotationScale
 
bool SurfaceStreamlines
 
vtkAbstractInterpolatedVelocityFieldInterpolatorPrototype
 
vtkCompositeDataSetInputData
 
bool HasMatchingPointAttributes
 
std::vector< CustomTerminationCallbackTypeCustomTerminationCallback
 
std::vector< void * > CustomTerminationClientData
 
std::vector< intCustomReasonForTermination
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkStreamTracer
static double ConvertToLength (double interval, int unit, double cellLength)
 
static double ConvertToLength (IntervalInformation &interval, double cellLength)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkStreamTracer
static const double EPSILON
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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

This class is deprecated. Use instead one of the following classes: vtkParticleTracerBase vtkParticleTracer vtkParticlePathFilter vtkStreaklineFilter See https://blog.kitware.com/improvements-in-path-tracing-in-vtk/

Definition at line 93 of file vtkTemporalStreamTracer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 97 of file vtkTemporalStreamTracer.h.

Member Enumeration Documentation

◆ Units

Enumerator
TERMINATION_TIME_UNIT 
TERMINATION_STEP_UNIT 

Definition at line 151 of file vtkTemporalStreamTracer.h.

Constructor & Destructor Documentation

◆ vtkTemporalStreamTracer()

vtkTemporalStreamTracer::vtkTemporalStreamTracer ( )
protected

◆ ~vtkTemporalStreamTracer()

vtkTemporalStreamTracer::~vtkTemporalStreamTracer ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStreamTracer.

Reimplemented in vtkPTemporalStreamTracer.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTemporalStreamTracer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkStreamTracer.

Reimplemented in vtkPTemporalStreamTracer.

◆ NewInstance()

vtkTemporalStreamTracer* vtkTemporalStreamTracer::NewInstance ( ) const

◆ PrintSelf()

void vtkTemporalStreamTracer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkStreamTracer.

Reimplemented in vtkPTemporalStreamTracer.

◆ New()

static vtkTemporalStreamTracer* vtkTemporalStreamTracer::New ( )
static

Construct object using 2nd order Runge Kutta.

◆ SetTimeStep()

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.

◆ GetTimeStep()

virtual unsigned int vtkTemporalStreamTracer::GetTimeStep ( )
virtual

◆ SetIgnorePipelineTime()

virtual void vtkTemporalStreamTracer::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 vtkTemporalStreamTracer::GetIgnorePipelineTime ( )
virtual

◆ IgnorePipelineTimeOn()

virtual void vtkTemporalStreamTracer::IgnorePipelineTimeOn ( )
virtual

◆ IgnorePipelineTimeOff()

virtual void vtkTemporalStreamTracer::IgnorePipelineTimeOff ( )
virtual

◆ SetTimeStepResolution()

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

◆ GetTimeStepResolution()

virtual double vtkTemporalStreamTracer::GetTimeStepResolution ( )
virtual

◆ SetForceReinjectionEveryNSteps()

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

◆ GetForceReinjectionEveryNSteps()

virtual int vtkTemporalStreamTracer::GetForceReinjectionEveryNSteps ( )
virtual

◆ SetTerminationTime()

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

◆ GetTerminationTime()

virtual double vtkTemporalStreamTracer::GetTerminationTime ( )
virtual

◆ SetTerminationTimeUnit()

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.

◆ GetTerminationTimeUnit()

virtual int vtkTemporalStreamTracer::GetTerminationTimeUnit ( )
virtual

◆ SetTerminationTimeUnitToTimeUnit()

void vtkTemporalStreamTracer::SetTerminationTimeUnitToTimeUnit ( )
inline

Definition at line 175 of file vtkTemporalStreamTracer.h.

◆ SetTerminationTimeUnitToStepUnit()

void vtkTemporalStreamTracer::SetTerminationTimeUnitToStepUnit ( )
inline

Definition at line 177 of file vtkTemporalStreamTracer.h.

◆ SetStaticSeeds()

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

◆ GetStaticSeeds()

virtual vtkTypeBool vtkTemporalStreamTracer::GetStaticSeeds ( )
virtual

◆ StaticSeedsOn()

virtual void vtkTemporalStreamTracer::StaticSeedsOn ( )
virtual

◆ StaticSeedsOff()

virtual void vtkTemporalStreamTracer::StaticSeedsOff ( )
virtual

◆ SetStaticMesh()

virtual void vtkTemporalStreamTracer::SetStaticMesh ( vtkTypeBool  )
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.

◆ GetStaticMesh()

virtual vtkTypeBool vtkTemporalStreamTracer::GetStaticMesh ( )
virtual

◆ StaticMeshOn()

virtual void vtkTemporalStreamTracer::StaticMeshOn ( )
virtual

◆ StaticMeshOff()

virtual void vtkTemporalStreamTracer::StaticMeshOff ( )
virtual

◆ SetParticleWriter()

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.

◆ GetParticleWriter()

virtual vtkAbstractParticleWriter* vtkTemporalStreamTracer::GetParticleWriter ( )
virtual

◆ SetParticleFileName()

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

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

◆ GetParticleFileName()

virtual char* vtkTemporalStreamTracer::GetParticleFileName ( )
virtual

◆ SetEnableParticleWriting()

virtual void vtkTemporalStreamTracer::SetEnableParticleWriting ( vtkTypeBool  )
virtual

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

◆ GetEnableParticleWriting()

virtual vtkTypeBool vtkTemporalStreamTracer::GetEnableParticleWriting ( )
virtual

◆ EnableParticleWritingOn()

virtual void vtkTemporalStreamTracer::EnableParticleWritingOn ( )
virtual

◆ EnableParticleWritingOff()

virtual void vtkTemporalStreamTracer::EnableParticleWritingOff ( )
virtual

◆ AddSourceConnection()

void vtkTemporalStreamTracer::AddSourceConnection ( vtkAlgorithmOutput input)

Provide support for multiple see sources.

◆ RemoveAllSources()

void vtkTemporalStreamTracer::RemoveAllSources ( )

◆ FillInputPortInformation()

int vtkTemporalStreamTracer::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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

◆ ProcessRequest()

vtkTypeBool vtkTemporalStreamTracer::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

see vtkAlgorithm for details

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestInformation()

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

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestUpdateExtent()

int vtkTemporalStreamTracer::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkStreamTracer.

Reimplemented in vtkPTemporalStreamTracer.

◆ ProcessInput()

virtual int vtkTemporalStreamTracer::ProcessInput ( vtkInformationVector **  inputVector)
protectedvirtual

◆ GenerateOutput()

virtual int vtkTemporalStreamTracer::GenerateOutput ( vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

◆ InitializeInterpolator()

int vtkTemporalStreamTracer::InitializeInterpolator ( )
protected

◆ SetTemporalInput()

int vtkTemporalStreamTracer::SetTemporalInput ( vtkDataObject td,
int  index 
)
protected

◆ TestParticles()

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

inside our data.

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

◆ AssignSeedsToProcessors()

virtual void vtkTemporalStreamTracer::AssignSeedsToProcessors ( vtkDataSet source,
int  sourceID,
int  ptId,
vtkTemporalStreamTracerNamespace::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 vtkPTemporalStreamTracer.

◆ AssignUniqueIds()

virtual void vtkTemporalStreamTracer::AssignUniqueIds ( vtkTemporalStreamTracerNamespace::ParticleVector LocalSeedPoints)
protectedvirtual

give each one a unique ID.

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

Reimplemented in vtkPTemporalStreamTracer.

◆ UpdateParticleList()

void vtkTemporalStreamTracer::UpdateParticleList ( vtkTemporalStreamTracerNamespace::ParticleVector candidates)
protected

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

◆ TransmitReceiveParticles()

virtual void vtkTemporalStreamTracer::TransmitReceiveParticles ( vtkTemporalStreamTracerNamespace::ParticleVector outofdomain,
vtkTemporalStreamTracerNamespace::ParticleVector received,
bool  removeself 
)
protectedvirtual

this is used during classification of seed points and also between iterations of the main loop as particles leave each processor domain

Reimplemented in vtkPTemporalStreamTracer.

◆ IntegrateParticle()

void vtkTemporalStreamTracer::IntegrateParticle ( vtkTemporalStreamTracerNamespace::ParticleListIterator it,
double  currenttime,
double  terminationtime,
vtkInitialValueProblemSolver integrator 
)
protected

particle between the two times supplied.

◆ RetryWithPush()

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

and sent to the other processors for possible continuation.

These routines manage the collection and sending after each main iteration. RetryWithPush adds a small pusj to aparticle along it's current velocity vector, this helps get over cracks in dynamic/rotating meshes

◆ SendParticleToAnotherProcess()

bool vtkTemporalStreamTracer::SendParticleToAnotherProcess ( vtkTemporalStreamTracerNamespace::ParticleInformation info,
double  point1[4],
double  delT 
)
protected

◆ AddParticleToMPISendList()

void vtkTemporalStreamTracer::AddParticleToMPISendList ( vtkTemporalStreamTracerNamespace::ParticleInformation info)
protected

◆ ComputeDomainExitLocation()

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

In dnamic 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....

◆ InsideBounds()

bool vtkTemporalStreamTracer::InsideBounds ( double  point[])
protected

Member Data Documentation

◆ RequestIndex

int vtkTemporalStreamTracer::RequestIndex
protected

Definition at line 385 of file vtkTemporalStreamTracer.h.

◆ UpdatePieceId

int vtkTemporalStreamTracer::UpdatePieceId
protected

Definition at line 388 of file vtkTemporalStreamTracer.h.

◆ UpdateNumPieces

int vtkTemporalStreamTracer::UpdateNumPieces
protected

Definition at line 389 of file vtkTemporalStreamTracer.h.

◆ AllFixedGeometry

int vtkTemporalStreamTracer::AllFixedGeometry
protected

Definition at line 392 of file vtkTemporalStreamTracer.h.

◆ StaticMesh

vtkTypeBool vtkTemporalStreamTracer::StaticMesh
protected

Definition at line 393 of file vtkTemporalStreamTracer.h.

◆ StaticSeeds

vtkTypeBool vtkTemporalStreamTracer::StaticSeeds
protected

Definition at line 394 of file vtkTemporalStreamTracer.h.

◆ TimeStep

unsigned int vtkTemporalStreamTracer::TimeStep
protected

Definition at line 397 of file vtkTemporalStreamTracer.h.

◆ ActualTimeStep

unsigned int vtkTemporalStreamTracer::ActualTimeStep
protected

Definition at line 398 of file vtkTemporalStreamTracer.h.

◆ IgnorePipelineTime

vtkTypeBool vtkTemporalStreamTracer::IgnorePipelineTime
protected

Definition at line 399 of file vtkTemporalStreamTracer.h.

◆ NumberOfInputTimeSteps

unsigned int vtkTemporalStreamTracer::NumberOfInputTimeSteps
protected

Definition at line 400 of file vtkTemporalStreamTracer.h.

◆ InputTimeValues

std::vector<double> vtkTemporalStreamTracer::InputTimeValues
protected

Definition at line 402 of file vtkTemporalStreamTracer.h.

◆ OutputTimeValues

std::vector<double> vtkTemporalStreamTracer::OutputTimeValues
protected

Definition at line 403 of file vtkTemporalStreamTracer.h.

◆ EarliestTime

double vtkTemporalStreamTracer::EarliestTime
protected

Definition at line 406 of file vtkTemporalStreamTracer.h.

◆ CurrentTimeSteps

double vtkTemporalStreamTracer::CurrentTimeSteps[2]
protected

Definition at line 407 of file vtkTemporalStreamTracer.h.

◆ TimeStepResolution

double vtkTemporalStreamTracer::TimeStepResolution
protected

Definition at line 408 of file vtkTemporalStreamTracer.h.

◆ TerminationTime

double vtkTemporalStreamTracer::TerminationTime
protected

Definition at line 411 of file vtkTemporalStreamTracer.h.

◆ TerminationTimeUnit

int vtkTemporalStreamTracer::TerminationTimeUnit
protected

Definition at line 412 of file vtkTemporalStreamTracer.h.

◆ ForceReinjectionEveryNSteps

int vtkTemporalStreamTracer::ForceReinjectionEveryNSteps
protected

Definition at line 415 of file vtkTemporalStreamTracer.h.

◆ ReinjectionFlag

bool vtkTemporalStreamTracer::ReinjectionFlag
protected

Definition at line 416 of file vtkTemporalStreamTracer.h.

◆ ReinjectionCounter

int vtkTemporalStreamTracer::ReinjectionCounter
protected

Definition at line 417 of file vtkTemporalStreamTracer.h.

◆ ParticleInjectionTime

vtkTimeStamp vtkTemporalStreamTracer::ParticleInjectionTime
protected

Definition at line 418 of file vtkTemporalStreamTracer.h.

◆ ParticleWriter

vtkAbstractParticleWriter* vtkTemporalStreamTracer::ParticleWriter
protected

Definition at line 421 of file vtkTemporalStreamTracer.h.

◆ ParticleFileName

char* vtkTemporalStreamTracer::ParticleFileName
protected

Definition at line 422 of file vtkTemporalStreamTracer.h.

◆ EnableParticleWriting

vtkTypeBool vtkTemporalStreamTracer::EnableParticleWriting
protected

Definition at line 423 of file vtkTemporalStreamTracer.h.

◆ NumberOfParticles

unsigned int vtkTemporalStreamTracer::NumberOfParticles
protected

Definition at line 426 of file vtkTemporalStreamTracer.h.

◆ ParticleHistories

vtkTemporalStreamTracerNamespace::ParticleDataList vtkTemporalStreamTracer::ParticleHistories
protected

Definition at line 427 of file vtkTemporalStreamTracer.h.

◆ LocalSeeds

vtkTemporalStreamTracerNamespace::ParticleVector vtkTemporalStreamTracer::LocalSeeds
protected

Definition at line 428 of file vtkTemporalStreamTracer.h.

◆ ParticleAge

vtkSmartPointer<vtkFloatArray> vtkTemporalStreamTracer::ParticleAge
protected

Definition at line 433 of file vtkTemporalStreamTracer.h.

◆ ParticleIds

vtkSmartPointer<vtkIntArray> vtkTemporalStreamTracer::ParticleIds
protected

Definition at line 434 of file vtkTemporalStreamTracer.h.

◆ ParticleSourceIds

vtkSmartPointer<vtkCharArray> vtkTemporalStreamTracer::ParticleSourceIds
protected

Definition at line 435 of file vtkTemporalStreamTracer.h.

◆ InjectedPointIds

vtkSmartPointer<vtkIntArray> vtkTemporalStreamTracer::InjectedPointIds
protected

Definition at line 436 of file vtkTemporalStreamTracer.h.

◆ InjectedStepIds

vtkSmartPointer<vtkIntArray> vtkTemporalStreamTracer::InjectedStepIds
protected

Definition at line 437 of file vtkTemporalStreamTracer.h.

◆ ErrorCodeArray

vtkSmartPointer<vtkIntArray> vtkTemporalStreamTracer::ErrorCodeArray
protected

Definition at line 438 of file vtkTemporalStreamTracer.h.

◆ ParticleVorticity

vtkSmartPointer<vtkFloatArray> vtkTemporalStreamTracer::ParticleVorticity
protected

Definition at line 439 of file vtkTemporalStreamTracer.h.

◆ ParticleRotation

vtkSmartPointer<vtkFloatArray> vtkTemporalStreamTracer::ParticleRotation
protected

Definition at line 440 of file vtkTemporalStreamTracer.h.

◆ ParticleAngularVel

vtkSmartPointer<vtkFloatArray> vtkTemporalStreamTracer::ParticleAngularVel
protected

Definition at line 441 of file vtkTemporalStreamTracer.h.

◆ cellVectors

vtkSmartPointer<vtkDoubleArray> vtkTemporalStreamTracer::cellVectors
protected

Definition at line 442 of file vtkTemporalStreamTracer.h.

◆ OutputPointData

vtkSmartPointer<vtkPointData> vtkTemporalStreamTracer::OutputPointData
protected

Definition at line 443 of file vtkTemporalStreamTracer.h.

◆ InterpolationCount

int vtkTemporalStreamTracer::InterpolationCount
protected

Definition at line 444 of file vtkTemporalStreamTracer.h.

◆ ParticleCells

vtkSmartPointer<vtkCellArray> vtkTemporalStreamTracer::ParticleCells
protected

Definition at line 447 of file vtkTemporalStreamTracer.h.

◆ OutputCoordinates

vtkSmartPointer<vtkPoints> vtkTemporalStreamTracer::OutputCoordinates
protected

Definition at line 448 of file vtkTemporalStreamTracer.h.

◆ MPISendList

vtkTemporalStreamTracerNamespace::ParticleVector vtkTemporalStreamTracer::MPISendList
protected

Definition at line 451 of file vtkTemporalStreamTracer.h.

◆ Interpolator

vtkSmartPointer<vtkTemporalInterpolatedVelocityField> vtkTemporalStreamTracer::Interpolator
protected

Definition at line 454 of file vtkTemporalStreamTracer.h.

◆ InputDataT

vtkSmartPointer<vtkMultiBlockDataSet> vtkTemporalStreamTracer::InputDataT[2]
protected

Definition at line 457 of file vtkTemporalStreamTracer.h.

◆ DataReferenceT

vtkSmartPointer<vtkDataSet> vtkTemporalStreamTracer::DataReferenceT[2]
protected

Definition at line 458 of file vtkTemporalStreamTracer.h.

◆ CachedBounds

std::vector<bounds> vtkTemporalStreamTracer::CachedBounds[2]
protected

Definition at line 464 of file vtkTemporalStreamTracer.h.

◆ UniqueIdCounter

vtkIdType vtkTemporalStreamTracer::UniqueIdCounter
protected

Definition at line 470 of file vtkTemporalStreamTracer.h.

◆ UniqueIdCounterMPI

vtkIdType vtkTemporalStreamTracer::UniqueIdCounterMPI
protected

Definition at line 471 of file vtkTemporalStreamTracer.h.

◆ substeps

int vtkTemporalStreamTracer::substeps
protected

Definition at line 473 of file vtkTemporalStreamTracer.h.


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