VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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. More...
 
vtkCachingInterpolatedVelocityFieldNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetDataSet (int I, vtkDataSet *dataset, bool staticdataset, vtkAbstractCellLocator *locator)
 Add a dataset used by the interpolation function evaluation. More...
 
void SetLastCellInfo (vtkIdType c, int datasetindex)
 Set LastCellId to c and LastCacheIndex datasetindex, cached from last evaluation. More...
 
void ClearLastCellInfo ()
 Set LastCellId to -1 and Cache to nullptr so that the next search does not start from the previous cell. More...
 
int FunctionValues (double *x, double *f) override
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. More...
 
virtual int InsideTest (double *x)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. More...
 
virtual char * GetVectorsSelection ()
 If you want to work with an arbitrary vector array, then set its name here. More...
 
void SelectVectors (const char *fieldName)
 If you want to work with an arbitrary vector array, then set its name here. More...
 
int GetLastWeights (double *w)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). More...
 
int GetLastLocalCoordinates (double pcoords[3])
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). More...
 
virtual int GetCellCacheHit ()
 Caching statistics. More...
 
virtual int GetDataSetCacheHit ()
 Caching statistics. More...
 
virtual int GetCacheMiss ()
 Caching statistics. More...
 
- Public Member Functions inherited from vtkFunctionSet
vtkFunctionSetNewInstance () const
 
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 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...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCachingInterpolatedVelocityFieldSafeDownCast (vtkObjectBase *o)
 
static vtkCachingInterpolatedVelocityFieldNew ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set. More...
 
- 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. 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

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. More...
 
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. More...
 
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. More...
 
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. More...
 
- Protected Member Functions inherited from vtkFunctionSet
 vtkFunctionSet ()
 
 ~vtkFunctionSet () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkGenericCellTempCell
 
int CellCacheHit
 
int DataSetCacheHit
 
int CacheMiss
 
int LastCacheIndex
 
int LastCellId
 
IVFDataSetInfo * Cache
 
IVFCacheList CacheList
 
char * VectorsSelection
 
std::vector< doubleWeights
 
- Protected Attributes inherited from vtkFunctionSet
int NumFuncs
 
int NumIndepVars
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkTemporalInterpolatedVelocityField
 

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 65 of file vtkCachingInterpolatedVelocityField.h.

Member Typedef Documentation

Definition at line 68 of file vtkCachingInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCachingInterpolatedVelocityField::vtkCachingInterpolatedVelocityField ( )
protected
vtkCachingInterpolatedVelocityField::~vtkCachingInterpolatedVelocityField ( )
overrideprotected

Member Function Documentation

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

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCachingInterpolatedVelocityField::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFunctionSet.

vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::NewInstance ( ) const
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 vtkFunctionSet.

static vtkCachingInterpolatedVelocityField* vtkCachingInterpolatedVelocityField::New ( )
static

Construct a vtkCachingInterpolatedVelocityField with no initial data set.

LastCellId is set to -1.

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.

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

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

Add a dataset used by the interpolation function evaluation.

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.

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 99 of file vtkCachingInterpolatedVelocityField.h.

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.

void vtkCachingInterpolatedVelocityField::ClearLastCellInfo ( )

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

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.

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.

virtual int vtkCachingInterpolatedVelocityField::GetCellCacheHit ( )
virtual

Caching statistics.

virtual int vtkCachingInterpolatedVelocityField::GetDataSetCacheHit ( )
virtual

Caching statistics.

virtual int vtkCachingInterpolatedVelocityField::GetCacheMiss ( )
virtual

Caching statistics.

virtual void vtkCachingInterpolatedVelocityField::SetVectorsSelection ( const char *  )
protectedvirtual
int vtkCachingInterpolatedVelocityField::FunctionValues ( IVFDataSetInfo *  cache,
double x,
double f 
)
protected
int vtkCachingInterpolatedVelocityField::InsideTest ( IVFDataSetInfo *  cache,
double x 
)
protected
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

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

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

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

Friends And Related Function Documentation

Definition at line 158 of file vtkCachingInterpolatedVelocityField.h.

Member Data Documentation

vtkGenericCell* vtkCachingInterpolatedVelocityField::TempCell
protected

Definition at line 139 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::CellCacheHit
protected

Definition at line 140 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::DataSetCacheHit
protected

Definition at line 141 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::CacheMiss
protected

Definition at line 142 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::LastCacheIndex
protected

Definition at line 143 of file vtkCachingInterpolatedVelocityField.h.

int vtkCachingInterpolatedVelocityField::LastCellId
protected

Definition at line 144 of file vtkCachingInterpolatedVelocityField.h.

IVFDataSetInfo* vtkCachingInterpolatedVelocityField::Cache
protected

Definition at line 145 of file vtkCachingInterpolatedVelocityField.h.

IVFCacheList vtkCachingInterpolatedVelocityField::CacheList
protected

Definition at line 146 of file vtkCachingInterpolatedVelocityField.h.

char* vtkCachingInterpolatedVelocityField::VectorsSelection
protected

Definition at line 147 of file vtkCachingInterpolatedVelocityField.h.

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

Definition at line 149 of file vtkCachingInterpolatedVelocityField.h.


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