Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkInterpolatedVelocityField Class Reference

Interface for obtaining. More...

#include <vtkInterpolatedVelocityField.h>

Inheritance diagram for vtkInterpolatedVelocityField:

Inheritance graph
Collaboration diagram for vtkInterpolatedVelocityField:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual int FunctionValues (float *x, float *f)
virtual void SetDataSet (vtkDataSet *dataset)
virtual vtkDataSetGetDataSet ()
virtual int GetLastCellId ()
virtual void SetLastCellId (int)
void ClearLastCellId ()
int GetLastWeights (float *w)
int GetLastLocalCoordinates (float pcoords[3])
virtual int GetCaching ()
virtual void SetCaching (int)
virtual void CachingOn ()
virtual void CachingOff ()
virtual int GetCacheHit ()
virtual int GetCacheMiss ()

Static Public Methods

int IsTypeOf (const char *type)
vtkInterpolatedVelocityField * SafeDownCast (vtkObject *o)
vtkInterpolatedVelocityField * New ()

Protected Methods

 vtkInterpolatedVelocityField ()
 ~vtkInterpolatedVelocityField ()
 vtkInterpolatedVelocityField (const vtkInterpolatedVelocityField &)
void operator= (const vtkInterpolatedVelocityField &)

Protected Attributes

float * Weights
float LastPCoords [3]
int LastCellId
int CacheHit
int CacheMiss
int Caching

Detailed Description

Interface for obtaining.

2000/12/10 20:08:11
interpolated velocity values

vtkInterpolatedVelocityField 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 id. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.

vtkInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
See also:
vtkFunctionSet vtkStreamer

Definition at line 74 of file vtkInterpolatedVelocityField.h.

Constructor & Destructor Documentation

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField   [protected]

vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField   [protected]

vtkInterpolatedVelocityField::vtkInterpolatedVelocityField const vtkInterpolatedVelocityField &    [inline, protected]

Definition at line 118 of file vtkInterpolatedVelocityField.h.

Member Function Documentation

virtual const char* vtkInterpolatedVelocityField::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkFunctionSet.

int vtkInterpolatedVelocityField::IsTypeOf const char *    type [static]

Return 1 if this class type 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.

virtual int vtkInterpolatedVelocityField::IsA const char *    type [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.

vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkFunctionSet.

virtual void vtkInterpolatedVelocityField::PrintSelf ostream &    os,
vtkIndent    indent

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.

vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::New   [static]

Construct a vtkInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.

Reimplemented from vtkObject.

virtual int vtkInterpolatedVelocityField::FunctionValues float *    x,
float *    f

Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.

Reimplemented from vtkFunctionSet.

virtual void vtkInterpolatedVelocityField::SetDataSet vtkDataSet   dataset [virtual]

Set / get the dataset used for the implicit function evaluation.

virtual vtkDataSet* vtkInterpolatedVelocityField::GetDataSet   [virtual]

virtual int vtkInterpolatedVelocityField::GetLastCellId   [virtual]

Return the cell id cached from last evaluation.

virtual void vtkInterpolatedVelocityField::SetLastCellId int    [virtual]

void vtkInterpolatedVelocityField::ClearLastCellId   [inline]

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

Definition at line 98 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::GetLastWeights float *    w

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.

int vtkInterpolatedVelocityField::GetLastLocalCoordinates float    pcoords[3]

virtual int vtkInterpolatedVelocityField::GetCaching   [virtual]

Turn caching on/off.

virtual void vtkInterpolatedVelocityField::SetCaching int    [virtual]

virtual void vtkInterpolatedVelocityField::CachingOn   [virtual]

virtual void vtkInterpolatedVelocityField::CachingOff   [virtual]

virtual int vtkInterpolatedVelocityField::GetCacheHit   [virtual]

Caching statistics.

virtual int vtkInterpolatedVelocityField::GetCacheMiss   [virtual]

void vtkInterpolatedVelocityField::operator= const vtkInterpolatedVelocityField &    [inline, protected]

Definition at line 119 of file vtkInterpolatedVelocityField.h.

Member Data Documentation

vtkDataSet* vtkInterpolatedVelocityField::DataSet [protected]

Definition at line 121 of file vtkInterpolatedVelocityField.h.

vtkGenericCell* vtkInterpolatedVelocityField::GenCell [protected]

Definition at line 122 of file vtkInterpolatedVelocityField.h.

vtkGenericCell* vtkInterpolatedVelocityField::Cell [protected]

Definition at line 123 of file vtkInterpolatedVelocityField.h.

float* vtkInterpolatedVelocityField::Weights [protected]

Definition at line 124 of file vtkInterpolatedVelocityField.h.

float vtkInterpolatedVelocityField::LastPCoords[3] [protected]

Definition at line 125 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::LastCellId [protected]

Definition at line 126 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::CacheHit [protected]

Definition at line 127 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::CacheMiss [protected]

Definition at line 128 of file vtkInterpolatedVelocityField.h.

int vtkInterpolatedVelocityField::Caching [protected]

Definition at line 129 of file vtkInterpolatedVelocityField.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:52:25 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001