VTK  9.4.20241013
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | 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]

Classes

struct  Source
 Records describing the source arrays for cells or cell-sides. More...
 

Public Types

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.
 
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.
 
const SourceGetCellSource (int sideType=-1) const
 Provide access to cell specifications in a uniform way (for both cells and sides).
 
SourceGetCellSource (int sideType=-1)
 
std::size_t GetNumberOfCellSources () const
 Python-accessible method to identify number of cell sources.
 
vtkDataArrayGetCellSourceConnectivity (int sideType=-1) const
 Python-accessible methods to fetch cell source information.
 
vtkDataArrayGetCellSourceNodalGhostMarks (int sideType=-1) const
 
vtkIdType GetCellSourceOffset (int sideType=-1) const
 
bool GetCellSourceIsBlanked (int sideType=-1) const
 
Shape GetCellSourceShape (int sideType=-1) const
 
int GetCellSourceSideType (int sideType=-1) const
 
int GetCellSourceSelectionType (int sideType=-1) const
 
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 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
 
 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 &)
 

Protected Attributes

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
 

Additional Inherited Members

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

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 43 of file vtkDGCell.h.

Member Typedef Documentation

◆ OperatorMap

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

Operators currently include "Basis" and "BasisGradient" to evaluate the polynomial basis functions for a cell-attribute. But in the future this may also include operators such as "Curl", "Divergence", and higher-order derivative operators.

Besides operators being indexed on their purpose (the operator name), they are indexed on the function space in which they live (such as the space of nodal functions, edge-centered functions, face-centered functions, constant functions, etc.), the polynomial basis inside the function space and its order are also indexed.

vtkDGInterpolateCalculator and other query-responders should use this map along with vtkDGOperation to perform interpolation or other work requiring basis-function computation.

Definition at line 62 of file vtkDGCell.h.

◆ Superclass

Definition at line 150 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.

None 

A placeholder for an indeterminate or invalid shape.

Definition at line 70 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 vtkDeRhamCell, vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDGCell::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDGCell * vtkDGCell::NewInstance ( ) const

◆ vtkInheritanceHierarchyOverrideMacro()

vtkDGCell::vtkInheritanceHierarchyOverrideMacro ( vtkDGCell  )

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetCellSpec()

Source & vtkDGCell::GetCellSpec ( )
inline

Provide access to the connectivity array used to define cells of this type.

Definition at line 155 of file vtkDGCell.h.

◆ GetSideSpecs()

std::vector< Source > & vtkDGCell::GetSideSpecs ( )
inline

Provide access to the (cellId,sideId)-arrays used to define side-cells of this type.

Definition at line 158 of file vtkDGCell.h.

◆ GetCellSource() [1/2]

const Source & vtkDGCell::GetCellSource ( int  sideType = -1) const

Provide access to cell specifications in a uniform way (for both cells and sides).

◆ GetCellSource() [2/2]

Source & vtkDGCell::GetCellSource ( int  sideType = -1)

◆ GetNumberOfCellSources()

std::size_t vtkDGCell::GetNumberOfCellSources ( ) const
inline

Python-accessible method to identify number of cell sources.

Definition at line 165 of file vtkDGCell.h.

◆ GetCellSourceConnectivity()

vtkDataArray * vtkDGCell::GetCellSourceConnectivity ( int  sideType = -1) const

Python-accessible methods to fetch cell source information.

In C++, you should simply call GetCellSource(sideType) and access the ivar.

◆ GetCellSourceNodalGhostMarks()

vtkDataArray * vtkDGCell::GetCellSourceNodalGhostMarks ( int  sideType = -1) const

◆ GetCellSourceOffset()

vtkIdType vtkDGCell::GetCellSourceOffset ( int  sideType = -1) const

◆ GetCellSourceIsBlanked()

bool vtkDGCell::GetCellSourceIsBlanked ( int  sideType = -1) const

◆ GetCellSourceShape()

Shape vtkDGCell::GetCellSourceShape ( int  sideType = -1) const

◆ GetCellSourceSideType()

int vtkDGCell::GetCellSourceSideType ( int  sideType = -1) const

◆ GetCellSourceSelectionType()

int vtkDGCell::GetCellSourceSelectionType ( int  sideType = -1) const

◆ GetNumberOfCells()

vtkIdType vtkDGCell::GetNumberOfCells ( )
overridevirtual

Return the number of cells (and sides) of this type present in this cell grid.

Reimplemented from vtkCellMetadata.

◆ ShallowCopy()

void vtkDGCell::ShallowCopy ( vtkCellMetadata other)
override

Copy cell-specific data from other into ourselves.

◆ DeepCopy()

void vtkDGCell::DeepCopy ( vtkCellMetadata other)
override

Copy cell-specific data from other into ourselves.

◆ IsInside()

virtual bool vtkDGCell::IsInside ( const vtkVector3d rst,
double  tolerance = 1e-6 
)
pure virtual

Return true if the parametric coordinates (rst) lie inside the reference cell or its closure and false otherwise.

The tolerance specifies a margin that should be included as part of the reference cell's interior to account for numerical imprecision.

Implemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetShapeCornerCount()

static int vtkDGCell::GetShapeCornerCount ( Shape  shape)
static

◆ GetShapeDimension()

static int vtkDGCell::GetShapeDimension ( Shape  shape)
static

