VTK  9.0.20200710
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPLagrangianParticleTracker Class Reference

parallel Lagrangian particle tracker More...

#include <vtkPLagrangianParticleTracker.h>

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

Public Types

typedef vtkLagrangianParticleTracker Superclass
 
- Public Types inherited from vtkLagrangianParticleTracker
enum  CellLengthComputation { STEP_CUR_CELL_LENGTH = 1, STEP_CUR_CELL_VEL_DIR = 3, STEP_CUR_CELL_DIV_THEO = 5 }
 
typedef vtkDataObjectAlgorithm Superclass
 
typedef enum vtkLagrangianParticleTracker::CellLengthComputation CellLengthComputation
 
- Public Types inherited from vtkDataObjectAlgorithm
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...
 
vtkPLagrangianParticleTrackerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkLagrangianParticleTracker
vtkLagrangianParticleTrackerNewInstance () const
 
void SetIntegrationModel (vtkLagrangianBasicIntegrationModel *integrationModel)
 Set/Get the integration model. More...
 
virtual vtkLagrangianBasicIntegrationModelGetIntegrationModel ()
 
void SetIntegrator (vtkInitialValueProblemSolver *integrator)
 Set/Get the integrator. More...
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
virtual void SetGeneratePolyVertexInteractionOutput (bool)
 Set/Get whether or not to use PolyVertex cell type for the interaction output Default is false. More...
 
virtual bool GetGeneratePolyVertexInteractionOutput ()
 
virtual void SetCellLengthComputationMode (int)
 Set/Get the cell length computation mode. More...
 
virtual int GetCellLengthComputationMode ()
 
virtual void SetStepFactor (double)
 Set/Get the integration step factor. More...
 
virtual double GetStepFactor ()
 
virtual void SetStepFactorMin (double)
 Set/Get the integration step factor min. More...
 
virtual double GetStepFactorMin ()
 
virtual void SetStepFactorMax (double)
 Set/Get the integration step factor max. More...
 
virtual double GetStepFactorMax ()
 
virtual void SetMaximumNumberOfSteps (int)
 Set/Get the maximum number of steps. More...
 
virtual int GetMaximumNumberOfSteps ()
 
virtual void SetMaximumIntegrationTime (double)
 Set/Get the maximum integration time. More...
 
virtual double GetMaximumIntegrationTime ()
 
virtual void SetAdaptiveStepReintegration (bool)
 Set/Get the Adaptive Step Reintegration feature. More...
 
virtual bool GetAdaptiveStepReintegration ()
 
virtual void AdaptiveStepReintegrationOn ()
 
virtual void AdaptiveStepReintegrationOff ()
 
virtual void SetGenerateParticlePathsOutput (bool)
 Set/Get the generation of the particle path output, Default is true. More...
 
virtual bool GetGenerateParticlePathsOutput ()
 
virtual void GenerateParticlePathsOutputOn ()
 
virtual void GenerateParticlePathsOutputOff ()
 
void SetSourceData (vtkDataObject *source)
 Specify the source object used to generate particle initial position (seeds). More...
 
vtkDataObjectGetSource ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the source object used to generate particle initial position (seeds). More...
 
void SetSurfaceData (vtkDataObject *source)
 Specify the source object used to compute surface interaction with Note that this method does not connect the pipeline. More...
 
vtkDataObjectGetSurface ()
 
void SetSurfaceConnection (vtkAlgorithmOutput *algOutput)
 Specify the object used to compute surface interaction with. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Declare input port type. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Declare output port type. More...
 
int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Create outputs objects. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Process inputs to integrate particle and generate output. More...
 
vtkMTimeType GetMTime () override
 Get the tracker modified time taking into account the integration model and the integrator. More...
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 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...
 
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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPLagrangianParticleTrackerSafeDownCast (vtkObjectBase *o)
 
static vtkPLagrangianParticleTrackerNew ()
 
- Static Public Member Functions inherited from vtkLagrangianParticleTracker
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLagrangianParticleTrackerSafeDownCast (vtkObjectBase *o)
 
