Detailed Description

This class represents a 3d pyramid element. The following sketch shows the node and edge numbering.

             4
           //|\
          // | \
        7//  |  \6
        //   |5  \
       //    |    \
      3/.... |.....2
     ./      |  2 /
    ./4      |   /
  3./        |  /1
  ./         | /
 ./          |/
0------------1
      0

Definition at line 43 of file PyramidRule5.h.

#include <PyramidRule5.h>

Inheritance diagram for MeshLib::PyramidRule5:

[legend]

Collaboration diagram for MeshLib::PyramidRule5:

[legend]

Public Types
using	EdgeReturn = MeshLib::LinearEdgeReturn
	Returns the i-th edge of the element. More...

Static Public Member Functions
static const Element *	getFace (const Element *e, unsigned i)
	Returns the i-th face of the element. More...

static bool	isPntInElement (Node const const nodes, MathLib::Point3d const &pnt, double eps)

static ElementErrorCode	validate (const Element *e)

static unsigned	identifyFace (Node const const , Node const *nodes[3])
	Returns the ID of a face given an array of nodes. More...

static double	computeVolume (Node const const _nodes)
	Calculates the volume of a convex hexahedron by partitioning it into six tetrahedra. More...

Static Public Member Functions inherited from MeshLib::CellRule
static bool	testElementNodeOrder (Element const &e)

Static Public Attributes
static const unsigned	n_base_nodes = 5u
	Constant: The number of base nodes for this element. More...

static const unsigned	n_all_nodes = 5u
	Constant: The number of all nodes for this element. More...

static const MeshElemType	mesh_elem_type = MeshElemType::PYRAMID
	Constant: The geometric type of the element. More...

static const CellType	cell_type = CellType::PYRAMID5
	Constant: The FEM type of the element. More...

static const unsigned	n_faces = 5
	Constant: The number of faces. More...

static const unsigned	n_edges = 8
	Constant: The number of edges. More...

static const unsigned	n_neighbors = 5
	Constant: The number of neighbors. More...

static const unsigned	face_nodes [5][4]
	Constant: Local node index table for faces. More...

static const unsigned	edge_nodes [8][2]
	Constant: Local node index table for edge. More...

static const unsigned	n_face_nodes [5] = {3, 3, 3, 3, 4}
	Constant: Table for the number of nodes for each face. More...

Static Public Attributes inherited from MeshLib::CellRule
static const unsigned	dimension = 3u
	Constant: Dimension of this mesh element. More...

Member Typedef Documentation

◆ EdgeReturn

using MeshLib::PyramidRule5::EdgeReturn = MeshLib::LinearEdgeReturn

Returns the i-th edge of the element.

Definition at line 77 of file PyramidRule5.h.

Member Function Documentation

◆ computeVolume()

double MeshLib::PyramidRule5::computeVolume ( Node const *const * _nodes )

static

Calculates the volume of a convex hexahedron by partitioning it into six tetrahedra.

Definition at line 64 of file PyramidRule5.cpp.

 {
     return MathLib::calcTetrahedronVolume(
                *_nodes[0], *_nodes[1], *_nodes[2], *_nodes[4]) +
            MathLib::calcTetrahedronVolume(
                *_nodes[2], *_nodes[3], *_nodes[0], *_nodes[4]);
 }

References MathLib::calcTetrahedronVolume().

◆ getFace()

const Element * MeshLib::PyramidRule5::getFace	(	const Element *	e,
		unsigned	i
	)

static

Returns the i-th face of the element.

Definition at line 42 of file PyramidRule5.cpp.

 {
     if (i < e->getNumberOfFaces())
     {
         unsigned nFaceNodes(PyramidRule5::n_face_nodes[i]);
         auto** nodes = new Node*[nFaceNodes];
         for (unsigned j = 0; j < nFaceNodes; j++)
         {
             nodes[j] = const_cast<Node*>(e->getNode(face_nodes[i][j]));
         }
  
         if (i < 4)
         {
             return new Tri(nodes, e->getID());
         }
  
         return new Quad(nodes, e->getID());
     }
     ERR("Error in MeshLib::Element::getFace() - Index {:d} does not exist.", i);
     return nullptr;
 }

References ERR(), face_nodes, MeshLib::Element::getID(), MeshLib::Element::getNode(), and n_face_nodes.

◆ identifyFace()

unsigned MeshLib::PyramidRule5::identifyFace	(	Node const const	_nodes,
		Node const *	nodes[3]
	)

static

Returns the ID of a face given an array of nodes.

Definition at line 82 of file PyramidRule5.cpp.

 {
     for (unsigned i = 0; i < 5; i++)
     {
         unsigned flag(0);
         for (unsigned j = 0; j < 4; j++)
         {
             for (unsigned k = 0; k < 3; k++)
             {
                 if (face_nodes[i][j] != 99 &&
                     _nodes[face_nodes[i][j]] == nodes[k])
                 {
                     flag++;
                 }
             }
         }
         if (flag == 3)
         {
             return i;
         }
     }
     return std::numeric_limits<unsigned>::max();
 }

