VTK  9.2.6
vtkCachingInterpolatedVelocityField Class Reference

Interface for obtaining interpolated velocity values. More...

#include <vtkCachingInterpolatedVelocityField.h>

Inheritance diagram for vtkCachingInterpolatedVelocityField:
[legend]
Collaboration diagram for vtkCachingInterpolatedVelocityField:
[legend]

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.
vtkCachingInterpolatedVelocityFieldNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
virtual void SetDataSet (int I, vtkDataSet *dataset, bool staticdataset, vtkAbstractCellLocator *locator)
 Add a dataset used by the interpolation function evaluation.
void SetLastCellInfo (vtkIdType c, int datasetindex)
 Set LastCellId to c and LastCacheIndex datasetindex, cached from last evaluation.
void ClearLastCellInfo ()
 Set LastCellId to -1 and Cache to nullptr so that the next search does not start from the previous cell.
virtual int FunctionValues (double *x, double *f, void *vtkNotUsed(userData))
int FunctionValues (double *x, double *f) override
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}.
virtual int InsideTest (double *x)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}.
virtual char * GetVectorsSelection ()
 If you want to work with an arbitrary vector array, then set its name here.
void SelectVectors (const char *fieldName)
 If you want to work with an arbitrary vector array, then set its name here.
int GetLastWeights (double *w)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1).
int GetLastLocalCoordinates (double pcoords[3])
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1).
virtual int GetCellCacheHit ()
 Caching statistics.
virtual int GetDataSetCacheHit ()
 Caching statistics.
virtual int GetCacheMiss ()
 Caching statistics.
Public Member Functions inherited from vtkFunctionSet
vtkFunctionSetNewInstance () 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)
int InvokeEvent (unsigned long event)
int 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.
vtkCommandGetCommand (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.
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 Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
static vtkCachingInterpolatedVelocityFieldSafeDownCast (vtkObjectBase *o)
static vtkCachingInterpolatedVelocityFieldNew ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set.
Static Public Member Functions inherited from vtkFunctionSet
static vtkTypeBool IsTypeOf (const char *type)
static vtkFunctionSetSafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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

virtual vtkObjectBaseNewInstanceInternal () const
 vtkCachingInterpolatedVelocityField ()
 ~vtkCachingInterpolatedVelocityField () override
virtual void SetVectorsSelection (const char *)
int FunctionValues (IVFDataSetInfo *cache, double *x, double *f)
int InsideTest (IVFDataSetInfo *cache, double *x)
void FastCompute (IVFDataSetInfo *cache, double f[3])
 If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.
bool InterpolatePoint (vtkPointData *outPD, vtkIdType outIndex)
 If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.
bool InterpolatePoint (vtkCachingInterpolatedVelocityField *inCIVF, vtkPointData *outPD, vtkIdType outIndex)
 If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.
vtkGenericCellGetLastCell ()
 If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.
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 &)

Protected Attributes

vtkGenericCellTempCell
int CellCacheHit
int DataSetCacheHit
int CacheMiss
int LastCacheIndex
int LastCellId
IVFDataSetInfo * Cache
IVFCacheList CacheList
char * VectorsSelection
std::vector< double > Weights
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

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

Interface for obtaining interpolated velocity values.

vtkCachingInterpolatedVelocityField acts as a continuous velocity field by performing cell interpolation on the underlying vtkDataSet. This is a concrete sub-class of vtkFunctionSet with NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). Normally, every time an evaluation is performed, the cell which contains the point (x,y,z) has to be found by calling FindCell. This is a computationally expensive operation. In certain cases, the cell search can be avoided or shortened by providing a guess for the cell id. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkCachingInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.

Warning
vtkCachingInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
See also
vtkFunctionSet vtkStreamTracer
Todo
Need to clean up style to match vtk/Kitware standards. Please help.

Definition at line 68 of file vtkCachingInterpolatedVelocityField.h.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCachingInterpolatedVelocityField()

vtkCachingInterpolatedVelocityField::vtkCachingInterpolatedVelocityField ( )
protected

◆ ~vtkCachingInterpolatedVelocityField()

vtkCachingInterpolatedVelocityField::~vtkCachingInterpolatedVelocityField ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCachingInterpolatedVelocityField::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFunctionSet.

◆ NewInstance()

vtkCachingInterpolatedVelocityField * vtkCachingInterpolatedVelocityField::NewInstance ( ) const

◆ PrintSelf()

void vtkCachingInterpolatedVelocityField::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 vtkObjectBase.

◆ New()

vtkCachingInterpolatedVelocityField * vtkCachingInterpolatedVelocityField::New ( )
static

Construct a vtkCachingInterpolatedVelocityField with no initial data set.

LastCellId is set to -1.

◆ FunctionValues() [1/3]

int vtkCachingInterpolatedVelocityField::FunctionValues ( double * x,
double * f )
overridevirtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}.

returns 1 if valid, 0 if test failed

Reimplemented from vtkFunctionSet.

◆ InsideTest() [1/2]

virtual int vtkCachingInterpolatedVelocityField::InsideTest ( double * x)
virtual

Evaluate the velocity field, f={u,v,w}, at {x, y, z}.

returns 1 if valid, 0 if test failed

◆ SetDataSet()

virtual void vtkCachingInterpolatedVelocityField::SetDataSet ( int I,
vtkDataSet * dataset,
bool staticdataset,
vtkAbstractCellLocator * locator )
virtual

Add a dataset used by the interpolation function evaluation.

◆ GetVectorsSelection()

virtual char * vtkCachingInterpolatedVelocityField::GetVectorsSelection ( )
virtual

If you want to work with an arbitrary vector array, then set its name here.

By default this in nullptr and the filter will use the active vector array.

◆ SelectVectors()

void vtkCachingInterpolatedVelocityField::SelectVectors ( const char * fieldName)
inline

If you want to work with an arbitrary vector array, then set its name here.

By default this in nullptr and the filter will use the active vector array.

Definition at line 106 of file vtkCachingInterpolatedVelocityField.h.

◆ SetLastCellInfo()

void vtkCachingInterpolatedVelocityField::SetLastCellInfo ( vtkIdType c,
int datasetindex )

Set LastCellId to c and LastCacheIndex datasetindex, cached from last evaluation.

If c isn't -1 then the corresponding cell is stored in Cache->Cell. These values should be valid or an assertion will be triggered.

◆ ClearLastCellInfo()

void vtkCachingInterpolatedVelocityField::ClearLastCellInfo ( )

Set LastCellId to -1 and Cache to nullptr so that the next search does not start from the previous cell.

◆ GetLastWeights()

int vtkCachingInterpolatedVelocityField::GetLastWeights ( double * w)

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1).

Otherwise, it does not change w and returns 0.

◆ GetLastLocalCoordinates()

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

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1).

Otherwise, it does not change w and returns 0.

◆ GetCellCacheHit()

virtual int vtkCachingInterpolatedVelocityField::GetCellCacheHit ( )
virtual

Caching statistics.

◆ GetDataSetCacheHit()

virtual int vtkCachingInterpolatedVelocityField::GetDataSetCacheHit ( )
virtual

Caching statistics.

◆ GetCacheMiss()

virtual int vtkCachingInterpolatedVelocityField::GetCacheMiss ( )
virtual

Caching statistics.

◆ SetVectorsSelection()

virtual void vtkCachingInterpolatedVelocityField::SetVectorsSelection ( const char * )
protectedvirtual

◆ FunctionValues() [2/3]

int vtkCachingInterpolatedVelocityField::FunctionValues ( IVFDataSetInfo * cache,
double * x,
double * f )
protected

◆ InsideTest() [2/2]

int vtkCachingInterpolatedVelocityField::InsideTest ( IVFDataSetInfo * cache,
double * x )
protected

◆ FastCompute()

void vtkCachingInterpolatedVelocityField::FastCompute ( IVFDataSetInfo * cache,
double f[3] )
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ InterpolatePoint() [1/2]

bool vtkCachingInterpolatedVelocityField::InterpolatePoint ( vtkPointData * outPD,
vtkIdType outIndex )
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ InterpolatePoint() [2/2]

bool vtkCachingInterpolatedVelocityField::InterpolatePoint ( vtkCachingInterpolatedVelocityField * inCIVF,
vtkPointData * outPD,
vtkIdType outIndex )
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ GetLastCell()

vtkGenericCell * vtkCachingInterpolatedVelocityField::GetLastCell ( )
protected

If all weights have been computed (parametric coords etc all valid) then we can quickly interpolate a scalar/vector using the known weights and the generic cell which has been stored.

This function is primarily reserved for use by vtkTemporalInterpolatedVelocityField

◆ FunctionValues() [3/3]

virtual int vtkFunctionSet::FunctionValues ( double * x,
double * f,
void * vtkNotUseduserData )
inlinevirtual

Reimplemented from vtkFunctionSet.

Definition at line 50 of file vtkFunctionSet.h.

◆ vtkTemporalInterpolatedVelocityField

Definition at line 164 of file vtkCachingInterpolatedVelocityField.h.

Member Data Documentation

◆ TempCell

vtkGenericCell* vtkCachingInterpolatedVelocityField::TempCell
protected

Definition at line 145 of file vtkCachingInterpolatedVelocityField.h.

◆ CellCacheHit

int vtkCachingInterpolatedVelocityField::CellCacheHit
protected

Definition at line 146 of file vtkCachingInterpolatedVelocityField.h.

◆ DataSetCacheHit

int vtkCachingInterpolatedVelocityField::DataSetCacheHit
protected

Definition at line 147 of file vtkCachingInterpolatedVelocityField.h.

◆ CacheMiss

int vtkCachingInterpolatedVelocityField::CacheMiss
protected

Definition at line 148 of file vtkCachingInterpolatedVelocityField.h.

◆ LastCacheIndex

int vtkCachingInterpolatedVelocityField::LastCacheIndex
protected

Definition at line 149 of file vtkCachingInterpolatedVelocityField.h.

◆ LastCellId

int vtkCachingInterpolatedVelocityField::LastCellId
protected

Definition at line 150 of file vtkCachingInterpolatedVelocityField.h.

◆ Cache

IVFDataSetInfo* vtkCachingInterpolatedVelocityField::Cache
protected

Definition at line 151 of file vtkCachingInterpolatedVelocityField.h.

◆ CacheList

IVFCacheList vtkCachingInterpolatedVelocityField::CacheList
protected

Definition at line 152 of file vtkCachingInterpolatedVelocityField.h.

◆ VectorsSelection

char* vtkCachingInterpolatedVelocityField::VectorsSelection
protected

Definition at line 153 of file vtkCachingInterpolatedVelocityField.h.

◆ Weights

std::vector<double> vtkCachingInterpolatedVelocityField::Weights
protected

Definition at line 155 of file vtkCachingInterpolatedVelocityField.h.


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