NOAH Class Reference

#include <ERF_NOAH.H>

Inheritance diagram for NOAH:

Collaboration diagram for NOAH:

Public Member Functions
	NOAH ()
virtual	~NOAH ()=default
void	Define (SolverChoice &) override
void	Init (const amrex::MultiFab &cons_in, const amrex::Geometry &geom, const amrex::Real &dt) override
void	Advance (const int &lev, amrex::MultiFab &cons_in, amrex::MultiFab &xvel_in, amrex::MultiFab &yvel_in, amrex::MultiFab *hfx3_out, amrex::MultiFab *qfx3_out, const amrex::Real &dt, const int &nstep) override
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	Advance (const amrex::Real &)
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_NOAH::NumVars >	lsm_fab_vars
amrex::Array< FabPtr, LsmVar_NOAH::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 = 400.0
amrex::Real	m_d_soil = m_k_soil / m_cp_soil
NoahmpIO_vector	noahmpio_vect

Member Typedef Documentation

FabPtr

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

private

Constructor & Destructor Documentation

NOAH()

NOAH::NOAH ( )

inline

{}

~NOAH()

virtual NOAH::~NOAH ( )

virtualdefault

Member Function Documentation

Advance()

void NOAH::Advance ( const int &  lev, amrex::MultiFab &  cons_in, amrex::MultiFab &  xvel_in, amrex::MultiFab &  yvel_in, amrex::MultiFab *  hfx3_out, amrex::MultiFab *  qfx3_out, const amrex::Real &  dt, const int &  nstep  )

overridevirtual

Reimplemented from NullSurf.

                                 {
 
    Box domain = m_geom.Domain();
 
    amrex::Print () << "Noah-MP driver started at time step: " << nstep+1 << std::endl;
 
    // Loop over blocks to copy forcing data to Noahmp, drive the land model,
    // and copy data back to ERF Multifabs.
    int idb = 0;
    for (amrex::MFIter mfi(xvel_in, false); mfi.isValid(); ++mfi, ++idb) {
 
        const amrex::Box& bx = mfi.tilebox();
 
        // Check if tile is at the lower boundary in lower z direction
        if (bx.smallEnd(2) == domain.smallEnd(2)) {
 
            NoahmpIO_type* noahmpio = &noahmpio_vect[idb];
 
            const amrex::Array4<const amrex::Real>& U_PHY = xvel_in.const_array(mfi);
            const amrex::Array4<const amrex::Real>& V_PHY = yvel_in.const_array(mfi);
            const amrex::Array4<const amrex::Real>& QV_TH = cons_in.const_array(mfi);
 
            amrex::Array4<amrex::Real> SHBXY = hfx3_out->array(mfi);
            amrex::Array4<amrex::Real> EVBXY = qfx3_out->array(mfi);
 
            // Copy forcing data from ERF to Noahmp.
            ParallelFor(bx, [=] AMREX_GPU_DEVICE (int i, int j, int ) noexcept
            {
                noahmpio->U_PHY(i,1,j) = U_PHY(i,j,0);
                noahmpio->V_PHY(i,1,j) = V_PHY(i,j,0);
                noahmpio->T_PHY(i,1,j) = QV_TH(i,j,0,RhoTheta_comp)/QV_TH(i,j,0,Rho_comp);
                noahmpio->QV_CURR(i,1,j) = QV_TH(i,j,0,RhoQ1_comp)/QV_TH(i,j,0,Rho_comp);
 
            });
 
            // Call the noahmpio driver code. This runs the land model forcing for
            // each object in noahmpio_vect that represent a block in the domain.
            noahmpio->itimestep = nstep+1;
            noahmpio->DriverMain();
 
            // Copy forcing data from Noahmp to ERF
            ParallelFor(bx, [=] AMREX_GPU_DEVICE (int i, int j, int ) noexcept
            {
                SHBXY(i,j,0) = noahmpio->SHBXY(i,j);
                EVBXY(i,j,0) = noahmpio->EVBXY(i,j);
            });
        }
    }
    amrex::Print () << "Noah-MP driver completed" << std::endl;
};

Define()

