Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Private Attributes | List of all members
AMP::Mesh::MeshPoint< TYPE > Class Template Reference

#include <MeshPoint.h>

Inheritance diagram for AMP::Mesh::MeshPoint< TYPE >:
Inheritance graph
[legend]

Public Member Functions

TYPE abs () const
 Return the magnitude.
 
constexpr const TYPE * begin () const noexcept
 
constexpr TYPE * begin () noexcept
 
constexpr const TYPE * data () const noexcept
 
constexpr TYPE * data () noexcept
 
constexpr const TYPE * end () const noexcept
 
constexpr TYPE * end () noexcept
 
constexpr MeshPoint () noexcept
 Empty constructor.
 
constexpr MeshPoint (const MeshPoint &) noexcept=default
 
template<class TYPE2 >
constexpr MeshPoint (const MeshPoint< TYPE2 > &rhs) noexcept
 
constexpr MeshPoint (const size_t ndim, const TYPE *x) noexcept
 
constexpr MeshPoint (const size_t ndim, std::initializer_list< TYPE > x)
 
template<std::size_t NDIM>
constexpr MeshPoint (const std::array< TYPE, NDIM > &x)
 
 MeshPoint (const std::vector< TYPE > &x)
 
constexpr MeshPoint (const TYPE &x) noexcept
 
constexpr MeshPoint (const TYPE &x, const TYPE &y) noexcept
 
constexpr MeshPoint (const TYPE &x, const TYPE &y, const TYPE &z) noexcept
 
constexpr MeshPoint (MeshPoint &&) noexcept=default
 
constexpr MeshPoint (size_t ndim) noexcept
 
constexpr MeshPoint (std::initializer_list< TYPE > x)
 
constexpr uint8_t ndim () const
 
constexpr TYPE norm () const
 Return the squared magnitude.
 
constexpr operator std::array< TYPE, 1 > () const
 
constexpr operator std::array< TYPE, 2 > () const
 
constexpr operator std::array< TYPE, 3 > () const
 
constexpr bool operator!= (const MeshPoint &rhs) const
 
constexpr MeshPointoperator*= (const TYPE &rhs) noexcept
 
template<class TYPE2 >
constexpr MeshPointoperator+= (const MeshPoint< TYPE2 > &rhs) noexcept
 
constexpr MeshPointoperator+= (const TYPE rhs) noexcept
 
template<class TYPE2 >
constexpr MeshPointoperator-= (const MeshPoint< TYPE2 > &rhs) noexcept
 
constexpr MeshPointoperator-= (const TYPE rhs) noexcept
 
constexpr bool operator< (const MeshPoint &rhs) const
 
constexpr bool operator<= (const MeshPoint &rhs) const
 
constexpr MeshPointoperator= (const MeshPoint &) noexcept=default
 
constexpr MeshPointoperator= (MeshPoint &&) noexcept=default
 
constexpr bool operator== (const MeshPoint &rhs) const
 
constexpr bool operator> (const MeshPoint &rhs) const
 
constexpr bool operator>= (const MeshPoint &rhs) const
 
constexpr TYPE & operator[] (std::size_t i)
 
constexpr const TYPE & operator[] (std::size_t i) const
 
std::string print () const
 Print the point.
 
void print (std::ostream &os) const
 Print the point.
 
constexpr void setNdim (uint8_t N)
 
constexpr size_t size () const
 
constexpr const TYPE & x () const
 
constexpr TYPE & x () noexcept
 
constexpr const TYPE & y () const
 
constexpr TYPE & y () noexcept
 
constexpr const TYPE & z () const
 
constexpr TYPE & z () noexcept
 

Private Attributes

TYPE d_data [3]
 
uint8_t d_ndim
 

Detailed Description

template<class TYPE>
class AMP::Mesh::MeshPoint< TYPE >

Definition at line 24 of file MeshPoint.h.

Constructor & Destructor Documentation

