MFEM  v4.5.2
Finite element discretization library
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
mfem::Tetrahedron Class Reference

Data type tetrahedron element. More...

#include <tetrahedron.hpp>

Inheritance diagram for mfem::Tetrahedron:
[legend]
Collaboration diagram for mfem::Tetrahedron:
[legend]

Public Types

enum  {
  TYPE_PU =0, TYPE_A =1, TYPE_PF =2, TYPE_O =3,
  TYPE_M =4
}
 Constants for different types of tetrahedrons. More...
 
typedef Geometry::Constants< Geometry::TETRAHEDRONgeom_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

 Tetrahedron ()
 
 Tetrahedron (const int *ind, int attr=1)
 Constructs tetrahedron by specifying the indices and the attribute. More...
 
 Tetrahedron (int ind1, int ind2, int ind3, int ind4, int attr=1)
 Constructs tetrahedron by specifying the indices and the attribute. More...
 
void Init (int ind1, int ind2, int ind3, int ind4, int attr=1, int ref_flag=0)
 Initialize the vertex indices and the attribute of a Tetrahedron. More...
 
virtual Type GetType () const
 Return element's type. More...
 
void ParseRefinementFlag (int refinement_edges[2], int &type, int &flag)
 
void CreateRefinementFlag (int refinement_edges[2], int type, int flag=0)
 
void GetMarkedFace (const int face, int *fv)
 
int GetRefinementFlag ()
 
void SetRefinementFlag (int rf)
 
virtual int NeedRefinement (HashTable< Hashed2 > &v_to_v) const
 Return 1 if the element needs refinement in order to get conforming mesh. More...
 
virtual void SetVertices (const int *ind)
 Set the vertices according to the given input. More...
 
virtual void MarkEdge (const DSTable &v_to_v, const int *length)
 
virtual void ResetTransform (int tr)
 Set current coarse-fine transformation number. More...
 
virtual unsigned GetTransform () const
 Return current coarse-fine transformation. More...
 
virtual void PushTransform (int tr)
 Add 'tr' to the current chain of coarse-fine transformations. More...
 
virtual void GetVertices (Array< int > &v) const
 Returns the indices of the element's vertices. More...
 
virtual int * GetVertices ()
 
virtual int GetNVertices () const
 
virtual int GetNEdges () const
 
virtual const int * GetEdgeVertices (int ei) const
 
virtual MFEM_DEPRECATED int GetNFaces (int &nFaceVertices) const
 
virtual int GetNFaces () const
 
virtual int GetNFaceVertices (int) const
 
virtual const int * GetFaceVertices (int fi) const
 
virtual ElementDuplicate (Mesh *m) const
 
virtual ~Tetrahedron ()
 
- Public Member Functions inherited from mfem::Element
 Element (Geometry::Type bg=Geometry::POINT)
 Default element constructor. More...
 
Geometry::Type GetGeometryType () const
 
int GetAttribute () const
 Return element's attribute. More...
 
void SetAttribute (const int attr)
 Set element's attribute. More...
 
const int * GetVertices () const
 
virtual ~Element ()
 Destroys element. More...
 

Static Public Member Functions

static void GetPointMatrix (unsigned transform, DenseMatrix &pm)
 Calculate point matrix corresponding to a chain of transformations. More...
 

Protected Attributes

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

Detailed Description

Data type tetrahedron element.

Definition at line 22 of file tetrahedron.hpp.

Member Typedef Documentation

◆ geom_t

Definition at line 40 of file tetrahedron.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Constants for different types of tetrahedrons.

Enumerator
TYPE_PU 
TYPE_A 
TYPE_PF 
TYPE_O 
TYPE_M 

Definition at line 43 of file tetrahedron.hpp.

Constructor & Destructor Documentation

◆ Tetrahedron() [1/3]

mfem::Tetrahedron::Tetrahedron ( )
inline

Definition at line 45 of file tetrahedron.hpp.

◆ Tetrahedron() [2/3]

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

Constructs tetrahedron by specifying the indices and the attribute.

Definition at line 19 of file tetrahedron.cpp.

◆ Tetrahedron() [3/3]

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

Constructs tetrahedron by specifying the indices and the attribute.

Definition at line 31 of file tetrahedron.cpp.

◆ ~Tetrahedron()

virtual mfem::Tetrahedron::~Tetrahedron ( )
inlinevirtual

Definition at line 116 of file tetrahedron.hpp.

Member Function Documentation

◆ CreateRefinementFlag()

void mfem::Tetrahedron::CreateRefinementFlag ( int  refinement_edges[2],
int  type,
int  flag = 0 
)

Definition at line 71 of file tetrahedron.cpp.

◆ Duplicate()

Element * mfem::Tetrahedron::Duplicate ( Mesh m) const
virtual

Implements mfem::Element.

Definition at line 335 of file tetrahedron.cpp.

◆ GetEdgeVertices()

virtual const int* mfem::Tetrahedron::GetEdgeVertices ( int  ei) const
inlinevirtual

Implements mfem::Element.

Definition at line 100 of file tetrahedron.hpp.

◆ GetFaceVertices()

virtual const int* mfem::Tetrahedron::GetFaceVertices ( int  fi) const
inlinevirtual

Implements mfem::Element.

Definition at line 111 of file tetrahedron.hpp.

◆ GetMarkedFace()

void mfem::Tetrahedron::GetMarkedFace ( const int  face,
int *  fv 
)

