vtkCachingInterpolatedVelocityField.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCachingInterpolatedVelocityField_h
#define vtkCachingInterpolatedVelocityField_h
 
#include "vtkDeprecation.h"            // for VTK_DEPRECATED_IN_9_2_0
#include "vtkFiltersFlowPathsModule.h" // For export macro
#include "vtkFunctionSet.h"
#include "vtkSmartPointer.h" // this is allowed
 
#include <vector> // we need them
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkDataArray;
class vtkPointData;
class vtkGenericCell;
class vtkAbstractCellLocator;
 
//---------------------------------------------------------------------------
class IVFDataSetInfo;
//---------------------------------------------------------------------------
class IVFCacheList : public std::vector<IVFDataSetInfo>
{
};
//---------------------------------------------------------------------------
 
class VTK_DEPRECATED_IN_9_2_0(
  "Use vtkCompositeInterpolatedVelocityField instead of vtkCachingInterpolatedVelocityField "
  "and set the desired strategy.") VTKFILTERSFLOWPATHS_EXPORT vtkCachingInterpolatedVelocityField
  : public vtkFunctionSet
{
public:
  vtkTypeMacro(vtkCachingInterpolatedVelocityField, vtkFunctionSet);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkCachingInterpolatedVelocityField* New();
 
  using Superclass::FunctionValues;
 
  int FunctionValues(double* x, double* f) override;
  virtual int InsideTest(double* x);
 
  virtual void SetDataSet(
    int I, vtkDataSet* dataset, bool staticdataset, vtkAbstractCellLocator* locator);
 
 
  vtkGetStringMacro(VectorsSelection);
  void SelectVectors(const char* fieldName) { this->SetVectorsSelection(fieldName); }
 
  void SetLastCellInfo(vtkIdType c, int datasetindex);
 
  void ClearLastCellInfo();
 
 
  int GetLastWeights(double* w);
  int GetLastLocalCoordinates(double pcoords[3]);
 
 
  vtkGetMacro(CellCacheHit, int);
  vtkGetMacro(DataSetCacheHit, int);
  vtkGetMacro(CacheMiss, int);
 
protected:
  vtkCachingInterpolatedVelocityField();
  ~vtkCachingInterpolatedVelocityField() override;
 
  vtkGenericCell* TempCell;
  int CellCacheHit;
  int DataSetCacheHit;
  int CacheMiss;
  int LastCacheIndex;
  int LastCellId;
  IVFDataSetInfo* Cache;
  IVFCacheList CacheList;
  char* VectorsSelection;
 
  std::vector<double> Weights;
 
  vtkSetStringMacro(VectorsSelection);
 
  // private versions which work on the passed dataset/cache
  // these do the real computation
  int FunctionValues(IVFDataSetInfo* cache, double* x, double* f);
  int InsideTest(IVFDataSetInfo* cache, double* x);
 
  friend class vtkTemporalInterpolatedVelocityField;
 
  void FastCompute(IVFDataSetInfo* cache, double f[3]);
  bool InterpolatePoint(vtkPointData* outPD, vtkIdType outIndex);
  bool InterpolatePoint(
    vtkCachingInterpolatedVelocityField* inCIVF, vtkPointData* outPD, vtkIdType outIndex);
  vtkGenericCell* GetLastCell();
 
private:
  vtkCachingInterpolatedVelocityField(const vtkCachingInterpolatedVelocityField&) = delete;
  void operator=(const vtkCachingInterpolatedVelocityField&) = delete;
};
 
//---------------------------------------------------------------------------
 
// IVFDataSetInfo
#ifndef DOXYGEN_SHOULD_SKIP_THIS
//
 
//
class IVFDataSetInfo
{
public:
  vtkSmartPointer<vtkDataSet> DataSet;
  vtkSmartPointer<vtkAbstractCellLocator> BSPTree;
  vtkSmartPointer<vtkGenericCell> Cell;
  double PCoords[3];
  float* VelocityFloat;
  double* VelocityDouble;
  double Tolerance;
  bool StaticDataSet;
  IVFDataSetInfo();
  IVFDataSetInfo(const IVFDataSetInfo& ivfci);
  IVFDataSetInfo& operator=(const IVFDataSetInfo& ivfci);
  void SetDataSet(
    vtkDataSet* data, char* velocity, bool staticdataset, vtkAbstractCellLocator* locator);
  //
  static const double TOLERANCE_SCALE;
};
 
//
 
//
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
VTK_ABI_NAMESPACE_END
#endif
 
// VTK-HeaderTest-Exclude: vtkCachingInterpolatedVelocityField.h