NOAHMP Class Reference

#include <ERF_NOAHMP.H>

Inheritance diagram for NOAHMP:

Collaboration diagram for NOAHMP:

Public Member Functions
	NOAHMP ()
virtual	~NOAHMP ()=default
void	Define (SolverChoice &) override
void	Init (const int &lev, const amrex::MultiFab &cons_in, const amrex::Geometry &geom, const amrex::Real &dt) override
void	Advance_With_State (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
int	Lsm_Flux_Size () override
std::string	Lsm_DataName (const int &varIdx) override
int	Lsm_DataIndex (std::string varname) override
std::string	Lsm_FluxName (const int &varIdx) override
int	Lsm_FluxIndex (std::string varname) 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_data_size = LsmData_NOAHMP::NumVars
int	m_lsm_flux_size = LsmFlux_NOAHMP::NumVars
amrex::Vector< int >	LsmDataMap
amrex::Vector< int >	LsmFluxMap
amrex::Vector< std::string >	LsmDataName
amrex::Vector< std::string >	LsmFluxName
amrex::Geometry	m_geom
amrex::Geometry	m_lsm_geom
amrex::Real	m_dt
int	khi_lsm
int	m_nz_lsm = 1
amrex::Real	m_dz_lsm = 1.0
amrex::Array< FabPtr, LsmData_NOAHMP::NumVars >	lsm_fab_data
amrex::Array< FabPtr, LsmFlux_NOAHMP::NumVars >	lsm_fab_flux
NoahmpIO_vector	noahmpio_vect
int	m_plot_int_1 = -1

Member Typedef Documentation

FabPtr

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

private

Constructor & Destructor Documentation

NOAHMP()

NOAHMP::NOAHMP ( )

inline

{}

~NOAHMP()

virtual NOAHMP::~NOAHMP ( )

virtualdefault

Member Function Documentation

Advance_With_State()

void NOAHMP::Advance_With_State ( 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();
 
    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 (MFIter mfi(cons_in, false); mfi.isValid(); ++mfi, ++idb) {
 
        const 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 Array4<const Real>& U_PHY  = xvel_in.const_array(mfi);
            const Array4<const Real>& V_PHY  = yvel_in.const_array(mfi);
            const Array4<const Real>& QV_TH  = cons_in.const_array(mfi);
 
            // Into NOAH-MP
            const Array4<const Real>& SWDOWN = lsm_fab_data[LsmData_NOAHMP::sw_flux_dn]->const_array(mfi);
            const Array4<const Real>& GLW    = lsm_fab_data[LsmData_NOAHMP::lw_flux_dn]->const_array(mfi);
            const Array4<const Real>& COSZEN = lsm_fab_data[LsmData_NOAHMP::cos_zenith_angle]->const_array(mfi);
 
            // Out of NOAH-MP
            Array4<Real> TSK           = lsm_fab_data[LsmData_NOAHMP::t_sfc]->array(mfi);
            Array4<Real> EMISS         = lsm_fab_data[LsmData_NOAHMP::sfc_emis]->array(mfi);
            Array4<Real> ALBSFCDIR_VIS = lsm_fab_data[LsmData_NOAHMP::sfc_alb_dir_vis]->array(mfi);
            Array4<Real> ALBSFCDIR_NIR = lsm_fab_data[LsmData_NOAHMP::sfc_alb_dir_nir]->array(mfi);
            Array4<Real> ALBSFCDIF_VIS = lsm_fab_data[LsmData_NOAHMP::sfc_alb_dif_vis]->array(mfi);
            Array4<Real> ALBSFCDIF_NIR = lsm_fab_data[LsmData_NOAHMP::sfc_alb_dif_nir]->array(mfi);
 
            // NOTE: Need to expose stresses and get stresses from NOAHMP
            Array4<Real> q_flux_arr    = lsm_fab_flux[LsmFlux_NOAHMP::q_flux]->array(mfi);
            Array4<Real> t_flux_arr    = lsm_fab_flux[LsmFlux_NOAHMP::t_flux]->array(mfi);
            //Array4<Real> tau13_arr     = lsm_fab_flux[LsmFlux_NOAHMP::tau13]->array(mfi);
            //Array4<Real> tau23_arr     = lsm_fab_flux[LsmFlux_NOAHMP::tau23]->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)   = 0.5*(U_PHY(i,j,0)+U_PHY(i+1,j  ,0));
                noahmpio->V_PHY(i,1,j)   = 0.5*(V_PHY(i,j,0)+V_PHY(i  ,j+1,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);
                noahmpio->SWDOWN(i,j)    = SWDOWN(i,j,0);
                noahmpio->GLW(i,j)       = GLW(i,j,0);
                noahmpio->COSZEN(i,j)    = COSZEN(i,j,0);
            });
 
            // 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
            {
                q_flux_arr(i,j,0) = noahmpio->SHBXY(i,j);
                t_flux_arr(i,j,0) = noahmpio->EVBXY(i,j);
                TSK(i,j,0)        = noahmpio->TSK(i,j);
                EMISS(i,j,0)      = noahmpio->EMISS(i,j);
                ALBSFCDIR_VIS(i,j,0) = noahmpio->ALBSFCDIRXY(i,1,j);
                ALBSFCDIR_NIR(i,j,0) = noahmpio->ALBSFCDIRXY(i,2,j);
                ALBSFCDIF_VIS(i,j,0) = noahmpio->ALBSFCDIFXY(i,1,j);
                ALBSFCDIF_NIR(i,j,0) = noahmpio->ALBSFCDIFXY(i,2,j);
            });
 
            if((nstep+1)%m_plot_int_1 == 0) {
                noahmpio->WriteLand(nstep+1);
            }
        }
    }
    Print () << "Noah-MP driver completed" << std::endl;
};

