AMReX_FluxRegister.H

Go to the documentation of this file.

#ifndef AMREX_FLUXREGISTER_H_
#define AMREX_FLUXREGISTER_H_
#include <AMReX_Config.H>
 
#include <AMReX_BndryRegister.H>
#include <AMReX_Geometry.H>
#include <AMReX_Array.H>

 
namespace amrex {
 

class FluxRegister
    :
    public BndryRegister
{
public:

    FluxRegister();

    FluxRegister (const BoxArray&            fine_boxes,
                  const DistributionMapping& dm,
                  const IntVect&             ref_ratio,
                  int                        fine_lev,
                  int                        nvar);

    ~FluxRegister () = default;
 
    FluxRegister (FluxRegister&& rhs) noexcept = default;
 
    FluxRegister (const FluxRegister& rhs) = delete;
    FluxRegister& operator= (const FluxRegister& rhs) = delete;
    FluxRegister& operator= (FluxRegister&& rhs) = delete;

    enum FrOp {COPY = 0, ADD = 1};

    void define (const BoxArray&            fine_boxes,
                 const DistributionMapping& dm,
                 const IntVect&             ref_ratio,
                 int                        fine_lev,
                 int                        nvar);

    void clear ();
 

    const IntVect& refRatio () const noexcept;

    int fineLevel () const noexcept;

    int crseLevel () const noexcept;

    int nComp () const noexcept;

    const BoxArray& coarsenedBoxes () const noexcept;

    Real SumReg (int comp) const;

    void CrseInit (const MultiFab& mflx,
                   const MultiFab& area,
                   int             dir,
                   int             srccomp,
                   int             destcomp,
                   int             numcomp,
                   Real            mult = -1.0,
                   FrOp            op = FluxRegister::COPY);

    void CrseInit (const MultiFab& mflx,
                   int             dir,
                   int             srccomp,
                   int             destcomp,
                   int             numcomp,
                   Real            mult = -1.0,
                   FrOp            op = FluxRegister::COPY);

    void CrseAdd (const MultiFab& mflx,
                  const MultiFab& area,
                  int             dir,
                  int             srccomp,
                  int             destcomp,
                  int             numcomp,
                  Real            mult,
                  const Geometry& geom);

    void CrseAdd (const MultiFab& mflx,
                  int             dir,
                  int             srccomp,
                  int             destcomp,
                  int             numcomp,
                  Real            mult,
                  const Geometry& geom);

    void FineAdd (const MultiFab& mflx,
                  int             dir,
                  int             srccomp,
                  int             destcomp,
                  int             numcomp,
                  Real            mult);

    void FineAdd (const MultiFab& mflx,
                  const MultiFab& area,
                  int             dir,
                  int             srccomp,
                  int             destcomp,
                  int             numcomp,
                  Real            mult);

    void FineAdd (const FArrayBox& flux,
                  int              dir,
                  int              boxno,
                  int              srccomp,
                  int              destcomp,
                  int              numcomp,
                  Real             mult,
                  RunOn            runon) noexcept;

    void FineAdd (const FArrayBox& flux,
                  const FArrayBox& area,
                  int              dir,
                  int              boxno,
                  int              srccomp,
                  int              destcomp,
                  int              numcomp,
                  Real             mult,
                  RunOn            runon) noexcept;

    void FineSetVal (int              dir,
                     int              boxno,
                     int              destcomp,
                     int              numcomp,
                     Real             val,
                     RunOn            runon) noexcept;

    void Reflux (MultiFab&       mf,
                 const MultiFab& volume,
                 Real            scale,
                 int             scomp,
                 int             dcomp,
                 int             nc,
                 const Geometry& crse_geom);

    void Reflux (MultiFab&       mf,
                 const MultiFab& volume,
                 int             dir,
                 Real            scale,
                 int             scomp,
                 int             dcomp,
                 int             nc,
                 const Geometry& crse_geom);

    void Reflux (MultiFab&       mf,
                 Real            scale,
                 int             scomp,
                 int             dcomp,
                 int             nc,
                 const Geometry& crse_geom);

    void Reflux (MultiFab&       mf,
                 int             dir,
                 Real            scale,
                 int             scomp,
                 int             dcomp,
                 int             nc,
                 const Geometry& crse_geom);

    void OverwriteFlux (Array<MultiFab*,AMREX_SPACEDIM> const& crse_fluxes,
                        Real scale, int srccomp, int destcomp, int numcomp,
                        const Geometry& crse_geom);
 

    void ClearInternalBorders (const Geometry& crse_geom);

    void write (const std::string& name, std::ostream& os) const;

    void read (const std::string& name, std::istream& is);
 
// public for cuda

    void Reflux (MultiFab& mf, const MultiFab& volume, Orientation face,
                 Real scale, int scomp, int dcomp, int nc, const Geometry& geom);
 
private:

    IntVect ratio;

    int fine_level;

    int ncomp;
};
 
}
 
#endif /*_FLUXREGISTER_H_*/