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

A concrete class for obtaining the interpolated velocity values at a point. More...

#include <vtkCellLocatorInterpolatedVelocityField.h>

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

Public Types

typedef vtkCompositeInterpolatedVelocityField Superclass
 
- Public Types inherited from vtkCompositeInterpolatedVelocityField
typedef vtkAbstractInterpolatedVelocityField Superclass
 
- Public Types inherited from vtkAbstractInterpolatedVelocityField
typedef vtkFunctionSet Superclass
 
- Public Types inherited from vtkFunctionSet
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCellLocatorInterpolatedVelocityField * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetCellLocatorPrototype (vtkAbstractCellLocator *prototype)
 
virtual void CopyParameters (vtkAbstractInterpolatedVelocityField *from)
 
virtual void AddDataSet (vtkDataSet *dataset)
 
virtual int FunctionValues (double *x, double *f)
 
virtual void SetLastCellId (vtkIdType c, int dataindex)
 
virtual vtkAbstractCellLocator * GetLastCellLocator ()
 
virtual vtkAbstractCellLocator * GetCellLocatorPrototype ()
 
virtual void SetLastCellId (vtkIdType c)
 
- Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
vtkCompositeInterpolatedVelocityField * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetLastDataSetIndex ()
 
virtual vtkDataSet * GetLastDataSet ()
 
- Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
vtkAbstractInterpolatedVelocityField * NewInstance () const
 
void SelectVectors (int fieldAssociation, const char *fieldName)
 
void ClearLastCellId ()
 
virtual void SetCaching (bool)
 
virtual bool GetCaching ()
 
virtual int GetCacheHit ()
 
virtual int GetCacheMiss ()
 
virtual vtkIdType GetLastCellId ()
 
virtual char * GetVectorsSelection ()
 
virtual int GetVectorsType ()
 
virtual void SetNormalizeVector (bool)
 
virtual bool GetNormalizeVector ()
 
virtual void SetForceSurfaceTangentVector (bool)
 
virtual bool GetForceSurfaceTangentVector ()
 
virtual void SetSurfaceDataset (bool)
 
virtual bool GetSurfaceDataset ()
 
int GetLastWeights (double *w)
 
int GetLastLocalCoordinates (double pcoords[3])
 
- Public Member Functions inherited from vtkFunctionSet
vtkFunctionSet * NewInstance () const
 
virtual int GetNumberOfFunctions ()
 
virtual int GetNumberOfIndependentVariables ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkCellLocatorInterpolatedVelocityField * SafeDownCast (vtkObjectBase *o)
 
static vtkCellLocatorInterpolatedVelocityField * New ()
 
- Static Public Member Functions inherited from vtkCompositeInterpolatedVelocityField
static int IsTypeOf (const char *type)
 
static vtkCompositeInterpolatedVelocityField * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractInterpolatedVelocityField
static int IsTypeOf (const char *type)
 
static vtkAbstractInterpolatedVelocityField * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkFunctionSet
static int IsTypeOf (const char *type)
 
static vtkFunctionSet * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCellLocatorInterpolatedVelocityField ()
 
 ~vtkCellLocatorInterpolatedVelocityField ()
 
int FunctionValues (vtkDataSet *ds, vtkAbstractCellLocator *loc, double *x, double *f)
 
virtual int FunctionValues (vtkDataSet *ds, double *x, double *f)
 
- Protected Member Functions inherited from vtkCompositeInterpolatedVelocityField
 vtkCompositeInterpolatedVelocityField ()
 
 ~vtkCompositeInterpolatedVelocityField ()
 
- Protected Member Functions inherited from vtkAbstractInterpolatedVelocityField
 vtkAbstractInterpolatedVelocityField ()
 
 ~vtkAbstractInterpolatedVelocityField ()
 
virtual bool CheckPCoords (double pcoords[3])
 
virtual bool FindAndUpdateCell (vtkDataSet *ds, double *x)
 
virtual void SetVectorsSelection (const char *)
 
void FastCompute (vtkDataArray *vectors, double f[3])
 
bool InterpolatePoint (vtkPointData *outPD, vtkIdType outIndex)
 
vtkGenericCell * GetLastCell ()
 
- Protected Member Functions inherited from vtkFunctionSet
 vtkFunctionSet ()
 
 ~vtkFunctionSet ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkCompositeInterpolatedVelocityField
int LastDataSetIndex
 
vtkCompositeInterpolatedVelocityFieldDataSetsType * DataSets
 
- Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
int CacheHit
 
int CacheMiss
 
int WeightsSize
 
bool Caching
 
bool NormalizeVector
 
bool ForceSurfaceTangentVector
 
bool SurfaceDataset
 
int VectorsType
 
char * VectorsSelection
 
double * Weights
 
double LastPCoords [3]
 
int LastSubId
 
vtkIdType LastCellId
 
vtkDataSet * LastDataSet
 
vtkGenericCell * Cell
 
vtkGenericCell * GenCell
 
- 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 inherited from vtkCompositeInterpolatedVelocityField
static const double TOLERANCE_SCALE
 
- Static Protected Attributes inherited from vtkAbstractInterpolatedVelocityField
static const double TOLERANCE_SCALE
 
