vtkTemporalInterpolatedVelocityField - A helper class for interpolating between times during particle tracing More...

Inheritance diagram for Kitware.VTK.vtkTemporalInterpolatedVelocityField:

Collaboration diagram for Kitware.VTK.vtkTemporalInterpolatedVelocityField:

Public Member Functions
	vtkTemporalInterpolatedVelocityField (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkTemporalInterpolatedVelocityField ()
	Construct a vtkTemporalInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.
void	AdvanceOneTimeStep ()
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
void	ClearCache ()
	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 u)
	Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.
int	FunctionValuesAtT (int T, IntPtr x, IntPtr u)
	Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.
bool	GetCachedCellIds (IntPtr id, IntPtr ds)
	Between iterations of the Particle Tracer, Id's of the Cell are stored and then at the start of the next particle the Ids are set to 'pre-fill' the cache.
virtual double	GetCurrentWeight ()
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
virtual double[]	GetLastGoodVelocity ()
	If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)
virtual void	GetLastGoodVelocity (ref double _arg1, ref double _arg2, ref double _arg3)
	If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)
virtual void	GetLastGoodVelocity (IntPtr _arg)
	If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)
bool	GetVorticityData (int T, IntPtr pcoords, IntPtr weights, vtkGenericCell cell, vtkDoubleArray cellVectors)
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
bool	InterpolatePoint (vtkPointData outPD1, vtkPointData outPD2, int outIndex)
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
bool	InterpolatePoint (int T, vtkPointData outPD1, int outIndex)
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
override int	IsA (string type)
	*Undocumented Block
bool	IsStatic (int datasetIndex)
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
new vtkTemporalInterpolatedVelocityField	NewInstance ()
	*Undocumented Block
int	QuickTestPoint (IntPtr x)
	A utility function which evaluates the point at T1, T2 to see if it is inside the data at both times or only one.
void	SelectVectors (string fieldName)
	If you want to work with an arbitrary vector array, then set its name here. By default this is NULL and the filter will use the active vector array.
void	SetCachedCellIds (IntPtr id, IntPtr ds)
	Between iterations of the Particle Tracer, Id's of the Cell are stored and then at the start of the next particle the Ids are set to 'pre-fill' the cache.
void	SetDataSetAtTime (int I, int N, double T, vtkDataSet dataset, bool staticdataset)
	In order to use this class, two sets of data must be supplied, corresponding to times T1 and T2. Data is added via this function.
void	ShowCacheResults ()
	Get the most recent weight between 0->1 from T1->T2. Initial value is 0.
int	TestPoint (IntPtr x)
	A utility function which evaluates the point at T1, T2 to see if it is inside the data at both times or only one.
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 vtkTemporalInterpolatedVelocityField	New ()
	Construct a vtkTemporalInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkTemporalInterpolatedVelocityField	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkTemporalInterpolatedVelocityField"
	Automatically generated type registration mechanics.
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 = "36vtkTemporalInterpolatedVelocityField"
	Automatically generated type registration mechanics.
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	vtkTemporalInterpolatedVelocityField ()
	Automatically generated type registration mechanics.

Detailed Description

vtkTemporalInterpolatedVelocityField - A helper class for interpolating between times during particle tracing

Description vtkTemporalInterpolatedVelocityField is a general purpose helper for the temporal particle tracing code (vtkTemporalStreamTracer)

It maintains two copies of vtkCachingInterpolatedVelocityField internally and uses them to obtain velocity values at time T0 and T1.

In fact the class does quite a bit more than this because when the geometry of the datasets is the same at T0 and T1, we can re-use cached cell Ids and weights used in the cell interpolation routines. Additionally, the same weights can be used when interpolating (point) scalar values and computing vorticity etc.

Caveats vtkTemporalInterpolatedVelocityField is probably not thread safe. A new instance should be created by each thread.

Datasets are added in lists. The list for T1 must be idential to that for T0 in structure/topology and dataset order, and any datasets marked as static, must remain so for all T - changing a dataset from static to dynamic between time steps will result in undefined behaviour (=crash probably)

vtkCachingInterpolatedVelocityField vtkTemporalStreamTracer

Constructor & Destructor Documentation

static Kitware.VTK.vtkTemporalInterpolatedVelocityField.vtkTemporalInterpolatedVelocityField ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkTemporalInterpolatedVelocityField.vtkTemporalInterpolatedVelocityField ( )

