MM5 Class Reference

#include <ERF_MM5.H>

Inheritance diagram for MM5:

Collaboration diagram for MM5:

Public Member Functions
	MM5 ()
virtual	~MM5 ()=default
void	Define (SolverChoice &) override
void	Init (const amrex::MultiFab &cons_in, const amrex::Geometry &geom, const amrex::Real &dt) override
void	Advance (const amrex::Real &dt) override
void	ComputeTsurf ()
void	ComputeFluxes ()
void	AdvanceMM5 ()
amrex::MultiFab *	Lsm_Data_Ptr (const int &varIdx) override
amrex::MultiFab *	Lsm_Flux_Ptr (const int &varIdx) override
amrex::Geometry	Lsm_Geom () override
int	Lsm_Data_Size () override
std::string	Lsm_VarName (const int &varIdx) override
Public Member Functions inherited from NullSurf
	NullSurf ()
virtual	~NullSurf ()=default
virtual void	Update_Micro_Vars (amrex::MultiFab &)
virtual void	Update_State_Vars (amrex::MultiFab &)
virtual void	Copy_State_to_Micro (const amrex::MultiFab &)
virtual void	Copy_Micro_to_State (amrex::MultiFab &)

Private Types
using	FabPtr = std::shared_ptr< amrex::MultiFab >

Private Attributes
int	m_lsm_size = 1
amrex::Vector< int >	LsmVarMap
amrex::Vector< std::string >	LsmVarName
amrex::Geometry	m_geom
amrex::Geometry	m_lsm_geom
amrex::Real	m_dt
int	khi_lsm
amrex::Array< FabPtr, LsmVar_MM5::NumVars >	lsm_fab_vars
amrex::Array< FabPtr, LsmVar_MM5::NumVars >	lsm_fab_flux
int	m_nz_lsm = 30
amrex::Real	m_dz_lsm = 0.1
amrex::Real	m_cp_soil = 1.26e6
amrex::Real	m_k_soil = 0.2
amrex::Real	m_theta_dir = 300.0
amrex::Real	m_d_soil = m_k_soil / m_cp_soil

Member Typedef Documentation

FabPtr

using MM5::FabPtr = std::shared_ptr<amrex::MultiFab>

private

Constructor & Destructor Documentation

MM5()

MM5::MM5 ( )

inline

{}

~MM5()

virtual MM5::~MM5 ( )

virtualdefault

Member Function Documentation

Advance()

void MM5::Advance ( const amrex::Real &  dt )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        m_dt = dt;
        this->ComputeFluxes();
        this->AdvanceMM5();
        this->ComputeTsurf();
    }

Here is the call graph for this function:

AdvanceMM5()

void MM5::AdvanceMM5

(

)

{
    // Expose for GPU copy
    Real dt = m_dt;
    Real dzInv = m_lsm_geom.InvCellSize(2);
 
    for ( MFIter mfi(*(lsm_fab_vars[LsmVar_MM5::theta])); mfi.isValid(); ++mfi) {
        auto box3d = mfi.tilebox();
 
        auto theta_array = lsm_fab_vars[LsmVar_MM5::theta]->array(mfi);
        auto theta_flux  = lsm_fab_flux[LsmVar_MM5::theta]->array(mfi);
 
        ParallelFor( box3d, [=] AMREX_GPU_DEVICE (int i, int j, int k)
        {
            theta_array(i,j,k) += dt * ( theta_flux(i,j,k+1) - theta_flux(i,j,k) ) * dzInv;
        });
    }
}

Referenced by Advance().

Here is the caller graph for this function:

ComputeFluxes()

void MM5::ComputeFluxes

(

)

{
    // Expose for GPU copy
    int khi = khi_lsm;
    Real Dsoil = m_d_soil;
    Real dzInv = m_lsm_geom.InvCellSize(2);
 
    for ( MFIter mfi(*(lsm_fab_flux[LsmVar_MM5::theta])); mfi.isValid(); ++mfi) {
        auto box3d = mfi.tilebox();
 
        // Do not overwrite the flux at the top (comes from MOST BC)
        if (box3d.bigEnd(2) == khi+1) box3d.setBig(2,khi);
 
        auto theta_array = lsm_fab_vars[LsmVar_MM5::theta]->array(mfi);
        auto theta_flux  = lsm_fab_flux[LsmVar_MM5::theta]->array(mfi);
 
        ParallelFor( box3d, [=] AMREX_GPU_DEVICE (int i, int j, int k)
        {
            theta_flux(i,j,k) = Dsoil * ( theta_array(i,j,k) - theta_array(i,j,k-1) ) * dzInv;
        });
    }
}

Referenced by Advance().

Here is the caller graph for this function:

ComputeTsurf()

void MM5::ComputeTsurf

(

)

{
    // Expose for GPU copy
    int khi = khi_lsm;
 
    for ( MFIter mfi(*(lsm_fab_vars[LsmVar_MM5::theta])); mfi.isValid(); ++mfi) {
        auto box2d = mfi.tilebox(); box2d.makeSlab(2,khi);
 
        auto theta_array = lsm_fab_vars[LsmVar_MM5::theta]->array(mfi);
 
        ParallelFor( box2d, [=] AMREX_GPU_DEVICE (int i, int j, int )
        {
            theta_array(i,j,khi+1) = 1.5*theta_array(i,j,khi) - 0.5*theta_array(i,j,khi-1);
        });
    }
}

Referenced by Advance().

Here is the caller graph for this function:

Define()

void MM5::Define ( SolverChoice &  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        // NOTE: We should parse things from sc here,
        //       but they are hard coded because this
        //       is a demonstration for now.
    }

