Block-Structured AMR Software Framework
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. More...
 
AMREX_GPU_HOST_DEVICE OrientationIter (const Orientation &_face) noexcept
 Construct an iterator on the Orientation. More...
 
AMREX_GPU_HOST_DEVICE void rewind () noexcept
 Reset (rewind) the iterator. More...
 
AMREX_GPU_HOST_DEVICE Orientation operator() () const noexcept
 Return the orientation of the face. More...
 
AMREX_GPU_HOST_DEVICE operator void * () noexcept
 Cast to void*. Used to test if iterator is valid. More...
 
AMREX_GPU_HOST_DEVICE bool isValid () const noexcept
 Is the iterator valid? More...
 
AMREX_GPU_HOST_DEVICE OrientationIteroperator-- () noexcept
 Pre-decrement. More...
 
AMREX_GPU_HOST_DEVICE OrientationIteroperator++ () noexcept
 Pre-increment. More...
 
AMREX_GPU_HOST_DEVICE OrientationIter operator-- (int) noexcept
 Post-decrement. More...
 
AMREX_GPU_HOST_DEVICE OrientationIter operator++ (int) noexcept
 Post-increment. More...
 
AMREX_GPU_HOST_DEVICE bool operator== (const OrientationIter &oi) const noexcept
 The equality operator. More...
 
AMREX_GPU_HOST_DEVICE bool operator!= (const OrientationIter &oi) const noexcept
 The inequality operator. More...
 

Private Member Functions

AMREX_GPU_HOST_DEVICE OrientationIter (int _face) noexcept
 Construct an iterator on the face. More...
 

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]

AMREX_GPU_HOST_DEVICE amrex::OrientationIter::OrientationIter ( const Orientation _face)
inlinenoexcept

Construct an iterator on the Orientation.

◆ OrientationIter() [3/3]

AMREX_GPU_HOST_DEVICE amrex::OrientationIter::OrientationIter ( int  _face)
inlineprivatenoexcept

Construct an iterator on the face.

Member Function Documentation

◆ isValid()

AMREX_GPU_HOST_DEVICE bool amrex::OrientationIter::isValid ( ) const
inlinenoexcept

Is the iterator valid?

◆ operator void *()

AMREX_GPU_HOST_DEVICE amrex::OrientationIter::operator void * ( )
inlinenoexcept

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

◆ operator!=()

AMREX_GPU_HOST_DEVICE bool amrex::OrientationIter::operator!= ( const OrientationIter oi) const
inlinenoexcept

The inequality operator.

◆ operator()()

AMREX_GPU_HOST_DEVICE Orientation amrex::OrientationIter::operator() ( ) const
inlinenoexcept

Return the orientation of the face.

◆ operator++() [1/2]

AMREX_GPU_HOST_DEVICE OrientationIter& amrex::OrientationIter::operator++ ( )
inlinenoexcept

Pre-increment.

◆ operator++() [2/2]

AMREX_GPU_HOST_DEVICE OrientationIter amrex::OrientationIter::operator++ ( int  )
inlinenoexcept

Post-increment.

◆ operator--() [1/2]

AMREX_GPU_HOST_DEVICE OrientationIter& amrex::OrientationIter::operator-- ( )
inlinenoexcept

Pre-decrement.

◆ operator--() [2/2]

AMREX_GPU_HOST_DEVICE OrientationIter amrex::OrientationIter::operator-- ( int  )
inlinenoexcept

Post-decrement.

◆ operator==()

AMREX_GPU_HOST_DEVICE bool amrex::OrientationIter::operator== ( const OrientationIter oi) const
inlinenoexcept

The equality operator.

◆ rewind()

AMREX_GPU_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: