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

A structure used to identify an element within a mesh. More...

#include <MeshID.h>

Public Member Functions

constexpr ElementID ()
 
constexpr ElementID (bool isLocal, GeomType type_id, uint32_t local_ID, uint32_t owner_rank_id)
 
constexpr ElementID (uint64_t id)
 
constexpr uint64_t getData () const
 
constexpr bool is_local () const
 
constexpr bool isNull () const
 
constexpr unsigned int local_id () const
 
constexpr bool operator!= (const ElementID &rhs) const
 
constexpr bool operator< (const ElementID &rhs) const
 
constexpr bool operator<= (const ElementID &rhs) const
 
constexpr bool operator== (const ElementID &rhs) const
 
constexpr bool operator> (const ElementID &rhs) const
 
constexpr bool operator>= (const ElementID &rhs) const
 
constexpr unsigned int owner_rank () const
 
constexpr void set_is_local (bool isLocal)
 
constexpr GeomType type () const
 

Private Attributes

uint64_t data
 

Detailed Description

A structure used to identify an element within a mesh.

This structure provides a unique id that can be used to identify a mesh element within a single unique mesh. To identify a global unique element MeshElementID should be used.

Definition at line 78 of file MeshID.h.

Constructor & Destructor Documentation

◆ ElementID() [1/3]

constexpr AMP::Mesh::ElementID::ElementID ( )
inlineconstexpr

Definition at line 82 of file MeshID.h.

◆ ElementID() [2/3]

constexpr AMP::Mesh::ElementID::ElementID ( bool  isLocal,
GeomType  type_id,
uint32_t  local_ID,
uint32_t  owner_rank_id 
)
inlineexplicitconstexpr

Definition at line 83 of file MeshID.h.

References data.

◆ ElementID() [3/3]

constexpr AMP::Mesh::ElementID::ElementID ( uint64_t  id)
inlineexplicitconstexpr

Definition at line 100 of file MeshID.h.

Member Function Documentation

◆ getData()

constexpr uint64_t AMP::Mesh::ElementID::getData ( ) const
inlineconstexpr

Definition at line 127 of file MeshID.h.

References data.

◆ is_local()

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

Definition at line 128 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::is_local().

◆ isNull()

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

Definition at line 132 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::isNull().

◆ local_id()

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

Definition at line 130 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::local_id().

◆ operator!=()

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

Definition at line 106 of file MeshID.h.

References data.

◆ operator<()

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

Definition at line 122 of file MeshID.h.

References data.

◆ operator<=()

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

Definition at line 114 of file MeshID.h.

References data.

◆ operator==()

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

Definition at line 102 of file MeshID.h.

References data.

◆ operator>()

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

Definition at line 118 of file MeshID.h.

References data.

◆ operator>=()

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

Definition at line 110 of file MeshID.h.

References data.

◆ owner_rank()

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

Definition at line 131 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::owner_rank().

◆ set_is_local()

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

Definition at line 133 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::set_is_local().

◆ type()

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

Definition at line 129 of file MeshID.h.

References data.

Referenced by AMP::Mesh::MeshElementID::type().

Member Data Documentation

◆ data

uint64_t AMP::Mesh::ElementID::data
private

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