Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Private Attributes | List of all members
AMP::Mesh::MeshElementID Struct Reference

A structure used to identify the mesh element. More...

#include <MeshID.h>

Public Member Functions

constexpr ElementID elemID () const
 
constexpr bool is_local () const
 
constexpr bool isNull () const
 
constexpr unsigned int local_id () const
 
constexpr MeshElementID ()
 
constexpr MeshElementID (bool isLocal, GeomType type, unsigned int local_ID, unsigned int rank, MeshID mesh_ID)
 
constexpr MeshElementID (MeshID mesh_ID, ElementID elem_id)
 
constexpr MeshID meshID () const
 
constexpr bool operator!= (const MeshElementID &rhs) const
 
constexpr bool operator< (const MeshElementID &rhs) const
 
constexpr bool operator<= (const MeshElementID &rhs) const
 
constexpr bool operator== (const MeshElementID &rhs) const
 
constexpr bool operator> (const MeshElementID &rhs) const
 
constexpr bool operator>= (const MeshElementID &rhs) const
 
constexpr unsigned int owner_rank () const
 
constexpr void resetElemID (ElementID elem_id)
 
constexpr void set_is_local (bool isLocal)
 
constexpr GeomType type () const
 

Private Attributes

ElementID elemId
 
MeshID meshId
 

Detailed Description

A structure used to identify the mesh element.

This structure provides a unique id that can be used to identify a mesh element.

Definition at line 156 of file MeshID.h.

Constructor & Destructor Documentation

◆ MeshElementID() [1/3]

constexpr AMP::Mesh::MeshElementID::MeshElementID ( )
inlineconstexpr

Definition at line 160 of file MeshID.h.

◆ MeshElementID() [2/3]

constexpr AMP::Mesh::MeshElementID::MeshElementID ( bool  isLocal,
GeomType  type,
unsigned int  local_ID,
unsigned int  rank,
MeshID  mesh_ID 
)
inlineexplicitconstexpr

Definition at line 161 of file MeshID.h.

◆ MeshElementID() [3/3]

constexpr AMP::Mesh::MeshElementID::MeshElementID ( MeshID  mesh_ID,
ElementID  elem_id 
)
inlineexplicitconstexpr

Definition at line 166 of file MeshID.h.

Member Function Documentation

◆ elemID()

constexpr ElementID AMP::Mesh::MeshElementID::elemID ( ) const
inlineconstexpr

Definition at line 210 of file MeshID.h.

References elemId.

◆ is_local()

constexpr bool AMP::Mesh::MeshElementID::is_local ( ) const
inlineconstexpr

Definition at line 205 of file MeshID.h.

References elemId, and AMP::Mesh::ElementID::is_local().

◆ isNull()

constexpr bool AMP::Mesh::MeshElementID::isNull ( ) const
inlineconstexpr

◆ local_id()

constexpr unsigned int AMP::Mesh::MeshElementID::local_id ( ) const
inlineconstexpr

Definition at line 207 of file MeshID.h.

References elemId, and AMP::Mesh::ElementID::local_id().

◆ meshID()

constexpr MeshID AMP::Mesh::MeshElementID::meshID ( ) const
inlineconstexpr

Definition at line 209 of file MeshID.h.

References meshId.

◆ operator!=()

constexpr bool AMP::Mesh::MeshElementID::operator!= ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 176 of file MeshID.h.

References elemId, and meshId.

◆ operator<()

constexpr bool AMP::Mesh::MeshElementID::operator< ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 192 of file MeshID.h.

References elemId, and meshId.

◆ operator<=()

constexpr bool AMP::Mesh::MeshElementID::operator<= ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 198 of file MeshID.h.

References elemId, and meshId.

◆ operator==()

constexpr bool AMP::Mesh::MeshElementID::operator== ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 172 of file MeshID.h.

References elemId, and meshId.

◆ operator>()

constexpr bool AMP::Mesh::MeshElementID::operator> ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 186 of file MeshID.h.

References elemId, and meshId.

◆ operator>=()

constexpr bool AMP::Mesh::MeshElementID::operator>= ( const MeshElementID rhs) const
inlineconstexpr

Definition at line 180 of file MeshID.h.

References elemId, and meshId.

◆ owner_rank()

constexpr unsigned int AMP::Mesh::MeshElementID::owner_rank ( ) const
inlineconstexpr

Definition at line 208 of file MeshID.h.

References elemId, and AMP::Mesh::ElementID::owner_rank().

◆ resetElemID()

constexpr void AMP::Mesh::MeshElementID::resetElemID ( ElementID  elem_id)
inlineconstexpr

Definition at line 170 of file MeshID.h.

References elemId.

Referenced by AMP::Mesh::TriangleMeshElement< NG >::resetElemId().

◆ set_is_local()

constexpr void AMP::Mesh::MeshElementID::set_is_local ( bool  isLocal)
inlineconstexpr

Definition at line 211 of file MeshID.h.

References elemId, and AMP::Mesh::ElementID::set_is_local().

◆ type()

constexpr GeomType AMP::Mesh::MeshElementID::type ( ) const
inlineconstexpr

Definition at line 206 of file MeshID.h.

References elemId, and AMP::Mesh::ElementID::type().

Referenced by AMP::Mesh::MeshElement::elementType().

Member Data Documentation

◆ elemId

ElementID AMP::Mesh::MeshElementID::elemId
private

◆ meshId

MeshID AMP::Mesh::MeshElementID::meshId
private

Definition at line 215 of file MeshID.h.

Referenced by isNull(), meshID(), operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().


The documentation for this struct was generated from the following file:



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:43.
Comments on this page