vtkCellLocatorInterpolatedVelocityField Class Reference

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

#include <vtkCellLocatorInterpolatedVelocityField.h>

Inheritance diagram for vtkCellLocatorInterpolatedVelocityField:

Collaboration diagram for vtkCellLocatorInterpolatedVelocityField:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkCellLocatorInterpolatedVelocityField *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetCellLocatorPrototype (vtkAbstractCellLocator *prototype)
virtual void	CopyParameters (vtkAbstractInterpolatedVelocityField *from)
virtual void	AddDataSet (vtkDataSet *dataset)
virtual int	FunctionValues (double *x, double *f)
virtual void	SetLastCellId (vtkIdType c, int dataindex)
virtual vtkAbstractCellLocator *	GetLastCellLocator ()
virtual vtkAbstractCellLocator *	GetCellLocatorPrototype ()
virtual void	SetLastCellId (vtkIdType c)
Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
vtkCompositeInterpolatedVelocityField *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetLastDataSetIndex ()
virtual vtkDataSet *	GetLastDataSet ()
Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
vtkAbstractInterpolatedVelocityField *	NewInstance () const
void	SelectVectors (int fieldAssociation, const char *fieldName)
void	ClearLastCellId ()
virtual void	SetCaching (bool)
virtual bool	GetCaching ()
virtual int	GetCacheHit ()
virtual int	GetCacheMiss ()
virtual vtkIdType	GetLastCellId ()
virtual char *	GetVectorsSelection ()
virtual int	GetVectorsType ()
virtual void	SetNormalizeVector (bool)
virtual bool	GetNormalizeVector ()
int	GetLastWeights (double *w)
int	GetLastLocalCoordinates (double pcoords[3])
Public Member Functions inherited from vtkFunctionSet
vtkFunctionSet *	NewInstance () const
virtual int	GetNumberOfFunctions ()
virtual int	GetNumberOfIndependentVariables ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCellLocatorInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
static vtkCellLocatorInterpolatedVelocityField *	New ()
Static Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
static int	IsTypeOf (const char *type)
static vtkCompositeInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
static int	IsTypeOf (const char *type)
static vtkAbstractInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkFunctionSet
static int	IsTypeOf (const char *type)
static vtkFunctionSet *	SafeDownCast (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCellLocatorInterpolatedVelocityField ()
	~vtkCellLocatorInterpolatedVelocityField ()
int	FunctionValues (vtkDataSet *ds, vtkAbstractCellLocator *loc, double *x, double *f)
virtual int	FunctionValues (vtkDataSet *ds, double *x, double *f)
Protected Member Functions inherited from vtkCompositeInterpolatedVelocityField
	vtkCompositeInterpolatedVelocityField ()
	~vtkCompositeInterpolatedVelocityField ()
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 ()

Additional Inherited Members
Protected Attributes inherited from vtkCompositeInterpolatedVelocityField
int	LastDataSetIndex
vtkCompositeInterpolatedVelocityFieldDataSetsType *	DataSets
Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
int	CacheHit
int	CacheMiss
int	WeightsSize
bool	Caching
bool	NormalizeVector
int	VectorsType
char *	VectorsSelection
double *	Weights
double	LastPCoords [3]
vtkIdType	LastCellId
vtkDataSet *	LastDataSet
vtkGenericCell *	Cell
vtkGenericCell *	GenCell
Protected Attributes inherited from vtkFunctionSet
int	NumFuncs
int	NumIndepVars
Static Protected Attributes inherited from vtkCompositeInterpolatedVelocityField
static const double	TOLERANCE_SCALE
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.

vtkCellLocatorInterpolatedVelocityField 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 vtkCompositeInterpolatedVelocityField, it adopts vtkAbstractCellLocator's sub-classes, e.g., vtkCellLocator and vtkModifiedBSPTree, without the use of vtkPointLocator ( employed by vtkDataSet/vtkPointSet::FindCell() in vtkInterpolatedVelocityField ). vtkCellLocatorInterpolatedVelocityField adopts one level of cell caching. Specifically, if the next point is still within the previous cell, cell location is then simply skipped and vtkCell:: EvaluatePosition() is called to obtain the new parametric coordinates and weights that are used to interpolate the velocity function values across the vertices of this cell. Otherwise a global cell (the target containing the next point) location is instead directly invoked, without exploiting the clue that vtkInterpolatedVelocityField makes use of from the previous cell (an immediate neighbor). Although ignoring the neighbor cell may incur a relatively high computational cost, vtkCellLocatorInterpolatedVelocityField is more robust in locating the target cell than its sibling class vtkInterpolatedVelocityField.

Warning

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

See Also

vtkCompositeInterpolatedVelocityField vtkInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamer vtkStreamTracer

Definition at line 57 of file vtkCellLocatorInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField::Superclass

Definition at line 61 of file vtkCellLocatorInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCellLocatorInterpolatedVelocityField::vtkCellLocatorInterpolatedVelocityField ( )

protected

vtkCellLocatorInterpolatedVelocityField::~vtkCellLocatorInterpolatedVelocityField ( )

protected

Member Function Documentation

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

static

virtual int vtkCellLocatorInterpolatedVelocityField::IsA ( const char *  type )

virtual

Reimplemented from vtkCompositeInterpolatedVelocityField.

static vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkCellLocatorInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeInterpolatedVelocityField.

vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::NewInstance

(

)

const

void vtkCellLocatorInterpolatedVelocityField::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Reimplemented from vtkAbstractInterpolatedVelocityField.

static vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::New ( )

static

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

virtual vtkAbstractCellLocator* vtkCellLocatorInterpolatedVelocityField::GetLastCellLocator ( )

virtual

Get the cell locator attached to the most recently visited dataset.

virtual vtkAbstractCellLocator* vtkCellLocatorInterpolatedVelocityField::GetCellLocatorPrototype ( )

virtual

Get the prototype of the cell locator that is used for interpolating the velocity field during integration.

void vtkCellLocatorInterpolatedVelocityField::SetCellLocatorPrototype

(

vtkAbstractCellLocator *

prototype

)

Set a prototype of the cell locator that is used for interpolating the velocity field during integration.

virtual void vtkCellLocatorInterpolatedVelocityField::CopyParameters ( vtkAbstractInterpolatedVelocityField *  from )

virtual

Import parameters. Sub-classes can add more after chaining.

Reimplemented from vtkAbstractInterpolatedVelocityField.

virtual void vtkCellLocatorInterpolatedVelocityField::AddDataSet ( vtkDataSet *  dataset )

virtual

Add a dataset coupled with a cell locator (of type vtkAbstractCellLocator) for vector function evaluation. Note the use of a vtkAbstractCellLocator enables robust cell location. 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 vtkCompositeInterpolatedVelocityField.

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

virtual

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

Implements vtkAbstractInterpolatedVelocityField.

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

virtual

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

Implements vtkAbstractInterpolatedVelocityField.

virtual void vtkCellLocatorInterpolatedVelocityField::SetLastCellId ( vtkIdType  c )

inlinevirtual

Set the cell id cached by the last evaluation.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 102 of file vtkCellLocatorInterpolatedVelocityField.h.

int vtkCellLocatorInterpolatedVelocityField::FunctionValues ( vtkDataSet *  ds, vtkAbstractCellLocator *  loc, double *  x, double *  f  )

protected

Evaluate the velocity field f at point (x, y, z) in a specified dataset (actually of type vtkPointSet only) through the use of the associated vtkAbstractCellLocator::FindCell() (instead of involving vtkPointLocator) to locate the next cell if the given point is outside the current cell.

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

inlineprotectedvirtual

Evaluate the velocity field f at point (x, y, z) in a specified dataset (of type vtkImageData or vtkRectilinearGrid only) by invoking FindCell() to locate the next cell if the given point is outside the current cell.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 125 of file vtkCellLocatorInterpolatedVelocityField.h.

---

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

• dox/Filters/FlowPaths/vtkCellLocatorInterpolatedVelocityField.h