◆ GetShapeName()

static vtkStringToken vtkDGCell::GetShapeName ( Shape  shape)
static

◆ GetShapeEnum()

static Shape vtkDGCell::GetShapeEnum ( vtkStringToken  shapeName)
static

Given a string description of a cell shape, return the DG equivalent enum.

Note that this also converts IOSS shape names to DG enums, so there are additional cases to handle spheres as points, springs as lines, etc.

◆ GetShape()

virtual Shape vtkDGCell::GetShape ( ) const
pure virtual

Return the topological shape of this cell or side type.

Implemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetDimension()

virtual int vtkDGCell::GetDimension ( ) const
inlinevirtual

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

Reimplemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

Definition at line 207 of file vtkDGCell.h.

◆ GetNumberOfCorners()

virtual int vtkDGCell::GetNumberOfCorners ( ) const
inlinevirtual

Return the number of corner points for this cell type.

Definition at line 210 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetParametricCenterOfSide()

virtual vtkVector3d vtkDGCell::GetParametricCenterOfSide ( int  sideId) const
virtual

Return the parametric center of a cell or its side.

Pass -1 for side if you want the cell's center. Otherwise, pass the side ID.

This method simply averages corner-point coordinates. It is not fast, since it averages values each time it is called. If you need to re-use this information, you are responsible for caching it locally.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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 [-2, this->GetNumberOfSideTypes()[.

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.

Values of ii 0 and above are for "strict" sides (i.e., sides whose dimension is less than the cell's dimension). If you pass ii = -2, this will return the total number of strict sides of all types. If you pass ii = -1, this will return an entry for the cell's "self" type [-1,0[.

Example: a tetrahedron will return the following:

  • for sideType -2 (all strict sides): [0, 14[
  • for sideType -1 (self): [-1, 0[
  • for sideType 0 (triangles): [0, 4[
  • for sideType 1 (edges): [4, 10[
  • for sideType 2 (verts): [10, 14[

Side types are ordered from highest dimension to lowest as ii increases. Note that it is possible to have multiple types of side that have the same dimension. For example, wedges and pyramids each have triangle and quadrilateral sides (of dimension 2, but of different types).

Implemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetSideRangeForSideType()

int * vtkDGCell::GetSideRangeForSideType ( int  sideType)

A python-wrapped version of GetSideRangeForType.

◆ GetSideRangeForDimension()

virtual std::pair< int, int > vtkDGCell::GetSideRangeForDimension ( int  dimension) const
virtual

Return the range of side IDs for all sides of the given dimension.

An invalid range (side.first > side.second) is returned if no sides of the given dimension exist.

◆ GetSideRangeForSideDimension()

int * vtkDGCell::GetSideRangeForSideDimension ( int  sideDimension)

A python-wrapped version of GetSideRangeForDimension.

◆ 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).

Passing a dimension of -1 will return 1 side; DG cells use a -1-dimensional side to indicate an entire cell should be treated as a side. This is useful for subsetting cells without re-writing the arrays holding connectivity and field values; it also allows a vtkDGCell instance to hold both sides of input cells mixed with a subset of the input cells. For example, given 3 triangles as input, generating an output with 1 input triangle unchanged and edges or vertices from the other two triangles requires per-cell blanking or subsetting of cells.

Implemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetSideTypeForShape()

virtual int vtkDGCell::GetSideTypeForShape ( Shape  s) const
virtual

Return the side type index for the given shape (or -1).

This method simply loops over the cell's side types until it finds one of the proper shape.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ GetSidesOfSide()

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

Return a vector of side IDs given an input side ID.

Passing a side of -1 will return the sides of the element itself. The returned values are not corner-point IDs; they are side IDs. You can call GetSideConnectivity on each entry of the returned vector to obtain corner-point IDs.

Implemented in vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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 vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ 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).

◆ GetAttributeTags()

vtkCellGridResponders::TagSet vtkDGCell::GetAttributeTags ( vtkCellAttribute attribute,
bool  inheritedTypes = false 
)

A convenience function to fetch attribute-calculator tags for an attribute.

Query-responders are ultimately responsible for providing tags when fetching a attribute-calculator, but this method is a convenience since many responders will follow the same pattern.

Pass inheritedTypes as true when passing the result to vtkCellGridResponders::AttributeCalculator() (so that any responder which applies to an inherited class will be used to find a calculator). Pass inheritedTypes as false when using the result to register a calculator (so that the calculator is not made available to parent classes of this cell type).

◆ GetOperatorEntry()

vtkDGOperatorEntry vtkDGCell::GetOperatorEntry ( vtkStringToken  opName,
const vtkCellAttribute::CellTypeInfo attributeInfo 
)

Return an operator entry.

◆ GetOperators()

static OperatorMap & vtkDGCell::GetOperators ( )
static

Return a map of operators registered for vtkDGCell and its subclasses.

Member Data Documentation

◆ CellSpec

Source vtkDGCell::CellSpec
protected

The connectivity array specifying cells.

There may be only one Source for all the cells of one type in a vtkCellGrid.

Definition at line 406 of file vtkDGCell.h.

◆ SideSpecs

std::vector<Source> vtkDGCell::SideSpecs
protected

The connectivity array(s) specifying sides.

There may be zero or more Source instances for sides in a vtkCellGrid.

Definition at line 409 of file vtkDGCell.h.


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