VTK  9.0.1
vtkPLagrangianParticleTracker.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPLagrangianParticleTracker.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
37 #ifndef vtkPLagrangianParticleTracker_h
38 #define vtkPLagrangianParticleTracker_h
39 
40 #include "vtkFiltersParallelFlowPathsModule.h" // For export macro
42 #include "vtkNew.h" // for ivars
43 
44 class MasterFlagManager;
45 class ParticleStreamManager;
46 class RankFlagManager;
47 class vtkMPIController;
50 
51 class VTKFILTERSPARALLELFLOWPATHS_EXPORT vtkPLagrangianParticleTracker
53 {
54 public:
56  virtual void PrintSelf(ostream& os, vtkIndent indent) override;
58 
59 protected:
62 
63  virtual int RequestUpdateExtent(
65 
66  void GenerateParticles(const vtkBoundingBox* bounds, vtkDataSet* seeds,
67  vtkDataArray* initialVelocities, vtkDataArray* initialIntegrationTimes, vtkPointData* seedData,
68  int nVar, std::queue<vtkLagrangianParticle*>& particles) override;
69 
84  virtual void GetParticleFeed(std::queue<vtkLagrangianParticle*>& particleQueue) override;
86  std::queue<vtkLagrangianParticle*>& particleQueue, vtkPolyData* particlePathsOutput,
87  vtkPolyLine* particlePath, vtkDataObject* interactionOutput) override;
88 
90 
93  void SendParticle(vtkLagrangianParticle* particle);
94  void ReceiveParticles(std::queue<vtkLagrangianParticle*>& particleQueue);
96 
97  bool FinalizeOutputs(vtkPolyData* particlePathsOutput, vtkDataObject* interactionOutput) override;
98 
99  bool UpdateSurfaceCacheIfNeeded(vtkDataObject*& surfaces) override;
100 
105  virtual vtkIdType GetNewParticleId() override;
106 
110  vtkGetMacro(ParticleCounter, vtkIdType);
111 
115  ParticleStreamManager* StreamManager;
116  MasterFlagManager* MFlagManager;
117  RankFlagManager* RFlagManager;
118 
119  std::mutex StreamManagerMutex;
120 
121 private:
123  void operator=(const vtkPLagrangianParticleTracker&) = delete;
124 };
125 #endif
vtkLagrangianParticleTracker::Integrate
virtual int Integrate(vtkInitialValueProblemSolver *integrator, vtkLagrangianParticle *, std::queue< vtkLagrangianParticle * > &, vtkPolyData *particlePathsOutput, vtkPolyLine *particlePath, vtkDataObject *interactionOutput)
This method is thread safe.
vtkPLagrangianParticleTracker::Controller
vtkMPIController * Controller
Definition: vtkPLagrangianParticleTracker.h:114
vtkLagrangianParticleTracker
Filter to inject and track particles in a flow.
Definition: vtkLagrangianParticleTracker.h:116
vtkPLagrangianParticleTracker::StreamManager
ParticleStreamManager * StreamManager
Definition: vtkPLagrangianParticleTracker.h:115
vtkLagrangianParticleTracker::GenerateParticles
virtual void GenerateParticles(const vtkBoundingBox *bounds, vtkDataSet *seeds, vtkDataArray *initialVelocities, vtkDataArray *initialIntegrationTimes, vtkPointData *seedData, int nVar, std::queue< vtkLagrangianParticle * > &particles)
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:31
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkLagrangianParticleTracker::UpdateSurfaceCacheIfNeeded
virtual bool UpdateSurfaceCacheIfNeeded(vtkDataObject *&surfaces)
vtkPLagrangianParticleTracker::TmpSurfaceInputMB
vtkNew< vtkMultiBlockDataSet > TmpSurfaceInputMB
Definition: vtkPLagrangianParticleTracker.h:113
vtkLagrangianParticleTracker::GetNewParticleId
virtual vtkIdType GetNewParticleId()
Get an unique id for a particle This method is thread safe.
vtkPLagrangianParticleTracker::RFlagManager
RankFlagManager * RFlagManager
Definition: vtkPLagrangianParticleTracker.h:117
vtkLagrangianParticleTracker::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPLagrangianParticleTracker::StreamManagerMutex
std::mutex StreamManagerMutex
Definition: vtkPLagrangianParticleTracker.h:119
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkMultiBlockDataSet
Composite dataset that organizes datasets into blocks.
Definition: vtkMultiBlockDataSet.h:45
vtkLagrangianParticleTracker.h
vtkPLagrangianParticleTracker::TmpSurfaceInput
vtkNew< vtkUnstructuredGrid > TmpSurfaceInput
Definition: vtkPLagrangianParticleTracker.h:110
vtkBoundingBox
Fast, simple class for dealing with 3D bounds.
Definition: vtkBoundingBox.h:34
vtkDataObjectAlgorithm::RequestUpdateExtent
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkDataObjectAlgorithm.h:111
vtkPolyLine
cell represents a set of 1D lines
Definition: vtkPolyLine.h:36
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkNew< vtkUnstructuredGrid >
vtkPLagrangianParticleTracker
parallel Lagrangian particle tracker
Definition: vtkPLagrangianParticleTracker.h:51
vtkLagrangianParticleTracker::GetParticleFeed
virtual void GetParticleFeed(std::queue< vtkLagrangianParticle * > &particleQueue)
vtkLagrangianParticle
Basis class for Lagrangian particles.
Definition: vtkLagrangianParticle.h:46
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkPLagrangianParticleTracker::MFlagManager
MasterFlagManager * MFlagManager
Definition: vtkPLagrangianParticleTracker.h:116
vtkNew.h
vtkLagrangianParticleTracker::New
static vtkLagrangianParticleTracker * New()
vtkLagrangianParticleTracker::FinalizeOutputs
virtual bool FinalizeOutputs(vtkPolyData *particlePathsOutput, vtkDataObject *interactionOutput)
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkUnstructuredGrid
dataset represents arbitrary combinations of all possible cell types
Definition: vtkUnstructuredGrid.h:92
vtkInitialValueProblemSolver
Integrate a set of ordinary differential equations (initial value problem) in time.
Definition: vtkInitialValueProblemSolver.h:40
vtkMPIController
Process communication using MPI.
Definition: vtkMPIController.h:55
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59