A concrete class for obtaining the interpolated velocity values at a point. More...
#include <vtkInterpolatedVelocityField.h>
Public Types | |
| typedef vtkCompositeInterpolatedVelocityField | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkInterpolatedVelocityField * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | AddDataSet (vtkDataSet *dataset) |
| virtual int | FunctionValues (double *x, double *f) |
| virtual void | SetLastCellId (vtkIdType c, int dataindex) |
| virtual void | SetLastCellId (vtkIdType c) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkInterpolatedVelocityField * | SafeDownCast (vtkObjectBase *o) |
| static vtkInterpolatedVelocityField * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkInterpolatedVelocityField () | |
| ~vtkInterpolatedVelocityField () | |
| virtual int | FunctionValues (vtkDataSet *ds, double *x, double *f) |
Detailed Description
A concrete class for obtaining the interpolated velocity values at a point.
vtkInterpolatedVelocityField 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, this class adopts two levels of cell caching for faster though less robust cell location than its sibling class vtkCellLocatorInterpolatedVelocityField. Level #0 begins with intra-cell caching. Specifically, if the previous cell is valid and the nex point is still within it, ( vtkCell::EvaluatePosition() returns 1, coupled with the new parametric coordinates and weights ), the function values are interpolated and vtkCell::EvaluatePosition() is invoked only. If it fails, level #1 follows by inter-cell location of the target cell (that contains the next point). By inter-cell, the previous cell gives an important clue / guess or serves as an immediate neighbor to aid in the location of the target cell (as is typically the case with integrating a streamline across cells) by means of vtkDataSet:: FindCell(). If this still fails, a global cell search is invoked via vtkDataSet::FindCell().
Regardless of inter-cell or global search, vtkPointLocator is employed as a crucial tool underlying the cell locator. The use of vtkPointLocator casues vtkInterpolatedVelocityField to return false target cells for datasets defined on complex grids.
- Warning:
- vtkInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
- See also:
- vtkCompositeInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField vtkGenericInterpolatedVelocityField vtkCachingInterpolatedVelocityField vtkTemporalInterpolatedVelocityField vtkFunctionSet vtkStreamer vtkStreamTracer
Definition at line 59 of file vtkInterpolatedVelocityField.h.
Member Typedef Documentation
Reimplemented from vtkCompositeInterpolatedVelocityField.
Definition at line 64 of file vtkInterpolatedVelocityField.h.
Constructor & Destructor Documentation
| vtkInterpolatedVelocityField::vtkInterpolatedVelocityField | ( | ) | [inline, protected] |
Definition at line 91 of file vtkInterpolatedVelocityField.h.
| vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField | ( | ) | [inline, protected] |
Definition at line 92 of file vtkInterpolatedVelocityField.h.
Member Function Documentation
| static int vtkInterpolatedVelocityField::IsTypeOf | ( | const char * | name | ) | [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 vtkCompositeInterpolatedVelocityField.
| virtual int vtkInterpolatedVelocityField::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 vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkCompositeInterpolatedVelocityField.
| virtual vtkObjectBase* vtkInterpolatedVelocityField::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkCompositeInterpolatedVelocityField.
Reimplemented from vtkCompositeInterpolatedVelocityField.
| void vtkInterpolatedVelocityField::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 vtkCompositeInterpolatedVelocityField.
| static vtkInterpolatedVelocityField* vtkInterpolatedVelocityField::New | ( | ) | [static] |
Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.
Reimplemented from vtkObject.
| virtual void vtkInterpolatedVelocityField::AddDataSet | ( | vtkDataSet * | 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.
Implements vtkCompositeInterpolatedVelocityField.
| virtual int vtkInterpolatedVelocityField::FunctionValues | ( | double * | x, |
| double * | f | ||
| ) | [virtual] |
Evaluate the velocity field f at point (x, y, z).
Implements vtkAbstractInterpolatedVelocityField.
| virtual void vtkInterpolatedVelocityField::SetLastCellId | ( | vtkIdType | c, |
| int | dataindex | ||
| ) | [virtual] |
Set the cell id cached by the last evaluation within a specified dataset.
Implements vtkAbstractInterpolatedVelocityField.
| virtual void vtkInterpolatedVelocityField::SetLastCellId | ( | vtkIdType | c | ) | [inline, virtual] |
Set the cell id cached by the last evaluation.
Reimplemented from vtkAbstractInterpolatedVelocityField.
Definition at line 86 of file vtkInterpolatedVelocityField.h.
| virtual int vtkInterpolatedVelocityField::FunctionValues | ( | vtkDataSet * | ds, |
| double * | x, | ||
| double * | f | ||
| ) | [inline, protected, virtual] |
Evaluate the velocity field f at point (x, y, z) in a specified dataset by either involving vtkPointLocator, via vtkPointSet::FindCell(), in locating the next cell (for datasets of type vtkPointSet) or simply invoking vtkImageData/vtkRectilinearGrid::FindCell() to fulfill the same task if the point is outside the current cell.
Reimplemented from vtkAbstractInterpolatedVelocityField.
Definition at line 101 of file vtkInterpolatedVelocityField.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Filters/FlowPaths/vtkInterpolatedVelocityField.h
