Metadata for a discontinuous Galerkin hexahedron. More...

#include <vtkDGHex.h>

Inheritance diagram for vtkDGHex:

Collaboration diagram for vtkDGHex:

Public Types
typedef vtkDGCell	Superclass

Public Types inherited from vtkDGCell
enum	Shape : int { Vertex , Edge , Triangle , Quadrilateral , Tetrahedron , Hexahedron , Wedge , Pyramid }
	All possible shapes for DG cells. More...

typedef vtkCellMetadata	Superclass

Public Types inherited from vtkCellMetadata
using	CellTypeId = vtkStringToken::Hash

using	DOFType = vtkStringToken

using	MetadataConstructor = std::function< vtkSmartPointer< vtkCellMetadata >(vtkCellGrid *)>

using	ConstructorMap = std::unordered_map< vtkStringToken, MetadataConstructor >

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.

vtkDGHex *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkIdType	GetNumberOfCells () override
	Return the number of cells of this type in the parent cell-grid object.

Shape	GetShape () const override
	Return the topological shape of this cell type.

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

const std::array< double, 3 > &	GetCornerParameter (int corner) const override
	Return the coordinates of the reference element's corner vertex.

int	GetNumberOfSideTypes () const override
	Return the number of different side shapes of this cell type.

std::pair< int, int >	GetSideRangeForType (int sideType) const override
	Return the range of sides of the ii-th type, where ii is in [0, this->GetNumberOfSideTypes()[.

int	GetNumberOfSidesOfDimension (int dimension) const override
	Return the number of boundaries this type of cell has of a given dimension.

const std::vector< vtkIdType > &	GetSideConnectivity (int side) const override
	Return the connectivity of the given side.

Shape	GetSideShape (int side) const override
	For a given side, return its cell shape.

vtkTypeFloat32Array *	GetReferencePoints () const override
	Return a singleton array initialized with the reference-cell's corner point coordinates.

vtkTypeInt32Array *	GetSideConnectivity () const override
	Return a singleton array initialized with point-ids of each side's corners.

vtkTypeInt32Array *	GetSideOffsetsAndShapes () const override
	Return a singleton array initialized with 2-tuples of (offset, shape) values.

Public Member Functions inherited from vtkDGCell
vtkDGCell *	NewInstance () const

virtual int	GetNumberOfCorners () const
	Return the number of corner points for this cell type.

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 vtkCellMetadata
vtkCellMetadata *	NewInstance () const

CellTypeId	Hash ()
	Return a hash of the cell type.

virtual bool	SetCellGrid (vtkCellGrid *parent)
	Set the vtkCellGrid holding DOF arrays required by this cell.

virtual vtkCellGrid *	GetCellGrid ()
	Return the parent vtkCellGrid that owns this instance (or nullptr).

bool	Query (vtkCellGridQuery *query)
	Respond to a query on cells of this type.

virtual void	ShallowCopy (vtkCellMetadata *vtkNotUsed(other))
	Copy other into this instance (which must be of the same type).

virtual void	DeepCopy (vtkCellMetadata *vtkNotUsed(other))

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 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 vtkDGHex *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDGHex *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkDGCell
static vtkTypeBool	IsTypeOf (const char *type)

static vtkDGCell *	SafeDownCast (vtkObjectBase *o)

static int	GetShapeCornerCount (Shape shape)

static int	GetShapeDimension (Shape shape)

static vtkStringToken	GetShapeName (Shape shape)

Static Public Member Functions inherited from vtkCellMetadata
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellMetadata *	SafeDownCast (vtkObjectBase *o)

template<typename Subclass >
static bool	RegisterType ()
	Register a subclass of vtkCellMetadata.

template<typename Subclass >
static vtkSmartPointer< Subclass >	NewInstance (vtkCellGrid *grid=nullptr)

static vtkSmartPointer< vtkCellMetadata >	NewInstance (vtkStringToken className, vtkCellGrid *grid=nullptr)

static vtkCellGridResponders *	GetResponders ()
	Return the set of registered responder types.

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.

Static Public Attributes
static constexpr int	Dimension = 3

static const std::array< std::array< double, 3 >, 8 >	Parameters

static const std::array< std::vector< vtkIdType >, 26 >	Sides

static const std::array< int, Dimension+1 >	SideOffsets

static const std::array< Shape, Dimension+1 >	SideShapes

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDGHex ()

	~vtkDGHex () override

Protected Member Functions inherited from vtkDGCell
	vtkDGCell ()

	~vtkDGCell () override

Protected Member Functions inherited from vtkCellMetadata
	vtkCellMetadata ()=default

	~vtkCellMetadata () 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 vtkCellMetadata
vtkCellGrid *	CellGrid { nullptr }

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

Static Protected Attributes inherited from vtkCellMetadata
static ConstructorMap	Constructors

static vtkNew< vtkCellGridResponders >	Responders

Detailed Description

Metadata for a discontinuous Galerkin hexahedron.

Currently, only a linear shape is supported but this may change to arbitrary order.

Tests:: vtkDGHex (Tests)

Definition at line 27 of file vtkDGHex.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDGCell vtkDGHex::Superclass

Definition at line 32 of file vtkDGHex.h.

Constructor & Destructor Documentation

◆ vtkDGHex()

vtkDGHex::vtkDGHex ( )

protected

◆ ~vtkDGHex()

vtkDGHex::~vtkDGHex ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkDGHex * vtkDGHex::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDGHex::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDGCell.

◆ NewInstance()

vtkDGHex * vtkDGHex::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetNumberOfCells()

vtkIdType vtkDGHex::GetNumberOfCells ( )

overridevirtual

Return the number of cells of this type in the parent cell-grid object.

Subclasses must override this method.

Reimplemented from vtkCellMetadata.

◆ GetShape()

Shape vtkDGHex::GetShape ( ) const

inlineoverridevirtual

Return the topological shape of this cell type.

Implements vtkDGCell.

Definition at line 37 of file vtkDGHex.h.

◆ GetDimension()

int vtkDGHex::GetDimension ( ) const

inlineoverridevirtual

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

Reimplemented from vtkDGCell.

Definition at line 38 of file vtkDGHex.h.

◆ GetCornerParameter()

const std::array< double, 3 > & vtkDGHex::GetCornerParameter ( int corner ) const

overridevirtual

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.

Implements vtkDGCell.

◆ GetNumberOfSideTypes()

int vtkDGHex::GetNumberOfSideTypes ( ) const

overridevirtual

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

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

Implements vtkDGCell.

◆ GetSideRangeForType()

std::pair< int, int > vtkDGHex::GetSideRangeForType ( int sideType ) const

overridevirtual

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[

Implements vtkDGCell.

◆ GetNumberOfSidesOfDimension()

int vtkDGHex::GetNumberOfSidesOfDimension ( int dimension ) const

overridevirtual

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

Implements vtkDGCell.

◆ GetSideConnectivity() [1/2]

const std::vector< vtkIdType > & vtkDGHex::GetSideConnectivity ( int side ) const

overridevirtual

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.

Implements vtkDGCell.

◆ GetSideShape()

Shape vtkDGHex::GetSideShape ( int side ) const

overridevirtual

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.

Implements vtkDGCell.

◆ GetReferencePoints()

vtkTypeFloat32Array * vtkDGHex::GetReferencePoints ( ) const

overridevirtual

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.

Implements vtkDGCell.

◆ GetSideConnectivity() [2/2]

vtkTypeInt32Array * vtkDGHex::GetSideConnectivity ( ) const

overridevirtual

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.

Implements vtkDGCell.

◆ GetSideOffsetsAndShapes()

vtkTypeInt32Array * vtkDGHex::GetSideOffsetsAndShapes ( ) const

overridevirtual

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.

Implements vtkDGCell.

Member Data Documentation

◆ Dimension

constexpr int vtkDGHex::Dimension = 3

staticconstexpr

Definition at line 50 of file vtkDGHex.h.

◆ Parameters

const std::array<std::array<double, 3>, 8> vtkDGHex::Parameters

static

Definition at line 51 of file vtkDGHex.h.

◆ Sides

const std::array<std::vector<vtkIdType>, 26> vtkDGHex::Sides

static

Definition at line 52 of file vtkDGHex.h.

◆ SideOffsets

const std::array<int, Dimension + 1> vtkDGHex::SideOffsets

static

Definition at line 53 of file vtkDGHex.h.

◆ SideShapes

const std::array<Shape, Dimension + 1> vtkDGHex::SideShapes

static

Definition at line 54 of file vtkDGHex.h.

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

Filters/CellGrid/vtkDGHex.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkDGHex()

◆ ~vtkDGHex()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetNumberOfCells()

◆ GetShape()

◆ GetDimension()

◆ GetCornerParameter()

◆ GetNumberOfSideTypes()

◆ GetSideRangeForType()

◆ GetNumberOfSidesOfDimension()

◆ GetSideConnectivity() [1/2]

◆ GetSideShape()

◆ GetReferencePoints()

◆ GetSideConnectivity() [2/2]

◆ GetSideOffsetsAndShapes()

Member Data Documentation

◆ Dimension

◆ Parameters

◆ Sides

◆ SideOffsets

◆ SideShapes