VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCachingInterpolatedVelocityField Class Reference

Interface for obtaining interpolated velocity values. More...

#include <vtkCachingInterpolatedVelocityField.h>

Inheritance diagram for vtkCachingInterpolatedVelocityField:
[legend]
Collaboration diagram for vtkCachingInterpolatedVelocityField:
[legend]

Public Types

typedef vtkFunctionSet Superclass
 
- Public Types inherited from vtkFunctionSet
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCachingInterpolatedVelocityFieldNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetDataSet (int I, vtkDataSet *dataset, bool staticdataset, vtkAbstractCellLocator *locator)
 
void SetLastCellInfo (vtkIdType c, int datasetindex)
 
void ClearLastCellInfo ()
 
virtual int FunctionValues (double *x, double *f)
 
virtual int InsideTest (double *x)
 
virtual char * GetVectorsSelection ()
 
void SelectVectors (const char *fieldName)
 
int GetLastWeights (double *w)
 
int GetLastLocalCoordinates (double pcoords[3])
 
virtual int GetCellCacheHit ()
 
virtual int GetDataSetCacheHit ()
 
virtual int GetCacheMiss ()
 
- Public Member Functions inherited from vtkFunctionSet
vtkFunctionSetNewInstance () const
 
virtual int GetNumberOfFunctions ()
 
virtual int GetNumberOfIndependentVariables ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkCachingInterpolatedVelocityField
SafeDownCast (vtkObjectBase *o)
 
static
vtkCachingInterpolatedVelocityField
New ()
 
- Static Public Member Functions inherited from vtkFunctionSet
static int IsTypeOf (const char *type)
 
static vtkFunctionSetSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCachingInterpolatedVelocityField ()
 
 ~vtkCachingInterpolatedVelocityField ()
 
virtual void SetVectorsSelection (const char *)
 
int FunctionValues (IVFDataSetInfo *cache, double *x, double *f)
 
int InsideTest (IVFDataSetInfo *cache, double *x)
 
void FastCompute (IVFDataSetInfo *cache, double f[3])
 
bool InterpolatePoint (vtkPointData *outPD, vtkIdType outIndex)
 
vtkGenericCellGetLastCell ()
 
- Protected Member Functions inherited from vtkFunctionSet
 vtkFunctionSet ()
 
 ~vtkFunctionSet ()
 

Protected Attributes

vtkGenericCellTempCell
 
int CellCacheHit
 
int DataSetCacheHit
 
int CacheMiss
 
int LastCacheIndex
 
int LastCellId
 
IVFDataSetInfoCache
 
IVFCacheList CacheList
 
char * VectorsSelection
 
std::vector< double > Weights
 
- Protected Attributes inherited from vtkFunctionSet
int NumFuncs
 
int NumIndepVars
 

Friends

class vtkTemporalInterpolatedVelocityField
 

Detailed Description

Interface for obtaining interpolated velocity values.

vtkCachingInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is a concrete sub-class of vtkFunctionSet with NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). Normally, every time an evaluation is performed, the cell which contains the point (x,y,z) has to be found by calling FindCell. This is a computationally expensive operation. In certain cases, the cell search can be avoided or shortened by providing a guess for the cell id. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkCachingInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.

Warning
vtkCachingInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
See Also
vtkFunctionSet vtkStreamer
Todo:
Need to clean up style to match vtk/Kitware standards. Please help.

Definition at line 65 of file vtkCachingInterpolatedVelocityField.h.

Member Typedef Documentation

Definition at line 68 of file vtkCachingInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCachingInterpolatedVelocityField::vtkCachingInterpolatedVelocityField ( )
protected
vtkCachingInterpolatedVelocityField::~vtkCachingInterpolatedVelocityField ( )
protected

Member Function Documentation

static int vtkCachingInterpolatedVelocityField::IsTypeOf ( const char *  type)
static
virtual int vtkCachingInterpolatedVelocityField::IsA ( const char *  type)
virtual