Definition at line 137 of file tetrahedron.cpp.

◆ GetNEdges()

virtual int mfem::Tetrahedron::GetNEdges ( ) const
inlinevirtual

Implements mfem::Element.

Definition at line 98 of file tetrahedron.hpp.

◆ GetNFaces() [1/2]

virtual MFEM_DEPRECATED int mfem::Tetrahedron::GetNFaces ( int &  nFaceVertices) const
inlinevirtual
Deprecated:
Use GetNFaces(void) and GetNFaceVertices(int) instead.

Implements mfem::Element.

Definition at line 104 of file tetrahedron.hpp.

◆ GetNFaces() [2/2]

virtual int mfem::Tetrahedron::GetNFaces ( void  ) const
inlinevirtual

Implements mfem::Element.

Definition at line 107 of file tetrahedron.hpp.

◆ GetNFaceVertices()

virtual int mfem::Tetrahedron::GetNFaceVertices ( int  ) const
inlinevirtual

Implements mfem::Element.

Definition at line 109 of file tetrahedron.hpp.

◆ GetNVertices()

virtual int mfem::Tetrahedron::GetNVertices ( ) const
inlinevirtual

Implements mfem::Element.

Definition at line 96 of file tetrahedron.hpp.

◆ GetPointMatrix()

void mfem::Tetrahedron::GetPointMatrix ( unsigned  transform,
DenseMatrix pm 
)
static

Calculate point matrix corresponding to a chain of transformations.

Definition at line 284 of file tetrahedron.cpp.

◆ GetRefinementFlag()

int mfem::Tetrahedron::GetRefinementFlag ( )
inline

Definition at line 66 of file tetrahedron.hpp.

◆ GetTransform()

virtual unsigned mfem::Tetrahedron::GetTransform ( ) const
inlinevirtual

Return current coarse-fine transformation.

Reimplemented from mfem::Element.

Definition at line 82 of file tetrahedron.hpp.

◆ GetType()

virtual Type mfem::Tetrahedron::GetType ( ) const
inlinevirtual

Return element's type.

Implements mfem::Element.

Definition at line 59 of file tetrahedron.hpp.

◆ GetVertices() [1/2]

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

Returns the indices of the element's vertices.

Implements mfem::Element.

Definition at line 326 of file tetrahedron.cpp.

◆ GetVertices() [2/2]

virtual int* mfem::Tetrahedron::GetVertices ( )
inlinevirtual

Implements mfem::Element.

Definition at line 94 of file tetrahedron.hpp.

◆ Init()

void mfem::Tetrahedron::Init ( int  ind1,
int  ind2,
int  ind3,
int  ind4,
int  attr = 1,
int  ref_flag = 0 
)

Initialize the vertex indices and the attribute of a Tetrahedron.

Definition at line 43 of file tetrahedron.cpp.

◆ MarkEdge()

void mfem::Tetrahedron::MarkEdge ( const DSTable v_to_v,
const int *  length 
)
virtual

Reorder the vertices so that the longest edge is from vertex 0 to vertex 1. If called it should be once from the mesh constructor, because the order may be used later for setting the edges.

Reimplemented from mfem::Element.

Definition at line 187 of file tetrahedron.cpp.

◆ NeedRefinement()

int mfem::Tetrahedron::NeedRefinement ( HashTable< Hashed2 > &  v_to_v) const
virtual

Return 1 if the element needs refinement in order to get conforming mesh.

Reimplemented from mfem::Element.

Definition at line 168 of file tetrahedron.cpp.

◆ ParseRefinementFlag()

void mfem::Tetrahedron::ParseRefinementFlag ( int  refinement_edges[2],
int &  type,
int &  flag 
)

Definition at line 55 of file tetrahedron.cpp.

◆ PushTransform()

virtual void mfem::Tetrahedron::PushTransform ( int  tr)
inlinevirtual

Add 'tr' to the current chain of coarse-fine transformations.

Reimplemented from mfem::Element.

Definition at line 85 of file tetrahedron.hpp.

◆ ResetTransform()

virtual void mfem::Tetrahedron::ResetTransform ( int  tr)
inlinevirtual

Set current coarse-fine transformation number.

Reimplemented from mfem::Element.

Definition at line 81 of file tetrahedron.hpp.

◆ SetRefinementFlag()

void mfem::Tetrahedron::SetRefinementFlag ( int  rf)
inline

Definition at line 68 of file tetrahedron.hpp.

◆ SetVertices()

void mfem::Tetrahedron::SetVertices ( const int *  ind)
virtual

Set the vertices according to the given input.

Reimplemented from mfem::Element.

Definition at line 179 of file tetrahedron.cpp.

Member Data Documentation

◆ indices

int mfem::Tetrahedron::indices[4]
protected

Definition at line 25 of file tetrahedron.hpp.

◆ refinement_flag

int mfem::Tetrahedron::refinement_flag
protected

The refinement flag keeps (in order) :

  1. Two marked edges given with local index (0..5) for the two faces that don't have the refinement edge as edge. The refinement edge is determined by the first two nodes of the tetrahedron. Each marked edge is stored in 3 bits (or as implemented in the functions CreateRefinementFlag and ParseRefinementFlag.
  2. Type of the element, stored in the next 3 bits.
  3. The rest is free for now.

Definition at line 35 of file tetrahedron.hpp.

◆ transform

unsigned mfem::Tetrahedron::transform
protected

Definition at line 37 of file tetrahedron.hpp.


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