Line data    Source code

       1              : //
       2              : // This is the mechanism for impositing boundary conditions on :code:`Set::Field` objects of 
       3              : // scalar type.
       4              : // Typical convention is for :code:`[prefix]` to be given by the field name. For instance,
       5              : // 
       6              : // .. code-block:: make
       7              : // 
       8              : //                 bc.temp.type.xhi = dirichlet dirichlet dirichlet
       9              : //                 bc.temp.val.xhi  = 0.0 1.0 0.0
      10              : //
      11              : // corresponds to the boundary condition for temperature. See the specific integrator
      12              : // for details.
      13              : //
      14              : 
      15              : #ifndef BC_BC_H_
      16              : #define BC_BC_H_
      17              : 
      18              : #include <AMReX_ParallelDescriptor.H>
      19              : #include <AMReX_ParmParse.H>
      20              : #include <AMReX_BCRec.H>
      21              : #include <AMReX_PhysBCFunct.H>
      22              : #include <AMReX_LO_BCTYPES.H>
      23              : #include <AMReX_Mask.H>
      24              : #include <AMReX_Periodicity.H>
      25              : 
      26              : 
      27              : /// \brief Collection of boundary condition (BC) objects
      28              : namespace BC
      29              : {
      30              : enum Orientation {
      31              :     All = -1,
      32              :     AMREX_D_DECL(xlo = 0,
      33              :     ylo = 1,
      34              :     zlo = 2),
      35              :     AMREX_D_DECL(xhi = 0 + AMREX_SPACEDIM,
      36              :     yhi = 1 + AMREX_SPACEDIM,
      37              :     zhi = 2 + AMREX_SPACEDIM)
      38              : };
      39              : 
      40              : template<class T>
      41              : class BC
      42              : {
      43              : 
      44              : public:
      45           83 :     virtual ~BC() {};
      46              : 
      47       380225 :     void define(const amrex::Geometry& a_geom) { m_geom = a_geom; };
      48              : 
      49              :     virtual void FillBoundary(amrex::BaseFab<T>& in,
      50              :         const amrex::Box& box,
      51              :         int ngrow, int dcomp, int ncomp,
      52              :         amrex::Real time,
      53              :         Orientation face = Orientation::All,
      54              :         const amrex::Mask* mask = nullptr) = 0;
      55              : 
      56            0 :     virtual void FillBoundary(amrex::FabArray<amrex::BaseFab<T>>& mf,
      57              :         int dcomp, int ncomp,
      58              :         amrex::Real time, int /*bccomp*/)
      59              :     {
      60            0 :         mf.FillBoundary(m_geom.periodicity());
      61            0 :         for (amrex::MFIter mfi(mf, true); mfi.isValid(); ++mfi)
      62              :         {
      63            0 :             const amrex::Box& box = mfi.tilebox();
      64            0 :             amrex::BaseFab<T>& in = mf[mfi];
      65            0 :             FillBoundary(in, box, mf.nGrow(), dcomp, ncomp, time);
      66              :         }
      67            0 :     }
      68              : 
      69            0 :     virtual void FillBoundary(amrex::FabArray<amrex::BaseFab<T>>& mf,
      70              :         int dcomp, int ncomp, amrex::IntVect const& /*nghost*/,
      71              :         amrex::Real time, int bccomp) //override
      72              :     {
      73            0 :         FillBoundary(mf, dcomp, ncomp, time, bccomp);
      74            0 :     }
      75              : 
      76            0 :     void operator () (amrex::FabArray<amrex::BaseFab<T>>& mf,
      77              :         int dcomp, int ncomp, amrex::IntVect const& /*nghost*/,
      78              :         amrex::Real time, int bccomp)
      79              :     {
      80            0 :         FillBoundary(mf, dcomp, ncomp, time, bccomp);
      81            0 :     }
      82              : 
      83              : 
      84              : 
      85              :     template <class Q = T>
      86              :     typename std::enable_if<std::is_same<Q, amrex::Real>::value>::type
      87       593501 :         FillBoundary(amrex::MultiFab& mf,
      88              :             int dcomp, int ncomp,
      89              :             amrex::Real time, int /*bccomp*/)
      90              :     {
      91       593501 :         mf.FillBoundary(m_geom.periodicity());
      92      2651336 :         for (amrex::MFIter mfi(mf, true); mfi.isValid(); ++mfi)
      93              :         {
      94      2057835 :             const amrex::Box& box = mfi.tilebox();
      95      2057835 :             amrex::BaseFab<T>& in = mf[mfi];
      96      2057835 :             FillBoundary(in, box, mf.nGrow(), dcomp, ncomp, time);
      97              :         }
      98       593501 :     }
      99              : 
     100              :     template <class Q = T>
     101              :     typename std::enable_if<std::is_same<Q, amrex::Real>::value>::type
     102       593172 :         operator () (amrex::MultiFab& mf,
     103              :             int dcomp, int ncomp, amrex::IntVect const& /*nghost*/,
     104              :             amrex::Real time, int bccomp)
     105              :     {
     106       593172 :         FillBoundary(mf, dcomp, ncomp, time, bccomp);
     107       593172 :     }
     108              : 
     109              : 
     110              :     virtual amrex::BCRec GetBCRec() = 0;
     111              : 
     112            0 :     virtual amrex::Array<int, AMREX_SPACEDIM> IsPeriodic()
     113              :     {
     114            0 :         return { {AMREX_D_DECL(m_geom.isPeriodic(0),m_geom.isPeriodic(1),m_geom.isPeriodic(2))} };
     115              :     }
     116              : 
     117            0 :     virtual amrex::Periodicity Periodicity() const {
     118            0 :         return m_geom.periodicity();
     119              :     }
     120              : 
     121            0 :     virtual amrex::Periodicity Periodicity(const amrex::Box& b) {
     122            0 :         return m_geom.periodicity(b);
     123              :     }
     124              : 
     125              : 
     126              : protected:
     127              :     amrex::Geometry m_geom;
     128              :     //std::vector<amrex::Geometry> &geom;
     129              :     //int lev=0;
     130              : };
     131              : 
     132              : namespace BCUtil
     133              : {
     134              : int ReadString(std::string bcstring);
     135              : bool IsPeriodic(int bctype);
     136              : bool IsNeumann(int bctype);
     137              : bool IsReflectEven(int bctype);
     138              : bool IsReflectOdd(int bctype);
     139              : bool IsDirichlet(int bctype);
     140              : }
     141              : 
     142              : }
     143              : #endif