Reimplemented from vtkFunctionSet.

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCachingInterpolatedVelocityField::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFunctionSet.

vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::NewInstance ( ) const
virtual void vtkCachingInterpolatedVelocityField::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkFunctionSet.

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::New ( )
static

Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.

virtual int vtkCachingInterpolatedVelocityField::FunctionValues ( double *  x,
double *  f 
)
virtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed

Implements vtkFunctionSet.

virtual int vtkCachingInterpolatedVelocityField::InsideTest ( double *  x)
virtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed

virtual void vtkCachingInterpolatedVelocityField::SetDataSet ( int  I,
vtkDataSet *  dataset,
bool  staticdataset,
vtkAbstractCellLocator *  locator 
)
virtual

Add a dataset used by the interpolation function evaluation.

virtual char* vtkCachingInterpolatedVelocityField::GetVectorsSelection ( )
virtual

If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.

void vtkCachingInterpolatedVelocityField::SelectVectors ( const char *  fieldName)
inline

If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.

Definition at line 90 of file vtkCachingInterpolatedVelocityField.h.

void vtkCachingInterpolatedVelocityField::SetLastCellInfo ( vtkIdType  c,
int  datasetindex 
)

Return the cell id cached from last evaluation.

void vtkCachingInterpolatedVelocityField::ClearLastCellInfo ( )

Set the last cell id to -1 so that the next search does not start from the previous cell

int vtkCachingInterpolatedVelocityField::GetLastWeights ( double *  w)

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

int vtkCachingInterpolatedVelocityField::GetLastLocalCoordinates ( double  pcoords[3])

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

virtual int vtkCachingInterpolatedVelocityField::GetCellCacheHit ( )
virtual

Caching statistics.

virtual int vtkCachingInterpolatedVelocityField::GetDataSetCacheHit ( )
virtual

Caching statistics.

virtual int vtkCachingInterpolatedVelocityField::GetCacheMiss ( )
virtual

Caching statistics.

virtual void vtkCachingInterpolatedVelocityField::SetVectorsSelection ( const char *  )
protectedvirtual
int vtkCachingInterpolatedVelocityField::FunctionValues ( IVFDataSetInfo cache,
double *  x,
double *  f 
)
protected
int vtkCachingInterpolatedVelocityField::InsideTest ( IVFDataSetInfo cache,
double *  x 
)
protected
void vtkCachingInterpolatedVelocityField::FastCompute ( IVFDataSetInfo cache,
double  f[3] 
)
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored. This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

bool vtkCachingInterpolatedVelocityField::InterpolatePoint ( vtkPointData *  outPD,
vtkIdType  outIndex 
)
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored. This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

vtkGenericCell* vtkCachingInterpolatedVelocityField::GetLastCell ( )
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored. This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

Friends And Related Function Documentation

Definition at line 141 of file vtkCachingInterpolatedVelocityField.h.

Member Data Documentation

vtkGenericCell* vtkCachingInterpolatedVelocityField::TempCell
protected

Definition at line 120 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::CellCacheHit
protected

Definition at line 121 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::DataSetCacheHit
protected

Definition at line 122 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::CacheMiss
protected

Definition at line 123 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::LastCacheIndex
protected

Definition at line 124 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::LastCellId
protected

Definition at line 125 of file vtkCachingInterpolatedVelocityField.h.

IVFDataSetInfo* vtkCachingInterpolatedVelocityField::Cache
protected

Definition at line 126 of file vtkCachingInterpolatedVelocityField.h.

IVFCacheList vtkCachingInterpolatedVelocityField::CacheList
protected

Definition at line 127 of file vtkCachingInterpolatedVelocityField.h.

char* vtkCachingInterpolatedVelocityField::VectorsSelection
protected

Definition at line 128 of file vtkCachingInterpolatedVelocityField.h.

std::vector<double> vtkCachingInterpolatedVelocityField::Weights
protected

Definition at line 130 of file vtkCachingInterpolatedVelocityField.h.


The documentation for this class was generated from the following file: