mfem::Pyramid Class Reference

Data type Pyramid element. More...

#include <pyramid.hpp>

Inheritance diagram for mfem::Pyramid:

Collaboration diagram for mfem::Pyramid:

Public Types
typedef Geometry::Constants< Geometry::PYRAMID >	geom_t
Public Types inherited from mfem::Element
enum	Type {   POINT , SEGMENT , TRIANGLE , QUADRILATERAL ,   TETRAHEDRON , HEXAHEDRON , WEDGE , PYRAMID }
	Constants for the classes derived from Element. More...

Public Member Functions
	Pyramid ()
	Pyramid (const int *ind, int attr=1)
	Constructs pyramid by specifying the indices and the attribute.
	Pyramid (int ind1, int ind2, int ind3, int ind4, int ind5, int attr=1)
	Constructs pyramid by specifying the indices and the attribute.
Type	GetType () const override
	Return element's type.
void	GetVertices (Array< int > &v) const override
	Get the indices defining the vertices.
void	SetVertices (const Array< int > &v) override
	Set the indices defining the vertices.
int *	GetVertices () override
void	SetVertices (const int *ind) override
	Set the indices defining the vertices.
int	GetNVertices () const override
int	GetNEdges () const override
const int *	GetEdgeVertices (int ei) const override
MFEM_DEPRECATED int	GetNFaces (int &nFaceVertices) const override
int	GetNFaces () const override
int	GetNFaceVertices (int fi) const override
const int *	GetFaceVertices (int fi) const override
Element *	Duplicate (Mesh *m) const override
virtual	~Pyramid ()=default
Public Member Functions inherited from mfem::Element
	Element (Geometry::Type bg=Geometry::POINT)
	Default element constructor.
Geometry::Type	GetGeometryType () const
int	GetAttribute () const
	Return element's attribute.
void	SetAttribute (const int attr)
	Set element's attribute.
const int *	GetVertices () const
virtual void	MarkEdge (const DSTable &v_to_v, const int *length)
	Mark the longest edge by assuming/changing the order of the vertices.
virtual int	NeedRefinement (HashTable< Hashed2 > &v_to_v) const
	Return 1 if the element needs refinement in order to get conforming mesh.
virtual void	ResetTransform (int tr)
	Set current coarse-fine transformation number.
virtual void	PushTransform (int tr)
	Add 'tr' to the current chain of coarse-fine transformations.
virtual unsigned	GetTransform () const
	Return current coarse-fine transformation.
virtual	~Element ()
	Destroys element.

Protected Attributes
int	indices [5]
Protected Attributes inherited from mfem::Element
int	attribute
	Element's attribute (specifying material property, etc).
Geometry::Type	base_geom
	Element's type from the Finite Element's perspective.

Detailed Description

Data type Pyramid element.

Definition at line 22 of file pyramid.hpp.

Member Typedef Documentation

geom_t

typedef Geometry::Constants<Geometry::PYRAMID> mfem::Pyramid::geom_t

Definition at line 28 of file pyramid.hpp.

Constructor & Destructor Documentation

Pyramid() [1/3]

mfem::Pyramid::Pyramid ( )

inline

Definition at line 30 of file pyramid.hpp.

Pyramid() [2/3]

mfem::Pyramid::Pyramid	(	const int *	ind,
		int	attr = 1 )

Constructs pyramid by specifying the indices and the attribute.

Definition at line 19 of file pyramid.cpp.

Pyramid() [3/3]

mfem::Pyramid::Pyramid	(	int	ind1,
		int	ind2,
		int	ind3,
		int	ind4,
		int	ind5,
		int	attr = 1 )

Constructs pyramid by specifying the indices and the attribute.

Definition at line 29 of file pyramid.cpp.

~Pyramid()

virtual mfem::Pyramid::~Pyramid ( )

virtualdefault

Member Function Documentation

Duplicate()

Element * mfem::Pyramid::Duplicate ( Mesh * m ) const

inlineoverridevirtual

Note

The returned object should be deleted by the caller.

Implements mfem::Element.

Definition at line 72 of file pyramid.hpp.

GetEdgeVertices()

const int * mfem::Pyramid::GetEdgeVertices ( int ei ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 58 of file pyramid.hpp.

GetFaceVertices()

const int * mfem::Pyramid::GetFaceVertices ( int fi ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 69 of file pyramid.hpp.

GetNEdges()

int mfem::Pyramid::GetNEdges ( ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 56 of file pyramid.hpp.

GetNFaces() [1/2]

int mfem::Pyramid::GetNFaces ( void ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 64 of file pyramid.hpp.

GetNFaces() [2/2]

int mfem::Pyramid::GetNFaces ( int & nFaceVertices ) const

overridevirtual

Deprecated

Use GetNFaces(void) and GetNFaceVertices(int) instead.

Implements mfem::Element.

Definition at line 60 of file pyramid.cpp.

GetNFaceVertices()

int mfem::Pyramid::GetNFaceVertices ( int fi ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 66 of file pyramid.hpp.

GetNVertices()

int mfem::Pyramid::GetNVertices ( ) const

inlineoverridevirtual

Implements mfem::Element.

Definition at line 54 of file pyramid.hpp.

GetType()

Type mfem::Pyramid::GetType ( ) const

inlineoverridevirtual

Return element's type.

Implements mfem::Element.

Definition at line 40 of file pyramid.hpp.

GetVertices() [1/2]

int * mfem::Pyramid::GetVertices ( )

inlineoverridevirtual

Note

The returned array should NOT be deleted by the caller.

Implements mfem::Element.

Definition at line 49 of file pyramid.hpp.

GetVertices() [2/2]

void mfem::Pyramid::GetVertices ( Array< int > & v ) const

overridevirtual

Get the indices defining the vertices.

Implements mfem::Element.

Definition at line 48 of file pyramid.cpp.

SetVertices() [1/2]

void mfem::Pyramid::SetVertices ( const Array< int > & v )

overridevirtual

Set the indices defining the vertices.

Implements mfem::Element.

Definition at line 54 of file pyramid.cpp.

SetVertices() [2/2]

void mfem::Pyramid::SetVertices ( const int * ind )

overridevirtual

Set the indices defining the vertices.

Implements mfem::Element.

Definition at line 40 of file pyramid.cpp.

Member Data Documentation

indices

int mfem::Pyramid::indices[5]

protected

Definition at line 25 of file pyramid.hpp.

---

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

• mesh/pyramid.hpp
• mesh/pyramid.cpp