AMReX_Periodicity.H

Go to the documentation of this file.

#ifndef AMREX_PERIODICITY_H_
#define AMREX_PERIODICITY_H_
#include <AMReX_Config.H>
 
#include <AMReX_IntVect.H>
#include <AMReX_Box.H>
#include <vector>
 
namespace amrex {
 
class Periodicity
{
public:
    Periodicity () noexcept : period(AMREX_D_DECL(0,0,0)) {}
    explicit Periodicity (const IntVect& v) noexcept : period(v) {}
 
    [[nodiscard]] bool isAnyPeriodic () const noexcept
        { return AMREX_D_TERM(period[0]>0, || period[1]>0, || period[2]>0); }
    [[nodiscard]] bool isAllPeriodic () const noexcept
        { return AMREX_D_TERM(period[0]>0, && period[1]>0, && period[2]>0); }
    [[nodiscard]] bool isPeriodic (int dir) const noexcept
        { return period[dir]>0; }
 
    bool operator==(const Periodicity& rhs) const noexcept
        { return period == rhs.period; }
 
    [[nodiscard]] Box Domain () const noexcept;
 
    [[nodiscard]] IntVect const& intVect () const { return period; }
 
    [[nodiscard]] std::vector<IntVect> shiftIntVect (IntVect const& nghost = IntVect(0)) const;
 
    static const Periodicity& NonPeriodic () noexcept;
 
private:
    IntVect period;
};
 
}
 
#endif