◆ MeshPoint() [1/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( )
inlineconstexprnoexcept

Empty constructor.

Definition at line 28 of file MeshPoint.h.

◆ MeshPoint() [2/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( std::initializer_list< TYPE >  x)
inlineconstexpr

◆ MeshPoint() [3/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( size_t  ndim)
inlineexplicitconstexprnoexcept

Definition at line 40 of file MeshPoint.h.

◆ MeshPoint() [4/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const TYPE &  x)
inlineexplicitconstexprnoexcept

Definition at line 41 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::x().

◆ MeshPoint() [5/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const TYPE &  x,
const TYPE &  y 
)
inlineexplicitconstexprnoexcept

◆ MeshPoint() [6/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const TYPE &  x,
const TYPE &  y,
const TYPE &  z 
)
inlineexplicitconstexprnoexcept

◆ MeshPoint() [7/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const size_t  ndim,
const TYPE *  x 
)
inlineexplicitconstexprnoexcept

Definition at line 50 of file MeshPoint.h.

◆ MeshPoint() [8/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const size_t  ndim,
std::initializer_list< TYPE >  x 
)
inlineconstexpr

◆ MeshPoint() [9/13]

template<class TYPE >
template<std::size_t NDIM>
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const std::array< TYPE, NDIM > &  x)
inlineconstexpr

◆ MeshPoint() [10/13]

template<class TYPE >
AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const std::vector< TYPE > &  x)
inline

◆ MeshPoint() [11/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( MeshPoint< TYPE > &&  )
constexprdefaultnoexcept

◆ MeshPoint() [12/13]

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const MeshPoint< TYPE > &  )
constexprdefaultnoexcept

◆ MeshPoint() [13/13]

template<class TYPE >
template<class TYPE2 >
constexpr AMP::Mesh::MeshPoint< TYPE >::MeshPoint ( const MeshPoint< TYPE2 > &  rhs)
inlineconstexprnoexcept

Definition at line 92 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

Member Function Documentation

◆ abs()

template<class TYPE >
TYPE AMP::Mesh::MeshPoint< TYPE >::abs ( ) const
inline

Return the magnitude.

Definition at line 230 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::norm().

Referenced by AMP::Mesh::abs(), and AMP::Mesh::normalize().

◆ begin() [1/2]

template<class TYPE >
constexpr const TYPE * AMP::Mesh::MeshPoint< TYPE >::begin ( ) const
inlineconstexprnoexcept

Definition at line 129 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ begin() [2/2]

template<class TYPE >
constexpr TYPE * AMP::Mesh::MeshPoint< TYPE >::begin ( )
inlineconstexprnoexcept

Definition at line 127 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ data() [1/2]

template<class TYPE >
constexpr const TYPE * AMP::Mesh::MeshPoint< TYPE >::data ( ) const
inlineconstexprnoexcept

Definition at line 106 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ data() [2/2]

template<class TYPE >
constexpr TYPE * AMP::Mesh::MeshPoint< TYPE >::data ( )
inlineconstexprnoexcept

◆ end() [1/2]

template<class TYPE >
constexpr const TYPE * AMP::Mesh::MeshPoint< TYPE >::end ( ) const
inlineconstexprnoexcept

◆ end() [2/2]

template<class TYPE >
constexpr TYPE * AMP::Mesh::MeshPoint< TYPE >::end ( )
inlineconstexprnoexcept

◆ ndim()

template<class TYPE >
constexpr uint8_t AMP::Mesh::MeshPoint< TYPE >::ndim ( ) const
inlineconstexpr

Definition at line 101 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_ndim.

◆ norm()

template<class TYPE >
constexpr TYPE AMP::Mesh::MeshPoint< TYPE >::norm ( ) const
inlineconstexpr

Return the squared magnitude.

Definition at line 224 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

Referenced by AMP::Mesh::MeshPoint< TYPE >::abs().

◆ operator std::array< TYPE, 1 >()

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::operator std::array< TYPE, 1 > ( ) const
inlineconstexpr

Definition at line 79 of file MeshPoint.h.

◆ operator std::array< TYPE, 2 >()

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::operator std::array< TYPE, 2 > ( ) const
inlineconstexpr

Definition at line 80 of file MeshPoint.h.

◆ operator std::array< TYPE, 3 >()

template<class TYPE >
constexpr AMP::Mesh::MeshPoint< TYPE >::operator std::array< TYPE, 3 > ( ) const
inlineconstexpr

Definition at line 81 of file MeshPoint.h.

◆ operator!=()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator!= ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator*=()

template<class TYPE >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator*= ( const TYPE &  rhs)
inlineconstexprnoexcept

Definition at line 163 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ operator+=() [1/2]

template<class TYPE >
template<class TYPE2 >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator+= ( const MeshPoint< TYPE2 > &  rhs)
inlineconstexprnoexcept

Definition at line 141 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ operator+=() [2/2]

template<class TYPE >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator+= ( const TYPE  rhs)
inlineconstexprnoexcept

Definition at line 133 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ operator-=() [1/2]

template<class TYPE >
template<class TYPE2 >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator-= ( const MeshPoint< TYPE2 > &  rhs)
inlineconstexprnoexcept

Definition at line 156 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ operator-=() [2/2]

template<class TYPE >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator-= ( const TYPE  rhs)
inlineconstexprnoexcept

Definition at line 148 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ operator<()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator< ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator<=()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator<= ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator=() [1/2]

template<class TYPE >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator= ( const MeshPoint< TYPE > &  )
constexprdefaultnoexcept

◆ operator=() [2/2]

template<class TYPE >
constexpr MeshPoint & AMP::Mesh::MeshPoint< TYPE >::operator= ( MeshPoint< TYPE > &&  )
constexprdefaultnoexcept

◆ operator==()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator== ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator>()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator> ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator>=()

template<class TYPE >
constexpr bool AMP::Mesh::MeshPoint< TYPE >::operator>= ( const MeshPoint< TYPE > &  rhs) const
inlineconstexpr

◆ operator[]() [1/2]

template<class TYPE >
constexpr TYPE & AMP::Mesh::MeshPoint< TYPE >::operator[] ( std::size_t  i)
inlineconstexpr

◆ operator[]() [2/2]

template<class TYPE >
constexpr const TYPE & AMP::Mesh::MeshPoint< TYPE >::operator[] ( std::size_t  i) const
inlineconstexpr

◆ print() [1/2]

template<class TYPE >
std::string AMP::Mesh::MeshPoint< TYPE >::print ( ) const
inline

Print the point.

Definition at line 246 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::print().

Referenced by AMP::Mesh::MeshPoint< TYPE >::print().

◆ print() [2/2]

template<class TYPE >
void AMP::Mesh::MeshPoint< TYPE >::print ( std::ostream &  os) const
inline

Print the point.

Definition at line 233 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data, and AMP::Mesh::MeshPoint< TYPE >::d_ndim.

Referenced by AMP::Mesh::operator<<().

◆ setNdim()

template<class TYPE >
constexpr void AMP::Mesh::MeshPoint< TYPE >::setNdim ( uint8_t  N)
inlineconstexpr

◆ size()

template<class TYPE >
constexpr size_t AMP::Mesh::MeshPoint< TYPE >::size ( ) const
inlineconstexpr

◆ x() [1/2]

template<class TYPE >
constexpr const TYPE & AMP::Mesh::MeshPoint< TYPE >::x ( ) const
inlineconstexpr

Definition at line 110 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ x() [2/2]

template<class TYPE >
constexpr TYPE & AMP::Mesh::MeshPoint< TYPE >::x ( )
inlineconstexprnoexcept

◆ y() [1/2]

template<class TYPE >
constexpr const TYPE & AMP::Mesh::MeshPoint< TYPE >::y ( ) const
inlineconstexpr

Definition at line 111 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ y() [2/2]

template<class TYPE >
constexpr TYPE & AMP::Mesh::MeshPoint< TYPE >::y ( )
inlineconstexprnoexcept

◆ z() [1/2]

template<class TYPE >
constexpr const TYPE & AMP::Mesh::MeshPoint< TYPE >::z ( ) const
inlineconstexpr

Definition at line 112 of file MeshPoint.h.

References AMP::Mesh::MeshPoint< TYPE >::d_data.

◆ z() [2/2]

template<class TYPE >
constexpr TYPE & AMP::Mesh::MeshPoint< TYPE >::z ( )
inlineconstexprnoexcept

Member Data Documentation

◆ d_data

template<class TYPE >
TYPE AMP::Mesh::MeshPoint< TYPE >::d_data[3]
private

Definition at line 255 of file MeshPoint.h.

Referenced by AMP::Mesh::MeshPoint< TYPE >::begin(), AMP::Mesh::MeshPoint< TYPE >::begin(), AMP::Mesh::MeshPoint< TYPE >::data(), AMP::Mesh::MeshPoint< TYPE >::data(), AMP::Mesh::MeshPoint< TYPE >::end(), AMP::Mesh::MeshPoint< TYPE >::end(), AMP::Mesh::MeshPoint< TYPE >::MeshPoint(), AMP::Mesh::MeshPoint< TYPE >::MeshPoint(), AMP::Mesh::MeshPoint< TYPE >::MeshPoint(), AMP::Mesh::MeshPoint< TYPE >::MeshPoint(), AMP::Mesh::MeshPoint< TYPE >::MeshPoint(), AMP::Mesh::MeshPoint< TYPE >::norm(), AMP::Mesh::MeshPoint< double >::operator std::array< double, 1 >(), AMP::Mesh::MeshPoint< double >::operator std::array< double, 2 >(), AMP::Mesh::MeshPoint< double >::operator std::array< double, 3 >(), AMP::Mesh::MeshPoint< TYPE >::operator!=(), AMP::Mesh::MeshPoint< TYPE >::operator*=(), AMP::Mesh::MeshPoint< TYPE >::operator+=(), AMP::Mesh::MeshPoint< TYPE >::operator+=(), AMP::Mesh::MeshPoint< TYPE >::operator-=(), AMP::Mesh::MeshPoint< TYPE >::operator-=(), AMP::Mesh::MeshPoint< TYPE >::operator<(), AMP::Mesh::MeshPoint< TYPE >::operator<=(), AMP::Mesh::MeshPoint< TYPE >::operator==(), AMP::Mesh::MeshPoint< TYPE >::operator>(), AMP::Mesh::MeshPoint< TYPE >::operator>=(), AMP::Mesh::MeshPoint< TYPE >::operator[](), AMP::Mesh::MeshPoint< TYPE >::operator[](), AMP::Mesh::MeshPoint< TYPE >::print(), AMP::Mesh::MeshPoint< TYPE >::x(), AMP::Mesh::MeshPoint< TYPE >::x(), AMP::Mesh::MeshPoint< TYPE >::y(), AMP::Mesh::MeshPoint< TYPE >::y(), AMP::Mesh::MeshPoint< TYPE >::z(), and AMP::Mesh::MeshPoint< TYPE >::z().

◆ d_ndim

template<class TYPE >
uint8_t AMP::Mesh::MeshPoint< TYPE >::d_ndim
private

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



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