VTK  9.3.20240228
vtkAbstractInterpolatedVelocityField.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
64 #ifndef vtkAbstractInterpolatedVelocityField_h
65 #define vtkAbstractInterpolatedVelocityField_h
66 
67 #include "vtkFiltersFlowPathsModule.h" // For export macro
68 #include "vtkFunctionSet.h"
69 #include "vtkNew.h" // for vtkNew
70 #include "vtkSmartPointer.h" // for vtkSmartPointer
71 
72 #include <vector> // for weights
73 
74 VTK_ABI_NAMESPACE_BEGIN
79 class vtkDataObject;
80 class vtkDataSet;
81 class vtkDataArray;
82 class vtkIdList;
83 class vtkPointData;
84 class vtkGenericCell;
86 
87 class VTKFILTERSFLOWPATHS_EXPORT vtkAbstractInterpolatedVelocityField : public vtkFunctionSet
88 {
89 public:
91 
95  void PrintSelf(ostream& os, vtkIndent indent) override;
97 
98  // Keep track of how the interpolated velocity field is
99  // initialized. Currently, all datasets that compose the velocity field are
100  // initialized (meaning that supporting structures like locators are
101  // built).
103  {
104  NOT_INITIALIZED = 0,
105  INITIALIZE_ALL_DATASETS = 1,
106  SELF_INITIALIZE = 2
107  };
108 
110 
124  virtual void Initialize(vtkCompositeDataSet* compDS, int initStrategy = INITIALIZE_ALL_DATASETS);
125  vtkGetMacro(InitializationState, int);
127 
129 
135  vtkSetMacro(Caching, bool);
136  vtkGetMacro(Caching, bool);
138 
140 
144  vtkGetMacro(CacheHit, int);
145  vtkGetMacro(CacheMiss, int);
147 
148  vtkGetObjectMacro(LastDataSet, vtkDataSet);
149 
151 
154  vtkGetMacro(LastCellId, vtkIdType);
155  virtual void SetLastCellId(vtkIdType c) { this->LastCellId = c; }
157 
161  virtual void SetLastCellId(vtkIdType c, int dataindex) = 0;
162 
164 
168  vtkGetStringMacro(VectorsSelection);
169  vtkGetMacro(VectorsType, int);
171 
176  void SelectVectors(int fieldAssociation, const char* fieldName);
177 
179 
196  vtkSetMacro(NormalizeVector, bool);
197  vtkGetMacro(NormalizeVector, bool);
199 
201 
206  vtkSetMacro(ForceSurfaceTangentVector, bool);
207  vtkGetMacro(ForceSurfaceTangentVector, bool);
209 
211 
214  vtkSetMacro(SurfaceDataset, bool);
215  vtkGetMacro(SurfaceDataset, bool);
217 
225 
226  using Superclass::FunctionValues;
230  int FunctionValues(double* x, double* f) override = 0;
231 
235  void ClearLastCellId() { this->LastCellId = -1; }
236 
238 
242  int GetLastWeights(double* w);
243  int GetLastLocalCoordinates(double pcoords[3]);
245 
247 
254  vtkGetObjectMacro(FindCellStrategy, vtkFindCellStrategy);
256 
257 protected:
260 
261  static const double TOLERANCE_SCALE;
262  static const double SURFACE_TOLERANCE_SCALE;
263 
264  int CacheHit;
266  bool Caching;
272  std::vector<double> Weights;
273  double LastPCoords[3];
275  double LastClosestPoint[3];
281 
287 
288  // This is used to keep track of the find cell strategy and vector array
289  // associated with each dataset forming the velocity field. Note that the
290  // find cells strategy can be null, this means the find cell is invoked
291  // using the dataset's FindCell() method.
293  {
297 
299  : DataSet(dataSet)
300  , Strategy(strategy)
301  , Vectors(vectors)
302  {
303  }
304  };
306 
311  std::vector<vtkDataSetInformation> DataSetsInfo;
312  std::vector<vtkDataSetInformation>::iterator GetDataSetInfo(vtkDataSet* dataset);
314 
316 
319  vtkSetStringMacro(VectorsSelection);
321 
333  virtual int FunctionValues(vtkDataSet* ds, double* x, double* f);
334 
341  virtual bool FindAndUpdateCell(vtkDataSet* ds, vtkFindCellStrategy* strategy, double* x);
342 
345 
351  void FastCompute(vtkDataArray* vectors, double f[3]);
352  void FastCompute(vtkAbstractInterpolatedVelocityField* inIVF, vtkDataArray* vectors, double f[3]);
353  bool InterpolatePoint(vtkPointData* outPD, vtkIdType outIndex);
357  {
358  return (this->LastCellId != -1) ? this->CurrentCell.Get() : nullptr;
359  }
361 
363 
369  virtual int SelfInitialize() { return 0; }
373 
374 private:
376  void operator=(const vtkAbstractInterpolatedVelocityField&) = delete;
377 };
378 
379 VTK_ABI_NAMESPACE_END
380 #endif
An abstract class for obtaining the interpolated velocity values at a point.
int FunctionValues(double *x, double *f) override=0
Evaluate the velocity field f at point (x, y, z).
virtual int FunctionValues(vtkDataSet *ds, double *x, double *f)
Evaluate the velocity field f at point (x, y, z) in a specified dataset by invoking vtkDataSet::FindC...
virtual int SelfInitialize()
These methods pertain to initializing the vector field by subclasses (which may have special initiali...
int GetLastWeights(double *w)
Get the interpolation weights cached from last evaluation.
int GetLastLocalCoordinates(double pcoords[3])
Get the interpolation weights cached from last evaluation.
int InitializationState
Make sure the velocity field is initialized: record the initialization strategy.
size_t GetDataSetsInfoSize()
These methods pertain to initializing the vector field by subclasses (which may have special initiali...
virtual void Initialize(vtkCompositeDataSet *compDS, int initStrategy=INITIALIZE_ALL_DATASETS)
The Initialize() method is used to build and cache supporting structures (such as locators) which are...
void ClearLastCellId()
Set the last cell id to -1 to incur a global cell search for the next point.
virtual void SetFindCellStrategy(vtkFindCellStrategy *)
Set / get the strategy used to perform the FindCell() operation.
void FastCompute(vtkDataArray *vectors, double f[3])
If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly i...
std::vector< vtkDataSetInformation > DataSetsInfo
Define a FindCell() strategy, keep track of the strategies (and other cached information) associated ...
std::vector< vtkDataSetInformation >::iterator GetDataSetInfo(vtkDataSet *dataset)
Define a FindCell() strategy, keep track of the strategies (and other cached information) associated ...
void AddToDataSetsInfo(vtkDataSet *, vtkFindCellStrategy *, vtkDataArray *vectors)
These methods pertain to initializing the vector field by subclasses (which may have special initiali...
vtkFindCellStrategy * FindCellStrategy
Define a FindCell() strategy, keep track of the strategies (and other cached information) associated ...
bool InterpolatePoint(vtkPointData *outPD, vtkIdType outIndex)
If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly i...
bool InterpolatePoint(vtkAbstractInterpolatedVelocityField *inIVF, vtkPointData *outPD, vtkIdType outIndex)
If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly i...
virtual void CopyParameters(vtkAbstractInterpolatedVelocityField *from)
Copy essential parameters between instances of this class.
virtual void SetLastCellId(vtkIdType c)
Get/Set the id of the cell cached from last evaluation.
vtkGenericCell * GetLastCell()
If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly i...
virtual bool FindAndUpdateCell(vtkDataSet *ds, vtkFindCellStrategy *strategy, double *x)
Try to find the cell closest to provided x point in provided dataset, By first testing inclusion in i...
virtual void SetLastCellId(vtkIdType c, int dataindex)=0
Set the id of the most recently visited cell of a dataset.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for obtaining type information and printing the object state.
void FastCompute(vtkAbstractInterpolatedVelocityField *inIVF, vtkDataArray *vectors, double f[3])
If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly i...
void SelectVectors(int fieldAssociation, const char *fieldName)
the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field
implement a specific vtkPointSet::FindCell() strategy based on using a cell locator
implement a specific vtkPointSet::FindCell() strategy based on the N closest points
implement a specific vtkPointSet::FindCell() strategy based on closest point
abstract superclass for composite (multi-block or AMR) datasets
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:154
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:165
helper class to manage the vtkPointSet::FindCell() METHOD
Abstract interface for sets of functions.
provides thread-safe access to cells
list of point or cell ids
Definition: vtkIdList.h:132
a simple class to control print indentation
Definition: vtkIndent.h:108
T * Get() const noexcept
Get a raw pointer to the contained object.
Definition: vtkNew.h:250
represent and manipulate point attribute data
Definition: vtkPointData.h:139
A helper class for interpolating between times during particle tracing.
std::map< std::string, DataArray > DataSet
key: variable name, value: DataArray
Definition: VTXTypes.h:28
vtkDataSetInformation(vtkDataSet *dataSet, vtkFindCellStrategy *strategy, vtkDataArray *vectors)
int vtkIdType
Definition: vtkType.h:315