Init()

void MM5::Init ( const amrex::MultiFab &  cons_in, const amrex::Geometry &  geom, const amrex::Real &  dt  )

overridevirtual

Reimplemented from NullSurf.

{
    m_dt = dt;
    m_geom = geom;
 
    Box domain = geom.Domain();
    khi_lsm    = domain.smallEnd(2) - 1;
 
    LsmVarMap.resize(m_lsm_size);
    LsmVarMap = {LsmVar_MM5::theta};
 
    LsmVarName.resize(m_lsm_size);
    LsmVarName = {"theta"};
 
    // NOTE: All boxes in ba extend from zlo to zhi, so this transform is valid.
    //       If that were to change, the dm and new ba are no longer valid and
    //       direct copying between lsm data/flux vars cannot be done in a parfor.
 
    // Set box array for lsm data
    IntVect ng(0,0,1);
    BoxArray ba = cons_in.boxArray();
    DistributionMapping dm = cons_in.DistributionMap();
    BoxList bl_lsm = ba.boxList();
    for (auto& b : bl_lsm) {
        b.setBig(2,khi_lsm);                  // First point below the surface
        b.setSmall(2,khi_lsm - m_nz_lsm + 1); // Last point below the surface
    }
    BoxArray ba_lsm(std::move(bl_lsm));
 
    // Set up lsm geometry
    const RealBox& dom_rb = m_geom.ProbDomain();
    const Real*    dom_dx = m_geom.CellSize();
    RealBox lsm_rb = dom_rb;
    Real lsm_dx[AMREX_SPACEDIM] = {AMREX_D_DECL(dom_dx[0],dom_dx[1],m_dz_lsm)};
    Real lsm_z_hi = dom_rb.lo(2);
    Real lsm_z_lo = lsm_z_hi - Real(m_nz_lsm)*lsm_dx[2];
    lsm_rb.setHi(2,lsm_z_hi); lsm_rb.setLo(2,lsm_z_lo);
    m_lsm_geom.define( ba_lsm.minimalBox(), lsm_rb, m_geom.Coord(), m_geom.isPeriodic() );
 
    // Create the data and fluxes
    for (auto ivar = 0; ivar < LsmVar_MM5::NumVars; ++ivar) {
        // State vars are CC
        Real theta_0 = m_theta_dir;
        lsm_fab_vars[ivar] = std::make_shared<MultiFab>(ba_lsm, dm, 1, ng);
        lsm_fab_vars[ivar]->setVal(theta_0);
 
        // Fluxes are nodal in z
        lsm_fab_flux[ivar] = std::make_shared<MultiFab>(convert(ba_lsm, IntVect(0,0,1)), dm, 1, IntVect(0,0,0));
        lsm_fab_flux[ivar]->setVal(0.);
    }
}

Lsm_Data_Ptr()

amrex::MultiFab* MM5::Lsm_Data_Ptr ( const int &  varIdx )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmVarMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < MM5::m_lsm_size && lsmIdx>=0);
        return lsm_fab_vars[lsmIdx].get();
    }

Lsm_Data_Size()

int MM5::Lsm_Data_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return MM5::m_lsm_size; }

Lsm_Flux_Ptr()

amrex::MultiFab* MM5::Lsm_Flux_Ptr ( const int &  varIdx )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmVarMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < MM5::m_lsm_size && lsmIdx>=0);
        return lsm_fab_flux[lsmIdx].get();
    }

Lsm_Geom()

amrex::Geometry MM5::Lsm_Geom ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return m_lsm_geom; }

Lsm_VarName()

std::string MM5::Lsm_VarName ( const int &  varIdx )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmVarMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < MM5::m_lsm_size && lsmIdx>=0);
        return LsmVarName[lsmIdx];
    }

Member Data Documentation

khi_lsm

int MM5::khi_lsm

private

lsm_fab_flux

amrex::Array<FabPtr, LsmVar_MM5::NumVars> MM5::lsm_fab_flux

private

Referenced by Lsm_Flux_Ptr().

lsm_fab_vars

amrex::Array<FabPtr, LsmVar_MM5::NumVars> MM5::lsm_fab_vars

private

Referenced by Lsm_Data_Ptr().

LsmVarMap

amrex::Vector<int> MM5::LsmVarMap

private

Referenced by Lsm_Data_Ptr(), Lsm_Flux_Ptr(), and Lsm_VarName().

LsmVarName

amrex::Vector<std::string> MM5::LsmVarName

private

Referenced by Lsm_VarName().

m_cp_soil

amrex::Real MM5::m_cp_soil = 1.26e6

private

m_d_soil

amrex::Real MM5::m_d_soil = m_k_soil / m_cp_soil

private

m_dt

amrex::Real MM5::m_dt

private

Referenced by Advance().

m_dz_lsm

amrex::Real MM5::m_dz_lsm = 0.1

private

m_geom

amrex::Geometry MM5::m_geom

private

m_k_soil

amrex::Real MM5::m_k_soil = 0.2

private

m_lsm_geom

amrex::Geometry MM5::m_lsm_geom

private

Referenced by Lsm_Geom().

m_lsm_size

int MM5::m_lsm_size = 1

private

Referenced by Lsm_Data_Size().

m_nz_lsm

int MM5::m_nz_lsm = 30

private

m_theta_dir

amrex::Real MM5::m_theta_dir = 300.0

private

---

The documentation for this class was generated from the following files:

• Source/LandSurfaceModel/MM5/ERF_MM5.H
• Source/LandSurfaceModel/MM5/ERF_MM5.cpp