OGS
MeshLib::TetRule Class Reference

Detailed Description

Definition at line 20 of file TetRule.h.

#include <TetRule.h>

Inheritance diagram for MeshLib::TetRule:
[legend]
Collaboration diagram for MeshLib::TetRule:
[legend]

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)
 Calculates the volume of a tetrahedron.
 
- Static Public Member Functions inherited from MeshLib::CellRule
static bool testElementNodeOrder (Element const &e)
 

Static Public Attributes

static const unsigned n_base_nodes = 4u
 Constant: The number of base nodes for this element.
 
static const MeshElemType mesh_elem_type = MeshElemType::TETRAHEDRON
 Constant: The geometric type of the element.
 
static const unsigned n_faces = 4
 Constant: The number of faces.
 
static const unsigned n_edges = 6
 Constant: The number of edges.
 
static const unsigned n_neighbors = 4
 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::TetRule::computeVolume ( Node const *const * element_nodes)
static

Calculates the volume of a tetrahedron.

Definition at line 17 of file TetRule.cpp.

18{
19 return MathLib::calcTetrahedronVolume(*element_nodes[0], *element_nodes[1],
20 *element_nodes[2], *element_nodes[3]);
21}
double calcTetrahedronVolume(MathLib::Point3d const &a, MathLib::Point3d const &b, MathLib::Point3d const &c, MathLib::Point3d const &d)

References MathLib::calcTetrahedronVolume().

◆ isPntInElement()

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

Checks if a point is inside the element.

Parameters
pnta 3D MathLib::Point3d object
epstolerance for numerical algorithm used or computing the property
Returns
true if the point is not outside the element, false otherwise
Parameters
nodesthe nodes of the element.

Definition at line 23 of file TetRule.cpp.

25{
26 return MathLib::isPointInTetrahedron(pnt, *nodes[0], *nodes[1], *nodes[2],
27 *nodes[3], eps);
28}
bool isPointInTetrahedron(MathLib::Point3d const &p, MathLib::Point3d const &a, MathLib::Point3d const &b, MathLib::Point3d const &c, MathLib::Point3d const &d, double eps)

References MathLib::isPointInTetrahedron().

◆ validate()

ElementErrorCode MeshLib::TetRule::validate ( const Element * e)
static

Tests if the element is geometrically valid.

Definition at line 30 of file TetRule.cpp.

31{
32 ElementErrorCode error_code;
34 error_code[ElementErrorFlag::NodeOrder] = !e->testElementNodeOrder();
35 return error_code;
36}
Collects error flags for mesh elements.
bool hasZeroVolume(MeshLib::Element const &element)
Returns true if the element has zero length/area/volume.
Definition Element.cpp:119

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

Member Data Documentation

◆ mesh_elem_type

const MeshElemType MeshLib::TetRule::mesh_elem_type = MeshElemType::TETRAHEDRON
static

Constant: The geometric type of the element.

Definition at line 27 of file TetRule.h.

◆ n_base_nodes

const unsigned MeshLib::TetRule::n_base_nodes = 4u
static

Constant: The number of base nodes for this element.

Definition at line 24 of file TetRule.h.

◆ n_edges

const unsigned MeshLib::TetRule::n_edges = 6
static

Constant: The number of edges.

Definition at line 33 of file TetRule.h.

◆ n_faces

const unsigned MeshLib::TetRule::n_faces = 4
static

Constant: The number of faces.

Definition at line 30 of file TetRule.h.

Referenced by MeshLib::TetRule10::getFace(), and MeshLib::TetRule4::getFace().

◆ n_neighbors

const unsigned MeshLib::TetRule::n_neighbors = 4
static

Constant: The number of neighbors.

Definition at line 36 of file TetRule.h.


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