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 (long c, int dataindex)
	Set the cell id cached by the last evaluation within a specified dataset.
override void	SetLastCellId (long c)
	Set the cell id cached by the last evaluation.
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.
Static Public Attributes
static new readonly string	MRClassNameKey = "28vtkInterpolatedVelocityField"
	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	vtkInterpolatedVelocityField_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkInterpolatedVelocityField_AddDataSet_01 (HandleRef pThis, HandleRef dataset)
static internal int	vtkInterpolatedVelocityField_FunctionValues_02 (HandleRef pThis, IntPtr x, IntPtr f)
static internal int	vtkInterpolatedVelocityField_IsA_03 (HandleRef pThis, string type)
static internal int	vtkInterpolatedVelocityField_IsTypeOf_04 (string type)
static internal IntPtr	vtkInterpolatedVelocityField_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkInterpolatedVelocityField_SafeDownCast_07 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkInterpolatedVelocityField_SetLastCellId_08 (HandleRef pThis, long c, int dataindex)
static internal void	vtkInterpolatedVelocityField_SetLastCellId_09 (HandleRef pThis, long c)
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

static Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField ( ) [static, private]

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

override void Kitware.VTK.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.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

override void Kitware.VTK.vtkInterpolatedVelocityField.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.vtkAbstractInterpolatedVelocityField.

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

Evaluate the velocity field f at point (x, y, z).

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

static new vtkInterpolatedVelocityField Kitware.VTK.vtkInterpolatedVelocityField.New ( ) [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 new vtkInterpolatedVelocityField Kitware.VTK.vtkInterpolatedVelocityField.SafeDownCast ( vtkObjectBase o ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

Here is the call graph for this function:

override void Kitware.VTK.vtkInterpolatedVelocityField.SetLastCellId	(	long	c,
		int	dataindex
	)		`[virtual]`

Set the cell id cached by the last evaluation within a specified dataset.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

override void Kitware.VTK.vtkInterpolatedVelocityField.SetLastCellId ( long c ) [virtual]

Set the cell id cached by the last evaluation.

Reimplemented from Kitware.VTK.vtkAbstractInterpolatedVelocityField.

static internal void Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_AddDataSet_01	(	HandleRef	pThis,
		HandleRef	dataset
	)		`[private]`

static internal int Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_FunctionValues_02	(	HandleRef	pThis,
		IntPtr	x,
		IntPtr	f
	)		`[private]`

static internal int Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_IsA_03	(	HandleRef	pThis,
		string	type
	)		`[private]`

static internal int Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_IsTypeOf_04 ( string type ) [private]

static internal IntPtr Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_NewInstance_06	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_SafeDownCast_07	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal void Kitware.VTK.vtkInterpolatedVelocityField.vtkInterpolatedVelocityField_SetLastCellId_08	(	HandleRef	pThis,
		long	c,
		int	dataindex
	)		`[private]`