vtkTemporalInterpolatedVelocityField.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkTemporalInterpolatedVelocityField.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 vtkTemporalInterpolatedVelocityField_h
#define vtkTemporalInterpolatedVelocityField_h

#include "vtkFiltersFlowPathsModule.h" // For export macro
#include "vtkFunctionSet.h"
#include "vtkSmartPointer.h" // because it is good
//BTX
#include <vector> // Because they are good
//ETX

#define ID_INSIDE_ALL  00
#define ID_OUTSIDE_ALL 01
#define ID_OUTSIDE_T0  02
#define ID_OUTSIDE_T1  03

class vtkDataSet;
class vtkDataArray;
class vtkPointData;
class vtkGenericCell;
class vtkDoubleArray;
class vtkCachingInterpolatedVelocityField;

class VTKFILTERSFLOWPATHS_EXPORT vtkTemporalInterpolatedVelocityField : public vtkFunctionSet
{
public:
  vtkTypeMacro(vtkTemporalInterpolatedVelocityField,vtkFunctionSet);
  virtual void PrintSelf(ostream& os, vtkIndent indent);

  static vtkTemporalInterpolatedVelocityField *New();


  virtual int FunctionValues(double* x, double* u);
  int FunctionValuesAtT(int T, double* x, double* u);


  void SelectVectors(const char *fieldName)
    {this->SetVectorsSelection(fieldName);}

  void SetDataSetAtTime(int I, int N, double T, vtkDataSet* dataset, bool staticdataset);


  bool GetCachedCellIds(vtkIdType id[2], int ds[2]);
  void SetCachedCellIds(vtkIdType id[2], int ds[2]);

  void ClearCache();


  int TestPoint(double* x);
  int QuickTestPoint(double* x);


  vtkGetVector3Macro(LastGoodVelocity,double);


  vtkGetMacro(CurrentWeight,double);

  bool InterpolatePoint(vtkPointData *outPD1,
    vtkPointData *outPD2, vtkIdType outIndex);

  bool InterpolatePoint(int T, vtkPointData *outPD1, vtkIdType outIndex);

  bool GetVorticityData(
    int T, double pcoords[3], double *weights,
    vtkGenericCell *&cell, vtkDoubleArray *cellVectors);

  void ShowCacheResults();
  bool IsStatic(int datasetIndex);

  void AdvanceOneTimeStep();

protected:
  vtkTemporalInterpolatedVelocityField();
  ~vtkTemporalInterpolatedVelocityField();

  int FunctionValues(vtkDataSet* ds, double* x, double* f);
  virtual void SetVectorsSelection(const char *v);

  double Vals1[3];
  double Vals2[3];
  double Times[2];
  double LastGoodVelocity[3];

  // The weight (0.0->1.0) of the value of T between the two avaiable
  // time values for the current computation
  double CurrentWeight;
  // One minus the CurrentWeight
  double OneMinusWeight;
  // A scaling factor used when calculating the CurrentWeight { 1.0/(T2-T1) }
  double ScaleCoeff;
//BTX
  vtkSmartPointer<vtkCachingInterpolatedVelocityField> IVF[2];
  // we want to keep track of static datasets so we can optimize caching
  std::vector<bool> StaticDataSets;
//ETX
private:
  // Hide this since we need multiple time steps and are using a different
  // function prototype
  virtual void AddDataSet(vtkDataSet*) {}

private:
  vtkTemporalInterpolatedVelocityField(const vtkTemporalInterpolatedVelocityField&);  // Not implemented.
  void operator=(const vtkTemporalInterpolatedVelocityField&);  // Not implemented.
};

#endif