Define()

void NOAHMP::Define ( SolverChoice &  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        // NOTE: We should parse constants from sc here if needed,
    }

Init()

void NOAHMP::Init ( const int &  lev, 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;
 
    LsmDataMap.resize(m_lsm_data_size);
    LsmDataMap = {LsmData_NOAHMP::t_sfc           , LsmData_NOAHMP::sfc_emis       ,
                  LsmData_NOAHMP::sfc_alb_dir_vis , LsmData_NOAHMP::sfc_alb_dir_nir,
                  LsmData_NOAHMP::sfc_alb_dif_vis , LsmData_NOAHMP::sfc_alb_dif_nir,
                  LsmData_NOAHMP::cos_zenith_angle, LsmData_NOAHMP::sw_flux_dn     ,
                  LsmData_NOAHMP::lw_flux_dn                                        };
    LsmDataName.resize(m_lsm_data_size);
    LsmDataName = {"t_sfc"          , "sfc_emis"         ,
                   "sfc_alb_dir_vis" , "sfc_alb_dir_nir" ,
                   "sfc_alb_dif_vis" , "sfc_alb_dif_nir" ,
                   "cos_zenith_angle", "sw_flux_dn"      ,
                   "lw_flux_dn"      };
 
 
    LsmFluxMap.resize(m_lsm_flux_size);
    LsmFluxMap = {LsmFlux_NOAHMP::q_flux         , LsmFlux_NOAHMP::t_flux         ,
                  LsmFlux_NOAHMP::tau13          , LsmFlux_NOAHMP::tau23          };
    LsmFluxName.resize(m_lsm_flux_size);
    LsmFluxName = {"t_flux"         , "q_flux"         ,
                   "tau13"          , "tau23"          };
 
    ParmParse pp("erf");
    pp.query("plot_int_1" , m_plot_int_1);
 
    // 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 2D box array for lsm data
    IntVect ng(0,0,0);
    BoxArray ba = cons_in.boxArray();
    DistributionMapping dm = cons_in.DistributionMap();
    BoxList bl_lsm = ba.boxList();
    for (auto& b : bl_lsm) {
        b.setRange(2,0);
    }
    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
    for (auto ivar = 0; ivar < LsmData_NOAHMP::NumVars; ++ivar) {
        // State vars are CC
        lsm_fab_data[ivar] = std::make_shared<MultiFab>(ba_lsm, dm, 1, ng);
 
        // NOTE: Radiation steps first so we set values
        //       to reasonable initialization for coupling
        Real val_to_set = 0.0;
        if (ivar == LsmData_NOAHMP::t_sfc) {
            val_to_set = 300.0;
        } else if (ivar == LsmData_NOAHMP::sfc_emis) {
            val_to_set = 0.9;
        } else if ( (ivar>=LsmData_NOAHMP::sfc_alb_dir_vis) &&
                    (ivar<=LsmData_NOAHMP::sfc_alb_dif_nir) ) {
            val_to_set = 0.06;
        } else {
            val_to_set = 0.0;
        }
        lsm_fab_data[ivar]->setVal(val_to_set);
    }
 
    // Create the fluxes
    for (auto ivar = 0; ivar < LsmFlux_NOAHMP::NumVars; ++ivar) {
        // NOTE: Fluxes are CC with ghost cells for averaging
        lsm_fab_flux[ivar] = std::make_shared<MultiFab>(ba_lsm, dm, 1, IntVect(1,1,0));
        lsm_fab_flux[ivar]->setVal(0.);
    }
 
    Print() << "Noah-MP initialization started" << std::endl;
 
    // Set noahmpio_vect to the size of local blocks (boxes)
    noahmpio_vect.resize(cons_in.local_size(), lev);
 
    // 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 (MFIter mfi(cons_in, false); mfi.isValid(); ++mfi, ++idb) {
 
        // Get bounds for the tile
        const 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;
 
            // Pass level context to noahmpio
            noahmpio->level = lev;
 
            // Initialize scalar values
            noahmpio->ScalarInitDefault();
 
            // Store the rank of process for noahmp
            noahmpio->rank = ParallelDescriptor::MyProc();
 
            // Store parallel communicator for noahmp
            noahmpio->comm = MPI_Comm_c2f(ParallelDescriptor::Communicator());
 
            // 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();
 
            // Write initial plotfile for land with the tag 0
            Print() << "Noah-MP writing lnd.nc file at lev: " << lev << std::endl;
            noahmpio->WriteLand(0);
        }
  }
 
  Print() << "Noah-MP initialization completed" << std::endl;
 
};

