Interface for obtaining interpolated velocity values. More...

#include <vtkGenericInterpolatedVelocityField.h>

Inheritance diagram for vtkGenericInterpolatedVelocityField:

Collaboration diagram for vtkGenericInterpolatedVelocityField:

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)

vtkGenericInterpolatedVelocityField *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	FunctionValues (double x, double f)

virtual void	AddDataSet (vtkGenericDataSet *dataset)

void	ClearLastCell ()

vtkGenericAdaptorCell *	GetLastCell ()

int	GetLastLocalCoordinates (double pcoords[3])

virtual void	CopyParameters (vtkGenericInterpolatedVelocityField *from)


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 vtkGenericDataSet *	GetLastDataSet ()

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

static vtkGenericInterpolatedVelocityField *	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

	vtkGenericInterpolatedVelocityField ()

	~vtkGenericInterpolatedVelocityField ()

virtual void	SetVectorsSelection (const char *)

int	FunctionValues (vtkGenericDataSet ds, double x, double *f)

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
vtkGenericCellIterator *	GenCell

double	LastPCoords [3]

int	CacheHit

int	CacheMiss

int	Caching

vtkGenericDataSet *	LastDataSet

char *	VectorsSelection

vtkGenericInterpolatedVelocityFieldDataSetsType *	DataSets

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

Static Protected Attributes
static const double	TOLERANCE_SCALE

Detailed Description

Interface for obtaining interpolated velocity values.

vtkGenericInterpolatedVelocityField 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 expansive operation. In certain cases, the cell search can be avoided or shortened by providing a guess for the cell iterator. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkGenericInterpolatedVelocityField stores the last cell iterator. If caching is turned on, it uses this iterator as the starting point.

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

See also: vtkFunctionSet vtkGenericStreamTracer

Definition at line 53 of file vtkGenericInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkFunctionSet vtkGenericInterpolatedVelocityField::Superclass

Definition at line 56 of file vtkGenericInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkGenericInterpolatedVelocityField::vtkGenericInterpolatedVelocityField ( )

protected

vtkGenericInterpolatedVelocityField::~vtkGenericInterpolatedVelocityField ( )

protected

Member Function Documentation

static int vtkGenericInterpolatedVelocityField::IsTypeOf ( const char * type )

static

virtual int vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkGenericInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkFunctionSet.

vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::NewInstance ( ) const

virtual void vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::New ( )

static

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

virtual int vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField::AddDataSet ( vtkGenericDataSet * 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.

void vtkGenericInterpolatedVelocityField::ClearLastCell ( )

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

vtkGenericAdaptorCell* vtkGenericInterpolatedVelocityField::GetLastCell ( )

Return the cell cached from last evaluation.

int vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField::GetCaching ( )

virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::SetCaching ( int )

virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::CachingOn ( )

virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::CachingOff ( )

virtual

Turn caching on/off.

virtual int vtkGenericInterpolatedVelocityField::GetCacheHit ( )

virtual

Caching statistics.

virtual int vtkGenericInterpolatedVelocityField::GetCacheMiss ( )

virtual

Caching statistics.

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

virtual vtkGenericDataSet* vtkGenericInterpolatedVelocityField::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.

virtual void vtkGenericInterpolatedVelocityField::CopyParameters ( vtkGenericInterpolatedVelocityField * from )

virtual

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

virtual void vtkGenericInterpolatedVelocityField::SetVectorsSelection ( const char * )

protectedvirtual