AMReX_Orientation.H

Go to the documentation of this file.

 
#ifndef BL_ORIENTATION_H
#define BL_ORIENTATION_H
#include <AMReX_Config.H>
 
#include <AMReX_BLassert.H>
#include <AMReX_SPACE.H>
#include <AMReX_GpuQualifiers.H>
 
#include <iosfwd>
 
namespace amrex {
 
enum class Direction : int { AMREX_D_DECL(x = 0, y = 1, z = 2) };
 
class OrientationIter;
 
class Orientation
{
public:
 
    friend class OrientationIter;
    enum Side { low = 0, high = 1 };
    constexpr Orientation () noexcept = default;
    AMREX_GPU_HOST_DEVICE
    Orientation (int dir, Side side) noexcept
        :
        val(AMREX_SPACEDIM*side + dir)
    {
        BL_ASSERT(0 <= dir && dir < AMREX_SPACEDIM);
    }
    AMREX_GPU_HOST_DEVICE
    constexpr Orientation (Direction dir, Side side) noexcept
        : val(AMREX_SPACEDIM*side + static_cast<int>(dir))
    {}
 
    AMREX_GPU_HOST_DEVICE
    bool operator== (const Orientation& o) const noexcept { return val == o.val; }
    AMREX_GPU_HOST_DEVICE
    bool operator!= (const Orientation& o) const noexcept { return val != o.val; }
    AMREX_GPU_HOST_DEVICE
    bool operator<  (const Orientation& o) const noexcept { return val < o.val; }
    AMREX_GPU_HOST_DEVICE
    bool operator<= (const Orientation& o) const noexcept { return val <= o.val; }
    AMREX_GPU_HOST_DEVICE
    bool operator>  (const Orientation& o) const noexcept { return val > o.val; }
    AMREX_GPU_HOST_DEVICE
    bool operator>= (const Orientation& o) const noexcept { return val >= o.val; }
    AMREX_GPU_HOST_DEVICE
    constexpr operator int () const noexcept { return val; }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    Orientation flip () const noexcept
    {
        return Orientation(val < AMREX_SPACEDIM ? val+AMREX_SPACEDIM : val-AMREX_SPACEDIM);
    }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    int coordDir () const noexcept { return val%AMREX_SPACEDIM; }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    Side faceDir () const noexcept { return Side(val/AMREX_SPACEDIM); }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    bool isLow () const noexcept { return val < AMREX_SPACEDIM; }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    bool isHigh () const noexcept { return val >= AMREX_SPACEDIM; }
    friend std::istream& operator>> (std::istream& is, Orientation& o);
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int xlo () noexcept { return 0; }
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int xhi () noexcept { return AMREX_SPACEDIM; }
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int ylo () noexcept { return 1; }
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int yhi () noexcept { return 1+AMREX_SPACEDIM; }
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int zlo () noexcept { return 2; }
 
    AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
    static constexpr int zhi () noexcept { return 2+AMREX_SPACEDIM; }
 
private:
    AMREX_GPU_HOST_DEVICE
    Orientation (int v) noexcept : val(v) {}
    //
    int val = -1;
};
 
std::ostream& operator<< (std::ostream& os, const Orientation& o);
 
 
class OrientationIter
{
 
public:
    constexpr OrientationIter () noexcept = default;
    AMREX_GPU_HOST_DEVICE
    OrientationIter (const Orientation& _face) noexcept
        :
        face(_face) {}
    AMREX_GPU_HOST_DEVICE
    void rewind () noexcept { face = 0; }
    AMREX_GPU_HOST_DEVICE
    Orientation operator() () const noexcept { BL_ASSERT(isValid()); return Orientation(face); }
    AMREX_GPU_HOST_DEVICE
    operator void* () noexcept { return 0 <= face && face < 2*AMREX_SPACEDIM ? this : nullptr; }
    [[nodiscard]] AMREX_GPU_HOST_DEVICE
    bool isValid () const noexcept { return 0 <= face && face < 2*AMREX_SPACEDIM; }
    AMREX_GPU_HOST_DEVICE
    OrientationIter& operator-- () noexcept { BL_ASSERT(isValid()); --face; return *this; }
    AMREX_GPU_HOST_DEVICE
    OrientationIter& operator++ () noexcept { BL_ASSERT(isValid()); ++face; return *this; }
    AMREX_GPU_HOST_DEVICE
    OrientationIter operator-- (int) noexcept
    {
        BL_ASSERT(isValid()); OrientationIter it(face); --face; return it;
    }
    AMREX_GPU_HOST_DEVICE
    OrientationIter operator++ (int) noexcept
    {
        BL_ASSERT(isValid()); OrientationIter it(face); ++face; return it;
    }
    AMREX_GPU_HOST_DEVICE
    bool operator== (const OrientationIter& oi) const noexcept
    {
        BL_ASSERT(isValid() && oi.isValid()); return face == oi.face;
    }
    AMREX_GPU_HOST_DEVICE
    bool operator!= (const OrientationIter& oi) const noexcept
    {
        BL_ASSERT(isValid() && oi.isValid()); return face != oi.face;
    }
 
private:
 
    int face = 0;
    AMREX_GPU_HOST_DEVICE
    OrientationIter (int _face) noexcept : face(_face) {}
};
 
}
 
#endif /*BL_ORIENTATION_H*/