Here is the call graph for this function:

Lsm_Data_Ptr()

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

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmDataMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < NOAHMP::m_lsm_data_size && lsmIdx>=0);
        return lsm_fab_data[lsmIdx].get();
    }

Lsm_Data_Size()

int NOAHMP::Lsm_Data_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return NOAHMP::m_lsm_data_size; }

Lsm_DataIndex()

int NOAHMP::Lsm_DataIndex ( std::string  varname )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int varIdx = -1;
        std::string lc_varname = amrex::toLower(varname);
        for (int idx(0); idx<LsmData_NOAHMP::NumVars; ++idx) {
            if (lc_varname == amrex::toLower(LsmDataName[idx])) {
                varIdx = idx;
            }
        }
        return varIdx;
    }

Lsm_DataName()

std::string NOAHMP::Lsm_DataName ( const int &  varIdx )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmDataMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < NOAHMP::m_lsm_data_size && lsmIdx>=0);
        return LsmDataName[lsmIdx];
    }

Lsm_Flux_Ptr()

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

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmFluxMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < NOAHMP::m_lsm_flux_size && lsmIdx>=0);
        return lsm_fab_flux[lsmIdx].get();
    }

Lsm_Flux_Size()

int NOAHMP::Lsm_Flux_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return NOAHMP::m_lsm_flux_size; }

Lsm_FluxIndex()

int NOAHMP::Lsm_FluxIndex ( std::string  varname )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int varIdx = -1;
        std::string lc_varname = amrex::toLower(varname);
        for (int idx(0); idx<LsmFlux_NOAHMP::NumVars; ++idx) {
            if (lc_varname == amrex::toLower(LsmFluxName[idx])) {
                varIdx = idx;
            }
        }
        return varIdx;
    }

Lsm_FluxName()

std::string NOAHMP::Lsm_FluxName ( const int &  varIdx )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        int lsmIdx = LsmFluxMap[varIdx];
        AMREX_ALWAYS_ASSERT(lsmIdx < NOAHMP::m_lsm_flux_size && lsmIdx>=0);
        return LsmFluxName[lsmIdx];
    }

Lsm_Geom()

amrex::Geometry NOAHMP::Lsm_Geom ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return m_lsm_geom; }

Member Data Documentation

khi_lsm

int NOAHMP::khi_lsm

private

lsm_fab_data

amrex::Array<FabPtr, LsmData_NOAHMP::NumVars> NOAHMP::lsm_fab_data

private

Referenced by Lsm_Data_Ptr().

lsm_fab_flux

amrex::Array<FabPtr, LsmFlux_NOAHMP::NumVars> NOAHMP::lsm_fab_flux

private

Referenced by Lsm_Flux_Ptr().

LsmDataMap

amrex::Vector<int> NOAHMP::LsmDataMap

private

Referenced by Lsm_Data_Ptr(), and Lsm_DataName().

LsmDataName

amrex::Vector<std::string> NOAHMP::LsmDataName

private

Referenced by Lsm_DataIndex(), and Lsm_DataName().

LsmFluxMap

amrex::Vector<int> NOAHMP::LsmFluxMap

private

Referenced by Lsm_Flux_Ptr(), and Lsm_FluxName().

LsmFluxName

amrex::Vector<std::string> NOAHMP::LsmFluxName

private

Referenced by Lsm_FluxIndex(), and Lsm_FluxName().

m_dt

amrex::Real NOAHMP::m_dt

private

m_dz_lsm

amrex::Real NOAHMP::m_dz_lsm = 1.0

private

m_geom

amrex::Geometry NOAHMP::m_geom

private

m_lsm_data_size

int NOAHMP::m_lsm_data_size = LsmData_NOAHMP::NumVars

private

Referenced by Lsm_Data_Size().

m_lsm_flux_size

int NOAHMP::m_lsm_flux_size = LsmFlux_NOAHMP::NumVars

private

Referenced by Lsm_Flux_Size().

m_lsm_geom

amrex::Geometry NOAHMP::m_lsm_geom

private

Referenced by Lsm_Geom().

m_nz_lsm

int NOAHMP::m_nz_lsm = 1

private

m_plot_int_1

int NOAHMP::m_plot_int_1 = -1

private

noahmpio_vect

NoahmpIO_vector NOAHMP::noahmpio_vect

private

---

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

• Source/LandSurfaceModel/Noah-MP/ERF_NOAHMP.H
• Source/LandSurfaceModel/Noah-MP/ERF_NOAHMP.cpp