vtkCachingInterpolatedVelocityField Class Reference

#include <vtkCachingInterpolatedVelocityField.h>

Inheritance diagram for vtkCachingInterpolatedVelocityField:

[legend]

Collaboration diagram for vtkCachingInterpolatedVelocityField:

[legend]

List of all members.

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 64 of file vtkCachingInterpolatedVelocityField.h.


Public Types
typedef vtkFunctionSet	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCachingInterpolatedVelocityField *	SafeDownCast (vtkObject *o)
static vtkCachingInterpolatedVelocityField *	New ()
Protected Member Functions
	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)
vtkGenericCell *	GetLastCell ()
Protected Attributes
vtkGenericCell *	TempCell
int	CellCacheHit
int	DataSetCacheHit
int	CacheMiss
int	LastCacheIndex
int	LastCellId
IVFDataSetInfo *	Cache
IVFCacheList	CacheList
char *	VectorsSelection
vtkstd::vector< double >	Weights
Friends
class	vtkTemporalInterpolatedVelocityField

Member Typedef Documentation

typedef vtkFunctionSet vtkCachingInterpolatedVelocityField::Superclass

Reimplemented from vtkFunctionSet.

Definition at line 67 of file vtkCachingInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCachingInterpolatedVelocityField::vtkCachingInterpolatedVelocityField ( ) [protected]

vtkCachingInterpolatedVelocityField::~vtkCachingInterpolatedVelocityField ( ) [protected]

Member Function Documentation

virtual const char* vtkCachingInterpolatedVelocityField::GetClassName ( ) [virtual]

Reimplemented from vtkFunctionSet.

static int vtkCachingInterpolatedVelocityField::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkFunctionSet.

virtual int vtkCachingInterpolatedVelocityField::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkFunctionSet.

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkFunctionSet.

virtual void vtkCachingInterpolatedVelocityField::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkFunctionSet.

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::New ( ) [static]

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

Reimplemented from vtkObject.

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 89 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 * ) [protected, virtual]

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