VTK
vtkLagrangianParticleTracker.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLagrangianParticleTracker.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 =========================================================================*/
90 #ifndef vtkLagrangianParticleTracker_h
91 #define vtkLagrangianParticleTracker_h
92 
93 #include "vtkFiltersFlowPathsModule.h" // For export macro
94 #include "vtkDataObjectAlgorithm.h"
95 #include "vtkBoundingBox.h" // For cached bounds
96 
97 #include <queue> // for particle queue
98 
99 class vtkBoundingBox;
100 class vtkCellArray;
101 class vtkDataSet;
102 class vtkDoubleArray;
103 class vtkIdList;
104 class vtkInformation;
108 class vtkPointData;
109 class vtkPoints;
110 class vtkPolyData;
111 
112 class VTKFILTERSFLOWPATHS_EXPORT vtkLagrangianParticleTracker :
114 {
115 public:
116 
118  void PrintSelf(ostream& os, vtkIndent indent) override;
120 
121  typedef enum CellLengthComputation{
122  STEP_LAST_CELL_LENGTH = 0,
123  STEP_CUR_CELL_LENGTH = 1,
124  STEP_LAST_CELL_VEL_DIR = 2,
125  STEP_CUR_CELL_VEL_DIR = 3,
126  STEP_LAST_CELL_DIV_THEO = 4,
127  STEP_CUR_CELL_DIV_THEO = 5
128  } CellLengthComputation;
129 
131 
136  vtkGetObjectMacro(IntegrationModel, vtkLagrangianBasicIntegrationModel);
138 
140 
145  vtkGetObjectMacro(Integrator, vtkInitialValueProblemSolver);
147 
149 
154  vtkSetMacro(GeneratePolyVertexInteractionOutput, bool);
155  vtkGetMacro(GeneratePolyVertexInteractionOutput, bool);
157 
159 
184  vtkSetMacro(CellLengthComputationMode, int);
185  vtkGetMacro(CellLengthComputationMode, int);
187 
189 
192  vtkSetMacro(StepFactor, double);
193  vtkGetMacro(StepFactor, double);
195 
197 
200  vtkSetMacro(StepFactorMin, double);
201  vtkGetMacro(StepFactorMin, double);
203 
205 
208  vtkSetMacro(StepFactorMax, double);
209  vtkGetMacro(StepFactorMax, double);
211 
213 
216  vtkSetMacro(MaximumNumberOfSteps, int);
217  vtkGetMacro(MaximumNumberOfSteps, int);
219 
221 
225  vtkSetMacro(MaximumIntegrationTime, double);
226  vtkGetMacro(MaximumIntegrationTime, double);
228 
230 
236  vtkSetMacro(AdaptiveStepReintegration, bool);
237  vtkGetMacro(AdaptiveStepReintegration, bool);
238  vtkBooleanMacro(AdaptiveStepReintegration, bool);
240 
242 
248  vtkSetMacro(UseParticlePathsRenderingThreshold, bool);
249  vtkGetMacro(UseParticlePathsRenderingThreshold, bool);
250  vtkBooleanMacro(UseParticlePathsRenderingThreshold, bool);
252 
254 
260  vtkSetMacro(ParticlePathsRenderingPointsThreshold, int);
261  vtkGetMacro(ParticlePathsRenderingPointsThreshold, int);
263 
265 
274 
279 
281 
290 
295 
300 
305 
311  vtkInformationVector*) override;
312 
317  vtkInformationVector **inputVector,
318  vtkInformationVector *outputVector) override;
319 
324  vtkMTimeType GetMTime() override;
325 
330 
331 protected:
334 
335  virtual bool InitializeInputs(vtkInformationVector **inputVector,
336  vtkDataObject*& flow, vtkDataObject*& seeds, vtkDataObject*& surfaces,
337  std::queue<vtkLagrangianParticle*>& particleQueue, vtkPointData* seedData);
338  virtual bool InitializeFlow(vtkDataObject* flow, vtkBoundingBox* bounds);
339  virtual bool InitializeParticles(const vtkBoundingBox* bounds, vtkDataObject* seeds,
340  std::queue<vtkLagrangianParticle*>& particles, vtkPointData* seedData);
341  virtual void GenerateParticles(const vtkBoundingBox* bounds, vtkDataSet* seeds,
342  vtkDataArray* initialVelocities, vtkDataArray* initialIntegrationTimes,
343  vtkPointData* seedData, int nVar, std::queue<vtkLagrangianParticle*>& particles);
344  virtual bool UpdateSurfaceCacheIfNeeded(vtkDataObject*& surfaces);
345  virtual void InitializeSurface(vtkDataObject*& surfaces);
346  virtual bool InitializeOutputs(vtkInformationVector *outputVector, vtkPointData* seedData,
347  vtkIdType numberOfSeeds, vtkDataObject* surfaces,
348  vtkPolyData*& particlePathsOutput, vtkDataObject*& interactionOutput);
349 
350  virtual bool InitializePathsOutput(vtkInformationVector *outputVector,
351  vtkPointData* seedData, vtkIdType numberOfSeeds,
352  vtkPolyData*& particlePathsOutput);
353 
355  vtkPointData* seedData, vtkDataObject* surfaces, vtkDataObject*& interractionOutput);
356 
357  virtual void InitializeParticleData(vtkFieldData* particleData, int maxTuples = 0);
360 
361  virtual bool FinalizeOutputs(vtkPolyData* particlePathsOutput,
362  vtkDataObject* interractionOutput);
363 
364  static void InsertPolyVertexCell(vtkPolyData* polydata);
365  static void InsertVertexCells(vtkPolyData* polydata);
366 
367  virtual void GetParticleFeed(std::queue<vtkLagrangianParticle*>& particleQueue);
368 
369  virtual int Integrate(vtkLagrangianParticle*, std::queue<vtkLagrangianParticle*>&,
370  vtkPolyData* particlePathsOutput, vtkIdList* particlePathPointId,
371  vtkDataObject* interactionOutput);
372 
374  vtkPolyData* particlePathsOutput, vtkIdList* particlePathPointId,
375  bool prev = false);
376 
378  unsigned int interactedSurfaceFlatIndex, vtkDataObject* interactionOutput);
379 
384 
386 
388  double* xprev, double* xnext,
389  double t, double& delT, double& delTActual,
390  double minStep, double maxStep,
391  int& integrationRes);
392 
393  virtual bool CheckParticlePathsRenderingThreshold(vtkPolyData* particlePathsOutput);
394 
397 
399  double StepFactor;
409 
410  // internal parameters use for step computation
413 
414  // Cache related parameters
420 
421 private:
423  void operator=(const vtkLagrangianParticleTracker&) = delete;
424 };
425 
426 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:40
vtkLagrangianParticleTracker::ParticlePathsRenderingPointsThreshold
int ParticlePathsRenderingPointsThreshold
Definition: vtkLagrangianParticleTracker.h:407
vtkLagrangianParticleTracker
Filter to inject and track particles in a flow.
Definition: vtkLagrangianParticleTracker.h:114
vtkLagrangianParticleTracker::CheckParticlePathsRenderingThreshold
virtual bool CheckParticlePathsRenderingThreshold(vtkPolyData *particlePathsOutput)
vtkLagrangianParticleTracker::ComputeCellLength
double ComputeCellLength(vtkLagrangianParticle *particle)
vtkLagrangianBasicIntegrationModel
vtkFunctionSet abstract implementation to be used in the vtkLagrangianParticleTracker integrator.
Definition: vtkLagrangianBasicIntegrationModel.h:87
vtkLagrangianParticleTracker::UseParticlePathsRenderingThreshold
bool UseParticlePathsRenderingThreshold
Definition: vtkLagrangianParticleTracker.h:405
vtkLagrangianParticleTracker::MaximumIntegrationTime
double MaximumIntegrationTime
Definition: vtkLagrangianParticleTracker.h:403
vtkLagrangianParticleTracker::GenerateParticles
virtual void GenerateParticles(const vtkBoundingBox *bounds, vtkDataSet *seeds, vtkDataArray *initialVelocities, vtkDataArray *initialIntegrationTimes, vtkPointData *seedData, int nVar, std::queue< vtkLagrangianParticle * > &particles)
vtkLagrangianParticleTracker::IntegrationModel
vtkLagrangianBasicIntegrationModel * IntegrationModel
Definition: vtkLagrangianParticleTracker.h:395
vtkLagrangianParticleTracker::InitializeOutputs
virtual bool InitializeOutputs(vtkInformationVector *outputVector, vtkPointData *seedData, vtkIdType numberOfSeeds, vtkDataObject *surfaces, vtkPolyData *&particlePathsOutput, vtkDataObject *&interactionOutput)
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:38
vtkLagrangianParticleTracker::InitializeInteractionData
virtual void InitializeInteractionData(vtkFieldData *data)
vtkLagrangianParticleTracker::StepFactorMax
double StepFactorMax
Definition: vtkLagrangianParticleTracker.h:401
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkLagrangianParticleTracker::GetSurface
vtkDataObject * GetSurface()
vtkLagrangianParticleTracker::InsertPathOutputPoint
void InsertPathOutputPoint(vtkLagrangianParticle *particle, vtkPolyData *particlePathsOutput, vtkIdList *particlePathPointId, bool prev=false)
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkLagrangianParticleTracker::InsertPathData
void InsertPathData(vtkLagrangianParticle *particle, vtkFieldData *data)
vtkLagrangianParticleTracker::~vtkLagrangianParticleTracker
~vtkLagrangianParticleTracker() override
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkLagrangianParticleTracker::GeneratePolyVertexInteractionOutput
bool GeneratePolyVertexInteractionOutput
Definition: vtkLagrangianParticleTracker.h:406
vtkLagrangianParticleTracker::UpdateSurfaceCacheIfNeeded
virtual bool UpdateSurfaceCacheIfNeeded(vtkDataObject *&surfaces)
vtkDataObjectAlgorithm
Superclass for algorithms that produce only data object as output.
Definition: vtkDataObjectAlgorithm.h:44
vtkLagrangianParticleTracker::InitializeParticleData
virtual void InitializeParticleData(vtkFieldData *particleData, int maxTuples=0)
vtkLagrangianParticleTracker::MaximumNumberOfSteps
int MaximumNumberOfSteps
Definition: vtkLagrangianParticleTracker.h:402
vtkLagrangianParticleTracker::GetNewParticleId
virtual vtkIdType GetNewParticleId()
Get an unique id for a particle.
vtkLagrangianParticleTracker::StepFactorMin
double StepFactorMin
Definition: vtkLagrangianParticleTracker.h:400
vtkLagrangianParticleTracker::InitializeInteractionOutput
virtual bool InitializeInteractionOutput(vtkInformationVector *outputVector, vtkPointData *seedData, vtkDataObject *surfaces, vtkDataObject *&interractionOutput)
vtkLagrangianParticleTracker::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLagrangianParticleTracker::SetSourceConnection
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the source object used to generate particle initial position (seeds).
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkLagrangianParticleTracker::vtkLagrangianParticleTracker
vtkLagrangianParticleTracker()
vtkLagrangianParticleTracker::MinimumVelocityMagnitude
double MinimumVelocityMagnitude
Definition: vtkLagrangianParticleTracker.h:411
vtkLagrangianParticleTracker::FlowTime
vtkMTimeType FlowTime
Definition: vtkLagrangianParticleTracker.h:416
vtkLagrangianParticleTracker::StepFactor
double StepFactor
Definition: vtkLagrangianParticleTracker.h:399
vtkFieldData
represent and manipulate fields of data
Definition: vtkFieldData.h:57
vtkLagrangianParticleTracker::CellLengthComputation
CellLengthComputation
Definition: vtkLagrangianParticleTracker.h:121
vtkLagrangianParticleTracker::Integrate
virtual int Integrate(vtkLagrangianParticle *, std::queue< vtkLagrangianParticle * > &, vtkPolyData *particlePathsOutput, vtkIdList *particlePathPointId, vtkDataObject *interactionOutput)
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:825
vtkLagrangianParticleTracker::GetSource
vtkDataObject * GetSource()
vtkLagrangianParticleTracker::InitializePathsOutput
virtual bool InitializePathsOutput(vtkInformationVector *outputVector, vtkPointData *seedData, vtkIdType numberOfSeeds, vtkPolyData *&particlePathsOutput)
vtkBoundingBox
Fast Simple Class for dealing with 3D bounds.
Definition: vtkBoundingBox.h:36
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkLagrangianParticleTracker::InitializeFlow
virtual bool InitializeFlow(vtkDataObject *flow, vtkBoundingBox *bounds)
vtkLagrangianParticleTracker::CellLengthComputationMode
int CellLengthComputationMode
Definition: vtkLagrangianParticleTracker.h:398
vtkLagrangianParticleTracker::GetMTime
vtkMTimeType GetMTime() override
Get the tracker modified time taking into account the integration model and the integrator.
vtkLagrangianParticleTracker::InsertInteractionData
void InsertInteractionData(vtkLagrangianParticle *particle, vtkFieldData *data)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkLagrangianParticleTracker::SetSurfaceData
void SetSurfaceData(vtkDataObject *source)
Specify the source object used to compute surface interaction with Note that this method does not con...
vtkLagrangianParticleTracker::FinalizeOutputs
virtual bool FinalizeOutputs(vtkPolyData *particlePathsOutput, vtkDataObject *interractionOutput)
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:51
vtkLagrangianParticleTracker::ParticleCounter
vtkIdType ParticleCounter
Definition: vtkLagrangianParticleTracker.h:408
vtkLagrangianParticleTracker::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Declare input port type.
vtkLagrangianParticleTracker::RequestDataObject
int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Create outputs objects.
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:37
vtkLagrangianParticleTracker::SurfacesCache
vtkDataObject * SurfacesCache
Definition: vtkLagrangianParticleTracker.h:418
vtkLagrangianParticleTracker::InsertInteractionOutputPoint
void InsertInteractionOutputPoint(vtkLagrangianParticle *particle, unsigned int interactedSurfaceFlatIndex, vtkDataObject *interactionOutput)
vtkLagrangianParticleTracker::InsertParticleData
void InsertParticleData(vtkLagrangianParticle *particle, vtkFieldData *data, int stepEnum)
vtkLagrangianParticleTracker::InsertVertexCells
static void InsertVertexCells(vtkPolyData *polydata)
vtkLagrangianParticleTracker::SurfacesTime
vtkMTimeType SurfacesTime
Definition: vtkLagrangianParticleTracker.h:419
vtkLagrangianParticleTracker::ComputeNextStep
bool ComputeNextStep(double *xprev, double *xnext, double t, double &delT, double &delTActual, double minStep, double maxStep, int &integrationRes)
vtkLagrangianParticleTracker::GetParticleFeed
virtual void GetParticleFeed(std::queue< vtkLagrangianParticle * > &particleQueue)
vtkLagrangianParticleTracker::InitializeSurface
virtual void InitializeSurface(vtkDataObject *&surfaces)
vtkBoundingBox.h
vtkLagrangianParticleTracker::InitializeInputs
virtual bool InitializeInputs(vtkInformationVector **inputVector, vtkDataObject *&flow, vtkDataObject *&seeds, vtkDataObject *&surfaces, std::queue< vtkLagrangianParticle * > &particleQueue, vtkPointData *seedData)
vtkLagrangianParticle
Basis class for Lagrangian particles.
Definition: vtkLagrangianParticle.h:42
vtkLagrangianParticleTracker::FillOutputPortInformation
int FillOutputPortInformation(int port, vtkInformation *info) override
Declare output port type.
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkLagrangianParticleTracker::AdaptiveStepReintegration
bool AdaptiveStepReintegration
Definition: vtkLagrangianParticleTracker.h:404
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkLagrangianParticleTracker::FlowCache
vtkDataObject * FlowCache
Definition: vtkLagrangianParticleTracker.h:415
vtkLagrangianParticleTracker::New
static vtkLagrangianParticleTracker * New()
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:40
vtkLagrangianParticleTracker::SetIntegrationModel
void SetIntegrationModel(vtkLagrangianBasicIntegrationModel *integrationModel)
Set/Get the integration model.
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
vtkLagrangianParticleTracker::InitializePathData
virtual void InitializePathData(vtkFieldData *data)
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:42
vtkLagrangianParticleTracker::InitializeParticles
virtual bool InitializeParticles(const vtkBoundingBox *bounds, vtkDataObject *seeds, std::queue< vtkLagrangianParticle * > &particles, vtkPointData *seedData)
vtkLagrangianParticleTracker::SetSurfaceConnection
void SetSurfaceConnection(vtkAlgorithmOutput *algOutput)
Specify the object used to compute surface interaction with.
vtkDataObjectAlgorithm.h
vtkLagrangianParticleTracker::InsertPolyVertexCell
static void InsertPolyVertexCell(vtkPolyData *polydata)
vtkLagrangianParticleTracker::SetSourceData
void SetSourceData(vtkDataObject *source)
Specify the source object used to generate particle initial position (seeds).
vtkInitialValueProblemSolver
Integrate a set of ordinary differential equations (initial value problem) in time.
Definition: vtkInitialValueProblemSolver.h:41
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkLagrangianParticleTracker::SetIntegrator
void SetIntegrator(vtkInitialValueProblemSolver *integrator)
Set/Get the integrator.
vtkLagrangianParticleTracker::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Process inputs to integrate particle and generate output.
vtkLagrangianParticleTracker::Integrator
vtkInitialValueProblemSolver * Integrator
Definition: vtkLagrangianParticleTracker.h:396
vtkLagrangianParticleTracker::FlowBoundsCache
vtkBoundingBox FlowBoundsCache
Definition: vtkLagrangianParticleTracker.h:417
vtkLagrangianParticleTracker::MinimumReductionFactor
double MinimumReductionFactor
Definition: vtkLagrangianParticleTracker.h:412
vtkLagrangianParticleTracker::InsertSeedData
void InsertSeedData(vtkLagrangianParticle *particle, vtkFieldData *data)
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302