static vtkLagrangianParticleTrackerNew ()
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPLagrangianParticleTracker ()
 
 ~vtkPLagrangianParticleTracker () override
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
void GenerateParticles (const vtkBoundingBox *bounds, vtkDataSet *seeds, vtkDataArray *initialVelocities, vtkDataArray *initialIntegrationTimes, vtkPointData *seedData, int nVar, std::queue< vtkLagrangianParticle * > &particles) override
 
void GetParticleFeed (std::queue< vtkLagrangianParticle * > &particleQueue) override
 Flags description : Worker flag working : the worker has at least one particle in it's queue and is currently integrating it. More...
 
int Integrate (vtkInitialValueProblemSolver *integrator, vtkLagrangianParticle *, std::queue< vtkLagrangianParticle * > &particleQueue, vtkPolyData *particlePathsOutput, vtkPolyLine *particlePath, vtkDataObject *interactionOutput) override
 This method is thread safe. More...
 
void ReceiveParticles (std::queue< vtkLagrangianParticle * > &particleQueue)
 Non threadsafe methods to receive particles. More...
 
void ReceiveTransferredParticleIds ()
 Non threadsafe methods to receive transferred particle ids. More...
 
bool FinalizeOutputs (vtkPolyData *particlePathsOutput, vtkDataObject *interactionOutput) override
 
bool UpdateSurfaceCacheIfNeeded (vtkDataObject *&surfaces) override
 
vtkIdType GetNewParticleId () override
 Get an unique id for a particle This method is thread safe. More...
 
void DeleteParticle (vtkLagrangianParticle *particle) override
 Delete a particle if not out of domain If out of domain, it will be stored and deleted later in case it needs to be registered as a transferred particle. More...
 
virtual vtkIdType GetParticleCounter ()
 Get the complete number of created particles. More...
 
- Protected Member Functions inherited from vtkLagrangianParticleTracker
 vtkLagrangianParticleTracker ()
 
 ~vtkLagrangianParticleTracker () override
 
virtual bool InitializeFlow (vtkDataObject *flow, vtkBoundingBox *bounds)
 
virtual bool InitializeParticles (const vtkBoundingBox *bounds, vtkDataSet *seeds, std::queue< vtkLagrangianParticle * > &particles, vtkPointData *seedData)
 
virtual void InitializeSurface (vtkDataObject *&surfaces)
 
virtual bool InitializePathsOutput (vtkPointData *seedData, vtkIdType numberOfSeeds, vtkPolyData *&particlePathsOutput)
 This method is thread safe. More...
 
virtual bool InitializeInteractionOutput (vtkPointData *seedData, vtkDataObject *surfaces, vtkDataObject *&interractionOutput)
 This method is thread safe. More...
 
void InsertPathOutputPoint (vtkLagrangianParticle *particle, vtkPolyData *particlePathsOutput, vtkIdList *particlePathPointId, bool prev=false)
 This method is thread safe. More...
 
void InsertInteractionOutputPoint (vtkLagrangianParticle *particle, unsigned int interactedSurfaceFlatIndex, vtkDataObject *interactionOutput)
 This method is thread safe. More...
 
double ComputeCellLength (vtkLagrangianParticle *particle)
 Computes the cell length for the next step using the method set by CellLengthComputationMode. More...
 
bool ComputeNextStep (vtkInitialValueProblemSolver *integrator, double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, double cellLength, int &integrationRes, vtkLagrangianParticle *particle)
 This method is thread safe. More...
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- 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 vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. 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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkNew< vtkUnstructuredGridTmpSurfaceInput
 
vtkNew< vtkMultiBlockDataSetTmpSurfaceInputMB
 
vtkMPIControllerController
 
ParticleStreamManager * StreamManager
 
ParticleIdManager * TransferredParticleIdManager
 
ParticleFeedManager * FeedManager
 
std::mutex StreamManagerMutex
 
std::mutex OutOfDomainParticleMapMutex
 
std::map< vtkIdType, vtkLagrangianParticle * > OutOfDomainParticleMap
 
