amrex::Orientation Class Reference

Encapsulation of the Orientation of the Faces of a Box. More...

#include <AMReX_Orientation.H>

Public Types
enum	Side { low = 0 , high = 1 }
	In each dimension a face is either low or high. More...

Public Member Functions
constexpr	Orientation () noexcept=default
	The default constructor.
__host__ __device__	Orientation (int dir, Side side) noexcept
	Set the orientation of a side.
__host__ __device__ constexpr	Orientation (Direction dir, Side side) noexcept
__host__ __device__ bool	operator== (const Orientation &o) const noexcept
	Logical equality.
__host__ __device__ bool	operator!= (const Orientation &o) const noexcept
	Logical inequality.
__host__ __device__ bool	operator< (const Orientation &o) const noexcept
	Less-than.
__host__ __device__ bool	operator<= (const Orientation &o) const noexcept
	Less-than or equal.
__host__ __device__ bool	operator> (const Orientation &o) const noexcept
	Greater-than.
__host__ __device__ bool	operator>= (const Orientation &o) const noexcept
	Greater-than or equal.
__host__ __device__ constexpr	operator int () const noexcept
	This conversion operator maps an orientation into a unique integer in the range [0 .. 2*AMREX_SPACEDIM-1] according to the above ordering.
__host__ __device__ Orientation	flip () const noexcept
	Return opposite orientation.
__host__ __device__ int	coordDir () const noexcept
	Returns the coordinate direction.
__host__ __device__ Side	faceDir () const noexcept
	Returns the orientation of the face – low or high.
__host__ __device__ bool	isLow () const noexcept
	Returns true if Orientation is low.
__host__ __device__ bool	isHigh () const noexcept
	Returns true if Orientation is high.

Static Public Member Functions
__host__ static __device__ constexpr int	xlo () noexcept
	Int value of the x-lo-face.
__host__ static __device__ constexpr int	xhi () noexcept
	Int value of the x-hi-face.
__host__ static __device__ constexpr int	ylo () noexcept
	Int value of the y-lo-face.
__host__ static __device__ constexpr int	yhi () noexcept
	Int value of the y-hi-face.
__host__ static __device__ constexpr int	zlo () noexcept
	Int value of the z-lo-face.
__host__ static __device__ constexpr int	zhi () noexcept
	Int value of the z-hi-face.

Private Member Functions
__host__ __device__	Orientation (int v) noexcept
	Used internally.

Private Attributes
int	val = -1
	The data.

Friends
class	OrientationIter
std::istream &	operator>> (std::istream &is, Orientation &o)
	Read from an istream.

Detailed Description

Encapsulation of the Orientation of the Faces of a Box.

This class encapsulates the orientation of the faces of a Box by providing an ordering of each of the faces of a Box in AMREX_SPACEDIM dimensions. This allows iterating over all the faces of a Box. The ordering first traverses the AMREX_SPACEDIM low sides from direction 0 .. AMREX_SPACEDIM-1 and then the AMREX_SPACEDIM high sides from direction 0 .. AMREX_SPACEDIM-1.

Member Enumeration Documentation

Side

enum amrex::Orientation::Side

In each dimension a face is either low or high.

Enumerator
low
high

Constructor & Destructor Documentation

Orientation() [1/4]

constexpr amrex::Orientation::Orientation ( )

constexprdefaultnoexcept

The default constructor.

Orientation() [2/4]

__host__ __device__ amrex::Orientation::Orientation ( int  dir, Side  side  )

inlinenoexcept

Set the orientation of a side.

Orientation() [3/4]

__host__ __device__ constexpr amrex::Orientation::Orientation ( Direction  dir, Side  side  )

inlineconstexprnoexcept

Orientation() [4/4]

__host__ __device__ amrex::Orientation::Orientation ( int  v )

inlineprivatenoexcept

Used internally.

Member Function Documentation

coordDir()

__host__ __device__ int amrex::Orientation::coordDir ( ) const

inlinenoexcept

Returns the coordinate direction.

faceDir()

__host__ __device__ Side amrex::Orientation::faceDir ( ) const

inlinenoexcept

Returns the orientation of the face – low or high.

flip()

__host__ __device__ Orientation amrex::Orientation::flip ( ) const

inlinenoexcept

Return opposite orientation.

isHigh()

__host__ __device__ bool amrex::Orientation::isHigh ( ) const

inlinenoexcept

Returns true if Orientation is high.

isLow()

__host__ __device__ bool amrex::Orientation::isLow ( ) const

inlinenoexcept

Returns true if Orientation is low.

operator int()

__host__ __device__ constexpr amrex::Orientation::operator int ( ) const

inlineconstexprnoexcept

This conversion operator maps an orientation into a unique integer in the range [0 .. 2*AMREX_SPACEDIM-1] according to the above ordering.

operator!=()

__host__ __device__ bool amrex::Orientation::operator!= ( const Orientation &  o ) const

inlinenoexcept

Logical inequality.

operator<()

__host__ __device__ bool amrex::Orientation::operator< ( const Orientation &  o ) const

inlinenoexcept

Less-than.

operator<=()

__host__ __device__ bool amrex::Orientation::operator<= ( const Orientation &  o ) const

inlinenoexcept

Less-than or equal.

operator==()

__host__ __device__ bool amrex::Orientation::operator== ( const Orientation &  o ) const

inlinenoexcept

Logical equality.

operator>()

__host__ __device__ bool amrex::Orientation::operator> ( const Orientation &  o ) const

inlinenoexcept

Greater-than.

operator>=()

__host__ __device__ bool amrex::Orientation::operator>= ( const Orientation &  o ) const

inlinenoexcept

Greater-than or equal.

xhi()

__host__ static __device__ constexpr int amrex::Orientation::xhi ( )

inlinestaticconstexprnoexcept

Int value of the x-hi-face.

xlo()

__host__ static __device__ constexpr int amrex::Orientation::xlo ( )

inlinestaticconstexprnoexcept

Int value of the x-lo-face.

yhi()

__host__ static __device__ constexpr int amrex::Orientation::yhi ( )

inlinestaticconstexprnoexcept

Int value of the y-hi-face.

ylo()

__host__ static __device__ constexpr int amrex::Orientation::ylo ( )

inlinestaticconstexprnoexcept

Int value of the y-lo-face.

zhi()

__host__ static __device__ constexpr int amrex::Orientation::zhi ( )

inlinestaticconstexprnoexcept

Int value of the z-hi-face.

zlo()

__host__ static __device__ constexpr int amrex::Orientation::zlo ( )

inlinestaticconstexprnoexcept

Int value of the z-lo-face.

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream &  is, Orientation &  o  )

friend

Read from an istream.

OrientationIter

friend class OrientationIter

friend

Member Data Documentation

val

int amrex::Orientation::val = -1

private

The data.

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_Orientation.H