References face_nodes.

◆ isPntInElement()

bool MeshLib::PyramidRule5::isPntInElement	(	Node const const	nodes,
		MathLib::Point3d const &	pnt,
		double	eps
	)

static

Checks if a point is inside the element.

Parameters

pnt	a 3D MathLib::Point3d object
eps	tolerance for numerical algorithm used or computing the property

Returns: true if the point is not outside the element, false otherwise

Parameters

nodes the nodes of the element.

Definition at line 72 of file PyramidRule5.cpp.

 {
     return (MathLib::isPointInTetrahedron(
                 pnt, *nodes[0], *nodes[1], *nodes[2], *nodes[4], eps) ||
             MathLib::isPointInTetrahedron(
                 pnt, *nodes[0], *nodes[2], *nodes[3], *nodes[4], eps));
 }

References MathLib::isPointInTetrahedron().

◆ validate()

ElementErrorCode MeshLib::PyramidRule5::validate ( const Element * e )

static

Tests if the element is geometrically valid.

Definition at line 107 of file PyramidRule5.cpp.

 {
     ElementErrorCode error_code;
     error_code[ElementErrorFlag::ZeroVolume] = hasZeroVolume(*e);
  
     std::unique_ptr<MeshLib::Quad const> const base{
         dynamic_cast<MeshLib::Quad const*>(e->getFace(4))};
     if (base)
     {
         error_code |= base->validate();
         error_code[ElementErrorFlag::NodeOrder] = !e->testElementNodeOrder();
     }
     else
     {
         error_code.set(ElementErrorFlag::NodeOrder);
     }
  
     return error_code;
 }

References MeshLib::Element::getFace(), MeshLib::hasZeroVolume(), NodeOrder, ElementErrorCode::set(), MeshLib::Element::testElementNodeOrder(), and ZeroVolume.

Member Data Documentation

◆ cell_type

const CellType MeshLib::PyramidRule5::cell_type = CellType::PYRAMID5

static

Constant: The FEM type of the element.

Definition at line 56 of file PyramidRule5.h.

◆ edge_nodes

const unsigned MeshLib::PyramidRule5::edge_nodes

static

Initial value:

= {
    {0, 1},  
    {1, 2},  
    {2, 3},  
    {0, 3},  
    {0, 4},  
    {1, 4},  
    {2, 4},  
    {3, 4}   
}

Constant: Local node index table for edge.

Definition at line 71 of file PyramidRule5.h.

◆ face_nodes

const unsigned MeshLib::PyramidRule5::face_nodes

static

Initial value:

= {
    {0, 1, 4, 99},  
    {1, 2, 4, 99},  
    {2, 3, 4, 99},  
    {3, 0, 4, 99},  
    {0, 3, 2, 1}    
}

Constant: Local node index table for faces.

Definition at line 68 of file PyramidRule5.h.

Referenced by getFace(), and identifyFace().

◆ mesh_elem_type

const MeshElemType MeshLib::PyramidRule5::mesh_elem_type = MeshElemType::PYRAMID

static

Constant: The geometric type of the element.

Definition at line 53 of file PyramidRule5.h.

◆ n_all_nodes

const unsigned MeshLib::PyramidRule5::n_all_nodes = 5u

static

Constant: The number of all nodes for this element.

Definition at line 50 of file PyramidRule5.h.

◆ n_base_nodes

const unsigned MeshLib::PyramidRule5::n_base_nodes = 5u

static

Constant: The number of base nodes for this element.

Definition at line 47 of file PyramidRule5.h.

◆ n_edges

const unsigned MeshLib::PyramidRule5::n_edges = 8

static

Constant: The number of edges.

Definition at line 62 of file PyramidRule5.h.

◆ n_face_nodes

const unsigned MeshLib::PyramidRule5::n_face_nodes = {3, 3, 3, 3, 4}

static

Constant: Table for the number of nodes for each face.

Definition at line 74 of file PyramidRule5.h.

Referenced by getFace().

◆ n_faces

const unsigned MeshLib::PyramidRule5::n_faces = 5

static

Constant: The number of faces.

Definition at line 59 of file PyramidRule5.h.

◆ n_neighbors

const unsigned MeshLib::PyramidRule5::n_neighbors = 5

static

Constant: The number of neighbors.

Definition at line 65 of file PyramidRule5.h.

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

MeshLib/Elements/PyramidRule5.h
MeshLib/Elements/PyramidRule5.cpp

Detailed Description

Public Types

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ EdgeReturn

Member Function Documentation

◆ computeVolume()

◆ getFace()

◆ identifyFace()

◆ isPntInElement()

◆ validate()

Member Data Documentation

◆ cell_type

◆ edge_nodes

◆ face_nodes

◆ mesh_elem_type

◆ n_all_nodes

◆ n_base_nodes

◆ n_edges

◆ n_face_nodes

◆ n_faces

◆ n_neighbors