static const double SURFACE_TOLERANCE_SCALE
 

Detailed Description

A concrete class for obtaining the interpolated velocity values at a point.

vtkCellLocatorInterpolatedVelocityField acts as a continuous velocity field via cell interpolation on a vtkDataSet, NumberOfIndependentVariables = 4 (x,y,z,t) and NumberOfFunctions = 3 (u,v,w). As a concrete sub-class of vtkCompositeInterpolatedVelocityField, it adopts vtkAbstractCellLocator's sub-classes, e.g., vtkCellLocator and vtkModifiedBSPTree, without the use of vtkPointLocator ( employed by vtkDataSet/vtkPointSet::FindCell() in vtkInterpolatedVelocityField ). vtkCellLocatorInterpolatedVelocityField adopts one level of cell caching. Specifically, if the next point is still within the previous cell, cell location is then simply skipped and vtkCell:: EvaluatePosition() is called to obtain the new parametric coordinates and weights that are used to interpolate the velocity function values across the vertices of this cell. Otherwise a global cell (the target containing the next point) location is instead directly invoked, without exploiting the clue that vtkInterpolatedVelocityField makes use of from the previous cell (an immediate neighbor). Although ignoring the neighbor cell may incur a relatively high computational cost, vtkCellLocatorInterpolatedVelocityField is more robust in locating the target cell than its sibling class vtkInterpolatedVelocityField.

Warning
vtkCellLocatorInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
See also
vtkCompositeInterpolatedVelocityField vtkInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamTracer

Definition at line 57 of file vtkCellLocatorInterpolatedVelocityField.h.

Member Typedef Documentation

typedef vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField::Superclass

Definition at line 61 of file vtkCellLocatorInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkCellLocatorInterpolatedVelocityField::vtkCellLocatorInterpolatedVelocityField ( )
protected
vtkCellLocatorInterpolatedVelocityField::~vtkCellLocatorInterpolatedVelocityField ( )
protected

Member Function Documentation

static int vtkCellLocatorInterpolatedVelocityField::IsTypeOf ( const char *  type)
static
virtual int vtkCellLocatorInterpolatedVelocityField::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 vtkCompositeInterpolatedVelocityField.

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

Reimplemented from vtkCompositeInterpolatedVelocityField.

vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::NewInstance ( ) const
void vtkCellLocatorInterpolatedVelocityField::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

static vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::New ( )
static

Construct a vtkCellLocatorInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.

virtual vtkAbstractCellLocator* vtkCellLocatorInterpolatedVelocityField::GetLastCellLocator ( )
virtual

Get the cell locator attached to the most recently visited dataset.

virtual vtkAbstractCellLocator* vtkCellLocatorInterpolatedVelocityField::GetCellLocatorPrototype ( )
virtual

Get the prototype of the cell locator that is used for interpolating the velocity field during integration.

void vtkCellLocatorInterpolatedVelocityField::SetCellLocatorPrototype ( vtkAbstractCellLocator *  prototype)

Set a prototype of the cell locator that is used for interpolating the velocity field during integration.

virtual void vtkCellLocatorInterpolatedVelocityField::CopyParameters ( vtkAbstractInterpolatedVelocityField *  from)
virtual

Import parameters. Sub-classes can add more after chaining.

Reimplemented from vtkAbstractInterpolatedVelocityField.

virtual void vtkCellLocatorInterpolatedVelocityField::AddDataSet ( vtkDataSet *  dataset)
virtual

Add a dataset coupled with a cell locator (of type vtkAbstractCellLocator) for vector function evaluation. Note the use of a vtkAbstractCellLocator enables robust cell location. If more than one dataset is added, the evaluation point is searched in all until a match is found. THIS FUNCTION DOES NOT CHANGE THE REFERENCE COUNT OF dataset FOR THREAD SAFETY REASONS.

Implements vtkCompositeInterpolatedVelocityField.

virtual int vtkCellLocatorInterpolatedVelocityField::FunctionValues ( double *  x,
double *  f 
)
virtual

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

Implements vtkAbstractInterpolatedVelocityField.

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

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

Implements vtkAbstractInterpolatedVelocityField.

virtual void vtkCellLocatorInterpolatedVelocityField::SetLastCellId ( vtkIdType  c)
inlinevirtual

Set the cell id cached by the last evaluation.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 102 of file vtkCellLocatorInterpolatedVelocityField.h.

int vtkCellLocatorInterpolatedVelocityField::FunctionValues ( vtkDataSet *  ds,
vtkAbstractCellLocator *  loc,
double *  x,
double *  f 
)
protected

Evaluate the velocity field f at point (x, y, z) in a specified dataset (actually of type vtkPointSet only) through the use of the associated vtkAbstractCellLocator::FindCell() (instead of involving vtkPointLocator) to locate the next cell if the given point is outside the current cell.

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

Evaluate the velocity field f at point (x, y, z) in a specified dataset (of type vtkImageData or vtkRectilinearGrid only) by invoking FindCell() to locate the next cell if the given point is outside the current cell.

Reimplemented from vtkAbstractInterpolatedVelocityField.

Definition at line 125 of file vtkCellLocatorInterpolatedVelocityField.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:15:38 for VTK by   doxygen 1.8.9.1