- Protected Attributes inherited from vtkLagrangianParticleTracker
vtkLagrangianBasicIntegrationModelIntegrationModel
 
vtkInitialValueProblemSolverIntegrator
 
int CellLengthComputationMode
 
double StepFactor
 
double StepFactorMin
 
double StepFactorMax
 
int MaximumNumberOfSteps
 
double MaximumIntegrationTime
 
bool AdaptiveStepReintegration
 
bool GenerateParticlePathsOutput = true
 
bool GeneratePolyVertexInteractionOutput
 
std::atomic< vtkIdTypeParticleCounter
 
std::atomic< vtkIdTypeIntegratedParticleCounter
 
vtkIdType IntegratedParticleCounterIncrement
 
vtkPointDataSeedData
 
double MinimumVelocityMagnitude
 
double MinimumReductionFactor
 
vtkDataObjectFlowCache
 
vtkMTimeType FlowTime
 
vtkBoundingBox FlowBoundsCache
 
vtkDataObjectSurfacesCache
 
vtkMTimeType SurfacesTime
 
std::mutex ProgressMutex
 
vtkLagrangianThreadedDataSerialThreadedData
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkLagrangianParticleTracker
static void InsertPolyVertexCell (vtkPolyData *polydata)
 
static void InsertVertexCells (vtkPolyData *polydata)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

parallel Lagrangian particle tracker

This class implements parallel Lagrangian particle tracker. The implementation is as follows: First seeds input is parsed to create particle in each rank Particles which are not contained by the flow in a rank are sent to other ranks which can potentially contain it and will grab only if they actually contain it Then each rank begin integrating. When a particle goes out of domain, the particle will be sent to other ranks the same way. When a rank runs out of particle, it waits for other potential particles from other ranks. When all ranks run out of particles, integration is over. The master rank takes care of communications between rank regarding integration termination particles are directly streamed rank to rank, without going through the master

See also
vtkStreamTracer

Definition at line 53 of file vtkPLagrangianParticleTracker.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkPLagrangianParticleTracker.h.

Constructor & Destructor Documentation

◆ vtkPLagrangianParticleTracker()

vtkPLagrangianParticleTracker::vtkPLagrangianParticleTracker ( )
protected

◆ ~vtkPLagrangianParticleTracker()

vtkPLagrangianParticleTracker::~vtkPLagrangianParticleTracker ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPLagrangianParticleTracker::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLagrangianParticleTracker.

◆ NewInstance()

vtkPLagrangianParticleTracker* vtkPLagrangianParticleTracker::NewInstance ( ) const

◆ PrintSelf()

void vtkPLagrangianParticleTracker::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 vtkLagrangianParticleTracker.

◆ New()

static vtkPLagrangianParticleTracker* vtkPLagrangianParticleTracker::New ( )
static

◆ RequestUpdateExtent()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

◆ GenerateParticles()

void vtkPLagrangianParticleTracker::GenerateParticles ( const vtkBoundingBox bounds,
vtkDataSet seeds,
vtkDataArray initialVelocities,
vtkDataArray initialIntegrationTimes,
vtkPointData seedData,
int  nVar,
std::queue< vtkLagrangianParticle * > &  particles 
)
overrideprotectedvirtual

Reimplemented from vtkLagrangianParticleTracker.

◆ GetParticleFeed()

void vtkPLagrangianParticleTracker::GetParticleFeed ( std::queue< vtkLagrangianParticle * > &  particleQueue)
overrideprotectedvirtual

Flags description : Worker flag working : the worker has at least one particle in it's queue and is currently integrating it.

Worker flag empty : the worker has no more particle in it's queue and is activelly waiting for more particle to integrate from other ranks. Worker flag finished : the worker has received a master empty flag and after checking one last time, still doesn't have any particle to integrate. It is now just waiting for master to send the master finished flag. Master flag working : there is at least one worker or the master that have one or more particle to integrate. Master flag empty : all ranks, including master, have no more particles to integrate Master flag finished : all workers ranks have sent the worker flag finished

Reimplemented from vtkLagrangianParticleTracker.

◆ Integrate()