void NOAH::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 NOAH::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_NOAH::theta};
 
    LsmVarName.resize(m_lsm_size);
    LsmVarName = {"theta"};
 
    // NOTE: lsm data is not used for Noahmp, however, the initialization is done
    //       to maintin consistency with IO and Driver interfaces that depend on
    //       this data. We eventually want to tweak those interfaces so we don't
    //       have to allocate lsm_data while using Noahmp lsm.
 
    // 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_NOAH::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.);
    }
 
    // NOTE: Actual NoahmpIO interface that is relevant for the
    //       implementation of this lsm
 
    amrex::Print() << "Noah-MP initialization started" << std::endl;
 
    // Set noahmpio_vect to the size of local blocks (boxes)
    noahmpio_vect.resize(cons_in.local_size());
 
    // Iterate over multifab and noahmpio object together. Multifabs is
    // used to extract size of blocks and set bounds for noahmpio objects.
    int idb = 0;
    for (amrex::MFIter mfi(cons_in, false); mfi.isValid(); ++mfi, ++idb) {
 
        // Get bounds for the tile
        const amrex::Box& bx = mfi.tilebox();
 
        // Check if tile is at the lower boundary in lower z direction
        if (bx.smallEnd(2) == domain.smallEnd(2)) {
 
            // Get reference to the noahmpio object
            NoahmpIO_type* noahmpio = &noahmpio_vect[idb];
 
            // Pass idb context to noahmpio
            noahmpio->blkid = idb;
 
            // Initialize scalar values
            noahmpio->ScalarInitDefault();
 
            // Store the rank of process for noahmp
            noahmpio->rank = amrex::ParallelDescriptor::MyProc();
 
            // Read namelist.erf file. This file contains
            // noahmpio specific parameters and is read by
            // the Fortran side of the implementation.
            noahmpio->ReadNamelist();
 
            // Read the headers from the NetCDF land file. This is also
            // implemented on the Fortran side of things currently.
            noahmpio->ReadLandHeader();
 
            // Extract tile bounds and set them to their corresponding
            // noahmpio variables. At present we will set all the variables
            // corresponding to domain, memory, and tile to the same bounds.
            // This will be changed later if we want to do special memory
            // management for expensive use cases.
            noahmpio->xstart = bx.smallEnd(0);
            noahmpio->xend = bx.bigEnd(0);
            noahmpio->ystart = bx.smallEnd(1);
            noahmpio->yend = bx.bigEnd(1);
 
            // Domain bounds
            noahmpio->ids = noahmpio->xstart;
            noahmpio->ide = noahmpio->xend;
            noahmpio->jds = noahmpio->ystart;
            noahmpio->jde = noahmpio->yend;
            noahmpio->kds = 1;
            noahmpio->kde = 2;
 
            // Tile bounds
            noahmpio->its = noahmpio->xstart;
            noahmpio->ite = noahmpio->xend;
            noahmpio->jts = noahmpio->ystart;
            noahmpio->jte = noahmpio->yend;
            noahmpio->kts = 1;
            noahmpio->kte = 2;
 
            // Memory bounds
            noahmpio->ims = noahmpio->xstart;
            noahmpio->ime = noahmpio->xend;
            noahmpio->jms = noahmpio->ystart;
            noahmpio->jme = noahmpio->yend;
            noahmpio->kms = 1;
            noahmpio->kme = 2;
 
            // This procedure allocates memory in Fortran for IO variables
            // using bounds that are set above and read from namelist.erf
            // and headers from the NetCDF land file
            noahmpio->VarInitDefault();
 
            // This reads NoahmpTable.TBL file which is another input file
            // we need to set some IO variables.
            noahmpio->ReadTable();
 
            // Read and initialize data from the NetCDF land file.
            noahmpio->ReadLandMain();
 
            // Compute additional initial values that were not supplied
            // by the NetCDF land file.
            noahmpio->InitMain();
        }
  }
 
  amrex::Print() << "Noah-MP initialization completed" << std::endl;
 
};

Lsm_Data_Ptr()

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

inlineoverridevirtual

Reimplemented from NullSurf.

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

Lsm_Data_Size()

int NOAH::Lsm_Data_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return NOAH::m_lsm_size; }

Lsm_Flux_Ptr()

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

inlineoverridevirtual

Reimplemented from NullSurf.

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

Lsm_Geom()

amrex::Geometry NOAH::Lsm_Geom ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return m_lsm_geom; }

Lsm_VarName()

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

inlineoverridevirtual

Reimplemented from NullSurf.

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

Member Data Documentation

khi_lsm

int NOAH::khi_lsm

private

lsm_fab_flux

amrex::Array<FabPtr, LsmVar_NOAH::NumVars> NOAH::lsm_fab_flux

private

Referenced by Lsm_Flux_Ptr().

lsm_fab_vars

amrex::Array<FabPtr, LsmVar_NOAH::NumVars> NOAH::lsm_fab_vars

private

Referenced by Lsm_Data_Ptr().

LsmVarMap

amrex::Vector<int> NOAH::LsmVarMap

private

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

LsmVarName

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

private

Referenced by Lsm_VarName().

m_cp_soil

amrex::Real NOAH::m_cp_soil = 1.26e6

private

m_d_soil

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

private

m_dt

amrex::Real NOAH::m_dt

private

m_dz_lsm

amrex::Real NOAH::m_dz_lsm = 0.1

private

m_geom

amrex::Geometry NOAH::m_geom

private

m_k_soil

amrex::Real NOAH::m_k_soil = 0.2

private

m_lsm_geom

amrex::Geometry NOAH::m_lsm_geom

private

Referenced by Lsm_Geom().

m_lsm_size

int NOAH::m_lsm_size = 1

private

Referenced by Lsm_Data_Size().

m_nz_lsm

int NOAH::m_nz_lsm = 30

private

m_theta_dir

amrex::Real NOAH::m_theta_dir = 400.0

private

noahmpio_vect

NoahmpIO_vector NOAH::noahmpio_vect

private

---

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

• Source/LandSurfaceModel/NOAH/ERF_NOAH.H
• Source/LandSurfaceModel/NOAH/ERF_NOAH.cpp