Element.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <spdlog/fmt/ostr.h>
 
#include <limits>
#include <optional>
#include <span>
 
#include "MathLib/Point3d.h"
#include "MeshLib/Elements/ElementErrorCode.h"
#include "MeshLib/Mesh.h"
#include "MeshLib/MeshEnums.h"
 
namespace MeshLib
{
class Node;

class Element
{
    friend class Mesh;
 
public:
    std::optional<unsigned> addNeighbor(Element* e);

    virtual double getContent() const = 0;

    virtual const Node* getNode(unsigned idx) const = 0;
    virtual Node* getNode(unsigned idx) = 0;

    virtual void setNode(unsigned idx, Node* node) = 0;

    virtual Node* const* getNodes() const = 0;

    constexpr std::span<Node* const> nodes() const
    {
        return {getNodes(), getNumberOfNodes()};
    }

    virtual constexpr unsigned getDimension() const = 0;

    virtual const Element* getEdge(unsigned i) const = 0;

    virtual const Element* getFace(unsigned i) const = 0;
 
    virtual const Element* getBoundary(unsigned i) const = 0;

    std::size_t getID() const { return _id; }
 
    virtual unsigned getNumberOfBoundaries() const = 0;

    virtual unsigned getNumberOfEdges() const = 0;

    virtual unsigned getNumberOfFaces() const = 0;

    virtual const Element* getNeighbor(unsigned i) const = 0;

    virtual unsigned getNumberOfNeighbors() const = 0;

    virtual unsigned getNumberOfBaseNodes() const = 0;

    virtual unsigned getNumberOfNodes() const = 0;

    virtual MeshElemType getGeomType() const = 0;

    virtual CellType getCellType() const = 0;

    virtual bool isBoundaryElement() const;

    virtual bool isEdge(unsigned i, unsigned j) const = 0;

    virtual bool isPntInElement(
        MathLib::Point3d const& pnt,
        double eps = std::numeric_limits<double>::epsilon()) const = 0;

    virtual ElementErrorCode validate() const = 0;

    virtual ~Element();

    virtual Element* clone() const = 0;

    virtual Element* clone(Node** nodes, std::size_t id) const = 0;

    virtual double computeVolume() = 0;

    virtual unsigned identifyFace(Node const* nodes[3]) const = 0;

    virtual bool testElementNodeOrder() const = 0;

    virtual Node* getEdgeNode(unsigned edge_id, unsigned node_id) const = 0;
 
    friend std::ostream& operator<<(std::ostream& os, Element const& e);

    unsigned space_dimension_ = 3u;
 
protected:
    explicit Element(std::size_t id);

    void setID(std::size_t id) { _id = id; }
 
    std::size_t _id;
 
    Element** _neighbors;
    void setNeighbor(Element* neighbor, unsigned const face_id);
}; /* class */

bool areNeighbors(Element const* const element, Element const* const other);

bool hasZeroVolume(MeshLib::Element const& element);

MathLib::Point3d getCenterOfGravity(MeshLib::Element const& element);

std::pair<double, double> computeSqrNodeDistanceRange(
    MeshLib::Element const& element, bool const check_allnodes = true);

std::pair<double, double> computeSqrEdgeLengthRange(Element const& element);

bool isPointInElementXY(MathLib::Point3d const& p, Element const& e);

unsigned getNodeIDinElement(Element const& element, const Node* node);

std::size_t getNodeIndex(Element const& element, unsigned idx);
 
}  // namespace MeshLib
 
namespace fmt
{
template <>
struct formatter<::MeshLib::Element> : ostream_formatter
{
};
}  // namespace fmt