vtkGenericInterpolatedVelocityField Class Reference
#include <vtkGenericInterpolatedVelocityField.h>
Detailed Description
Interface for obtaining interpolated velocity values.vtkGenericInterpolatedVelocityField 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 iterator. For example, in streamline integration, the next evaluation is usually in the same or a neighbour cell. For this reason, vtkGenericInterpolatedVelocityField stores the last cell iterator. If caching is turned on, it uses this iterator as the starting point.
- Warning:
- vtkGenericInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
- See also:
- vtkFunctionSet vtkGenericStreamTracer
Definition at line 52 of file vtkGenericInterpolatedVelocityField.h.
Public Types | |
| typedef vtkFunctionSet | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual int | FunctionValues (double *x, double *f) |
| virtual void | AddDataSet (vtkGenericDataSet *dataset) |
| void | ClearLastCell () |
| vtkGenericAdaptorCell * | GetLastCell () |
| int | GetLastLocalCoordinates (double pcoords[3]) |
| virtual void | CopyParameters (vtkGenericInterpolatedVelocityField *from) |
| virtual int | GetCaching () |
| virtual void | SetCaching (int) |
| virtual void | CachingOn () |
| virtual void | CachingOff () |
| virtual int | GetCacheHit () |
| virtual int | GetCacheMiss () |
| virtual char * | GetVectorsSelection () |
| void | SelectVectors (const char *fieldName) |
| virtual vtkGenericDataSet * | GetLastDataSet () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkGenericInterpolatedVelocityField * | SafeDownCast (vtkObject *o) |
| static vtkGenericInterpolatedVelocityField * | New () |
Protected Member Functions | |
| vtkGenericInterpolatedVelocityField () | |
| ~vtkGenericInterpolatedVelocityField () | |
| virtual void | SetVectorsSelection (const char *) |
| int | FunctionValues (vtkGenericDataSet *ds, double *x, double *f) |
Protected Attributes | |
| vtkGenericCellIterator * | GenCell |
| double | LastPCoords [3] |
| int | CacheHit |
| int | CacheMiss |
| int | Caching |
| vtkGenericDataSet * | LastDataSet |
| char * | VectorsSelection |
| vtkGenericInterpolatedVelocityFieldDataSetsType * | DataSets |
Static Protected Attributes | |
| static const double | TOLERANCE_SCALE |
Member Typedef Documentation
Reimplemented from vtkFunctionSet.
Definition at line 55 of file vtkGenericInterpolatedVelocityField.h.
Constructor & Destructor Documentation
| vtkGenericInterpolatedVelocityField::vtkGenericInterpolatedVelocityField | ( | ) | [protected] |
| vtkGenericInterpolatedVelocityField::~vtkGenericInterpolatedVelocityField | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkGenericInterpolatedVelocityField::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkFunctionSet.
| static int vtkGenericInterpolatedVelocityField::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 vtkFunctionSet.
| virtual int vtkGenericInterpolatedVelocityField::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 vtkFunctionSet.
| static vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkFunctionSet.
| virtual void vtkGenericInterpolatedVelocityField::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.
| static vtkGenericInterpolatedVelocityField* vtkGenericInterpolatedVelocityField::New | ( | ) | [static] |
Construct a vtkGenericInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.
Reimplemented from vtkObject.
| virtual int vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField::AddDataSet | ( | vtkGenericDataSet * | 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.
| void vtkGenericInterpolatedVelocityField::ClearLastCell | ( | ) |
Set the last cell id to -1 so that the next search does not start from the previous cell
| vtkGenericAdaptorCell* vtkGenericInterpolatedVelocityField::GetLastCell | ( | ) |
Return the cell cached from last evaluation.
| int vtkGenericInterpolatedVelocityField::GetLastLocalCoordinates | ( | double | pcoords[3] | ) |
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.
| virtual int vtkGenericInterpolatedVelocityField::GetCaching | ( | ) | [virtual] |
Turn caching on/off.
| virtual void vtkGenericInterpolatedVelocityField::SetCaching | ( | int | ) | [virtual] |
Turn caching on/off.
| virtual void vtkGenericInterpolatedVelocityField::CachingOn | ( | ) | [virtual] |
Turn caching on/off.
| virtual void vtkGenericInterpolatedVelocityField::CachingOff | ( | ) | [virtual] |
Turn caching on/off.
| virtual int vtkGenericInterpolatedVelocityField::GetCacheHit | ( | ) | [virtual] |
Caching statistics.
| virtual int vtkGenericInterpolatedVelocityField::GetCacheMiss | ( | ) | [virtual] |
Caching statistics.
| virtual char* vtkGenericInterpolatedVelocityField::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 vtkGenericInterpolatedVelocityField::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 102 of file vtkGenericInterpolatedVelocityField.h.
| virtual vtkGenericDataSet* vtkGenericInterpolatedVelocityField::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.
| virtual void vtkGenericInterpolatedVelocityField::CopyParameters | ( | vtkGenericInterpolatedVelocityField * | from | ) | [virtual] |
Copy the user set parameters from source. This copies the Caching parameters. Sub-classes can add more after chaining.
| virtual void vtkGenericInterpolatedVelocityField::SetVectorsSelection | ( | const char * | ) | [protected, virtual] |
| int vtkGenericInterpolatedVelocityField::FunctionValues | ( | vtkGenericDataSet * | ds, | |
| double * | x, | |||
| double * | f | |||
| ) | [protected] |
Member Data Documentation
Definition at line 122 of file vtkGenericInterpolatedVelocityField.h.
double vtkGenericInterpolatedVelocityField::LastPCoords[3] [protected] |
Definition at line 124 of file vtkGenericInterpolatedVelocityField.h.
int vtkGenericInterpolatedVelocityField::CacheHit [protected] |
Definition at line 125 of file vtkGenericInterpolatedVelocityField.h.
int vtkGenericInterpolatedVelocityField::CacheMiss [protected] |
Definition at line 126 of file vtkGenericInterpolatedVelocityField.h.
int vtkGenericInterpolatedVelocityField::Caching [protected] |
Definition at line 127 of file vtkGenericInterpolatedVelocityField.h.
Definition at line 129 of file vtkGenericInterpolatedVelocityField.h.
char* vtkGenericInterpolatedVelocityField::VectorsSelection [protected] |
Definition at line 131 of file vtkGenericInterpolatedVelocityField.h.
vtkGenericInterpolatedVelocityFieldDataSetsType* vtkGenericInterpolatedVelocityField::DataSets [protected] |
Definition at line 134 of file vtkGenericInterpolatedVelocityField.h.
const double vtkGenericInterpolatedVelocityField::TOLERANCE_SCALE [static, protected] |
Definition at line 138 of file vtkGenericInterpolatedVelocityField.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkGenericInterpolatedVelocityField.h
