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 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)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkInterpolatedVelocityField *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	AddDataSet (vtkDataSet *dataset)
	Add a dataset used for the implicit function evaluation. More...
virtual int	FunctionValues (double *x, double *f)
	Evaluate the velocity field f at point (x, y, z). More...
virtual int	SnapPointOnCell (double *pOrigin, double *pProj)
	Project the provided point on current cell, current dataset. More...
virtual void	SetLastCellId (vtkIdType c, int dataindex)
	Set the cell id cached by the last evaluation within a specified dataset. More...
virtual void	SetLastCellId (vtkIdType c)
	Set the cell id cached by the last evaluation. More...
Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
vtkCompositeInterpolatedVelocityField *	NewInstance () const
virtual int	GetLastDataSetIndex ()
	Get the most recently visited dataset and it id. More...
virtual vtkDataSet *	GetLastDataSet ()
	Get the most recently visited dataset and it id. More...
Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
vtkAbstractInterpolatedVelocityField *	NewInstance () const
void	SelectVectors (int fieldAssociation, const char *fieldName)
	the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field More...
virtual void	CopyParameters (vtkAbstractInterpolatedVelocityField *from)
	Import parameters. More...
void	ClearLastCellId ()
	Set the last cell id to -1 to incur a global cell search for the next point. More...
virtual void	SetCaching (bool)
	Set/Get the caching flag. More...
virtual bool	GetCaching ()
	Set/Get the caching flag. More...
virtual int	GetCacheHit ()
	Get the caching statistics. More...
virtual int	GetCacheMiss ()
	Get the caching statistics. More...
virtual vtkIdType	GetLastCellId ()
	Get/Set the id of the cell cached from last evaluation. More...
virtual char *	GetVectorsSelection ()
	Get/Set the name of a spcified vector array. More...
virtual int	GetVectorsType ()
	Get/Set the name of a spcified vector array. More...
virtual void	SetNormalizeVector (bool)
	Set/Get the flag indicating vector post-normalization (following vector interpolation). More...
virtual bool	GetNormalizeVector ()
	Set/Get the flag indicating vector post-normalization (following vector interpolation). More...
virtual void	SetForceSurfaceTangentVector (bool)
	If set to true, the first three point of the cell will be used to compute a normal to the cell, this normal will then be removed from the vorticity so the resulting vector in tangent to the cell. More...
virtual bool	GetForceSurfaceTangentVector ()
	If set to true, the first three point of the cell will be used to compute a normal to the cell, this normal will then be removed from the vorticity so the resulting vector in tangent to the cell. More...
virtual void	SetSurfaceDataset (bool)
	If set to true, cell within tolerance factor will always be found, except for edges. More...
virtual bool	GetSurfaceDataset ()
	If set to true, cell within tolerance factor will always be found, except for edges. More...
int	GetLastWeights (double *w)
	Get the interpolation weights cached from last evaluation. More...
int	GetLastLocalCoordinates (double pcoords[3])
	Get the interpolation weights cached from last evaluation. More...
Public Member Functions inherited from vtkFunctionSet
vtkFunctionSet *	NewInstance () const
virtual int	GetNumberOfFunctions ()
	Return the number of functions. More...
virtual int	GetNumberOfIndependentVariables ()
	Return the number of independent variables. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
void	PrintRevisions (ostream &)
	Legacy. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
static vtkInterpolatedVelocityField *	New ()
	Construct a vtkInterpolatedVelocityField without an initial dataset. More...
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)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInterpolatedVelocityField ()
	~vtkInterpolatedVelocityField ()
virtual int	FunctionValues (vtkDataSet *ds, double *x, double *f)
	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. More...
Protected Member Functions inherited from vtkCompositeInterpolatedVelocityField
	vtkCompositeInterpolatedVelocityField ()
	~vtkCompositeInterpolatedVelocityField ()
Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
	vtkAbstractInterpolatedVelocityField ()
	~vtkAbstractInterpolatedVelocityField ()
virtual bool	CheckPCoords (double pcoords[3])
	Check that all three pcoords are between 0 and 1 included. More...
virtual bool	FindAndUpdateCell (vtkDataSet *ds, double *x)
	Try to find the cell closest to provided x point in provided dataset, By first testing inclusion in it's cached cell and neighbor Then testing globally Then , only if surfacic is activated finding the closest cell using FindPoint and comparing distance with tolerance. More...
virtual void	SetVectorsSelection (const char *)
	Set the name of a specific vector to be interpolated. More...
void	FastCompute (vtkDataArray *vectors, double f[3])
	If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly interpolated using the known weights and the cached generic cell. More...
bool	InterpolatePoint (vtkPointData *outPD, vtkIdType outIndex)
	If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly interpolated using the known weights and the cached generic cell. More...
vtkGenericCell *	GetLastCell ()
	If all weights have been computed (parametric coords etc all valid), a scalar/vector can be quickly interpolated using the known weights and the cached generic cell. More...
Protected Member Functions inherited from vtkFunctionSet
	vtkFunctionSet ()
	~vtkFunctionSet () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

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
bool	ForceSurfaceTangentVector
bool	SurfaceDataset
int	VectorsType
char *	VectorsSelection
double *	Weights
double	LastPCoords [3]
int	LastSubId
vtkIdType	LastCellId
vtkDataSet *	LastDataSet
vtkGenericCell *	Cell
vtkGenericCell *	GenCell
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 inherited from vtkCompositeInterpolatedVelocityField
static const double	TOLERANCE_SCALE
Static Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
static const double	TOLERANCE_SCALE
static const double	SURFACE_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 vtkCompositeInterpolatedVelocityField, 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

vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamTracer

Definition at line 60 of file vtkInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkCompositeInterpolatedVelocityField vtkInterpolatedVelocityField::Superclass

Definition at line 65 of file vtkInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField ( )

inlineprotected

Definition at line 104 of file vtkInterpolatedVelocityField.h.

vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField ( )

inlineprotected

Definition at line 105 of file vtkInterpolatedVelocityField.h.

Member Function Documentation

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

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

static

virtual vtkObjectBase* vtkInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositeInterpolatedVelocityField.

vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::NewInstance

(

)

const

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

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

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

virtual

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

Implements vtkAbstractInterpolatedVelocityField.

virtual int vtkInterpolatedVelocityField::SnapPointOnCell ( double *  pOrigin, double *  pProj  )

virtual

Project the provided point on current cell, current dataset.

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 100 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 114 of file vtkInterpolatedVelocityField.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Filters/FlowPaths/vtkInterpolatedVelocityField.h