MeshLib::LineRule Class Reference

Detailed Description

A 1d Edge or Line Element.

Definition at line 22 of file LineRule.h.

#include <LineRule.h>

Inheritance diagram for MeshLib::LineRule:

Collaboration diagram for MeshLib::LineRule:

Static Public Member Functions
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[1])
	Returns the ID of a face given an array of nodes.
static double	computeVolume (Node const *const *element_nodes)
	Calculates the length of a line.
Static Public Member Functions inherited from MeshLib::EdgeRule
static const Element *	getFace (const Element *, unsigned)
	Returns the i-th face of the element.
static bool	testElementNodeOrder (Element const &)

Static Public Attributes
static const unsigned	n_base_nodes = 2u
	Constant: The number of base nodes for this element.
static const MeshElemType	mesh_elem_type = MeshElemType::LINE
	Constant: The geometric type of the element.
static const unsigned	n_neighbors = 2
	Constant: The number of neighbors.
Static Public Attributes inherited from MeshLib::EdgeRule
static const unsigned	dimension = 1u
	Constant: Dimension of this mesh element.
static const unsigned	n_faces = 0
	Constant: The number of faces.
static const unsigned	n_edges = 1
	Constant: The number of edges.

Member Function Documentation

computeVolume()

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

static

Calculates the length of a line.

Definition at line 17 of file LineRule.cpp.

{
    return std::sqrt(MathLib::sqrDist(*element_nodes[0], *element_nodes[1]));
}

References MathLib::sqrDist().

identifyFace()

unsigned MeshLib::LineRule::identifyFace ( Node const *const * element_nodes, Node const * nodes[1] )

static

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

Definition at line 55 of file LineRule.cpp.

{
    if (nodes[0] == element_nodes[0])
    {
        return 0;
    }
    if (nodes[0] == element_nodes[1])
    {
        return 1;
    }
    return std::numeric_limits<unsigned>::max();
}

isPntInElement()

bool MeshLib::LineRule::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 22 of file LineRule.cpp.

{
    auto const& a = *nodes[0];
    auto const& b = *nodes[1];
 
    if (MathLib::sqrDist(a, pnt) < eps * eps)
    {
        return true;
    }
    if (MathLib::sqrDist(b, pnt) < eps * eps)
    {
        return true;
    }
 
    double lambda;
    double distance_of_proj_pnt_to_a;
    auto const distance_from_line = MathLib::calcProjPntToLineAndDists(
        pnt, a, b, lambda, distance_of_proj_pnt_to_a);
 
    if (lambda >= 0 && lambda <= 1)
    {
        // pnt has been projected to the interior of the line
        return distance_from_line < eps;
    }
    else
    {
        // pnt has been projected outside the line segment
        // corner cases have already been treated in the beginning
        return false;
    }
}

References MathLib::calcProjPntToLineAndDists(), and MathLib::sqrDist().

validate()

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

static

Tests if the element is geometrically valid.

Definition at line 69 of file LineRule.cpp.

{
    ElementErrorCode error_code;
    error_code[ElementErrorFlag::ZeroVolume] = hasZeroVolume(*e);
    return error_code;
}

References MeshLib::hasZeroVolume(), and ZeroVolume.

Member Data Documentation

mesh_elem_type

const MeshElemType MeshLib::LineRule::mesh_elem_type = MeshElemType::LINE

static

Constant: The geometric type of the element.

Definition at line 29 of file LineRule.h.

n_base_nodes

const unsigned MeshLib::LineRule::n_base_nodes = 2u

static

Constant: The number of base nodes for this element.

Definition at line 26 of file LineRule.h.

n_neighbors

const unsigned MeshLib::LineRule::n_neighbors = 2

static

Constant: The number of neighbors.

Definition at line 32 of file LineRule.h.

---

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

• MeshLib/Elements/LineRule.h
• MeshLib/Elements/LineRule.cpp