Construct a vtkTemporalInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.

Member Function Documentation

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.AdvanceOneTimeStep ( )

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.ClearCache ( )

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

override void Kitware.VTK.vtkTemporalInterpolatedVelocityField.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.vtkTemporalInterpolatedVelocityField.FunctionValues	(	IntPtr	x,
		IntPtr	u
	)

virtual

Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.

Reimplemented from Kitware.VTK.vtkFunctionSet.

int Kitware.VTK.vtkTemporalInterpolatedVelocityField.FunctionValuesAtT	(	int	T,
		IntPtr	x,
		IntPtr	u
	)

Evaluate the velocity field, f, at (x, y, z, t). For now, t is ignored.

bool Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetCachedCellIds	(	IntPtr	id,
		IntPtr	ds
	)

Between iterations of the Particle Tracer, Id's of the Cell are stored and then at the start of the next particle the Ids are set to 'pre-fill' the cache.

virtual double Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetCurrentWeight ( )

virtual

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

virtual double [] Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetLastGoodVelocity ( )

virtual

If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetLastGoodVelocity	(	ref double	_arg1,
		ref double	_arg2,
		ref double	_arg3
	)

virtual

If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetLastGoodVelocity ( IntPtr _arg )

virtual

If an interpolation was successful, we can retrieve the last computed value from here. Initial value is (0.0,0.0,0.0)

bool Kitware.VTK.vtkTemporalInterpolatedVelocityField.GetVorticityData	(	int	T,
		IntPtr	pcoords,
		IntPtr	weights,
		vtkGenericCell	cell,
		vtkDoubleArray	cellVectors
	)

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

bool Kitware.VTK.vtkTemporalInterpolatedVelocityField.InterpolatePoint	(	vtkPointData	outPD1,
		vtkPointData	outPD2,
		int	outIndex
	)

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

bool Kitware.VTK.vtkTemporalInterpolatedVelocityField.InterpolatePoint	(	int	T,
		vtkPointData	outPD1,
		int	outIndex
	)

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

override int Kitware.VTK.vtkTemporalInterpolatedVelocityField.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

bool Kitware.VTK.vtkTemporalInterpolatedVelocityField.IsStatic ( int datasetIndex )

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

static new int Kitware.VTK.vtkTemporalInterpolatedVelocityField.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

static new vtkTemporalInterpolatedVelocityField Kitware.VTK.vtkTemporalInterpolatedVelocityField.New ( )

static

Construct a vtkTemporalInterpolatedVelocityField with no initial data set. Caching is on. LastCellId is set to -1.

Reimplemented from Kitware.VTK.vtkObject.

new vtkTemporalInterpolatedVelocityField Kitware.VTK.vtkTemporalInterpolatedVelocityField.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

int Kitware.VTK.vtkTemporalInterpolatedVelocityField.QuickTestPoint ( IntPtr x )

A utility function which evaluates the point at T1, T2 to see if it is inside the data at both times or only one.

static new vtkTemporalInterpolatedVelocityField Kitware.VTK.vtkTemporalInterpolatedVelocityField.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkFunctionSet.

Here is the call graph for this function:

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.SelectVectors ( string fieldName )

If you want to work with an arbitrary vector array, then set its name here. By default this is NULL and the filter will use the active vector array.

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.SetCachedCellIds	(	IntPtr	id,
		IntPtr	ds
	)

Between iterations of the Particle Tracer, Id's of the Cell are stored and then at the start of the next particle the Ids are set to 'pre-fill' the cache.

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.SetDataSetAtTime	(	int	I,
		int	N,
		double	T,
		vtkDataSet	dataset,
		bool	staticdataset
	)

In order to use this class, two sets of data must be supplied, corresponding to times T1 and T2. Data is added via this function.

void Kitware.VTK.vtkTemporalInterpolatedVelocityField.ShowCacheResults ( )

Get the most recent weight between 0->1 from T1->T2. Initial value is 0.

int Kitware.VTK.vtkTemporalInterpolatedVelocityField.TestPoint ( IntPtr x )

A utility function which evaluates the point at T1, T2 to see if it is inside the data at both times or only one.

Member Data Documentation

new readonly string Kitware.VTK.vtkTemporalInterpolatedVelocityField.MRClassNameKey = "36vtkTemporalInterpolatedVelocityField"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkFunctionSet.

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

csharp/vtkTemporalInterpolatedVelocityField.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation