VTK  9.3.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDGCell Class Referenceabstract

Base class for a discontinuous Galerkin cells of all shapes. More...

#include <vtkDGCell.h>

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

Public Types

enum  Shape : int {
  Vertex , Edge , Triangle , Quadrilateral ,
  Tetrahedron , Hexahedron , Wedge , Pyramid
}
 All possible shapes for DG cells. More...
 
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.
 
vtkDGCellNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual Shape GetShape () const =0
 Return the topological shape of this cell 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 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 [0, this->GetNumberOfSideTypes()[.
 
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 const std::vector< vtkIdType > & GetSideConnectivity (int side) const =0
 Return the connectivity of the given side.
 
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.
 
- 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 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.
 
virtual 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 vtkDGCellSafeDownCast (vtkObjectBase *o)
 
static int GetShapeCornerCount (Shape shape)
 
static int GetShapeDimension (Shape shape)
 
static vtkStringToken GetShapeName (Shape shape)
 
- 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
 
 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 ReportReferences (vtkGarbageCollector *)
 
 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

Base class for a discontinuous Galerkin cells of all shapes.

This class exists to offer each shape's parameterization via a uniform API.

All DG cells have shapes that can be described by corner points in a reference (parametric) coordinate system. Sides (boundaries) of the element of any dimension can be fetched as offsets into the list of corners. You can also obtain a list of the coordinates in parametric space of all the corner points.

Tests:
vtkDGCell (Tests)

Definition at line 36 of file vtkDGCell.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkDGCell.h.

Member Enumeration Documentation

◆ Shape

enum vtkDGCell::Shape : int

All possible shapes for DG cells.

Enumerator
Vertex 

A corner point.

Edge 

A curve connecting two vertices.

Triangle 

A three-cornered face bounded by 3 edges.

Quadrilateral 

A four-cornered face bounded by 4 edges.

Tetrahedron 

A four-cornered volume bounded by 4 triangular shapes.

Hexahedron 

An eight-cornered volume; a quadrilateral prism.

Wedge 

A volumetric, triangular prism.

Pyramid 

A volumetric shape whose quadrilateral base attaches to a vertex.

Definition at line 43 of file vtkDGCell.h.

Constructor & Destructor Documentation

◆ vtkDGCell()

vtkDGCell::vtkDGCell ( )
protected

◆ ~vtkDGCell()

vtkDGCell::~vtkDGCell ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkDGHex, and vtkDGTet.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDGCell::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellMetadata.

Reimplemented in vtkDGHex, and vtkDGTet.

◆ NewInstance()

vtkDGCell * vtkDGCell::NewInstance ( ) const

◆ PrintSelf()

void vtkDGCell::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, and vtkDGTet.

◆ GetShapeCornerCount()

static int vtkDGCell::GetShapeCornerCount ( Shape  shape)
static

◆ GetShapeDimension()

static int vtkDGCell::GetShapeDimension ( Shape  shape)
static

◆ GetShapeName()

static vtkStringToken vtkDGCell::GetShapeName ( Shape  shape)
static

◆ GetShape()

virtual Shape vtkDGCell::GetShape ( ) const
pure virtual

Return the topological shape of this cell type.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetDimension()

virtual int vtkDGCell::GetDimension ( ) const
inlinevirtual

Return the parametric dimension of this cell type (0, 1, 2, or 3).

Reimplemented in vtkDGHex, and vtkDGTet.

Definition at line 68 of file vtkDGCell.h.

◆ GetNumberOfCorners()

virtual int vtkDGCell::GetNumberOfCorners ( ) const
inlinevirtual

Return the number of corner points for this cell type.

Reimplemented in vtkDGTet.

Definition at line 71 of file vtkDGCell.h.

◆ GetCornerParameter()

virtual const std::array< double, 3 > & vtkDGCell::GetCornerParameter ( int  corner) const
pure virtual

Return the coordinates of the reference element's corner vertex.

Any well-formed element in world coordinates can be mapped to its reference element by transforming its corner points to these; this mapping is frequently used to visualize and analyze elements.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetNumberOfSideTypes()

virtual int vtkDGCell::GetNumberOfSideTypes ( ) const
pure virtual

Return the number of different side shapes of this cell type.

Example: a wedge has 4 side shapes: Quadrilateral, Triangle, Edge, and Vertex.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetSideRangeForType()

virtual std::pair< int, int > vtkDGCell::GetSideRangeForType ( int  sideType) const
pure virtual

Return the range of sides of the ii-th type, where ii is in [0, this->GetNumberOfSideTypes()[.

If you pass ii = -1, this will return the total number of sides of all types.

The returned pair of integers is a half-open interval of side IDs. The difference between the returned values is the number of sides of sideType.

Example: a tetrahedron will return the following:

  • for sideType 0 (faces): [0, 4[
  • for sideType 1 (edges): [4, 10[
  • for sideType 2 (verts): [10, 14[
  • for sideType -1 (all): [0, 14[

Implemented in vtkDGHex, and vtkDGTet.

◆ GetNumberOfSidesOfDimension()

virtual int vtkDGCell::GetNumberOfSidesOfDimension ( int  dimension) const
pure virtual

Return the number of boundaries this type of cell has of a given dimension.

DG cells can be thought of as CW-complex cells; they are tuples of corner points which represent an open point set plus its closure decomposed into a union of open sets of lower dimension. For example, a hexahedron is an 8-tuple of corner points representing an underlying space shaped as an open, rectangular prism plus six 4-tuples representing its quadrilateral faces, plus twelve 2-tuples representing its edges, plus 8 1-tuples representing its corners. Thus, a hexahedron has 6 + 12 + 8 = 26 sides (plus its interior).

Implemented in vtkDGHex, and vtkDGTet.

◆ GetSideShape()

virtual Shape vtkDGCell::GetSideShape ( int  side) const
pure virtual

For a given side, return its cell shape.

The sides of a vtkDGCell are always ordered from highest dimension to lowest. For example, a hexahedron's quadrilateral sides are numbered 0–5, its line sides are numbered 6–17, and its corner point sides are numbered 18–25. Sometimes, the interior of the element is considered a side labeled -1.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetSideConnectivity() [1/2]

virtual const std::vector< vtkIdType > & vtkDGCell::GetSideConnectivity ( int  side) const
pure virtual

Return the connectivity of the given side.

The side connectivity is a vector holding the indexes of corner-points of the side into the connectivity vector of this cell.

Passing a side of -1 should return the connectivity of the cell's interior (a vector of the counting numbers from 0 to this->GetNumberOfCorners()). This feature is used when rendering cells of dimension 2 or lower.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetReferencePoints()

virtual vtkTypeFloat32Array * vtkDGCell::GetReferencePoints ( ) const
pure virtual

Return a singleton array initialized with the reference-cell's corner point coordinates.

When implementing a subclass, call FillReferencePoints() in your override. This should always return the same vtkTypeFloat32Array each time so that the array is only uploaded to the GPU once.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetSideConnectivity() [2/2]

virtual vtkTypeInt32Array * vtkDGCell::GetSideConnectivity ( ) const
pure virtual

Return a singleton array initialized with point-ids of each side's corners.

To make use of this array, you should also call GetSideOffsetsAndShapes() and GetShapeCornerCount().

When implementing a subclass, call FillSideConnectivity() in your override. This should always return the same vtkTypeInt32Array each time so that the array is only uploaded to the GPU once.

Implemented in vtkDGHex, and vtkDGTet.

◆ GetSideOffsetsAndShapes()

virtual vtkTypeInt32Array * vtkDGCell::GetSideOffsetsAndShapes ( ) const
pure virtual

Return a singleton array initialized with 2-tuples of (offset, shape) values.

When implementing a subclass, call FillSideOffsetsAndShapes() in your override. This should always return the same vtkTypeInt32Array each time so that the array is only uploaded to the GPU once.

Implemented in vtkDGHex, and vtkDGTet.

◆ FillReferencePoints()

void vtkDGCell::FillReferencePoints ( vtkTypeFloat32Array *  arr) const

Fill the passed array with the parametric coordinates of all the element's corners.

◆ FillSideConnectivity()

void vtkDGCell::FillSideConnectivity ( vtkTypeInt32Array *  arr) const

Fill the passed array with the connectivity (point IDs) of all the element's sides.

◆ FillSideOffsetsAndShapes()

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

Note that the final tuple contains the total size of the offset array and a shape corresponding to the element itself.

Each element's vertex side-connectivity (the penultimate offset) can also be used as the connectivity for the element's connectivity.

Simple example: a vtkDGTri has 3 tuples:

Complex example: a vtkDGWedge has 5 tuples:

Note that the wedge has multiple 2-d sides (both quadilaterals and triangles).


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