OceanSurf Class Reference

#include <ERF_OceanSurf.H>

Inheritance diagram for OceanSurf:

Collaboration diagram for OceanSurf:

Public Member Functions
	OceanSurf ()=default
	~OceanSurf () override=default
void	Define (SolverChoice &) override
void	Init (const int &, const amrex::MultiFab &cons_in, const amrex::Geometry &geom, const amrex::Geometry &, amrex::Vector< amrex::BCRec > &, amrex::IntVect &, const amrex::Real &dt, amrex::Vector< amrex::Vector< std::string >> &) override
void	Advance (const double &dt) override
amrex::MultiFab *	Lsm_Data_Ptr (const int &varIdx) override
amrex::MultiFab *	Lsm_Flux_Ptr (const int &) override
amrex::Geometry	Lsm_Geom () override
int	Lsm_Data_Size () override
int	Lsm_Flux_Size () override
std::string	Lsm_DataName (const int &varIdx) override
std::string	Lsm_FluxName (const int &) override
int	Lsm_DataIndex (std::string varname) override
int	Lsm_FluxIndex (std::string) override
void	SetOceanState (const amrex::Vector< amrex::MultiFab * > *ocean_state)
const amrex::Vector< amrex::MultiFab * > *	OceanState () const
Public Member Functions inherited from NullSurf
	NullSurf ()
virtual	~NullSurf ()=default
virtual void	Advance_With_State (const int &, amrex::MultiFab &, amrex::MultiFab &, amrex::MultiFab &, amrex::MultiFab *, amrex::MultiFab *, const SurfacePrecipAccumulationSources &, const amrex::Real &, const amrex::Real &, const int &, const bool)
virtual void	Plot_Landfile (const int &)
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 &)
virtual std::unordered_map< std::string, std::string > &	Lsm_WRFInputNames ()
virtual void	Lsm_Set_Lev0_Data_Ptr (const int &, amrex::MultiFab *)
virtual void	Lsm_Set_Lev0_Flux_Ptr (const int &, amrex::MultiFab *)
virtual bool	Get_Update_Status ()
virtual int	Get_LSM_Step () const
virtual void	Set_LSM_Step (int)
virtual void	Write_Lsm_Restart (const std::string &) const
virtual void	Read_Lsm_Restart (const std::string &)

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::Vector< FabPtr >	lsm_fab_data
amrex::Geometry	m_lsm_geom
double	m_dt {0.0}
int	khi_lsm {0}
amrex::Real	m_default_tsurf {amrex::Real(300.0)}
const amrex::Vector< amrex::MultiFab * > *	m_ocean_state = nullptr

Member Typedef Documentation

FabPtr

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

private

Constructor & Destructor Documentation

OceanSurf()

OceanSurf::OceanSurf ( )

default

~OceanSurf()

OceanSurf::~OceanSurf ( )

overridedefault

Member Function Documentation

Advance()

void OceanSurf::Advance ( const double &  dt )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        // OceanSurf currently does not evolve internal state here; keep the
        // latest timestep for bookkeeping so this stays aligned with other LSMs.
        m_dt = dt;
    }

Define()

void OceanSurf::Define ( SolverChoice &  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        amrex::ParmParse pp("erf");
        m_default_tsurf = amrex::Real(300.0);
        pp.query("most.surf_temp", m_default_tsurf);
    }

Here is the call graph for this function:

Init()

