MeshLib::PyramidRule Class Reference

Detailed Description

Definition at line 20 of file PyramidRule.h.

#include <PyramidRule.h>

Inheritance diagram for MeshLib::PyramidRule:

Collaboration diagram for MeshLib::PyramidRule:

Static Public Member Functions
static bool	isPntInElement (Node const *const *nodes, MathLib::Point3d const &pnt, double eps)
static ElementErrorCode	validate (const Element *e)
static double	computeVolume (Node const *const *element_nodes)
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.
static const MeshElemType	mesh_elem_type = MeshElemType::PYRAMID
	Constant: The geometric type of the element.
static const unsigned	n_faces = 5
	Constant: The number of faces.
static const unsigned	n_edges = 8
	Constant: The number of edges.
static const unsigned	n_neighbors = 5
	Constant: The number of neighbors.
Static Public Attributes inherited from MeshLib::CellRule
static const unsigned	dimension = 3u
	Constant: Dimension of this mesh element.

Additional Inherited Members
Static Protected Member Functions inherited from MeshLib::CellRule
template<typename ElementRule >
static unsigned	identifyFace (Node const *const *element_nodes, Node const *nodes[ElementRule::dimension])
	Returns the ID of a face given an array of nodes.

Member Function Documentation

computeVolume()

double MeshLib::PyramidRule::computeVolume ( Node const *const * element_nodes )

static

Calculates the volume of a flat-sided pyramid by partitioning it into two tetrahedra.

Definition at line 18 of file PyramidRule.cpp.

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

References MathLib::calcTetrahedronVolume().

isPntInElement()

bool MeshLib::PyramidRule::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 30 of file PyramidRule.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::PyramidRule::validate ( const Element * e )

static

Tests if the element is geometrically valid.

Definition at line 40 of file PyramidRule.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

mesh_elem_type

const MeshElemType MeshLib::PyramidRule::mesh_elem_type = MeshElemType::PYRAMID

static

Constant: The geometric type of the element.

Definition at line 27 of file PyramidRule.h.

n_base_nodes

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

static

Constant: The number of base nodes for this element.

Definition at line 24 of file PyramidRule.h.

n_edges

const unsigned MeshLib::PyramidRule::n_edges = 8

static

Constant: The number of edges.

Definition at line 33 of file PyramidRule.h.

n_faces

const unsigned MeshLib::PyramidRule::n_faces = 5

static

Constant: The number of faces.

Definition at line 30 of file PyramidRule.h.

Referenced by MeshLib::PyramidRule13::getFace(), and MeshLib::PyramidRule5::getFace().

n_neighbors

const unsigned MeshLib::PyramidRule::n_neighbors = 5

static

Constant: The number of neighbors.

Definition at line 36 of file PyramidRule.h.

---

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

• MeshLib/Elements/PyramidRule.h
• MeshLib/Elements/PyramidRule.cpp