MeshElement.h

Go to the documentation of this file.

#ifndef included_AMP_MeshElement
#define included_AMP_MeshElement
 
#include "AMP/mesh/MeshElementVector.h"
#include "AMP/mesh/MeshID.h"
#include "AMP/utils/MeshPoint.h"
#include "AMP/utils/typeid.h"
 
#include <memory>
#include <vector>
 
 
namespace AMP::Mesh {
 
 
class Mesh;
 
 
class MeshElement
{
public:
    using ElementListPtr = MeshElementVectorPtr;
 
public: // non-virtual functions
    MeshElement() = default;
 
    inline bool isNull() const { return globalID().isNull(); }
 
    inline GeomType elementType() const { return globalID().type(); }
 
    // Overload operators
    inline bool operator==( const MeshElement &rhs ) const { return globalID() == rhs.globalID(); }
    inline bool operator!=( const MeshElement &rhs ) const { return globalID() != rhs.globalID(); }
    inline bool operator<( const MeshElement &rhs ) const { return globalID() < rhs.globalID(); }
    inline bool operator>( const MeshElement &rhs ) const { return globalID() > rhs.globalID(); }
    inline bool operator<=( const MeshElement &rhs ) const { return globalID() <= rhs.globalID(); }
    inline bool operator>=( const MeshElement &rhs ) const { return globalID() >= rhs.globalID(); }
    inline bool operator==( const MeshElementID &rhs ) const { return globalID() == rhs; }
    inline bool operator!=( const MeshElementID &rhs ) const { return globalID() != rhs; }
    inline bool operator<( const MeshElementID &rhs ) const { return globalID() < rhs; }
    inline bool operator>( const MeshElementID &rhs ) const { return globalID() > rhs; }
    inline bool operator<=( const MeshElementID &rhs ) const { return globalID() <= rhs; }
    inline bool operator>=( const MeshElementID &rhs ) const { return globalID() >= rhs; }
 
    inline double coord( int i ) const { return coord()[i]; }
 
 
    bool containsPoint( const std::vector<double> &pos, double TOL = 1e-12 ) const;
 
 
    std::string print( uint8_t indent = 0 ) const;
 
 
public: // Virtual functions
    virtual const typeID &getTypeID() const;
 
    virtual MeshElementID globalID() const;
 
    unsigned int globalOwnerRank( const Mesh &mesh ) const;
 
    virtual std::string elementClass() const;
 
    virtual Point coord() const;
 
    virtual Point centroid() const;
 
    virtual double volume() const;
 
    virtual Point norm() const;
 
    virtual bool containsPoint( const Point &pos, double TOL = 1e-12 ) const;
 
    virtual Point nearest( const Point &pos ) const;
 
    virtual double distance( const Point &pos, const Point &dir ) const;
 
    virtual bool isOnSurface() const;
 
    virtual bool isOnBoundary( int id ) const;
 
    virtual bool isInBlock( int id ) const;
 
 
    virtual ElementListPtr getElements( const GeomType type ) const;
 
    virtual ElementListPtr getNeighbors() const;
 
 
public: // Advanced functions
    virtual int getElementsID( const GeomType type, MeshElementID *ID ) const;
 
    virtual void getVertices( std::vector<Point> &vertices ) const;
 
    virtual void getNeighborVertices( std::vector<Point> &vertices ) const;
 
    virtual std::unique_ptr<MeshElement> clone() const;
 
    virtual ~MeshElement() = default;
 
 
protected: // Constructors
    MeshElement( const MeshElement & ) = default;
    MeshElement( MeshElement && )      = default;
    MeshElement &operator=( const MeshElement & ) = default;
    MeshElement &operator=( MeshElement && ) = default;
};
 
 
} // namespace AMP::Mesh
 
 
#endif