vtkDGInterpolateCalculator Class Reference

Calculate field values at a point in a cell's parametric space. More...

#include <vtkDGInterpolateCalculator.h>

Inheritance diagram for vtkDGInterpolateCalculator:

Collaboration diagram for vtkDGInterpolateCalculator:

Public Types
typedef vtkInterpolateCalculator	Superclass
Public Types inherited from vtkInterpolateCalculator
typedef vtkCellAttributeCalculator	Superclass
Public Types inherited from vtkCellAttributeCalculator
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDGInterpolateCalculator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Evaluate (vtkIdType cellId, const vtkVector3d &rst, std::vector< double > &value) override
	Subclasses may override this method to perform multiple evaluations at a time.
void	Evaluate (vtkIdTypeArray *cellIds, vtkDataArray *rst, vtkDataArray *result) override
	Subclasses may override this method to perform multiple evaluations at a time.
bool	AnalyticDerivative () const override
	Return true if the function has an analytic derivative.
void	EvaluateDerivative (vtkIdType cellId, const vtkVector3d &rst, std::vector< double > &jacobian, double neighborhood) override
	Return the derivative of the function at rst.
void	EvaluateDerivative (vtkIdTypeArray *cellIds, vtkDataArray *rst, vtkDataArray *result) override
	Subclasses may override this method to perform multiple derivative-evaluations at a time.
vtkSmartPointer< vtkCellAttributeCalculator >	PrepareForGrid (vtkCellMetadata *cell, vtkCellAttribute *field) override
Public Member Functions inherited from vtkInterpolateCalculator
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkInterpolateCalculator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
Public Member Functions inherited from vtkCellAttributeCalculator
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkCellAttributeCalculator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
template<typename CalculatorType >
vtkSmartPointer< CalculatorType >	Prepare (vtkCellMetadata *cell, vtkCellAttribute *field)
	Return an instance of a calculator ready to work on cell and field.
virtual vtkSmartPointer< vtkCellAttributeCalculator >	PrepareForGrid (vtkCellMetadata *vtkNotUsed(cell), vtkCellAttribute *vtkNotUsed(field))
	Subclasses should override this to create an instance of their class with member variables set to perform calculations on the given cell type and field.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkDGInterpolateCalculator *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDGInterpolateCalculator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkInterpolateCalculator
static vtkTypeBool	IsTypeOf (const char *type)
static vtkInterpolateCalculator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCellAttributeCalculator
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCellAttributeCalculator *	SafeDownCast (vtkObjectBase *o)
static vtkCellAttributeCalculator *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDGInterpolateCalculator ()=default
	~vtkDGInterpolateCalculator () override=default
template<bool UseShape>
void	InternalDerivative (vtkIdType cellId, const vtkVector3d &rst, std::vector< double > &jacobian, double neighborhood)
Protected Member Functions inherited from vtkInterpolateCalculator
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInterpolateCalculator ()=default
	Subclasses may override this method to perform multiple evaluations at a time.
	~vtkInterpolateCalculator () override=default
	Subclasses may override this method to perform multiple evaluations at a time.
Protected Member Functions inherited from vtkCellAttributeCalculator
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCellAttributeCalculator ()=default
	~vtkCellAttributeCalculator () override=default
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDGCell *	CellType { nullptr }
	The cell-type for which interpolation will be performed.
vtkCellAttribute *	Field { nullptr }
	The cell-attribute for which interpolation will be performed.
vtkDGOperation< vtkDGArraysInputAccessor, vtkDGArrayOutputAccessor >	FieldEvaluator
	Used to compute a field value for a cell.
vtkDGOperation< vtkDGArraysInputAccessor, vtkDGArrayOutputAccessor >	FieldDerivative
	Used to compute a field derivative for a cell.
vtkNew< vtkDoubleArray >	LocalField
	Used when an array passed to Evaluate()/EvaluateDerivative() is not a double-array.
int	Dimension { 3 }
	The parametric dimension of the current cell-type.
vtkDGCell::Shape	CellShape { vtkDGCell::Shape::None }
	The shape of the current cell type.
vtkCellAttribute::CellTypeInfo	FieldCellInfo
	The function space, basis, etc.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDGRangeResponder

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Calculate field values at a point in a cell's parametric space.

Interpolate a field's value and possibly derivatives at a point in a cell.

Tests:

vtkDGInterpolateCalculator (Tests)

Definition at line 33 of file vtkDGInterpolateCalculator.h.

Member Typedef Documentation

Superclass

typedef vtkInterpolateCalculator vtkDGInterpolateCalculator::Superclass

Definition at line 37 of file vtkDGInterpolateCalculator.h.

Constructor & Destructor Documentation

vtkDGInterpolateCalculator()

vtkDGInterpolateCalculator::vtkDGInterpolateCalculator ( )

protecteddefault

~vtkDGInterpolateCalculator()

vtkDGInterpolateCalculator::~vtkDGInterpolateCalculator ( )

overrideprotecteddefault

Member Function Documentation

New()

static vtkDGInterpolateCalculator * vtkDGInterpolateCalculator::New ( )

static

IsTypeOf()

static vtkTypeBool vtkDGInterpolateCalculator::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkDGInterpolateCalculator::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 vtkInterpolateCalculator.

