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 Member Functions
void	AddDataSet (vtkDataSet *dataset) override
	Add a dataset used for the implicit function evaluation.

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

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.

Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCompositeInterpolatedVelocityField *	NewInstance () const

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

virtual void	AddDataSet (vtkDataSet *dataset)=0
	Add a dataset for implicit velocity function evaluation.

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

Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractInterpolatedVelocityField *	NewInstance () const

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

virtual vtkDataSet *	GetLastDataSet ()

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

void	SelectVectors (int fieldAssociation, const char *fieldName)
	the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field

virtual void	CopyParameters (vtkAbstractInterpolatedVelocityField *from)
	Import parameters.

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

void	ClearLastCellId ()
	Set the last cell id to -1 to incur a global cell search for the next point.

virtual int	FunctionValues (double x, double f)
	Evaluate functions at x_j.

virtual int	FunctionValues (double x, double f, void *vtkNotUsed(userData))

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 spcified vector array.

virtual int	GetVectorsType ()
	Get/Set the name of a spcified 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.

Public Member Functions inherited from vtkFunctionSet
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkFunctionSet *	NewInstance () const

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

virtual int	FunctionValues (double x, double f)
	Evaluate functions at x_j.

virtual int	FunctionValues (double x, double f, void *vtkNotUsed(userData))

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)

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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.

Static Public Member Functions
static vtkInterpolatedVelocityField *	New ()
	Construct a vtkInterpolatedVelocityField without an initial dataset.

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int 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 int	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
	vtkInterpolatedVelocityField ()=default

	~vtkInterpolatedVelocityField () override=default

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 vtkCompositeInterpolatedVelocityField
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeInterpolatedVelocityField ()

	~vtkCompositeInterpolatedVelocityField () override

Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractInterpolatedVelocityField ()

	~vtkAbstractInterpolatedVelocityField () override

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 bool	CheckPCoords (double pcoords[3])
	Check that all three pcoords are between 0 and 1 included.

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.

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.

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.

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.

Protected Member Functions inherited from vtkFunctionSet
virtual vtkObjectBase *	NewInstanceInternal () const

	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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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 vtkInterpolatedVelocityField *	SafeDownCast (vtkObjectBase *o)
	Standard methods for type information and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for type information and printing.

vtkInterpolatedVelocityField *	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

Public Types inherited from vtkAbstractInterpolatedVelocityField
typedef vtkFunctionSet	Superclass

Public Types inherited from vtkFunctionSet
typedef vtkObject	Superclass

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

vtkFindCellStrategy *	FindCellStrategy

vtkStrategyMap *	StrategyMap

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

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 next 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, a point locator is employed as a crucial tool underlying the interpolation process. The use of a point locator, while faster than a cell locator, is not optimal and may cause vtkInterpolatedVelocityField to return incorrect results (i.e., premature streamline termination) for datasets defined on complex grids (especially those this discontinuous/incompatible cells). In these cases, try vtkCellLocatorInterpolatedVelocityField which produces the best results at the cost of speed.

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

Member Typedef Documentation

◆ Superclass

typedef vtkCompositeInterpolatedVelocityField vtkInterpolatedVelocityField::Superclass

Standard methods for type information and printing.

Definition at line 78 of file vtkInterpolatedVelocityField.h.

Constructor & Destructor Documentation

◆ vtkInterpolatedVelocityField()

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField ( )

protecteddefault

◆ ~vtkInterpolatedVelocityField()

vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkInterpolatedVelocityField * vtkInterpolatedVelocityField::New ( )

static

Construct a vtkInterpolatedVelocityField without an initial dataset.

Caching is set on and LastCellId is set to -1.

◆ IsTypeOf()

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

static

Standard methods for type information and printing.

◆ IsA()

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

virtual

Standard methods for type information and printing.

Reimplemented from vtkCompositeInterpolatedVelocityField.

◆ SafeDownCast()

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

static

Standard methods for type information and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for type information and printing.

Reimplemented from vtkCompositeInterpolatedVelocityField.

◆ NewInstance()

vtkInterpolatedVelocityField * vtkInterpolatedVelocityField::NewInstance ( ) const

Standard methods for type information and printing.

◆ PrintSelf()

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

overridevirtual

Standard methods for type information and printing.

Reimplemented from vtkCompositeInterpolatedVelocityField.

◆ AddDataSet()

void vtkInterpolatedVelocityField::AddDataSet ( vtkDataSet * dataset )

overridevirtual

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.

◆ FunctionValues() [1/2]

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

overridevirtual

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

Implements vtkAbstractInterpolatedVelocityField.

◆ SnapPointOnCell()

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

virtual

Project the provided point on current cell, current dataset.

◆ SetLastCellId() [1/2]

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

overridevirtual

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

Implements vtkAbstractInterpolatedVelocityField.

◆ SetLastCellId() [2/2]

void vtkInterpolatedVelocityField::SetLastCellId ( vtkIdType c )

inlineoverridevirtual

Set the cell id cached by the last evaluation.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 109 of file vtkInterpolatedVelocityField.h.

◆ FunctionValues() [2/2]

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

inlineoverrideprotectedvirtual

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.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 122 of file vtkInterpolatedVelocityField.h.

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

Filters/FlowPaths/vtkInterpolatedVelocityField.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkInterpolatedVelocityField()

◆ ~vtkInterpolatedVelocityField()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AddDataSet()

◆ FunctionValues() [1/2]

◆ SnapPointOnCell()

◆ SetLastCellId() [1/2]

◆ SetLastCellId() [2/2]

◆ FunctionValues() [2/2]