vtkAbstractInterpolatedVelocityField.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkAbstractInterpolatedVelocityField.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkAbstractInterpolatedVelocityField_h
#define vtkAbstractInterpolatedVelocityField_h
 
#include "vtkFunctionSet.h"
 
class vtkDataSet;
class vtkDataArray;
class vtkPointData;
class vtkGenericCell;
class vtkAbstractInterpolatedVelocityFieldDataSetsType;
class vtkFindCellStrategy;
struct vtkStrategyMap;
 
#include "vtkFiltersFlowPathsModule.h" // For export macro
 
class VTKFILTERSFLOWPATHS_EXPORT vtkAbstractInterpolatedVelocityField : public vtkFunctionSet
{
public:
  vtkTypeMacro(vtkAbstractInterpolatedVelocityField, vtkFunctionSet);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  vtkSetMacro(Caching, bool);
  vtkGetMacro(Caching, bool);
 
 
  vtkGetMacro(CacheHit, int);
  vtkGetMacro(CacheMiss, int);
 
  vtkGetObjectMacro(LastDataSet, vtkDataSet);
 
 
  vtkGetMacro(LastCellId, vtkIdType);
  virtual void SetLastCellId(vtkIdType c) { this->LastCellId = c; }
 
  virtual void SetLastCellId(vtkIdType c, int dataindex) = 0;
 
 
  vtkGetStringMacro(VectorsSelection);
  vtkGetMacro(VectorsType, int);
 
  void SelectVectors(int fieldAssociation, const char* fieldName);
 
 
  vtkSetMacro(NormalizeVector, bool);
  vtkGetMacro(NormalizeVector, bool);
 
 
  vtkSetMacro(ForceSurfaceTangentVector, bool);
  vtkGetMacro(ForceSurfaceTangentVector, bool);
 
 
  vtkSetMacro(SurfaceDataset, bool);
  vtkGetMacro(SurfaceDataset, bool);
 
  virtual void CopyParameters(vtkAbstractInterpolatedVelocityField* from);
 
  using Superclass::FunctionValues;
  int FunctionValues(double* x, double* f) override = 0;
 
  void ClearLastCellId() { this->LastCellId = -1; }
 
 
  int GetLastWeights(double* w);
  int GetLastLocalCoordinates(double pcoords[3]);
 
 
  virtual void SetFindCellStrategy(vtkFindCellStrategy*);
  vtkGetObjectMacro(FindCellStrategy, vtkFindCellStrategy);
 
protected:
  vtkAbstractInterpolatedVelocityField();
  ~vtkAbstractInterpolatedVelocityField() override;
 
  static const double TOLERANCE_SCALE;
  static const double SURFACE_TOLERANCE_SCALE;
 
  int CacheHit;
  int CacheMiss;
  int WeightsSize;
  bool Caching;
  bool NormalizeVector;
  bool ForceSurfaceTangentVector;
  bool SurfaceDataset;
  int VectorsType;
  char* VectorsSelection;
  double* Weights;
  double LastPCoords[3];
  int LastSubId;
  vtkIdType LastCellId;
  vtkDataSet* LastDataSet;
  vtkGenericCell* Cell;
  vtkGenericCell* GenCell; // the current cell
 
  // Define a FindCell() strategy, keep track of the strategies assigned to
  // each dataset
  vtkFindCellStrategy* FindCellStrategy;
  vtkStrategyMap* StrategyMap;
 
 
  vtkSetStringMacro(VectorsSelection);
 
  virtual int FunctionValues(vtkDataSet* ds, double* x, double* f);
 
  virtual bool CheckPCoords(double pcoords[3]);
 
  virtual bool FindAndUpdateCell(vtkDataSet* ds, double* x);
 
  friend class vtkTemporalInterpolatedVelocityField;
 
  void FastCompute(vtkDataArray* vectors, double f[3]);
  bool InterpolatePoint(vtkPointData* outPD, vtkIdType outIndex);
  vtkGenericCell* GetLastCell() { return (this->LastCellId != -1) ? this->GenCell : nullptr; }
 
private:
  vtkAbstractInterpolatedVelocityField(const vtkAbstractInterpolatedVelocityField&) = delete;
  void operator=(const vtkAbstractInterpolatedVelocityField&) = delete;
};
 
#endif