vtkInterpolatedVelocityField - A concrete class for obtaining the interpolated velocity values at a point. More...
Inheritance diagram for Kitware.VTK.vtkInterpolatedVelocityField:
Collaboration diagram for Kitware.VTK.vtkInterpolatedVelocityField:
Public Member Functions | |
| vtkInterpolatedVelocityField (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkInterpolatedVelocityField () | |
| Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1. | |
| override void | AddDataSet (vtkDataSet dataset) |
| 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. | |
| override int | FunctionValues (IntPtr x, IntPtr f) |
| Evaluate the velocity field f at point (x, y, z). | |
| override int | IsA (string type) |
| *Undocumented Block | |
| new vtkInterpolatedVelocityField | NewInstance () |
| *Undocumented Block | |
| override void | SetLastCellId (int c, int dataindex) |
| Set the cell id cached by the last evaluation within a specified dataset. | |
| override void | SetLastCellId (int c) |
| Set the cell id cached by the last evaluation. | |
 Public Member Functions inherited from Kitware.VTK.vtkAbstractInterpolatedVelocityField | |
| vtkAbstractInterpolatedVelocityField (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| void | ClearLastCellId () |
| Set the last cell id to -1 to incur a global cell search for the next point. | |
| virtual void | CopyParameters (vtkAbstractInterpolatedVelocityField from) |
| Import parameters. Sub-classes can add more after chaining. | |
| virtual int | GetCacheHit () |
| Get the caching statistics. CacheHit refers to the number of level #0 cache hits while CacheMiss is the number of level #0 cache misses. | |
| virtual int | GetCacheMiss () |
| Get the caching statistics. CacheHit refers to the number of level #0 cache hits while CacheMiss is the number of level #0 cache misses. | |
| virtual bool | GetCaching () |
| Set/Get the caching flag. If this flag is turned ON, there are two levels of caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating the function values at any point. | |
| virtual int | GetLastCellId () |
| Get/Set the id of the cell cached from last evaluation. | |
| virtual vtkDataSet | GetLastDataSet () |
| Get the most recently visited dataset and it id. The dataset is used for a guess regarding where the next point will be, without searching through all datasets. When setting the last dataset, care is needed as no reference counting or checks are performed. This feature is intended for custom interpolators only that cache datasets independently. | |
| virtual int | GetLastDataSetIndex () |
| Get the most recently visited dataset and it id. The dataset is used for a guess regarding where the next point will be, without searching through all datasets. When setting the last dataset, care is needed as no reference counting or checks are performed. This feature is intended for custom interpolators only that cache datasets independently. | |
| int | GetLastLocalCoordinates (IntPtr pcoords) |
| Get the interpolation weights cached from last evaluation. Return 1 if the cached cell is valid and 0 otherwise. | |
| int | GetLastWeights (IntPtr w) |
| Get the interpolation weights cached from last evaluation. Return 1 if the cached cell is valid and 0 otherwise. | |
| virtual bool | GetNormalizeVector () |
| Set/Get the flag indicating vector post-normalization (following vector interpolation). Vector post-normalization is required to avoid the 'curve-overshooting' problem (caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed (when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantly-differing velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is. Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep() as subsequent operations, e.g., vorticity computation, may need non-normalized vectors. | |
| virtual string | GetVectorsSelection () |
| Get/Set the name of a spcified vector array. By default it is NULL, with the active vector array for use. | |
| void | SelectVectors (string fieldName) |
| Get/Set the name of a spcified vector array. By default it is NULL, with the active vector array for use. | |
| virtual void | SetCaching (bool _arg) |
| Set/Get the caching flag. If this flag is turned ON, there are two levels of caching for derived concrete class vtkInterpolatedVelocityField and one level of caching for derived concrete class vtkCellLocatorInterpolatedVelocityField. Otherwise a global cell location is always invoked for evaluating the function values at any point. | |
| virtual void | SetNormalizeVector (bool _arg) |
| Set/Get the flag indicating vector post-normalization (following vector interpolation). Vector post-normalization is required to avoid the 'curve-overshooting' problem (caused by high velocity magnitude) that occurs when Cell-Length is used as the step size unit (particularly the Minimum step size unit). Furthermore, it is required by RK45 to achieve, as expected, high numerical accuracy (or high smoothness of flow lines) through adaptive step sizing. Note this operation is performed (when NormalizeVector TRUE) right after vector interpolation such that the differing amount of contribution of each node (of a cell) to the resulting direction of the interpolated vector, due to the possibly significantly-differing velocity magnitude values at the nodes (which is the case with large cells), can be reflected as is. Also note that this flag needs to be turned to FALSE after vtkInitialValueProblemSolver:: ComputeNextStep() as subsequent operations, e.g., vorticity computation, may need non-normalized vectors. | |
| Public Member Functions inherited from Kitware.VTK.vtkFunctionSet | |
| vtkFunctionSet (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| virtual int | GetNumberOfFunctions () |
| Return the number of functions. Note that this is constant for a given type of set of functions and can not be changed at run time. | |
| virtual int | GetNumberOfIndependentVariables () |
| Return the number of independent variables. Note that this is constant for a given type of set of functions and can not be changed at run time. | |
| Public Member Functions inherited from Kitware.VTK.vtkObject | |
| vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkObject () | |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
| uint | AddObserver (uint arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| uint | AddObserver (string arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| virtual void | DebugOff () |
| Turn debugging output off. | |
| virtual void | DebugOn () |
| Turn debugging output on. | |
| vtkCommand | GetCommand (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| byte | GetDebug () |
| Get the value of the debug flag. | |
| virtual uint | GetMTime () |
| Return this object's modified time. | |
| int | HasObserver (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (uint arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (string arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| virtual void | Modified () |
| Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer. | |
| void | RemoveAllObservers () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObserver (vtkCommand arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObserver (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | SetDebug (byte debugFlag) |
| Set the value of the debug flag. A non-zero value turns debugging on. | |
| override string | ToString () |
| Returns the result of calling vtkObject::Print as a C# string. | |
| delegate void | vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e) |
| Generic signature for all vtkObject events. | |
| void | RemoveAllHandlersForAllEvents () |
| Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen... | |
| Public Member Functions inherited from Kitware.VTK.vtkObjectBase | |
| vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkObjectBase () | |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
| virtual void | Register (vtkObjectBase o) |
| Increase the reference count (mark as used by another object). | |
| virtual void | FastDelete () |
| Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done. | |
| string | GetClassName () |
| Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h. | |
| int | GetReferenceCount () |
| Return the current reference count of this object. | |
| void | SetReferenceCount (int arg0) |
| Sets the reference count. (This is very dangerous, use with care.) | |
Static Public Member Functions | |
| static new vtkInterpolatedVelocityField | New () |
| Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1. | |
| static new int | IsTypeOf (string type) |
| *Undocumented Block | |
| static new vtkInterpolatedVelocityField | SafeDownCast (vtkObjectBase o) |
| *Undocumented Block | |
Public Attributes | |
| new const string | MRFullTypeName = "Kitware.VTK.vtkInterpolatedVelocityField" |
| Automatically generated type registration mechanics. | |
| Public Attributes inherited from Kitware.VTK.vtkAbstractInterpolatedVelocityField | |
| Public Attributes inherited from Kitware.VTK.vtkFunctionSet | |
| Public Attributes inherited from Kitware.VTK.vtkObject | |
| Public Attributes inherited from Kitware.VTK.vtkObjectBase | |
| Public Attributes inherited from Kitware.VTK.WrappedObject | |
| const string | vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so" |
| Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable. | |
| const string | vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so" |
| Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable. | |
| const string | vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so" |
| Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable. | |
| const string | vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so" |
| Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable. | |
| const string | vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so" |
| Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable. | |
| const string | vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so" |
| Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable. | |
| const string | vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so" |
| Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable. | |
| const string | vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so" |
| Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable. | |
| const string | vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so" |
| Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable. | |
| const string | vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so" |
| Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable. | |
| const string | vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so" |
| Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable. | |
| const string | vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so" |
| Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable. | |
| const string | vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so" |
| Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable. | |
| const string | vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so" |
| Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable. | |
| const string | vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so" |
| Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable. | |
Static Public Attributes | |
| static new readonly string | MRClassNameKey = "28vtkInterpolatedVelocityField" |
| Automatically generated type registration mechanics. | |
| Static Public Attributes inherited from Kitware.VTK.vtkAbstractInterpolatedVelocityField | |
| Static Public Attributes inherited from Kitware.VTK.vtkFunctionSet | |
| Static Public Attributes inherited from Kitware.VTK.vtkObject | |
| Static Public Attributes inherited from Kitware.VTK.vtkObjectBase | |
Protected Member Functions | |
| override void | Dispose (bool disposing) |
| Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly. | |
Static Private Member Functions | |
| static | vtkInterpolatedVelocityField () |
| Automatically generated type registration mechanics. | |
Detailed Description
vtkInterpolatedVelocityField - A concrete class for obtaining the interpolated velocity values at a point.
Description 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 vtkAbstractInterpolatedVelocityField, 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.
Caveats vtkInterpolatedVelocityField is not thread safe. A new instance should be created by each thread.
Constructor & Destructor Documentation
|
staticprivate |
Automatically generated type registration mechanics.
| Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField | ( | IntPtr | rawCppThis, |
| bool | callDisposalMethod, | ||
| bool | strong | ||
| ) |
Automatically generated constructor - called from generated code. DO NOT call directly.
| Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField | ( | ) |
Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.
Member Function Documentation
|
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.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
protected |
Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
virtual |
Evaluate the velocity field f at point (x, y, z).
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
virtual |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
static |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
static |
Construct a vtkInterpolatedVelocityField without an initial dataset. Caching is set on and LastCellId is set to -1.
Reimplemented from Kitware.VTK.vtkObject.
| new vtkInterpolatedVelocityField Kitware.VTK.vtkInterpolatedVelocityField.NewInstance | ( | ) |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
static |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
Here is the call graph for this function:
|
virtual |
Set the cell id cached by the last evaluation within a specified dataset.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
|
virtual |
Set the cell id cached by the last evaluation.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
Member Data Documentation
|
static |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
| new const string Kitware.VTK.vtkInterpolatedVelocityField.MRFullTypeName = "Kitware.VTK.vtkInterpolatedVelocityField" |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.
The documentation for this class was generated from the following file:
