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

#include <vtkAbstractInterpolatedVelocityField.h>

Inheritance diagram for vtkAbstractInterpolatedVelocityField:

Collaboration diagram for vtkAbstractInterpolatedVelocityField:

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

vtkAbstractInterpolatedVelocityField *	NewInstance () const

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

virtual vtkDataSet *	GetLastDataSet ()

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

int	FunctionValues (double x, double f) override=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...


virtual void	SetFindCellStrategy (vtkFindCellStrategy *)
	Set / get the strategy used to perform the FindCell() operation. More...

virtual vtkFindCellStrategy *	GetFindCellStrategy ()
	Set / get the strategy used to perform the FindCell() operation. More...

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

vtkFunctionSet *	NewInstance () const

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

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

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

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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

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

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

static const double	SURFACE_TOLERANCE_SCALE

Friends
class	vtkTemporalInterpolatedVelocityField

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

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

vtkAbstractInterpolatedVelocityField 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: vtkAbstractInterpolatedVelocityField 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 82 of file vtkAbstractInterpolatedVelocityField.h.

Member Typedef Documentation

◆ Superclass

typedef vtkFunctionSet vtkAbstractInterpolatedVelocityField::Superclass

Definition at line 85 of file vtkAbstractInterpolatedVelocityField.h.

Constructor & Destructor Documentation

◆ vtkAbstractInterpolatedVelocityField()

vtkAbstractInterpolatedVelocityField::vtkAbstractInterpolatedVelocityField ( )

protected

◆ ~vtkAbstractInterpolatedVelocityField()

vtkAbstractInterpolatedVelocityField::~vtkAbstractInterpolatedVelocityField ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkAbstractInterpolatedVelocityField::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 vtkFunctionSet.

Reimplemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, vtkCompositeInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAbstractInterpolatedVelocityField::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkFunctionSet.

Reimplemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, vtkCompositeInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ NewInstance()

vtkAbstractInterpolatedVelocityField * vtkAbstractInterpolatedVelocityField::NewInstance ( ) const

◆ PrintSelf()

void vtkAbstractInterpolatedVelocityField::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 vtkFunctionSet.

Reimplemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, vtkCompositeInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ SetCaching()

virtual void vtkAbstractInterpolatedVelocityField::SetCaching ( bool )

virtual

Set/Get the caching flag.

If this flag is turned ON, there are two levels of caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating the function values at any point.

◆ GetCaching()

virtual bool vtkAbstractInterpolatedVelocityField::GetCaching ( )

virtual

Set/Get the caching flag.

If this flag is turned ON, there are two levels of caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating the function values at any point.

◆ GetCacheHit()

virtual int vtkAbstractInterpolatedVelocityField::GetCacheHit ( )

virtual

Get the caching statistics.

CacheHit refers to the number of level #0 cache hits while CacheMiss is the number of level #0 cache misses.

◆ GetCacheMiss()

virtual int vtkAbstractInterpolatedVelocityField::GetCacheMiss ( )

virtual

Get the caching statistics.

CacheHit refers to the number of level #0 cache hits while CacheMiss is the number of level #0 cache misses.

◆ GetLastDataSet()

virtual vtkDataSet * vtkAbstractInterpolatedVelocityField::GetLastDataSet ( )

virtual

◆ GetLastCellId()

virtual vtkIdType vtkAbstractInterpolatedVelocityField::GetLastCellId ( )

virtual

Get/Set the id of the cell cached from last evaluation.

◆ SetLastCellId() [1/2]

virtual void vtkAbstractInterpolatedVelocityField::SetLastCellId ( vtkIdType c )

inlinevirtual

Get/Set the id of the cell cached from last evaluation.

Reimplemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, and vtkInterpolatedVelocityField.

Definition at line 116 of file vtkAbstractInterpolatedVelocityField.h.

◆ SetLastCellId() [2/2]

virtual void vtkAbstractInterpolatedVelocityField::SetLastCellId	(	vtkIdType	c,
		int	dataindex
	)

pure virtual

Set the id of the most recently visited cell of a dataset.

Implemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ GetVectorsSelection()

virtual char * vtkAbstractInterpolatedVelocityField::GetVectorsSelection ( )

virtual

Get/Set the name of a spcified vector array.

By default it is nullptr, with the active vector array for use.

◆ GetVectorsType()

virtual int vtkAbstractInterpolatedVelocityField::GetVectorsType ( )

virtual

Get/Set the name of a spcified vector array.

By default it is nullptr, with the active vector array for use.

◆ SelectVectors()

void vtkAbstractInterpolatedVelocityField::SelectVectors	(	int	fieldAssociation,
		const char *	fieldName
	)

the association type (see vtkDataObject::FieldAssociations) and the name of the velocity data field

◆ SetNormalizeVector()

virtual void vtkAbstractInterpolatedVelocityField::SetNormalizeVector ( bool )

virtual

Set/Get the flag indicating vector post-normalization (following vector interpolation).

Vector post-normalization is required to avoid the 'curve-overshooting' problem (caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed (when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantly-differing velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is. Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep() as subsequent operations, e.g., vorticity computation, may need non-normalized vectors.

◆ GetNormalizeVector()

virtual bool vtkAbstractInterpolatedVelocityField::GetNormalizeVector ( )

virtual

Set/Get the flag indicating vector post-normalization (following vector interpolation).

Vector post-normalization is required to avoid the 'curve-overshooting' problem (caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed (when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantly-differing velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is. Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep() as subsequent operations, e.g., vorticity computation, may need non-normalized vectors.

◆ SetForceSurfaceTangentVector()

virtual void vtkAbstractInterpolatedVelocityField::SetForceSurfaceTangentVector ( bool )

virtual

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.

◆ GetForceSurfaceTangentVector()

virtual bool vtkAbstractInterpolatedVelocityField::GetForceSurfaceTangentVector ( )

virtual

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.

◆ SetSurfaceDataset()

virtual void vtkAbstractInterpolatedVelocityField::SetSurfaceDataset ( bool )

virtual

If set to true, cell within tolerance factor will always be found, except for edges.

◆ GetSurfaceDataset()

virtual bool vtkAbstractInterpolatedVelocityField::GetSurfaceDataset ( )

virtual

If set to true, cell within tolerance factor will always be found, except for edges.

◆ CopyParameters()

virtual void vtkAbstractInterpolatedVelocityField::CopyParameters ( vtkAbstractInterpolatedVelocityField * from )

virtual

Import parameters.

Sub-classes can add more after chaining.

Reimplemented in vtkCellLocatorInterpolatedVelocityField.

◆ FunctionValues() [1/2]

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

overridepure virtual

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

Reimplemented from vtkFunctionSet.

Implemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ ClearLastCellId()

void vtkAbstractInterpolatedVelocityField::ClearLastCellId ( )

inline

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

Definition at line 193 of file vtkAbstractInterpolatedVelocityField.h.

◆ GetLastWeights()

int vtkAbstractInterpolatedVelocityField::GetLastWeights ( double * w )

Get the interpolation weights cached from last evaluation.

Return 1 if the cached cell is valid and 0 otherwise.

◆ GetLastLocalCoordinates()

int vtkAbstractInterpolatedVelocityField::GetLastLocalCoordinates ( double pcoords[3] )

Get the interpolation weights cached from last evaluation.

Return 1 if the cached cell is valid and 0 otherwise.

◆ SetFindCellStrategy()

virtual void vtkAbstractInterpolatedVelocityField::SetFindCellStrategy ( vtkFindCellStrategy * )

virtual

Set / get the strategy used to perform the FindCell() operation.

This strategy is used when operating on vtkPointSet subclasses. Note if the input is a composite dataset then the strategy will be used to clone one strategy per leaf dataset.

◆ GetFindCellStrategy()

virtual vtkFindCellStrategy * vtkAbstractInterpolatedVelocityField::GetFindCellStrategy ( )

virtual

Set / get the strategy used to perform the FindCell() operation.

This strategy is used when operating on vtkPointSet subclasses. Note if the input is a composite dataset then the strategy will be used to clone one strategy per leaf dataset.

◆ SetVectorsSelection()

virtual void vtkAbstractInterpolatedVelocityField::SetVectorsSelection ( const char * )

protectedvirtual

Set the name of a specific vector to be interpolated.

◆ FunctionValues() [2/2]

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

protectedvirtual

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.

To address vtkPointSet, vtkPointLocator is involved via vtkPointSet::FindCell() in vtkInterpolatedVelocityField for cell location. In vtkCellLocatorInterpolatedVelocityField, this function is invoked just to handle vtkImageData and vtkRectilinearGrid that are not assigned with any vtkAbstractCellLocatot-type cell locator. If activated, returned vector will be tangential to the first three point of the cell

Reimplemented in vtkAMRInterpolatedVelocityField, vtkCellLocatorInterpolatedVelocityField, and vtkInterpolatedVelocityField.

◆ CheckPCoords()

virtual bool vtkAbstractInterpolatedVelocityField::CheckPCoords ( double pcoords[3] )

protectedvirtual

Check that all three pcoords are between 0 and 1 included.

◆ FindAndUpdateCell()

virtual bool vtkAbstractInterpolatedVelocityField::FindAndUpdateCell	(	vtkDataSet *	ds,
		double *	x
	)

protectedvirtual

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.

◆ FastCompute()

void vtkAbstractInterpolatedVelocityField::FastCompute	(	vtkDataArray *	vectors,
		double	f[3]
	)

protected

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.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ InterpolatePoint()

bool vtkAbstractInterpolatedVelocityField::InterpolatePoint	(	vtkPointData *	outPD,
		vtkIdType	outIndex
	)

protected

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.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ GetLastCell()

vtkGenericCell * vtkAbstractInterpolatedVelocityField::GetLastCell ( )

inlineprotected

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.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

Definition at line 288 of file vtkAbstractInterpolatedVelocityField.h.

Friends And Related Function Documentation

◆ vtkTemporalInterpolatedVelocityField

friend class vtkTemporalInterpolatedVelocityField

friend

Definition at line 278 of file vtkAbstractInterpolatedVelocityField.h.

Member Data Documentation

◆ TOLERANCE_SCALE

const double vtkAbstractInterpolatedVelocityField::TOLERANCE_SCALE

staticprotected

Definition at line 219 of file vtkAbstractInterpolatedVelocityField.h.

◆ SURFACE_TOLERANCE_SCALE

const double vtkAbstractInterpolatedVelocityField::SURFACE_TOLERANCE_SCALE

staticprotected

Definition at line 220 of file vtkAbstractInterpolatedVelocityField.h.

◆ CacheHit

int vtkAbstractInterpolatedVelocityField::CacheHit

protected

Definition at line 222 of file vtkAbstractInterpolatedVelocityField.h.

◆ CacheMiss

int vtkAbstractInterpolatedVelocityField::CacheMiss

protected

Definition at line 223 of file vtkAbstractInterpolatedVelocityField.h.

◆ WeightsSize

int vtkAbstractInterpolatedVelocityField::WeightsSize

protected

Definition at line 224 of file vtkAbstractInterpolatedVelocityField.h.

◆ Caching

bool vtkAbstractInterpolatedVelocityField::Caching

protected

Definition at line 225 of file vtkAbstractInterpolatedVelocityField.h.

◆ NormalizeVector

bool vtkAbstractInterpolatedVelocityField::NormalizeVector

protected

Definition at line 226 of file vtkAbstractInterpolatedVelocityField.h.

◆ ForceSurfaceTangentVector

bool vtkAbstractInterpolatedVelocityField::ForceSurfaceTangentVector

protected

Definition at line 227 of file vtkAbstractInterpolatedVelocityField.h.

◆ SurfaceDataset

bool vtkAbstractInterpolatedVelocityField::SurfaceDataset

protected

Definition at line 228 of file vtkAbstractInterpolatedVelocityField.h.

◆ VectorsType

int vtkAbstractInterpolatedVelocityField::VectorsType

protected

Definition at line 229 of file vtkAbstractInterpolatedVelocityField.h.

◆ VectorsSelection

char* vtkAbstractInterpolatedVelocityField::VectorsSelection

protected

Definition at line 230 of file vtkAbstractInterpolatedVelocityField.h.

◆ Weights

double* vtkAbstractInterpolatedVelocityField::Weights

protected

Definition at line 231 of file vtkAbstractInterpolatedVelocityField.h.

◆ LastPCoords

double vtkAbstractInterpolatedVelocityField::LastPCoords[3]

protected

Definition at line 232 of file vtkAbstractInterpolatedVelocityField.h.

◆ LastSubId

int vtkAbstractInterpolatedVelocityField::LastSubId

protected

Definition at line 233 of file vtkAbstractInterpolatedVelocityField.h.

◆ LastCellId

vtkIdType vtkAbstractInterpolatedVelocityField::LastCellId

protected

Definition at line 234 of file vtkAbstractInterpolatedVelocityField.h.

◆ LastDataSet

vtkDataSet* vtkAbstractInterpolatedVelocityField::LastDataSet

protected

Definition at line 235 of file vtkAbstractInterpolatedVelocityField.h.

◆ Cell

vtkGenericCell* vtkAbstractInterpolatedVelocityField::Cell

protected

Definition at line 236 of file vtkAbstractInterpolatedVelocityField.h.

◆ GenCell

vtkGenericCell* vtkAbstractInterpolatedVelocityField::GenCell

protected

Definition at line 237 of file vtkAbstractInterpolatedVelocityField.h.

◆ FindCellStrategy

vtkFindCellStrategy* vtkAbstractInterpolatedVelocityField::FindCellStrategy

protected

Definition at line 241 of file vtkAbstractInterpolatedVelocityField.h.

◆ StrategyMap

vtkStrategyMap* vtkAbstractInterpolatedVelocityField::StrategyMap

protected

Definition at line 242 of file vtkAbstractInterpolatedVelocityField.h.

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

Filters/FlowPaths/vtkAbstractInterpolatedVelocityField.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkAbstractInterpolatedVelocityField()

◆ ~vtkAbstractInterpolatedVelocityField()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetCaching()

◆ GetCaching()

◆ GetCacheHit()

◆ GetCacheMiss()

◆ GetLastDataSet()

◆ GetLastCellId()

◆ SetLastCellId() [1/2]

◆ SetLastCellId() [2/2]

◆ GetVectorsSelection()

◆ GetVectorsType()

◆ SelectVectors()

◆ SetNormalizeVector()

◆ GetNormalizeVector()

◆ SetForceSurfaceTangentVector()

◆ GetForceSurfaceTangentVector()

◆ SetSurfaceDataset()

◆ GetSurfaceDataset()

◆ CopyParameters()

◆ FunctionValues() [1/2]

◆ ClearLastCellId()

◆ GetLastWeights()

◆ GetLastLocalCoordinates()

◆ SetFindCellStrategy()

◆ GetFindCellStrategy()

◆ SetVectorsSelection()

◆ FunctionValues() [2/2]

◆ CheckPCoords()

◆ FindAndUpdateCell()

◆ FastCompute()

◆ InterpolatePoint()

◆ GetLastCell()

Friends And Related Function Documentation

◆ vtkTemporalInterpolatedVelocityField

Member Data Documentation

◆ TOLERANCE_SCALE

◆ SURFACE_TOLERANCE_SCALE

◆ CacheHit

◆ CacheMiss

◆ WeightsSize

◆ Caching

◆ NormalizeVector

◆ ForceSurfaceTangentVector

◆ SurfaceDataset

◆ VectorsType

◆ VectorsSelection

◆ Weights

◆ LastPCoords

◆ LastSubId

◆ LastCellId

◆ LastDataSet

◆ Cell

◆ GenCell

◆ FindCellStrategy

◆ StrategyMap