A concrete class for obtaining the interpolated velocity values at a point. More...
#include <vtkCellLocatorInterpolatedVelocityField.h>
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 vtkStreamer vtkStreamTracer
Definition at line 57 of file vtkCellLocatorInterpolatedVelocityField.h.
Member Typedef Documentation
Reimplemented from vtkCompositeInterpolatedVelocityField.
Definition at line 61 of file vtkCellLocatorInterpolatedVelocityField.h.
Constructor & Destructor Documentation
Member Function Documentation
| static int vtkCellLocatorInterpolatedVelocityField::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 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] |
Reimplemented from vtkCompositeInterpolatedVelocityField.
| virtual vtkObjectBase* vtkCellLocatorInterpolatedVelocityField::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkCompositeInterpolatedVelocityField.
| vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::NewInstance | ( | ) | const |
Reimplemented from vtkCompositeInterpolatedVelocityField.
| 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 vtkCompositeInterpolatedVelocityField.
| static vtkCellLocatorInterpolatedVelocityField* vtkCellLocatorInterpolatedVelocityField::New | ( | ) | [static] |
Construct a vtkCellLocatorInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.
Reimplemented from vtkObject.
| 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 | ) | [inline, virtual] |
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 | ||
| ) | [inline, protected, virtual] |
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:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Filters/FlowPaths/vtkCellLocatorInterpolatedVelocityField.h
