An abstract class for obtaining the interpolated velocity values at a point. More...

#include <vtkCompositeInterpolatedVelocityField.h>

Inheritance diagram for vtkCompositeInterpolatedVelocityField:

Collaboration diagram for vtkCompositeInterpolatedVelocityField:

Public Types
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...

vtkCompositeInterpolatedVelocityField *	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)=0
	Add a dataset for implicit velocity function evaluation. More...


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

virtual void	SetLastCellId (vtkIdType c, int dataindex)=0
	Set the id of the most recently visited cell of a dataset. More...

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

virtual int	FunctionValues (double x, double f)=0
	Evaluate the velocity field f at point (x, y, z). 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 void	SetLastCellId (vtkIdType c)
	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 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

	vtkCompositeInterpolatedVelocityField ()

	~vtkCompositeInterpolatedVelocityField ()

Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
	vtkAbstractInterpolatedVelocityField ()

	~vtkAbstractInterpolatedVelocityField ()

virtual int	FunctionValues (vtkDataSet ds, double x, double *f)
	Evaluate the velocity field f at point (x, y, z) in a specified dataset by invoking vtkDataSet::FindCell() to locate the next cell if the given point is outside the current cell. More...

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 &)

Protected Attributes
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
static const double	TOLERANCE_SCALE

Static Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
static const double	TOLERANCE_SCALE

static const double	SURFACE_TOLERANCE_SCALE

Detailed Description

An abstract class for obtaining the interpolated velocity values at a point.

vtkCompositeInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is an abstract sub-class of vtkFunctionSet, NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). With a brute-force scheme, every time an evaluation is performed, the target cell containing point (x,y,z) needs to be found by calling FindCell(), via either vtkDataSet or vtkAbstractCelllocator's sub-classes (vtkCellLocator & vtkModifiedBSPTree). As it incurs a large cost, one (for vtkCellLocatorInterpolatedVelocityField via vtkAbstractCellLocator) or two (for vtkInterpolatedVelocityField via vtkDataSet that involves vtkPointLocator in addressing vtkPointSet) levels of cell caching may be exploited to increase the performance.

For vtkInterpolatedVelocityField, level #0 begins with intra-cell caching. Specifically if the previous cell is valid and the next point is still in it ( i.e., vtkCell::EvaluatePosition() returns 1, coupled with newly created parametric coordinates & weights ), the function values can be interpolated and only vtkCell::EvaluatePosition() is invoked. If this fails, then level #1 follows by inter-cell search for the target cell that contains the next point. By an inter-cell search, the previous cell provides an important clue or serves as an immediate neighbor to aid in locating the target cell via vtkPointSet:: FindCell(). If this still fails, a global cell location / search is invoked via vtkPointSet::FindCell(). Here regardless of either inter-cell or global search, vtkPointLocator is in fact employed (for datasets of type vtkPointSet only, note vtkImageData and vtkRectilinearGrid are able to provide rapid and robust cell location due to the simple mesh topology) as a crucial tool underlying the cell locator. However, the use of vtkPointLocator makes vtkInterpolatedVelocityField non-robust in cell location for vtkPointSet.

For vtkCellLocatorInterpolatedVelocityField, the only caching (level #0) works by intra-cell trial. In case of failure, a global search for the target cell is invoked via vtkAbstractCellLocator::FindCell() and the actual work is done by either vtkCellLocator or vtkModifiedBSPTree (for datasets of type vtkPointSet only, while vtkImageData and vtkRectilinearGrid themselves are able to provide fast robust cell location). Without the involvement of vtkPointLocator, robust cell location is achieved for vtkPointSet.

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

See also: vtkInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamTracer

Definition at line 83 of file vtkCompositeInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkAbstractInterpolatedVelocityField vtkCompositeInterpolatedVelocityField::Superclass

Definition at line 86 of file vtkCompositeInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCompositeInterpolatedVelocityField::vtkCompositeInterpolatedVelocityField ( )

protected

vtkCompositeInterpolatedVelocityField::~vtkCompositeInterpolatedVelocityField ( )

protected

Member Function Documentation

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

static

virtual int vtkCompositeInterpolatedVelocityField::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.

Reimplemented in vtkInterpolatedVelocityField, and vtkCellLocatorInterpolatedVelocityField.

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

static

virtual vtkObjectBase* vtkCompositeInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractInterpolatedVelocityField.

Reimplemented in vtkInterpolatedVelocityField, and vtkCellLocatorInterpolatedVelocityField.

vtkCompositeInterpolatedVelocityField* vtkCompositeInterpolatedVelocityField::NewInstance ( ) const

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

Reimplemented in vtkInterpolatedVelocityField.

virtual int vtkCompositeInterpolatedVelocityField::GetLastDataSetIndex ( )

virtual

Get the most recently visited dataset and it id.

The dataset is used for a guess regarding where the next point will be, without searching through all datasets. When setting the last dataset, care is needed as no reference counting or checks are performed. This feature is intended for custom interpolators only that cache datasets independently.

virtual vtkDataSet* vtkCompositeInterpolatedVelocityField::GetLastDataSet ( )

virtual

Get the most recently visited dataset and it id.

The dataset is used for a guess regarding where the next point will be, without searching through all datasets. When setting the last dataset, care is needed as no reference counting or checks are performed. This feature is intended for custom interpolators only that cache datasets independently.

Reimplemented from vtkAbstractInterpolatedVelocityField.

virtual void vtkCompositeInterpolatedVelocityField::AddDataSet ( vtkDataSet * dataset )

pure virtual

Add a dataset for implicit velocity 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.

Implemented in vtkCellLocatorInterpolatedVelocityField, and vtkInterpolatedVelocityField.