ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkCachingInterpolatedVelocityField Class Reference

vtkCachingInterpolatedVelocityField - Interface for obtaining interpolated velocity values More...

Inheritance diagram for Kitware.VTK.vtkCachingInterpolatedVelocityField:
[legend]
Collaboration diagram for Kitware.VTK.vtkCachingInterpolatedVelocityField:
[legend]

List of all members.

Public Member Functions

 vtkCachingInterpolatedVelocityField (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCachingInterpolatedVelocityField ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.
void ClearLastCellInfo ()
 Set the last cell id to -1 so that the next search does not start from the previous cell.
override int FunctionValues (IntPtr x, IntPtr f)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.
virtual int GetCacheMiss ()
 Caching statistics.
virtual int GetCellCacheHit ()
 Caching statistics.
virtual int GetDataSetCacheHit ()
 Caching statistics.
int GetLastLocalCoordinates (IntPtr pcoords)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.
int GetLastWeights (IntPtr w)
 Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.
virtual string GetVectorsSelection ()
 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.
virtual int InsideTest (IntPtr x)
 Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.
override int IsA (string type)
 Undocumented Block.
new
vtkCachingInterpolatedVelocityField 
NewInstance ()
 Undocumented Block.
void SelectVectors (string fieldName)
 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.
virtual void SetDataSet (int I, vtkDataSet dataset, bool staticdataset, vtkAbstractCellLocator locator)
 Add a dataset used by the interpolation function evaluation.
void SetLastCellInfo (int c, int datasetindex)
 Return the cell id cached from last evaluation.

Static Public Member Functions

static new
vtkCachingInterpolatedVelocityField 
New ()
 Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkCachingInterpolatedVelocityField 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkCachingInterpolatedVelocityField"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "35vtkCachingInterpolatedVelocityField"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkCachingInterpolatedVelocityField_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCachingInterpolatedVelocityField_ClearLastCellInfo_01 (HandleRef pThis)
static internal int vtkCachingInterpolatedVelocityField_FunctionValues_02 (HandleRef pThis, IntPtr x, IntPtr f)
static internal int vtkCachingInterpolatedVelocityField_GetCacheMiss_03 (HandleRef pThis)
static internal int vtkCachingInterpolatedVelocityField_GetCellCacheHit_04 (HandleRef pThis)
static internal int vtkCachingInterpolatedVelocityField_GetDataSetCacheHit_05 (HandleRef pThis)
static internal int vtkCachingInterpolatedVelocityField_GetLastLocalCoordinates_06 (HandleRef pThis, IntPtr pcoords)
static internal int vtkCachingInterpolatedVelocityField_GetLastWeights_07 (HandleRef pThis, IntPtr w)
static internal IntPtr vtkCachingInterpolatedVelocityField_GetVectorsSelection_08 (HandleRef pThis)
static internal int vtkCachingInterpolatedVelocityField_InsideTest_09 (HandleRef pThis, IntPtr x)
static internal int vtkCachingInterpolatedVelocityField_IsA_10 (HandleRef pThis, string type)
static internal int vtkCachingInterpolatedVelocityField_IsTypeOf_11 (string type)
static internal IntPtr vtkCachingInterpolatedVelocityField_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCachingInterpolatedVelocityField_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCachingInterpolatedVelocityField_SelectVectors_15 (HandleRef pThis, string fieldName)
static internal void vtkCachingInterpolatedVelocityField_SetDataSet_16 (HandleRef pThis, int I, HandleRef dataset, byte staticdataset, HandleRef locator)
static internal void vtkCachingInterpolatedVelocityField_SetLastCellInfo_17 (HandleRef pThis, int c, int datasetindex)

Static Private Member Functions

static vtkCachingInterpolatedVelocityField ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCachingInterpolatedVelocityField - Interface for obtaining interpolated velocity values

Description vtkCachingInterpolatedVelocityField 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 expensive 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, vtkCachingInterpolatedVelocityField stores the last cell id. If caching is turned on, it uses this id as the starting point.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.


Member Function Documentation

Set the last cell id to -1 so that the next search does not start from the previous cell.

override void Kitware.VTK.vtkCachingInterpolatedVelocityField.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkFunctionSet.

override int Kitware.VTK.vtkCachingInterpolatedVelocityField.FunctionValues ( IntPtr  x,
IntPtr  f 
) [virtual]

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.

Reimplemented from Kitware.VTK.vtkFunctionSet.

Caching statistics.

Caching statistics.

Caching statistics.

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

Returns the interpolation weights/pcoords cached from last evaluation if the cached cell is valid (returns 1). Otherwise, it does not change w and returns 0.

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.

Evaluate the velocity field, f={u,v,w}, at {x, y, z}. returns 1 if valid, 0 if test failed.

override int Kitware.VTK.vtkCachingInterpolatedVelocityField.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkFunctionSet.

static new int Kitware.VTK.vtkCachingInterpolatedVelocityField.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkFunctionSet.

Construct a vtkCachingInterpolatedVelocityField with no initial data set. LastCellId is set to -1.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkFunctionSet.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkFunctionSet.

Here is the call graph for this function:

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.

virtual void Kitware.VTK.vtkCachingInterpolatedVelocityField.SetDataSet ( int  I,
vtkDataSet  dataset,
bool  staticdataset,
vtkAbstractCellLocator  locator 
) [virtual]

Add a dataset used by the interpolation function evaluation.

Return the cell id cached from last evaluation.

static internal int Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_FunctionValues_02 ( HandleRef  pThis,
IntPtr  x,
IntPtr  f 
) [private]
static internal int Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_GetLastLocalCoordinates_06 ( HandleRef  pThis,
IntPtr  pcoords 
) [private]
static internal int Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_GetLastWeights_07 ( HandleRef  pThis,
IntPtr  w 
) [private]
static internal int Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_InsideTest_09 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal int Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal IntPtr Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_SelectVectors_15 ( HandleRef  pThis,
string  fieldName 
) [private]
static internal void Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_SetDataSet_16 ( HandleRef  pThis,
int  I,
HandleRef  dataset,
byte  staticdataset,
HandleRef  locator 
) [private]
static internal void Kitware.VTK.vtkCachingInterpolatedVelocityField.vtkCachingInterpolatedVelocityField_SetLastCellInfo_17 ( HandleRef  pThis,
int  c,
int  datasetindex 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCachingInterpolatedVelocityField.MRClassNameKey = "35vtkCachingInterpolatedVelocityField" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.

new const string Kitware.VTK.vtkCachingInterpolatedVelocityField.MRFullTypeName = "Kitware.VTK.vtkCachingInterpolatedVelocityField"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.


The documentation for this class was generated from the following file: