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 vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCellLocatorInterpolatedVelocityField *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetCellLocatorPrototype (vtkAbstractCellLocator *prototype)
	Set a prototype of the cell locator that is used for interpolating the velocity field during integration. More...

void	CopyParameters (vtkAbstractInterpolatedVelocityField *from) override
	Import parameters. More...

void	AddDataSet (vtkDataSet *dataset) override
	Add a dataset coupled with a cell locator (of type vtkAbstractCellLocator) for vector function evaluation. More...

int	FunctionValues (double x, double f) override
	Evaluate the velocity field f at point (x, y, z). More...

void	SetLastCellId (vtkIdType c, int dataindex) override
	Set the cell id cached by the last evaluation within a specified dataset. More...

void	SetLastCellId (vtkIdType c) override
	Set the cell id cached by the last evaluation. More...


virtual vtkAbstractCellLocator *	GetLastCellLocator ()
	Get the cell locator attached to the most recently visited dataset. More...


virtual vtkAbstractCellLocator *	GetCellLocatorPrototype ()
	Get the prototype of the cell locator that is used for interpolating the velocity field during integration. More...

Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
vtkCompositeInterpolatedVelocityField *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual int	GetLastDataSetIndex ()
	Get the most recently visited dataset and it id. More...

Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
vtkAbstractInterpolatedVelocityField *	NewInstance () const

virtual vtkDataSet *	GetLastDataSet ()

void	SelectVectors (int fieldAssociation, const char *fieldName)
	the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field 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 ()

vtkTypeBool	HasObserver (unsigned long event)

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

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	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 vtkTypeBool	IsTypeOf (const char *type)

static vtkCellLocatorInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)

static vtkCellLocatorInterpolatedVelocityField *	New ()
	Construct a vtkCellLocatorInterpolatedVelocityField without an initial dataset. More...

Static Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCompositeInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkFunctionSet
static vtkTypeBool	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

	vtkCellLocatorInterpolatedVelocityField ()

	~vtkCellLocatorInterpolatedVelocityField () override

int	FunctionValues (vtkDataSet ds, vtkAbstractCellLocator loc, double x, double f)
	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. More...

int	FunctionValues (vtkDataSet ds, double x, double *f) override
	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. More...

Protected Member Functions inherited from vtkCompositeInterpolatedVelocityField
	vtkCompositeInterpolatedVelocityField ()

	~vtkCompositeInterpolatedVelocityField () override

Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
	vtkAbstractInterpolatedVelocityField ()

	~vtkAbstractInterpolatedVelocityField () override

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=nullptr)
	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 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.

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 vtkStreamTracer

Definition at line 58 of file vtkCellLocatorInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField::Superclass

Definition at line 62 of file vtkCellLocatorInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCellLocatorInterpolatedVelocityField::vtkCellLocatorInterpolatedVelocityField ( )

protected

vtkCellLocatorInterpolatedVelocityField::~vtkCellLocatorInterpolatedVelocityField ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool vtkCellLocatorInterpolatedVelocityField::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 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
	)

overridevirtual

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

void vtkCellLocatorInterpolatedVelocityField::CopyParameters ( vtkAbstractInterpolatedVelocityField * from )

overridevirtual

Import parameters.

Sub-classes can add more after chaining.

Reimplemented from vtkAbstractInterpolatedVelocityField.

void vtkCellLocatorInterpolatedVelocityField::AddDataSet ( vtkDataSet * dataset )

overridevirtual

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.

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

overridevirtual

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

Implements vtkAbstractInterpolatedVelocityField.

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

overridevirtual

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

Implements vtkAbstractInterpolatedVelocityField.

void vtkCellLocatorInterpolatedVelocityField::SetLastCellId ( vtkIdType c )

inlineoverridevirtual

Set the cell id cached by the last evaluation.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 118 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.

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

inlineoverrideprotectedvirtual

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 139 of file vtkCellLocatorInterpolatedVelocityField.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Filters/FlowPaths/vtkCellLocatorInterpolatedVelocityField.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation