vtkInterpolatedVelocityField Class Reference
#include <vtkInterpolatedVelocityField.h>
Inheritance diagram for vtkInterpolatedVelocityField:
[legend]Collaboration diagram for vtkInterpolatedVelocityField:
[legend]List of all members.
Detailed Description
Interface for obtaining 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.
- Warning:
- vtkInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
- See also:
- vtkFunctionSet vtkStreamer
Definition at line 50 of file vtkInterpolatedVelocityField.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkInterpolatedVelocityField::vtkInterpolatedVelocityField |
( |
|
) |
[protected] |
|
| vtkInterpolatedVelocityField::~vtkInterpolatedVelocityField |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkInterpolatedVelocityField::GetClassName |
( |
|
) |
[virtual] |
|
| static 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkFunctionSet. |
| virtual 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 vtkFunctionSet. |
|
|
Construct a vtkInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.
Reimplemented from vtkObject. |
| virtual int vtkInterpolatedVelocityField::FunctionValues |
( |
double * |
x, |
|
|
double * |
f |
|
) |
[virtual] |
|
|
|
Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.
Implements vtkFunctionSet. |
| 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. |
| virtual vtkIdType vtkInterpolatedVelocityField::GetLastCellId |
( |
|
) |
[virtual] |
|
|
|
Return the cell id cached from last evaluation. |
| virtual void vtkInterpolatedVelocityField::SetLastCellId |
( |
vtkIdType |
|
) |
[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 vtkInterpolatedVelocityField::ClearLastCellId |
( |
|
) |
[inline] |
|
| int vtkInterpolatedVelocityField::GetLastWeights |
( |
double * |
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 |
( |
double |
pcoords[3] |
) |
|
|
|
|
Set the last cell id to -1 so that the next search does not start from the previous cell |
| virtual int vtkInterpolatedVelocityField::GetCaching |
( |
|
) |
[virtual] |
|
| virtual void vtkInterpolatedVelocityField::SetCaching |
( |
int |
|
) |
[virtual] |
|
| virtual void vtkInterpolatedVelocityField::CachingOn |
( |
|
) |
[virtual] |
|
| virtual void vtkInterpolatedVelocityField::CachingOff |
( |
|
) |
[virtual] |
|
| virtual int vtkInterpolatedVelocityField::GetCacheHit |
( |
|
) |
[virtual] |
|
| virtual int vtkInterpolatedVelocityField::GetCacheMiss |
( |
|
) |
[virtual] |
|
| virtual char* vtkInterpolatedVelocityField::GetVectorsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array. |
| void vtkInterpolatedVelocityField::SelectVectors |
( |
const char * |
fieldName |
) |
[inline] |
|
|
|
If you want to work with an arbitrary vector array, then set its name here. By default this in NULL and the filter will use the active vector array.
Definition at line 106 of file vtkInterpolatedVelocityField.h. |
| virtual vtkDataSet* vtkInterpolatedVelocityField::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. |
|
|
Copy the user set parameters from source. This copies the Caching parameters. Sub-classes can add more after chaining. |
| virtual void vtkInterpolatedVelocityField::SetVectorsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
| int vtkInterpolatedVelocityField::FunctionValues |
( |
vtkDataSet * |
ds, |
|
|
double * |
x, |
|
|
double * |
f |
|
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:57:44 2008 for VTK by
1.4.3-20050530