SafeDownCast()

static vtkDGInterpolateCalculator * vtkDGInterpolateCalculator::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkDGInterpolateCalculator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInterpolateCalculator.

NewInstance()

vtkDGInterpolateCalculator * vtkDGInterpolateCalculator::NewInstance

(

)

const

PrintSelf()

void vtkDGInterpolateCalculator::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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 vtkCellAttributeCalculator.

Evaluate() [1/2]

void vtkDGInterpolateCalculator::Evaluate ( vtkIdType  cellId, const vtkVector3d &  rst, std::vector< double > &  value  )

overridevirtual

Subclasses may override this method to perform multiple evaluations at a time.

Implements vtkInterpolateCalculator.

Evaluate() [2/2]

void vtkDGInterpolateCalculator::Evaluate ( vtkIdTypeArray *  cellIds, vtkDataArray *  rst, vtkDataArray *  result  )

overridevirtual

Subclasses may override this method to perform multiple evaluations at a time.

Implements vtkInterpolateCalculator.

AnalyticDerivative()

bool vtkDGInterpolateCalculator::AnalyticDerivative ( ) const

overridevirtual

Return true if the function has an analytic derivative.

Reimplemented from vtkInterpolateCalculator.

EvaluateDerivative() [1/2]

void vtkDGInterpolateCalculator::EvaluateDerivative ( vtkIdType  cellId, const vtkVector3d &  rst, std::vector< double > &  jacobian, double  neighborhood  )

overridevirtual

Return the derivative of the function at rst.

The derivative should be ordered as d/dx, d/dy, then d/dz.

If you do not override AnalyticDerivative and EvaluateDerivative, this class will approximate the derivative by perturbing along each axis to compute a finite difference.

In the case of a non-analytic derivative, you can control the magnitude of the difference along each axis by passing a different neighborhood value.

Reimplemented from vtkInterpolateCalculator.

EvaluateDerivative() [2/2]

void vtkDGInterpolateCalculator::EvaluateDerivative ( vtkIdTypeArray *  cellIds, vtkDataArray *  rst, vtkDataArray *  result  )

overridevirtual

Subclasses may override this method to perform multiple derivative-evaluations at a time.

Implements vtkInterpolateCalculator.

PrepareForGrid()

vtkSmartPointer< vtkCellAttributeCalculator > vtkDGInterpolateCalculator::PrepareForGrid ( vtkCellMetadata *  cell, vtkCellAttribute *  field  )

override

InternalDerivative()

template<bool UseShape>

void vtkDGInterpolateCalculator::InternalDerivative ( vtkIdType  cellId, const vtkVector3d &  rst, std::vector< double > &  jacobian, double  neighborhood  )

protected

Friends And Related Symbol Documentation

vtkDGRangeResponder

friend class vtkDGRangeResponder

friend

Definition at line 53 of file vtkDGInterpolateCalculator.h.

Member Data Documentation

CellType

vtkDGCell* vtkDGInterpolateCalculator::CellType { nullptr }

protected

The cell-type for which interpolation will be performed.

This is set by PrepareForGrid().

Definition at line 64 of file vtkDGInterpolateCalculator.h.

Field

vtkCellAttribute* vtkDGInterpolateCalculator::Field { nullptr }

protected

The cell-attribute for which interpolation will be performed.

This is set by PrepareForGrid().

Definition at line 68 of file vtkDGInterpolateCalculator.h.

FieldEvaluator

vtkDGOperation<vtkDGArraysInputAccessor, vtkDGArrayOutputAccessor> vtkDGInterpolateCalculator::FieldEvaluator

protected

Used to compute a field value for a cell.

Definition at line 71 of file vtkDGInterpolateCalculator.h.

FieldDerivative

vtkDGOperation<vtkDGArraysInputAccessor, vtkDGArrayOutputAccessor> vtkDGInterpolateCalculator::FieldDerivative

protected

Used to compute a field derivative for a cell.

Definition at line 73 of file vtkDGInterpolateCalculator.h.

LocalField

vtkNew<vtkDoubleArray> vtkDGInterpolateCalculator::LocalField

protected

Used when an array passed to Evaluate()/EvaluateDerivative() is not a double-array.

The basis operators only process doubles (on the CPU). If needed, we copy the parameter and/or output arrays to/from a "local" double-valued array into what was passed.

Definition at line 80 of file vtkDGInterpolateCalculator.h.

Dimension

int vtkDGInterpolateCalculator::Dimension { 3 }

protected

The parametric dimension of the current cell-type.

Definition at line 83 of file vtkDGInterpolateCalculator.h.

CellShape

vtkDGCell::Shape vtkDGInterpolateCalculator::CellShape { vtkDGCell::Shape::None }

protected

The shape of the current cell type.

Definition at line 85 of file vtkDGInterpolateCalculator.h.

FieldCellInfo

vtkCellAttribute::CellTypeInfo vtkDGInterpolateCalculator::FieldCellInfo

protected

The function space, basis, etc.

of the target field.

This is populated by PrepareForGrid.

Definition at line 90 of file vtkDGInterpolateCalculator.h.

---

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

• Filters/CellGrid/vtkDGInterpolateCalculator.h