VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkGenericInterpolatedVelocityField Class Reference

Interface for obtaining interpolated velocity values. More...

#include <vtkGenericInterpolatedVelocityField.h>

Inheritance diagram for vtkGenericInterpolatedVelocityField:
[legend]
Collaboration diagram for vtkGenericInterpolatedVelocityField:
[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...
 
vtkGenericInterpolatedVelocityFieldNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int FunctionValues (double *x, double *f) override
 Evaluate the velocity field, f, at (x, y, z, t). More...
 
virtual void AddDataSet (vtkGenericDataSet *dataset)
 Add a dataset used for the implicit function evaluation. More...
 
void ClearLastCell ()
 Set the last cell id to -1 so that the next search does not start from the previous cell. More...
 
vtkGenericAdaptorCellGetLastCell ()
 Return the cell cached from last evaluation. More...
 
int GetLastLocalCoordinates (double pcoords[3])
 Returns the interpolation weights cached from last evaluation if the cached cell is valid (returns 1). More...
 
virtual void CopyParameters (vtkGenericInterpolatedVelocityField *from)
 Copy the user set parameters from source. More...
 
virtual vtkTypeBool GetCaching ()
 Turn caching on/off. More...
 
virtual void SetCaching (vtkTypeBool)
 Turn caching on/off. More...
 
virtual void CachingOn ()
 Turn caching on/off. More...
 
virtual void CachingOff ()
 Turn caching on/off. More...
 
virtual int GetCacheHit ()
 Caching statistics. More...
 
virtual int GetCacheMiss ()
 Caching statistics. 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...
 
virtual vtkGenericDataSetGetLastDataSet ()
 Returns the last dataset that was visited. More...
 
- 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. 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 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 vtkGenericInterpolatedVelocityFieldSafeDownCast (vtkObjectBase *o)
 
static vtkGenericInterpolatedVelocityFieldNew ()
 Construct a vtkGenericInterpolatedVelocityField 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
 
 vtkGenericInterpolatedVelocityField ()
 
 ~vtkGenericInterpolatedVelocityField () override
 
virtual void SetVectorsSelection (const char *)
 
int FunctionValues (vtkGenericDataSet *ds, double *x, double *f)
 
- 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

vtkGenericCellIteratorGenCell
 
double LastPCoords [3]
 
int CacheHit
 
int CacheMiss
 
vtkTypeBool Caching
 
vtkGenericDataSetLastDataSet
 
char * VectorsSelection
 
vtkGenericInterpolatedVelocityFieldDataSetsType * DataSets
 
- 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
 

Static Protected Attributes

static const double TOLERANCE_SCALE
 

Detailed Description

Interface for obtaining interpolated velocity values.

vtkGenericInterpolatedVelocityField 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 expansive operation. In certain cases, the cell search can be avoided or shortened by providing a guess for the cell iterator. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkGenericInterpolatedVelocityField stores the last cell iterator. If caching is turned on, it uses this iterator as the starting point.

Warning
vtkGenericInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
See also
vtkFunctionSet vtkGenericStreamTracer

Definition at line 54 of file vtkGenericInterpolatedVelocityField.h.

Member Typedef Documentation

Definition at line 57 of file vtkGenericInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkGenericInterpolatedVelocityField::vtkGenericInterpolatedVelocityField ( )
protected
vtkGenericInterpolatedVelocityField::~vtkGenericInterpolatedVelocityField ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkGenericInterpolatedVelocityField::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGenericInterpolatedVelocityField::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkFunctionSet.

vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::NewInstance ( ) const
void vtkGenericInterpolatedVelocityField::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 vtkObject.

static vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::New ( )
static

Construct a vtkGenericInterpolatedVelocityField with no initial data set.

Caching is on. LastCellId is set to -1.

int vtkGenericInterpolatedVelocityField::FunctionValues ( double x,
double f 
)
overridevirtual

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

For now, t is ignored.

Reimplemented from vtkFunctionSet.

virtual void vtkGenericInterpolatedVelocityField::AddDataSet ( vtkGenericDataSet dataset)
virtual

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.

void vtkGenericInterpolatedVelocityField::ClearLastCell ( )

Set the last cell id to -1 so that the next search does not start from the previous cell.

vtkGenericAdaptorCell* vtkGenericInterpolatedVelocityField::GetLastCell ( )

Return the cell cached from last evaluation.

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

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

Otherwise, it does not change w and returns 0.

virtual vtkTypeBool vtkGenericInterpolatedVelocityField::GetCaching ( )
virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::SetCaching ( vtkTypeBool  )
virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::CachingOn ( )
virtual

Turn caching on/off.

virtual void vtkGenericInterpolatedVelocityField::CachingOff ( )
virtual

Turn caching on/off.

virtual int vtkGenericInterpolatedVelocityField::GetCacheHit ( )
virtual

Caching statistics.

virtual int vtkGenericInterpolatedVelocityField::GetCacheMiss ( )
virtual

Caching statistics.

virtual char* vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField::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 124 of file vtkGenericInterpolatedVelocityField.h.

virtual vtkGenericDataSet* vtkGenericInterpolatedVelocityField::GetLastDataSet ( )
virtual

Returns the last dataset that was visited.

Can be used as a first guess as to where the next point will be as well as to avoid searching through all datasets to get more information about the point.

virtual void vtkGenericInterpolatedVelocityField::CopyParameters ( vtkGenericInterpolatedVelocityField from)
virtual

Copy the user set parameters from source.

This copies the Caching parameters. Sub-classes can add more after chaining.

virtual void vtkGenericInterpolatedVelocityField::SetVectorsSelection ( const char *  )
protectedvirtual
int vtkGenericInterpolatedVelocityField::FunctionValues ( vtkGenericDataSet ds,
double x,
double f 
)
protected

Member Data Documentation

vtkGenericCellIterator* vtkGenericInterpolatedVelocityField::GenCell
protected

Definition at line 149 of file vtkGenericInterpolatedVelocityField.h.

double vtkGenericInterpolatedVelocityField::LastPCoords[3]
protected

Definition at line 151 of file vtkGenericInterpolatedVelocityField.h.

int vtkGenericInterpolatedVelocityField::CacheHit
protected

Definition at line 152 of file vtkGenericInterpolatedVelocityField.h.

int vtkGenericInterpolatedVelocityField::CacheMiss
protected

Definition at line 153 of file vtkGenericInterpolatedVelocityField.h.

vtkTypeBool vtkGenericInterpolatedVelocityField::Caching
protected

Definition at line 154 of file vtkGenericInterpolatedVelocityField.h.

vtkGenericDataSet* vtkGenericInterpolatedVelocityField::LastDataSet
protected

Definition at line 156 of file vtkGenericInterpolatedVelocityField.h.

char* vtkGenericInterpolatedVelocityField::VectorsSelection
protected

Definition at line 158 of file vtkGenericInterpolatedVelocityField.h.

vtkGenericInterpolatedVelocityFieldDataSetsType* vtkGenericInterpolatedVelocityField::DataSets
protected

Definition at line 161 of file vtkGenericInterpolatedVelocityField.h.

const double vtkGenericInterpolatedVelocityField::TOLERANCE_SCALE
staticprotected

Definition at line 165 of file vtkGenericInterpolatedVelocityField.h.


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