VTK  9.3.20240618
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDeRhamCell Class Reference

Base class for cells that form 2-d or 3-d DeRham complexes. More...

#include <vtkDeRhamCell.h>

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

Public Types

typedef vtkDGCell Superclass
 
- Public Types inherited from vtkDGCell
enum  Shape : int {
  Vertex , Edge , Triangle , Quadrilateral ,
  Tetrahedron , Hexahedron , Wedge , Pyramid ,
  None
}
 All possible shapes for DG cells. More...
 
using OperatorMap = std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< int, std::unordered_map< vtkStringToken, vtkDGOperatorEntry > > > > >
 A map holding operators that evaluate DG cells.
 
typedef vtkCellMetadata 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.
 
vtkDeRhamCellNewInstance () const
 
 vtkInheritanceHierarchyOverrideMacro (vtkDeRhamCell)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
- Public Member Functions inherited from vtkDGCell
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDGCellNewInstance () const
 
 vtkInheritanceHierarchyOverrideMacro (vtkDGCell)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
SourceGetCellSpec ()
 Provide access to the connectivity array used to define cells of this type.
 
std::vector< Source > & GetSideSpecs ()
 Provide access to the (cellId,sideId)-arrays used to define side-cells of this type.
 
vtkIdType GetNumberOfCells () override
 Return the number of cells (and sides) of this type present in this cell grid.
 
virtual bool IsInside (const vtkVector3d &rst, double tolerance=1e-6)=0
 Return true if the parametric coordinates (rst) lie inside the reference cell or its closure and false otherwise.
 
virtual Shape GetShape () const =0
 Return the topological shape of this cell or side type.
 
virtual int GetDimension () const
 Return the parametric dimension of this cell type (0, 1, 2, or 3).
 
virtual int GetNumberOfCorners () const
 Return the number of corner points for this cell type.
 
virtual const std::array< double, 3 > & GetCornerParameter (int corner) const =0
 Return the coordinates of the reference element's corner vertex.
 
virtual vtkVector3d GetParametricCenterOfSide (int sideId) const
 Return the parametric center of a cell or its side.
 
virtual int GetNumberOfSideTypes () const =0
 Return the number of different side shapes of this cell type.
 
virtual std::pair< int, int > GetSideRangeForType (int sideType) const =0
 Return the range of sides of the ii-th type, where ii is in [-2, this->GetNumberOfSideTypes()[.
 
int * GetSideRangeForSideType (int sideType)
 A python-wrapped version of GetSideRangeForType.
 
virtual std::pair< int, int > GetSideRangeForDimension (int dimension) const
 Return the range of side IDs for all sides of the given dimension.
 
int * GetSideRangeForSideDimension (int sideDimension)
 A python-wrapped version of GetSideRangeForDimension.
 
virtual int GetNumberOfSidesOfDimension (int dimension) const =0
 Return the number of boundaries this type of cell has of a given dimension.
 
virtual Shape GetSideShape (int side) const =0
 For a given side, return its cell shape.
 
virtual int GetSideTypeForShape (Shape s) const
 Return the side type index for the given shape (or -1).
 
virtual const std::vector< vtkIdType > & GetSideConnectivity (int side) const =0
 Return the connectivity of the given side.
 
virtual const std::vector< vtkIdType > & GetSidesOfSide (int side) const =0
 Return a vector of side IDs given an input side ID.
 
virtual vtkTypeFloat32Array * GetReferencePoints () const =0
 Return a singleton array initialized with the reference-cell's corner point coordinates.
 
virtual vtkTypeInt32Array * GetSideConnectivity () const =0
 Return a singleton array initialized with point-ids of each side's corners.
 
virtual vtkTypeInt32Array * GetSideOffsetsAndShapes () const =0
 Return a singleton array initialized with 2-tuples of (offset, shape) values.
 
void FillReferencePoints (vtkTypeFloat32Array *arr) const
 Fill the passed array with the parametric coordinates of all the element's corners.
 
void FillSideConnectivity (vtkTypeInt32Array *arr) const
 Fill the passed array with the connectivity (point IDs) of all the element's sides.
 
void FillSideOffsetsAndShapes (vtkTypeInt32Array *arr) const
 Fill the passed array with tuples of (1) offsets into the side-connectivity and (2) shapes for each type of side.
 
vtkCellGridResponders::TagSet GetAttributeTags (vtkCellAttribute *attribute, bool inheritedTypes=false)
 A convenience function to fetch attribute-calculator tags for an attribute.
 
vtkDGOperatorEntry GetOperatorEntry (vtkStringToken opName, const vtkCellAttribute::CellTypeInfo &attributeInfo)
 Return an operator entry.
 
void ShallowCopy (vtkCellMetadata *other) override
 
void DeepCopy (vtkCellMetadata *other) override
 
- 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 vtkDeRhamCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDGCell
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDGCellSafeDownCast (vtkObjectBase *o)
 
static int GetShapeCornerCount (Shape shape)
 
static int GetShapeDimension (Shape shape)
 
static vtkStringToken GetShapeName (Shape shape)
 
static Shape GetShapeEnum (vtkStringToken shapeName)
 Given a string description of a cell shape, return the DG equivalent enum.
 
static OperatorMapGetOperators ()
 Return a map of operators registered for vtkDGCell and its subclasses.
 
- 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
 
 vtkDeRhamCell ()=default
 
 ~vtkDeRhamCell () override=default
 
- Protected Member Functions inherited from vtkDGCell
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDGCell ()
 
 ~vtkDGCell () override
 
- 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 vtkDGCell
Source CellSpec
 The connectivity array specifying cells.
 
std::vector< SourceSideSpecs
 The connectivity array(s) specifying sides.
 
- 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

Base class for cells that form 2-d or 3-d DeRham complexes.

This class exists so that cell-attributes specific to DeRham sequences can register responders and calculators. Only 2-d and 3-d cell-shapes are allowed to subclass vtkDeRhamCell since H(Curl) and H(Div) function spaces require cells of parametric dimension 2 or greater.

This class inherits the API of vtkDGCell.

Tests:
vtkDeRhamCell (Tests)

Definition at line 25 of file vtkDeRhamCell.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkDeRhamCell.h.

Constructor & Destructor Documentation

◆ vtkDeRhamCell()

vtkDeRhamCell::vtkDeRhamCell ( )
protecteddefault

◆ ~vtkDeRhamCell()

vtkDeRhamCell::~vtkDeRhamCell ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkDeRhamCell::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 vtkDGCell.

Reimplemented in vtkDGHex, vtkDGQuad, vtkDGTet, vtkDGTri, and vtkDGWdg.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDeRhamCell::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDGCell.

Reimplemented in vtkDGHex, vtkDGQuad, vtkDGTet, vtkDGTri, and vtkDGWdg.

◆ NewInstance()

vtkDeRhamCell * vtkDeRhamCell::NewInstance ( ) const

◆ vtkInheritanceHierarchyOverrideMacro()

vtkDeRhamCell::vtkInheritanceHierarchyOverrideMacro ( vtkDeRhamCell  )

◆ PrintSelf()

void vtkDeRhamCell::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 vtkCellMetadata.

Reimplemented in vtkDGHex, vtkDGQuad, vtkDGTet, vtkDGTri, and vtkDGWdg.


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