VTK  9.3.20240723
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCellAttributeInformation Class Referenceabstract

Provide information about a cell attribute's basis functions on one cell type. More...

#include <vtkCellAttributeInformation.h>

Inheritance diagram for vtkCellAttributeInformation:
[legend]
Collaboration diagram for vtkCellAttributeInformation:
[legend]

Public Types

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.
 
vtkCellAttributeInformationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual int GetBasisOrder () const =0
 Return the polynomial order of the interpolant.
 
virtual int GetNumberOfBasisFunctions () const =0
 Return the number of basis functions for the cell type in question.
 
virtual int GetBasisValueSize () const =0
 Return the number of components generated for each basis function.
 
virtual int GetDegreeOfFreedomSize () const =0
 Return the number of times each basis function should be applied to obtain an attribute value.
 
virtual bool GetSharedDegreesOfFreedom () const =0
 Return whether degrees of freedom are shared by multiple cells or not.
 
virtual std::string GetBasisName () const =0
 Return a name for a basis function specific to both the cell-metadata and the cell-attribute type.
 
- 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.
 
vtkCellAttributeCalculatorNewInstance () 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< vtkCellAttributeCalculatorPrepareForGrid (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.
 
vtkCommandGetCommand (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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellAttributeInformationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCellAttributeCalculator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellAttributeCalculatorSafeDownCast (vtkObjectBase *o)
 
static vtkCellAttributeCalculatorNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkCellAttributeInformation ()=default
 
 ~vtkCellAttributeInformation () override=default
 
- Protected Member Functions inherited from vtkCellAttributeCalculator
virtual vtkObjectBaseNewInstanceInternal () 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 &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- 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
 

Detailed Description

Provide information about a cell attribute's basis functions on one cell type.

Note that some of the methods may be unable to return meaningful information about some attribute types; this class has methods that may be specific to subclasses of vtkDGCell. If this API does not fit your cell type or attribute type; do not register a calculator subclass of this type. Instead, it is up to consuming code to ensure a non-null calculator is returned.

This calculator assumes interpolation is performed as a weighted sum of basis functions evaluated at some parameter value.

\[ f_j = \sum_i B_i(r) w_{i,j} \]

where \(i\in[0, M - 1]\) and \(j\in[0,N - 1[\).

Definition at line 39 of file vtkCellAttributeInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkCellAttributeInformation.h.

Constructor & Destructor Documentation

◆ vtkCellAttributeInformation()

vtkCellAttributeInformation::vtkCellAttributeInformation ( )
protecteddefault

◆ ~vtkCellAttributeInformation()

vtkCellAttributeInformation::~vtkCellAttributeInformation ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellAttributeInformation::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 vtkCellAttributeCalculator.

Reimplemented in vtkDGAttributeInformation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellAttributeInformation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellAttributeCalculator.

Reimplemented in vtkDGAttributeInformation.

◆ NewInstance()

vtkCellAttributeInformation * vtkCellAttributeInformation::NewInstance ( ) const

◆ PrintSelf()

void vtkCellAttributeInformation::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.

Reimplemented in vtkDGAttributeInformation.

◆ GetBasisOrder()

virtual int vtkCellAttributeInformation::GetBasisOrder ( ) const
pure virtual

Return the polynomial order of the interpolant.

Subclasses must override this method to perform evaluation.

Implemented in vtkDGAttributeInformation.

◆ GetNumberOfBasisFunctions()

virtual int vtkCellAttributeInformation::GetNumberOfBasisFunctions ( ) const
pure virtual

Return the number of basis functions for the cell type in question.

Implemented in vtkDGAttributeInformation.

◆ GetBasisValueSize()

virtual int vtkCellAttributeInformation::GetBasisValueSize ( ) const
pure virtual

Return the number of components generated for each basis function.

For HGRAD function spaces, this is 1. For HCURL or HDIV function spaces, this is equal to the parametric dimension of the cell type in question.

Implemented in vtkDGAttributeInformation.

◆ GetDegreeOfFreedomSize()

virtual int vtkCellAttributeInformation::GetDegreeOfFreedomSize ( ) const
pure virtual

Return the number of times each basis function should be applied to obtain an attribute value.

For example, each HGRAD basis function for a hexahedron returns a single value per degree of freedom. However, when the output attribute has 3 components (say, x, y, and z point coordinates), then the weighted sum of the basis functions must be applied 3 times (once for each point coordinate). This is how vector- or tensor-valued attributes may be composed from scalar basis functions.

Implemented in vtkDGAttributeInformation.

◆ GetSharedDegreesOfFreedom()

virtual bool vtkCellAttributeInformation::GetSharedDegreesOfFreedom ( ) const
pure virtual

Return whether degrees of freedom are shared by multiple cells or not.

This roughly translates to whether the attribute is allowed to express discontinuities at cell boundaries; when degrees of freedom are shared, continuity is presumed. Otherwise, the interpolation functions may not produce identical values where cell boundaries overlap.

Implemented in vtkDGAttributeInformation.

◆ GetBasisName()

virtual std::string vtkCellAttributeInformation::GetBasisName ( ) const
pure virtual

Return a name for a basis function specific to both the cell-metadata and the cell-attribute type.

This is used by some render responders and interpolation calculators to choose a function to invoke.

Implemented in vtkDGAttributeInformation.


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