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 
134  void SetIntegrationModel(vtkLagrangianBasicIntegrationModel* integrationModel);
135  vtkGetObjectMacro(IntegrationModel, vtkLagrangianBasicIntegrationModel);
137 
139 
142  void SetIntegrator(vtkInitialValueProblemSolver* integrator);
143  vtkGetObjectMacro(Integrator, vtkInitialValueProblemSolver);
145 
147 
171  vtkSetMacro(CellLengthComputationMode, int);
172  vtkGetMacro(CellLengthComputationMode, int);
174 
176 
179  vtkSetMacro(StepFactor, double);
180  vtkGetMacro(StepFactor, double);
182 
184 
187  vtkSetMacro(StepFactorMin, double);
188  vtkGetMacro(StepFactorMin, double);
190 
192 
195  vtkSetMacro(StepFactorMax, double);
196  vtkGetMacro(StepFactorMax, double);
198 
200 
203  vtkSetMacro(MaximumNumberOfSteps, int);
204  vtkGetMacro(MaximumNumberOfSteps, int);
206 
208 
213  vtkSetMacro(AdaptiveStepReintegration, bool);
214  vtkGetMacro(AdaptiveStepReintegration, bool);
215  vtkBooleanMacro(AdaptiveStepReintegration, bool);
217 
219 
222  vtkSetMacro(UseParticlePathsRenderingThreshold, bool);
223  vtkGetMacro(UseParticlePathsRenderingThreshold, bool);
224  vtkBooleanMacro(UseParticlePathsRenderingThreshold, bool);
226 
228 
231  vtkSetMacro(ParticlePathsRenderingPointsThreshold, int);
232  vtkGetMacro(ParticlePathsRenderingPointsThreshold, int);
234 
236 
239  vtkSetMacro(CreateOutOfDomainParticle, bool);
240  vtkGetMacro(CreateOutOfDomainParticle, bool);
241  vtkBooleanMacro(CreateOutOfDomainParticle, bool);
243 
245 
251  void SetSourceData(vtkDataObject* source);
252  vtkDataObject* GetSource();
254 
258  void SetSourceConnection(vtkAlgorithmOutput* algOutput);
259 
261 
267  void SetSurfaceData(vtkDataObject *source);
268  vtkDataObject *GetSurface();
270 
274  void SetSurfaceConnection(vtkAlgorithmOutput* algOutput);
275 
279  int FillInputPortInformation(int port, vtkInformation* info) override;
280 
285 
291  vtkInformationVector*) override;
292 
296  int RequestData(vtkInformation *request,
297  vtkInformationVector **inputVector,
298  vtkInformationVector *outputVector) override;
299 
304  vtkMTimeType GetMTime() override;
305 
309  virtual vtkIdType GetNewParticleId();
310 
311 protected:
313  ~vtkLagrangianParticleTracker() override;
314 
315  virtual bool InitializeInputs(vtkInformationVector **inputVector,
316  vtkDataObject*& flow, vtkDataObject*& seeds, vtkDataObject*& surfaces,
317  std::queue<vtkLagrangianParticle*>& particleQueue, vtkPointData* seedData);
318  virtual bool InitializeFlow(vtkDataObject* flow, vtkBoundingBox* bounds);
319  virtual bool InitializeParticles(const vtkBoundingBox* bounds, vtkDataObject* seeds,
320  std::queue<vtkLagrangianParticle*>& particles, vtkPointData* seedData);
321  virtual void GenerateParticles(const vtkBoundingBox* bounds, vtkDataSet* seeds,
322  vtkDataArray* initialVelocities, vtkDataArray* initialIntegrationTimes,
323  vtkPointData* seedData, int nVar, std::queue<vtkLagrangianParticle*>& particles);
324  virtual bool UpdateSurfaceCacheIfNeeded(vtkDataObject*& surfaces);
325  virtual void InitializeSurface(vtkDataObject*& surfaces);
326  virtual bool InitializeOutputs(vtkInformationVector *outputVector, vtkPointData* seedData,
327  vtkIdType numberOfSeeds, vtkDataObject* surfaces,
328  vtkPolyData*& particlePathsOutput, vtkDataObject*& interactionOutput);
329 
330  virtual bool InitializePathsOutput(vtkInformationVector *outputVector,
331  vtkPointData* seedData, vtkIdType numberOfSeeds,
332  vtkPolyData*& particlePathsOutput);
333 
334  virtual bool InitializeInteractionOutput(vtkInformationVector *outputVector,
335  vtkPointData* seedData, vtkDataObject* surfaces, vtkDataObject*& interractionOutput);
336 
337  virtual void InitializeParticleData(vtkFieldData* particleData, int maxTuples = 0);
338  virtual void InitializePathData(vtkFieldData* data);
339  virtual void InitializeInteractionData(vtkFieldData* data);
340 
341  virtual bool FinalizeOutputs(vtkPolyData* particlePathsOutput,
342  vtkDataObject* interractionOutput);
343 
344  static void InsertPolyVertexCell(vtkPolyData* polydata);
345 
346  virtual void GetParticleFeed(std::queue<vtkLagrangianParticle*>& particleQueue);
347 
348  virtual int Integrate(vtkLagrangianParticle*, std::queue<vtkLagrangianParticle*>&,
349  vtkPolyData* particlePathsOutput, vtkIdList* particlePathPointId,
350  vtkDataObject* interactionOutput);
351 
352  void InsertPathOutputPoint(vtkLagrangianParticle* particle,
353  vtkPolyData* particlePathsOutput, vtkIdList* particlePathPointId,
354  bool prev = false);
355 
356  void InsertInteractionOutputPoint(vtkLagrangianParticle* particle,
357  unsigned int interactedSurfaceFlatIndex, vtkDataObject* interactionOutput);
358 
359  void InsertSeedData(vtkLagrangianParticle* particle, vtkFieldData* data);
360  void InsertPathData(vtkLagrangianParticle* particle, vtkFieldData* data);
361  void InsertInteractionData(vtkLagrangianParticle* particle, vtkFieldData* data);
362  void InsertParticleData(vtkLagrangianParticle* particle, vtkFieldData* data, int stepEnum);
363 
364  double ComputeCellLength(vtkLagrangianParticle* particle);
365 
366  bool ComputeNextStep(
367  double* xprev, double* xnext,
368  double t, double& delT, double& delTActual,
369  double minStep, double maxStep,
370  int& integrationRes);
371 
372  virtual bool CheckParticlePathsRenderingThreshold(vtkPolyData* particlePathsOutput);
373 
376 
378  double StepFactor;
387 
388  // internal parameters use for step computation
391 
392  // Cache related parameters
398 
399 private:
401  void operator=(const vtkLagrangianParticleTracker&) = delete;
402 };
403 
404 #endif
virtual int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
represent and manipulate point attribute data
Definition: vtkPointData.h:37
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:300
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
static vtkDataObjectAlgorithm * New()
vtkInitialValueProblemSolver * Integrator
int vtkIdType
Definition: vtkType.h:345
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
Proxy object to connect input/output ports.
dynamic, self-adjusting array of double
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkFunctionSet abstract implementation to be used in the vtkLagrangianParticleTracker integrator.
list of point or cell ids
Definition: vtkIdList.h:36
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
virtual vtkMTimeType GetMTime()
Return this object's modified time.
Basis class for Lagrangian particles.
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Superclass for algorithms that produce only data object as output.
object to represent cell connectivity
Definition: vtkCellArray.h:50
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkLagrangianBasicIntegrationModel * IntegrationModel
Store zero or more vtkInformation instances.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkBooleanMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
general representation of visualization data
Definition: vtkDataObject.h:64
Filter to inject and track particles in a flow.
represent and manipulate 3D points
Definition: vtkPoints.h:39
Fast Simple Class for dealing with 3D bounds.
represent and manipulate fields of data
Definition: vtkFieldData.h:56
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Integrate a set of ordinary differential equations (initial value problem) in time.