vtkInterpolatedVelocityField Class Reference

#include <vtkInterpolatedVelocityField.h>

Inheritance diagram for vtkInterpolatedVelocityField:

[legend]

Collaboration diagram for vtkInterpolatedVelocityField:

[legend]

List of all members.

Detailed Description

Interface for obtaining interpolated velocity values.

vtkInterpolatedVelocityField 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, vtkInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.

Warning:: vtkInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.

See also:: vtkFunctionSet vtkStreamer

Definition at line 52 of file vtkInterpolatedVelocityField.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 int	FunctionValues (double x, double f)
virtual void	AddDataSet (vtkDataSet *dataset)
void	ClearLastCellId ()
virtual void	CopyParameters (vtkInterpolatedVelocityField *from)

virtual vtkIdType	GetLastCellId ()
void	SetLastCellId (vtkIdType c)
void	SetLastCellId (vtkIdType c, int dataindex)

int	GetLastWeights (double *w)
int	GetLastLocalCoordinates (double pcoords[3])

virtual int	GetCaching ()
virtual void	SetCaching (int)
virtual void	CachingOn ()
virtual void	CachingOff ()

virtual int	GetCacheHit ()
virtual int	GetCacheMiss ()

virtual char *	GetVectorsSelection ()
void	SelectVectors (const char *fieldName)

virtual vtkDataSet *	GetLastDataSet ()
virtual int	GetLastDataSetIndex ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInterpolatedVelocityField *	SafeDownCast (vtkObject *o)
static vtkInterpolatedVelocityField *	New ()
Protected Member Functions
	vtkInterpolatedVelocityField ()
	~vtkInterpolatedVelocityField ()
virtual void	SetVectorsSelection (const char *)
int	FunctionValues (vtkDataSet ds, double x, double *f)

void	FastCompute (vtkDataArray *vectors, double f[3])
bool	InterpolatePoint (vtkPointData *outPD, vtkIdType outIndex)
vtkGenericCell *	GetLastCell ()
Protected Attributes
vtkGenericCell *	GenCell
vtkGenericCell *	Cell
double *	Weights
int	WeightsSize
double	LastPCoords [3]
vtkIdType	LastCellId
int	CacheHit
int	CacheMiss
int	Caching
int	LastDataSetIndex
vtkDataSet *	LastDataSet
char *	VectorsSelection
vtkInterpolatedVelocityFieldDataSetsType *	DataSets
Static Protected Attributes
static const double	TOLERANCE_SCALE
Friends
class	vtkTemporalInterpolatedVelocityField

Member Typedef Documentation

typedef vtkFunctionSet vtkInterpolatedVelocityField::Superclass

Reimplemented from vtkFunctionSet.

Definition at line 55 of file vtkInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField ( ) [protected]

vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkFunctionSet.

static int vtkInterpolatedVelocityField::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 vtkInterpolatedVelocityField::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 vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkFunctionSet.

virtual void vtkInterpolatedVelocityField::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 vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::New ( ) [static]

Construct a vtkInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.

Reimplemented from vtkObject.

virtual int vtkInterpolatedVelocityField::FunctionValues	(	double *	x,
		double *	f
	)			`[virtual]`

Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.

Implements vtkFunctionSet.

virtual void vtkInterpolatedVelocityField::AddDataSet ( vtkDataSet * dataset ) [virtual]

Add a dataset used for the implicit function evaluation. If more than one dataset is added, the evaluation point is searched in all until a match is found. THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT OF dataset FOR THREAD SAFETY REASONS.

virtual vtkIdType vtkInterpolatedVelocityField::GetLastCellId ( ) [virtual]

Return the cell id cached from last evaluation.

void vtkInterpolatedVelocityField::SetLastCellId ( vtkIdType c ) [inline]

Return the cell id cached from last evaluation.

Definition at line 75 of file vtkInterpolatedVelocityField.h.

void vtkInterpolatedVelocityField::SetLastCellId	(	vtkIdType	c,
		int	dataindex
	)

Return the cell id cached from last evaluation.

void vtkInterpolatedVelocityField::ClearLastCellId ( ) [inline]

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

Definition at line 82 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::GetLastWeights ( double * w )

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

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

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

virtual int vtkInterpolatedVelocityField::GetCaching ( ) [virtual]

Turn caching on/off.

virtual void vtkInterpolatedVelocityField::SetCaching ( int ) [virtual]

Turn caching on/off.

virtual void vtkInterpolatedVelocityField::CachingOn ( ) [virtual]

Turn caching on/off.

virtual void vtkInterpolatedVelocityField::CachingOff ( ) [virtual]

Turn caching on/off.

virtual int vtkInterpolatedVelocityField::GetCacheHit ( ) [virtual]

Caching statistics.

virtual int vtkInterpolatedVelocityField::GetCacheMiss ( ) [virtual]

Caching statistics.

virtual char* vtkInterpolatedVelocityField::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 vtkInterpolatedVelocityField::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 110 of file vtkInterpolatedVelocityField.h.

virtual vtkDataSet* vtkInterpolatedVelocityField::GetLastDataSet ( ) [virtual]

Returns the last dataset that was visited. Can be used as a first guess as to where the next point will be as well as to avoid searching through all datasets to get more information about the point. When setting the last dataset, you must be very careful no reference counting or checks are performed the feature is intended only to be used by custom interpolators which cache datasets independently

virtual int vtkInterpolatedVelocityField::GetLastDataSetIndex ( ) [virtual]

Returns the last dataset that was visited. Can be used as a first guess as to where the next point will be as well as to avoid searching through all datasets to get more information about the point. When setting the last dataset, you must be very careful no reference counting or checks are performed the feature is intended only to be used by custom interpolators which cache datasets independently

virtual void vtkInterpolatedVelocityField::CopyParameters ( vtkInterpolatedVelocityField * from ) [virtual]

Copy the user set parameters from source. This copies the Caching parameters. Sub-classes can add more after chaining.

virtual void vtkInterpolatedVelocityField::SetVectorsSelection ( const char * ) [protected, virtual]

int vtkInterpolatedVelocityField::FunctionValues	(	vtkDataSet *	ds,
		double *	x,
		double *	f
	)			`[protected]`

void vtkInterpolatedVelocityField::FastCompute	(	vtkDataArray *	vectors,
		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 vtkInterpolatedVelocityField::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* vtkInterpolatedVelocityField::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