ERF_NullMoist.H

Go to the documentation of this file.

#ifndef ERF_NULLMOIST_H
#define ERF_NULLMOIST_H
 
#include <AMReX_MultiFabUtil.H>
#include <AMReX_iMultiFab.H>
#include <AMReX_Geometry.H>
#include <ERF_DataStruct.H>
#include "ERF_SurfacePrecipitation.H"
#include "ERF_SedimentationFlux.H"
 
class NullMoist {
 
public:
    NullMoist () {}
 
    virtual ~NullMoist () = default;
 
    virtual
    void
    Define (SolverChoice& /*sc*/) { }
 
    virtual
    void Init (const amrex::MultiFab& /*cons_in*/,
               const amrex::BoxArray& /*grids*/,
               const amrex::Geometry& /*geom*/,
               const amrex::Real& /*dt_advance*/,
               std::unique_ptr<amrex::MultiFab>& /*z_phys_nd*/,
               std::unique_ptr<amrex::MultiFab>& /*detJ_cc*/) { }
 
    virtual
    void
    Advance (const amrex::Real& /*dt_advance*/,
             const SolverChoice& /*solverChoce*/) { }
 
    virtual
    void
    Update_Micro_Vars (amrex::MultiFab& /*cons_in*/) { }
 
    // Optional explicit anelastic thermodynamic context.  The default routes
    // to the legacy model entry point so non-SatAdj models retain behavior.
    virtual
    void
    Update_Micro_Vars (amrex::MultiFab& cons_in,
                       const amrex::MultiFab* /*base_state*/) {
        Update_Micro_Vars(cons_in);
    }
 
    virtual
    void
    Update_State_Vars (amrex::MultiFab& /*cons_in*/,
                       const amrex::MultiFab& /*z_phys_nd*/) { }
 
    virtual
    void
    Copy_State_to_Micro (const amrex::MultiFab& /*cons_in*/) { }
 
    virtual
    void
    Copy_Micro_to_State (amrex::MultiFab& /*cons_in*/) { }
 
    virtual
    amrex::MultiFab*
    Qmoist_Ptr (const int& /*varIdx*/ ) { return nullptr; }
 
    virtual
    int
    Qmoist_Size () { return NullMoist::m_qmoist_size; }
 
    virtual
    int
    Qstate_Moist_Size () { return NullMoist::m_qstate_moist_size; }
 
    virtual
    int
    Qstate_Moist_NumConc_Size () { return NullMoist::m_qstate_moist_numconc_size; }
 
    virtual
    int
    Qstate_NonMoist_Size () { return NullMoist::m_qstate_nonmoist_size; }
 
    virtual
    void
    Qmoist_Restart_Vars ( const SolverChoice&, std::vector<int>& a_idx, std::vector<std::string>& a_names) const
    {
        a_idx.clear();
        a_names.clear();
    }
 
    virtual
    void
    GetPlotVarNames (amrex::Vector<std::string>& a_vec) const
    {
        a_vec.resize(0);
    }
 
    virtual
    void
    GetPlotVar (const std::string& /* a_name */,
                amrex::MultiFab& /* a_mf */ ) const
    {
        amrex::Abort("NullMoist::GetPlotVar() should never be called.");
    }
 
    virtual
    void
    GetPlotVar (const std::string& a_name,
                amrex::MultiFab& a_mf,
                const int /*a_lev*/) const
    {
        GetPlotVar(a_name, a_mf);
    }
 
    virtual
    void
    SetCurrentLevel (const int& lev)
    {
        AMREX_ALWAYS_ASSERT(lev >= 0);
        m_level = lev;
    }
 
    virtual
    void
    InitLevel (const int, const amrex::MultiFab&) {}
 
    virtual
    int
    getDiagnosticsInterval () const { return 0; }
 
    virtual
    void
    Set_dzmin (const amrex::Real /*dz_min*/) { }
 
    /*! \brief Import ERF's land/water mask. Only schemes whose physics branches
     *         on land vs water need to override this. */
    virtual
    void
    Set_Lmask (amrex::iMultiFab* /*lmask*/) { }
 
    virtual
    SurfacePrecipAccumulationSources
    Get_Surface_Precip_Accumulation_Ptrs (const int&) const
    {
        return {};
    }
 
    /*! \brief The sedimentation face fluxes of the most recent Advance, or null for a
     *         scheme that does not sediment (see ERF_SedimentationFlux.H) */
    virtual
    const SedimentationFlux*
    Sed_Flux () const { return nullptr; }
 
    /*! \brief The inflow through the top of a fine patch for the next Advance, or null
     *         (see ERF_SedimentationFlux.H); the caller keeps it alive for that Advance */
    virtual
    void
    Set_Sed_Inflow (const amrex::MultiFab* inflow) { m_sed_inflow = inflow; }
 
    virtual
    void
    // Current SatAdj/Kessler development paths do not trim by real width, but
    // tests still exercise Set_RealWidth(0/1/2) as a future-proof contract.
    // Keep the base hook as a no-op unless a concrete microphysics model
    // chooses to implement width-sensitive behavior.
    Set_RealWidth (const int /*real_width*/) { }
 
protected:
    // The inflow through the top of a fine patch for the current Advance (Set_Sed_Inflow)
    const amrex::MultiFab* m_sed_inflow = nullptr;
 
    void
    set_anelastic_reference_pressure_mode (const SolverChoice& sc)
    {
        if (sc.anelastic.empty()) {
            m_use_anelastic_reference_pressure = false;
        } else {
            AMREX_ALWAYS_ASSERT(
                m_level < static_cast<int>(sc.anelastic.size()));
            m_use_anelastic_reference_pressure = (sc.anelastic[m_level] == 1);
        }
    }
 
    void
    assert_base_state_available (const amrex::MultiFab* base_state) const
    {
        AMREX_ALWAYS_ASSERT_WITH_MESSAGE(
            !m_use_anelastic_reference_pressure || base_state != nullptr,
            "Anelastic microphysics requires the hydrostatic base state at copy-in");
    }
 
    int m_level{0};
    bool m_use_anelastic_reference_pressure{false};
 
private:
    int m_qmoist_size = 0;
    int m_qstate_moist_size = 0;
    int m_qstate_moist_numconc_size = 0;
    int m_qstate_nonmoist_size = 0;
};
 
#endif