vtkInterpolatedVelocityField Class Reference

A concrete class for obtaining the interpolated velocity values at a point. More...

#include <vtkInterpolatedVelocityField.h>

Inheritance diagram for vtkInterpolatedVelocityField:

Collaboration diagram for vtkInterpolatedVelocityField:

Public Types
typedef vtkAbstractInterpolatedVelocityField	Superclass
Public Types inherited from vtkAbstractInterpolatedVelocityField
typedef vtkFunctionSet	Superclass
Public Types inherited from vtkFunctionSet
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	AddDataSet (vtkDataSet *dataset)
virtual int	FunctionValues (double *x, double *f)
virtual void	SetLastCellId (vtkIdType c, int dataindex)
virtual void	SetLastCellId (vtkIdType c)
Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
void	ClearLastCellId ()
virtual void	SetCaching (bool)
virtual bool	GetCaching ()
virtual int	GetCacheHit ()
virtual int	GetCacheMiss ()
virtual int	GetLastDataSetIndex ()
virtual vtkDataSet *	GetLastDataSet ()
virtual vtkIdType	GetLastCellId ()
virtual char *	GetVectorsSelection ()
void	SelectVectors (const char *fieldName)
virtual void	SetNormalizeVector (bool)
virtual bool	GetNormalizeVector ()
virtual void	CopyParameters (vtkAbstractInterpolatedVelocityField *from)
int	GetLastWeights (double *w)
int	GetLastLocalCoordinates (double pcoords[3])
Public Member Functions inherited from vtkFunctionSet
virtual int	GetNumberOfFunctions ()
virtual int	GetNumberOfIndependentVariables ()
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char 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)
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 &os)
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 vtkInterpolatedVelocityField *	SafeDownCast (vtkObject *o)
static vtkInterpolatedVelocityField *	New ()
Static Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
static int	IsTypeOf (const char *type)
static vtkAbstractInterpolatedVelocityField *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkFunctionSet
static int	IsTypeOf (const char *type)
static vtkFunctionSet *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObject *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
	vtkInterpolatedVelocityField ()
	~vtkInterpolatedVelocityField ()
virtual int	FunctionValues (vtkDataSet *ds, double *x, double *f)
Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
	vtkAbstractInterpolatedVelocityField ()
	~vtkAbstractInterpolatedVelocityField ()
virtual void	SetVectorsSelection (const char *)
void	FastCompute (vtkDataArray *vectors, double f[3])
bool	InterpolatePoint (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 &os)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
int	CacheHit
int	CacheMiss
int	WeightsSize
int	LastDataSetIndex
bool	Caching
bool	NormalizeVector
char *	VectorsSelection
double *	Weights
double	LastPCoords [3]
vtkIdType	LastCellId
vtkDataSet *	LastDataSet
vtkGenericCell *	Cell
vtkGenericCell *	GenCell
vtkAbstractInterpolatedVelocityFieldDataSetsType *	DataSets
Protected Attributes inherited from vtkFunctionSet
int	NumFuncs
int	NumIndepVars
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
static const double	TOLERANCE_SCALE

Detailed Description

A concrete class for obtaining the interpolated velocity values at a point.

vtkInterpolatedVelocityField acts as a continuous velocity field via cell interpolation on a vtkDataSet, NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). As a concrete sub-class of vtkAbstractInterpolatedVelocityField, this class adopts two levels of cell caching for faster though less robust cell location than its sibling class vtkCellLocatorInterpolatedVelocityField. Level #0 begins with intra-cell caching. Specifically, if the previous cell is valid and the nex point is still within it, ( vtkCell::EvaluatePosition() returns 1, coupled with the new parametric coordinates and weights ), the function values are interpolated and vtkCell::EvaluatePosition() is invoked only. If it fails, level #1 follows by inter-cell location of the target cell (that contains the next point). By inter-cell, the previous cell gives an important clue / guess or serves as an immediate neighbor to aid in the location of the target cell (as is typically the case with integrating a streamline across cells) by means of vtkDataSet:: FindCell(). If this still fails, a global cell search is invoked via vtkDataSet::FindCell().

Regardless of inter-cell or global search, vtkPointLocator is employed as a crucial tool underlying the cell locator. The use of vtkPointLocator casues vtkInterpolatedVelocityField to return false target cells for datasets defined on complex grids.

Warning

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

See also

vtkAbstractInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamer vtkStreamTracer

Definition at line 58 of file vtkInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkAbstractInterpolatedVelocityField vtkInterpolatedVelocityField::Superclass

Definition at line 63 of file vtkInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField ( )

inlineprotected

Definition at line 90 of file vtkInterpolatedVelocityField.h.

vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField ( )

inlineprotected

Definition at line 91 of file vtkInterpolatedVelocityField.h.

Member Function Documentation

virtual const char* vtkInterpolatedVelocityField::GetClassName ( )

virtual

Reimplemented from vtkAbstractInterpolatedVelocityField.

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

static

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

Reimplemented from vtkAbstractInterpolatedVelocityField.

static vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::SafeDownCast ( vtkObject *  o )

static

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 vtkAbstractInterpolatedVelocityField.

static vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::New ( )

static

Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.

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.

Implements vtkAbstractInterpolatedVelocityField.

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

virtual

Evaluate the velocity field f at point (x, y, z).

Implements vtkAbstractInterpolatedVelocityField.

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

virtual

Set the cell id cached by the last evaluation within a specified dataset.

Implements vtkAbstractInterpolatedVelocityField.

virtual void vtkInterpolatedVelocityField::SetLastCellId ( vtkIdType  c )

inlinevirtual

Set the cell id cached by the last evaluation.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 85 of file vtkInterpolatedVelocityField.h.

virtual int vtkInterpolatedVelocityField::FunctionValues ( vtkDataSet *  ds, double *  x, double *  f  )

inlineprotectedvirtual

Evaluate the velocity field f at point (x, y, z) in a specified dataset by either involving vtkPointLocator, via vtkPointSet::FindCell(), in locating the next cell (for datasets of type vtkPointSet) or simply invoking vtkImageData/vtkRectilinearGrid::FindCell() to fulfill the same task if the point is outside the current cell.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 100 of file vtkInterpolatedVelocityField.h.

---

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

• dox/Filtering/vtkInterpolatedVelocityField.h