Interface for obtaining interpolated velocity values. More...

#include <vtkCachingInterpolatedVelocityField.h>

Inheritance diagram for vtkCachingInterpolatedVelocityField:

Collaboration diagram for vtkCachingInterpolatedVelocityField:

Public Types
typedef vtkFunctionSet	Superclass

Public Types inherited from vtkFunctionSet
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCachingInterpolatedVelocityField *	NewInstance () 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
vtkFunctionSet *	NewInstance () const

virtual int	GetNumberOfFunctions ()

virtual int	GetNumberOfIndependentVariables ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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 vtkFunctionSet *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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)

bool	InterpolatePoint (vtkCachingInterpolatedVelocityField inCIVF, vtkPointData outPD, vtkIdType outIndex)

vtkGenericCell *	GetLastCell ()

Protected Member Functions inherited from vtkFunctionSet
	vtkFunctionSet ()

	~vtkFunctionSet ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkGenericCell *	TempCell

int	CellCacheHit

int	DataSetCacheHit

int	CacheMiss

int	LastCacheIndex

int	LastCellId

IVFDataSetInfo *	Cache

IVFCacheList	CacheList

char *	VectorsSelection

std::vector< double >	Weights

Protected Attributes inherited from vtkFunctionSet
int	NumFuncs

int	NumIndepVars

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 vtkStreamTracer

Todo:: Need to clean up style to match vtk/Kitware standards. Please help.

Definition at line 65 of file vtkCachingInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkFunctionSet vtkCachingInterpolatedVelocityField::Superclass

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 * 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 vtkTypeMacro found in vtkSetGet.h.

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

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.

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
	)

Set LastCellId to c and LastCacheIndex datasetindex, cached from last evaluation. If c isn't -1 then the corresponding cell is stored in Cache->Cell. These values should be valid or an assertion will be triggered.

void vtkCachingInterpolatedVelocityField::ClearLastCellInfo ( )

Set LastCellId to -1 and Cache to NULL 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

bool vtkCachingInterpolatedVelocityField::InterpolatePoint	(	vtkCachingInterpolatedVelocityField *	inCIVF,
		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