int vtkPLagrangianParticleTracker::Integrate ( vtkInitialValueProblemSolver integrator,
vtkLagrangianParticle ,
std::queue< vtkLagrangianParticle * > &  ,
vtkPolyData particlePathsOutput,
vtkPolyLine particlePath,
vtkDataObject interactionOutput 
)
overrideprotectedvirtual

This method is thread safe.

Reimplemented from vtkLagrangianParticleTracker.

◆ ReceiveParticles()

void vtkPLagrangianParticleTracker::ReceiveParticles ( std::queue< vtkLagrangianParticle * > &  particleQueue)
protected

Non threadsafe methods to receive particles.

◆ ReceiveTransferredParticleIds()

void vtkPLagrangianParticleTracker::ReceiveTransferredParticleIds ( )
protected

Non threadsafe methods to receive transferred particle ids.

◆ FinalizeOutputs()

bool vtkPLagrangianParticleTracker::FinalizeOutputs ( vtkPolyData particlePathsOutput,
vtkDataObject interactionOutput 
)
overrideprotectedvirtual

Reimplemented from vtkLagrangianParticleTracker.

◆ UpdateSurfaceCacheIfNeeded()

bool vtkPLagrangianParticleTracker::UpdateSurfaceCacheIfNeeded ( vtkDataObject *&  surfaces)
overrideprotectedvirtual

Reimplemented from vtkLagrangianParticleTracker.

◆ GetNewParticleId()

vtkIdType vtkPLagrangianParticleTracker::GetNewParticleId ( )
overrideprotectedvirtual

Get an unique id for a particle This method is thread safe.

Reimplemented from vtkLagrangianParticleTracker.

◆ DeleteParticle()

void vtkPLagrangianParticleTracker::DeleteParticle ( vtkLagrangianParticle particle)
overrideprotectedvirtual

Delete a particle if not out of domain If out of domain, it will be stored and deleted later in case it needs to be registered as a transferred particle.

Reimplemented from vtkLagrangianParticleTracker.

◆ GetParticleCounter()

virtual vtkIdType vtkPLagrangianParticleTracker::GetParticleCounter ( )
protectedvirtual

Get the complete number of created particles.

Member Data Documentation

◆ TmpSurfaceInput

vtkNew<vtkUnstructuredGrid> vtkPLagrangianParticleTracker::TmpSurfaceInput
protected

Definition at line 120 of file vtkPLagrangianParticleTracker.h.

◆ TmpSurfaceInputMB

vtkNew<vtkMultiBlockDataSet> vtkPLagrangianParticleTracker::TmpSurfaceInputMB
protected

Definition at line 123 of file vtkPLagrangianParticleTracker.h.

◆ Controller

vtkMPIController* vtkPLagrangianParticleTracker::Controller
protected

Definition at line 124 of file vtkPLagrangianParticleTracker.h.

◆ StreamManager

ParticleStreamManager* vtkPLagrangianParticleTracker::StreamManager
protected

Definition at line 125 of file vtkPLagrangianParticleTracker.h.

◆ TransferredParticleIdManager

ParticleIdManager* vtkPLagrangianParticleTracker::TransferredParticleIdManager
protected

Definition at line 126 of file vtkPLagrangianParticleTracker.h.

◆ FeedManager

ParticleFeedManager* vtkPLagrangianParticleTracker::FeedManager
protected

Definition at line 127 of file vtkPLagrangianParticleTracker.h.

◆ StreamManagerMutex

std::mutex vtkPLagrangianParticleTracker::StreamManagerMutex
protected

Definition at line 129 of file vtkPLagrangianParticleTracker.h.

◆ OutOfDomainParticleMapMutex

std::mutex vtkPLagrangianParticleTracker::OutOfDomainParticleMapMutex
protected

Definition at line 130 of file vtkPLagrangianParticleTracker.h.

◆ OutOfDomainParticleMap

std::map<vtkIdType, vtkLagrangianParticle*> vtkPLagrangianParticleTracker::OutOfDomainParticleMap
protected

Definition at line 132 of file vtkPLagrangianParticleTracker.h.


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