void OceanSurf::Init ( const int &  , const amrex::MultiFab &  cons_in, const amrex::Geometry &  geom, const amrex::Geometry &  , amrex::Vector< amrex::BCRec > &  , amrex::IntVect &  , const amrex::Real &  dt, amrex::Vector< amrex::Vector< std::string >> &    )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        m_dt = dt;
        m_lsm_geom = geom;
 
        amrex::Box domain = geom.Domain();
        khi_lsm    = domain.smallEnd(2);
 
        LsmVarMap.resize(m_lsm_size);
        LsmVarMap = {LsmVar_OceanSurf::t_surf};
 
        LsmVarName.resize(m_lsm_size);
        LsmVarName = {"t_surf"};
 
        amrex::IntVect ng(1,1,0);
        amrex::BoxArray ba = cons_in.boxArray();
        amrex::DistributionMapping dm = cons_in.DistributionMap();
        amrex::BoxList bl_lsm = ba.boxList();
        for (auto& b : bl_lsm) {
            b.setRange(2,0);
        }
        amrex::BoxArray ba_lsm(std::move(bl_lsm));
 
        const amrex::RealBox& dom_rb = geom.ProbDomain();
        amrex::RealBox lsm_rb = dom_rb;
        lsm_rb.setHi(2, dom_rb.hi(2));
        lsm_rb.setLo(2, dom_rb.lo(2));
        m_lsm_geom.define(ba_lsm.minimalBox(), lsm_rb, geom.Coord(), geom.isPeriodic());
 
        lsm_fab_data.resize(m_lsm_size);
        lsm_fab_data[0] = std::make_shared<amrex::MultiFab>(ba_lsm, dm, 1, ng);
        lsm_fab_data[0]->setVal(m_default_tsurf);
    }

Lsm_Data_Ptr()

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

inlineoverridevirtual

Reimplemented from NullSurf.

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

Here is the call graph for this function:

Lsm_Data_Size()

int OceanSurf::Lsm_Data_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return OceanSurf::m_lsm_size; }

Lsm_DataIndex()

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

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        std::string lc_varname = amrex::toLower(varname);
        if (lc_varname == "t_surf" || lc_varname == "theta") {
            return 0;
        }
        return -1;
    }

Lsm_DataName()

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

inlineoverridevirtual

Reimplemented from NullSurf.

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

Here is the call graph for this function:

Lsm_Flux_Ptr()

amrex::MultiFab* OceanSurf::Lsm_Flux_Ptr ( const int &  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        return nullptr;
    }

Lsm_Flux_Size()

int OceanSurf::Lsm_Flux_Size ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return 0; }

Lsm_FluxIndex()

int OceanSurf::Lsm_FluxIndex ( std::string  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        return -1;
    }

Lsm_FluxName()

std::string OceanSurf::Lsm_FluxName ( const int &  )

inlineoverridevirtual

Reimplemented from NullSurf.

    {
        return "";
    }

Lsm_Geom()

amrex::Geometry OceanSurf::Lsm_Geom ( )

inlineoverridevirtual

Reimplemented from NullSurf.

{ return m_lsm_geom; }

OceanState()

const amrex::Vector<amrex::MultiFab*>* OceanSurf::OceanState ( ) const

inline

    {
        return m_ocean_state;
    }

SetOceanState()

void OceanSurf::SetOceanState ( const amrex::Vector< amrex::MultiFab * > *  ocean_state )

inline

    {
        // This pointer is currently packed and filled by ERF_Coupling.cpp.
        m_ocean_state = ocean_state;
    }

Member Data Documentation

khi_lsm

int OceanSurf::khi_lsm {0}

private

Referenced by Init().

lsm_fab_data

amrex::Vector<FabPtr> OceanSurf::lsm_fab_data

private

Referenced by Init(), and Lsm_Data_Ptr().

LsmVarMap

amrex::Vector<int> OceanSurf::LsmVarMap

private

Referenced by Init(), Lsm_Data_Ptr(), and Lsm_DataName().

LsmVarName

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

private

Referenced by Init(), and Lsm_DataName().

m_default_tsurf

amrex::Real OceanSurf::m_default_tsurf {amrex::Real(300.0)}

private

Referenced by Define(), and Init().

m_dt

double OceanSurf::m_dt {0.0}

private

Referenced by Advance(), and Init().

m_lsm_geom

amrex::Geometry OceanSurf::m_lsm_geom

private

Referenced by Init(), and Lsm_Geom().

m_lsm_size

int OceanSurf::m_lsm_size = 1

private

Referenced by Init(), and Lsm_Data_Size().

m_ocean_state

const amrex::Vector<amrex::MultiFab*>* OceanSurf::m_ocean_state = nullptr

private

Referenced by OceanState(), and SetOceanState().

---

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

• Source/LandSurfaceModel/OceanSurf/ERF_OceanSurf.H