amrex::OrientationIter Class Reference

An Iterator over the Orientation of Faces of a Box. More...

#include <AMReX_Orientation.H>

Public Member Functions
constexpr	OrientationIter () noexcept=default
	The default constructor.
__host__ __device__	OrientationIter (const Orientation &_face) noexcept
	Construct an iterator on the Orientation.
__host__ __device__ void	rewind () noexcept
	Reset (rewind) the iterator.
__host__ __device__ Orientation	operator() () const noexcept
	Return the orientation of the face.
__host__ __device__	operator void * () noexcept
	Cast to void*. Used to test if iterator is valid.
__host__ __device__ bool	isValid () const noexcept
	Is the iterator valid?
__host__ __device__ OrientationIter &	operator-- () noexcept
	Pre-decrement.
__host__ __device__ OrientationIter &	operator++ () noexcept
	Pre-increment.
__host__ __device__ OrientationIter	operator-- (int) noexcept
	Post-decrement.
__host__ __device__ OrientationIter	operator++ (int) noexcept
	Post-increment.
__host__ __device__ bool	operator== (const OrientationIter &oi) const noexcept
	The equality operator.
__host__ __device__ bool	operator!= (const OrientationIter &oi) const noexcept
	The inequality operator.

Private Member Functions
__host__ __device__	OrientationIter (int _face) noexcept
	Construct an iterator on the face.

Private Attributes
int	face = 0

Detailed Description

An Iterator over the Orientation of Faces of a Box.

Constructor & Destructor Documentation

OrientationIter() [1/3]

constexpr amrex::OrientationIter::OrientationIter ( )

constexprdefaultnoexcept

The default constructor.

OrientationIter() [2/3]

__host__ __device__ amrex::OrientationIter::OrientationIter ( const Orientation &  _face )

inlinenoexcept

Construct an iterator on the Orientation.

OrientationIter() [3/3]

__host__ __device__ amrex::OrientationIter::OrientationIter ( int  _face )

inlineprivatenoexcept

Construct an iterator on the face.

Member Function Documentation

isValid()

__host__ __device__ bool amrex::OrientationIter::isValid ( ) const

inlinenoexcept

Is the iterator valid?

operator void *()

__host__ __device__ amrex::OrientationIter::operator void * ( )

inlinenoexcept

Cast to void*. Used to test if iterator is valid.

operator!=()

__host__ __device__ bool amrex::OrientationIter::operator!= ( const OrientationIter &  oi ) const

inlinenoexcept

The inequality operator.

operator()()

__host__ __device__ Orientation amrex::OrientationIter::operator() ( ) const

inlinenoexcept

Return the orientation of the face.

operator++() [1/2]

__host__ __device__ OrientationIter & amrex::OrientationIter::operator++ ( )

inlinenoexcept

Pre-increment.

operator++() [2/2]

__host__ __device__ OrientationIter amrex::OrientationIter::operator++ ( int  )

inlinenoexcept

Post-increment.

operator--() [1/2]

__host__ __device__ OrientationIter & amrex::OrientationIter::operator-- ( )

inlinenoexcept

Pre-decrement.

operator--() [2/2]

__host__ __device__ OrientationIter amrex::OrientationIter::operator-- ( int  )

inlinenoexcept

Post-decrement.

operator==()

__host__ __device__ bool amrex::OrientationIter::operator== ( const OrientationIter &  oi ) const

inlinenoexcept

The equality operator.

rewind()

__host__ __device__ void amrex::OrientationIter::rewind ( )

inlinenoexcept

Reset (rewind) the iterator.

Member Data Documentation

face

int amrex::OrientationIter::face = 0

private

---

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

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