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:

Static Public Member Functions
static vtkCellLocatorInterpolatedVelocityField *	New ()
	Construct a vtkCompositeInterpolatedVelocityField subclass.
Static Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
static vtkCompositeInterpolatedVelocityField *	New ()
	Construct a vtkCompositeInterpolatedVelocityField class.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.
static vtkCompositeInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.
Static Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for obtaining type information and printing the object state.
static vtkAbstractInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
	Standard methods for obtaining type information and printing the object state.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkCellLocatorInterpolatedVelocityField ()
	~vtkCellLocatorInterpolatedVelocityField () override
Protected Member Functions inherited from vtkCompositeInterpolatedVelocityField
	vtkCompositeInterpolatedVelocityField ()
	~vtkCompositeInterpolatedVelocityField () override
int	FunctionValues (vtkDataSet *ds, double *x, double *f) override
	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::FindCell() or vtkRectilinearGrid::FindCell() to fulfill the same task if the point is outside the current cell.
Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
	vtkAbstractInterpolatedVelocityField ()
	~vtkAbstractInterpolatedVelocityField () override
virtual bool	FindAndUpdateCell (vtkDataSet *ds, vtkFindCellStrategy *strategy, 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.
virtual void	SetVectorsSelection (const char *)
	Set the name of a specific vector to be interpolated.
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.
void	FastCompute (vtkAbstractInterpolatedVelocityField *inIVF, 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.
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.
bool	InterpolatePoint (vtkAbstractInterpolatedVelocityField *inIVF, 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.
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.
virtual int	SelfInitialize ()
	These methods pertain to initializing the vector field by subclasses (which may have special initialization needs).
void	AddToDataSetsInfo (vtkDataSet *, vtkFindCellStrategy *, vtkDataArray *vectors)
	These methods pertain to initializing the vector field by subclasses (which may have special initialization needs).
size_t	GetDataSetsInfoSize ()
	These methods pertain to initializing the vector field by subclasses (which may have special initialization needs).
std::vector< vtkDataSetInformation >::iterator	GetDataSetInfo (vtkDataSet *dataset)
	Define a FindCell() strategy, keep track of the strategies (and other cached information) associated with each dataset.
Protected Member Functions inherited from vtkFunctionSet
	vtkFunctionSet ()
	~vtkFunctionSet () override=default
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
typedef vtkCompositeInterpolatedVelocityField	Superclass
	Standard methods for type information and printing.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for type information and printing.
static vtkCellLocatorInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.
vtkCellLocatorInterpolatedVelocityField *	NewInstance () const
	Standard methods for type information and printing.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for type information and printing.

Additional Inherited Members
Public Types inherited from vtkCompositeInterpolatedVelocityField
typedef vtkAbstractInterpolatedVelocityField	Superclass
	Standard methods for type information and printing.
Public Types inherited from vtkAbstractInterpolatedVelocityField
enum	VelocityFieldInitializationState { NOT_INITIALIZED = 0 , INITIALIZE_ALL_DATASETS = 1 , SELF_INITIALIZE = 2 }
typedef vtkFunctionSet	Superclass
	Standard methods for obtaining type information and printing the object state.
Public Types inherited from vtkFunctionSet
typedef vtkObject	Superclass
Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
virtual void	AddDataSet (vtkDataSet *dataset, size_t maxCellSize=0)
	Add a dataset for implicit velocity function evaluation.
int	FunctionValues (double *x, double *f) override
	Evaluate the velocity field f at point (x, y, z).
int	InsideTest (double *x)
	Check if point x is inside the dataset.
virtual int	SnapPointOnCell (double *pOrigin, double *pProj)
	Project the provided point on current cell, current dataset.
void	SetLastCellId (vtkIdType c, int dataindex) override
	Set the cell id cached by the last evaluation within a specified dataset.
void	SetLastCellId (vtkIdType c) override
	Set the cell id cached by the last evaluation.
void	CopyParameters (vtkAbstractInterpolatedVelocityField *from) override
	Copy essential parameters between instances of this class.
int	FunctionValues (double *x, double *f) override=0
	Evaluate the velocity field f at point (x, y, z).
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.
virtual int	FunctionValues (double *x, double *f)
	Evaluate functions at x_j.
virtual int	FunctionValues (double *x, double *f, void *vtkNotUsed(userData))
virtual int	GetLastDataSetIndex ()
	Get the most recently visited dataset and its id.
virtual int	GetCacheDataSetHit ()
	Get Cache DataSet hits and misses.
virtual int	GetCacheDataSetMiss ()
	Get Cache DataSet hits and misses.
vtkCompositeInterpolatedVelocityField *	NewInstance () const
	Standard methods for type information and printing.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for type information and printing.
Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
virtual vtkDataSet *	GetLastDataSet ()
void	SelectVectors (int fieldAssociation, const char *fieldName)
	the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field
void	ClearLastCellId ()
	Set the last cell id to -1 to incur a global cell search for the next point.
virtual void	Initialize (vtkCompositeDataSet *compDS, int initStrategy=INITIALIZE_ALL_DATASETS)
	The Initialize() method is used to build and cache supporting structures (such as locators) which are used when operating on the interpolated velocity field.
virtual int	GetInitializationState ()
	The Initialize() method is used to build and cache supporting structures (such as locators) which are used when operating on the interpolated velocity field.
virtual void	SetCaching (bool)
	Set/Get the caching flag.
virtual bool	GetCaching ()
	Set/Get the caching flag.
virtual int	GetCacheHit ()
	Get the caching statistics.
virtual int	GetCacheMiss ()
	Get the caching statistics.
virtual vtkIdType	GetLastCellId ()
	Get/Set the id of the cell cached from last evaluation.
virtual char *	GetVectorsSelection ()
	Get/Set the name of a specified vector array.
virtual int	GetVectorsType ()
	Get/Set the name of a specified vector array.
virtual void	SetNormalizeVector (bool)
	Set/Get the flag indicating vector post-normalization (following vector interpolation).
virtual bool	GetNormalizeVector ()
	Set/Get the flag indicating vector post-normalization (following vector interpolation).
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.
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.
virtual void	SetSurfaceDataset (bool)
	If set to true, cell within tolerance factor will always be found, except for edges.
virtual bool	GetSurfaceDataset ()
	If set to true, cell within tolerance factor will always be found, except for edges.
int	GetLastWeights (double *w)
	Get the interpolation weights cached from last evaluation.
int	GetLastLocalCoordinates (double pcoords[3])
	Get the interpolation weights cached from last evaluation.
virtual void	SetFindCellStrategy (vtkFindCellStrategy *)
	Set / get the strategy used to perform the FindCell() operation.
virtual vtkFindCellStrategy *	GetFindCellStrategy ()
	Set / get the strategy used to perform the FindCell() operation.
vtkAbstractInterpolatedVelocityField *	NewInstance () const
	Standard methods for obtaining type information and printing the object state.
Public Member Functions inherited from vtkFunctionSet
vtkFunctionSet *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual int	GetNumberOfFunctions ()
	Return the number of functions.
virtual int	GetNumberOfIndependentVariables ()
	Return the number of independent variables.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkCompositeInterpolatedVelocityField
int	CacheDataSetHit
int	CacheDataSetMiss
int	LastDataSetIndex
std::vector< DataSetBoundsInformation >	DataSetsBoundsInfo
Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
int	CacheHit
int	CacheMiss
bool	Caching
bool	NormalizeVector
bool	ForceSurfaceTangentVector
bool	SurfaceDataset
int	VectorsType
char *	VectorsSelection
std::vector< double >	Weights
double	LastPCoords [3]
int	LastSubId
double	LastClosestPoint [3]
vtkIdType	LastCellId
vtkDataSet *	LastDataSet
vtkNew< vtkGenericCell >	LastCell
vtkNew< vtkGenericCell >	CurrentCell
vtkNew< vtkIdList >	PointIds
int	InitializationState
	Make sure the velocity field is initialized: record the initialization strategy.
vtkFindCellStrategy *	FindCellStrategy
	Define a FindCell() strategy, keep track of the strategies (and other cached information) associated with each dataset.
std::vector< vtkDataSetInformation >	DataSetsInfo
	Define a FindCell() strategy, keep track of the strategies (and other cached information) associated with each dataset.
Protected Attributes inherited from vtkFunctionSet
int	NumFuncs
int	NumIndepVars
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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::FindCell() and 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 49 of file vtkCellLocatorInterpolatedVelocityField.h.

Member Typedef Documentation

Superclass

typedef vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField::Superclass

Standard methods for type information and printing.

Definition at line 64 of file vtkCellLocatorInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCellLocatorInterpolatedVelocityField()

vtkCellLocatorInterpolatedVelocityField::vtkCellLocatorInterpolatedVelocityField ( )

protected

~vtkCellLocatorInterpolatedVelocityField()

vtkCellLocatorInterpolatedVelocityField::~vtkCellLocatorInterpolatedVelocityField ( )

overrideprotected

Member Function Documentation

New()

static vtkCellLocatorInterpolatedVelocityField * vtkCellLocatorInterpolatedVelocityField::New ( )

static

Construct a vtkCompositeInterpolatedVelocityField subclass.

IsTypeOf()

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

static

Standard methods for type information and printing.

IsA()

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

virtual

Standard methods for type information and printing.

Reimplemented from vtkCompositeInterpolatedVelocityField.

SafeDownCast()

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

static

Standard methods for type information and printing.

NewInstanceInternal()

virtual vtkObjectBase * vtkCellLocatorInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkCompositeInterpolatedVelocityField.

NewInstance()

vtkCellLocatorInterpolatedVelocityField * vtkCellLocatorInterpolatedVelocityField::NewInstance

(

)

const

Standard methods for type information and printing.

PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkAbstractInterpolatedVelocityField.

---

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

• Filters/FlowPaths/vtkCellLocatorInterpolatedVelocityField.h