ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_LandSurface.H
Go to the documentation of this file.
1 #ifndef ERF_LANDSURFACE_H
2 #define ERF_LANDSURFACE_H
3 
4 #include <AMReX_PlotFileUtil.H>
5 #include <AMReX_MultiFabUtil.H>
6 
7 #include <ERF_NullSurf.H>
8 #include <ERF_SLM.H>
9 #include <ERF_MM5.H>
10 
11 #if ERF_USE_NOAHMP
12 #include <ERF_NOAHMP.H>
13 #endif
14 
15 class LandSurface {
16 
17 public:
18 
19  LandSurface () { }
20 
21  ~LandSurface () = default;
22 
23  void
24  ReSize (const int& nlev) { m_lsm_model.resize(nlev); }
25 
26  template<class NewSurfModel>
27  void
29  {
30  for (int lev(0); lev<m_lsm_model.size(); ++lev) {
31  m_lsm_model[lev] = std::make_unique<NewSurfModel>();
32  }
33  }
34 
35  void
36  Define (const int& lev,
37  SolverChoice& sc)
38  {
39  m_lsm_model[lev]->Define(sc);
40  }
41 
42  void
43  Init (const int& lev,
44  const amrex::MultiFab& cons_in,
45  const amrex::Geometry& geom,
46  const amrex::Real& dt_advance)
47  {
48  m_lsm_model[lev]->Init(lev, cons_in, geom, dt_advance);
49  }
50 
51  void
52  Advance (const int& lev,
53  amrex::MultiFab& cons_in,
54  amrex::MultiFab& xvel_in,
55  amrex::MultiFab& yvel_in,
56  amrex::MultiFab* hfx3_out,
57  amrex::MultiFab* qfx3_out,
58  const amrex::Real& dt_advance,
59  const int& nstep)
60  {
61  m_lsm_model[lev]->Advance_With_State(lev, cons_in, xvel_in, yvel_in, hfx3_out, qfx3_out, dt_advance, nstep);
62  }
63 
64  void
65  Advance (const int& lev, const amrex::Real& dt_advance)
66  {
67  m_lsm_model[lev]->Advance(dt_advance);
68  }
69 
70  void
71  Update_Micro_Vars_Lev (const int& lev, amrex::MultiFab& cons_in)
72  {
73  m_lsm_model[lev]->Update_Micro_Vars(cons_in);
74  }
75 
76  void
77  Update_State_Vars_Lev (const int& lev, amrex::MultiFab& cons_in)
78  {
79  m_lsm_model[lev]->Update_State_Vars(cons_in);
80  }
81 
82  amrex::MultiFab*
83  Get_Data_Ptr (const int& lev, const int& varIdx) { return m_lsm_model[lev]->Lsm_Data_Ptr(varIdx); }
84 
85  amrex::MultiFab*
86  Get_Flux_Ptr (const int& lev, const int& varIdx) { return m_lsm_model[lev]->Lsm_Flux_Ptr(varIdx); }
87 
88  amrex::Geometry
89  Get_Lsm_Geom (const int& lev ) { return m_lsm_model[lev]->Lsm_Geom(); }
90 
91  int
92  Get_Data_Size () { return m_lsm_model[0]->Lsm_Data_Size(); }
93 
94  int
95  Get_Flux_Size () { return m_lsm_model[0]->Lsm_Flux_Size(); }
96 
97  std::string
98  Get_DataName (const int& varIdx) { return m_lsm_model[0]->Lsm_DataName(varIdx); }
99 
100  int
101  Get_DataIdx (const int& lev, std::string& varname) { return m_lsm_model[lev]->Lsm_DataIndex(varname); }
102 
103  std::string
104  Get_FluxName (const int& varIdx) { return m_lsm_model[0]->Lsm_FluxName(varIdx); }
105 
106  int
107  Get_FluxIdx (const int& lev, std::string& varname) { return m_lsm_model[lev]->Lsm_FluxIndex(varname); }
108 
109  void
111  const amrex::Vector<int> &level_steps,
112  const amrex::Vector<amrex::IntVect> &ref_ratio)
113  {
114  int nlev = m_lsm_model.size();
115  int nvar = this->Get_Data_Size();
116  amrex::Vector<std::string> varnames;
117 
118  // Only write if we have valid pointers
119  if (this->Get_Data_Ptr(0,0)) {
120  varnames.resize(nvar);
121  m_lsm_geom_lev.resize(nlev);
122  m_lsm_data_lev.resize(nlev);
123  std::string plotfilename = amrex::Concatenate(plot_file_lsm, level_steps[0], 5);
124  for (int lev(0); lev<nlev; ++lev) {
125  m_lsm_geom_lev[lev] = this->Get_Lsm_Geom(lev);
126 
127  amrex::MultiFab* mf_lsm = this->Get_Data_Ptr(lev,0);
128  amrex::IntVect ng(0,0,0);
129  amrex::BoxArray ba = mf_lsm->boxArray();
130  amrex::DistributionMapping dm = mf_lsm->DistributionMap();
131  m_lsm_data_lev[lev].define(ba, dm, nvar, ng);
132  for (int n(0); n<nvar; ++n) {
133  mf_lsm = this->Get_Data_Ptr(lev,n);
134  amrex::MultiFab::Copy(m_lsm_data_lev[lev],*(mf_lsm),0,n,1,0);
135  if (lev==0) varnames[n] = this->Get_DataName(n);
136  }
137  }
138  WriteMultiLevelPlotfile (plotfilename, nlev, GetVecOfConstPtrs(m_lsm_data_lev),
139  varnames, m_lsm_geom_lev, time, level_steps, ref_ratio);
140  m_lsm_geom_lev.clear();
141  m_lsm_data_lev.clear();
142  }
143  }
144 
145  template<class SurfModelType>
146  SurfModelType* get_model_lev(const int &lev) {
147  return static_cast<SurfModelType*>(m_lsm_model[lev].get());
148  }
149 
150 private:
151  // lsm model at each level
152  amrex::Vector<std::unique_ptr<NullSurf>> m_lsm_model;
153 
154  // plotfile prefix
155  std::string plot_file_lsm {"plt_lsm_"};
156 
157  // Vector of geometry
158  amrex::Vector<amrex::Geometry> m_lsm_geom_lev;
159 
160  // Vector of data pointers
161  amrex::Vector<amrex::MultiFab> m_lsm_data_lev;
162 };
163 #endif
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Definition: ERF_LandSurface.H:15
amrex::Vector< amrex::Geometry > m_lsm_geom_lev
Definition: ERF_LandSurface.H:158
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_advance, const int &nstep)
Definition: ERF_LandSurface.H:52
void Advance(const int &lev, const amrex::Real &dt_advance)
Definition: ERF_LandSurface.H:65
int Get_Data_Size()
Definition: ERF_LandSurface.H:92
amrex::Geometry Get_Lsm_Geom(const int &lev)
Definition: ERF_LandSurface.H:89
~LandSurface()=default
SurfModelType * get_model_lev(const int &lev)
Definition: ERF_LandSurface.H:146
int Get_FluxIdx(const int &lev, std::string &varname)
Definition: ERF_LandSurface.H:107
void ReSize(const int &nlev)
Definition: ERF_LandSurface.H:24
amrex::Vector< amrex::MultiFab > m_lsm_data_lev
Definition: ERF_LandSurface.H:161
std::string Get_DataName(const int &varIdx)
Definition: ERF_LandSurface.H:98
void Plot_Lsm_Data(amrex::Real time, const amrex::Vector< int > &level_steps, const amrex::Vector< amrex::IntVect > &ref_ratio)
Definition: ERF_LandSurface.H:110
std::string Get_FluxName(const int &varIdx)
Definition: ERF_LandSurface.H:104
amrex::Vector< std::unique_ptr< NullSurf > > m_lsm_model
Definition: ERF_LandSurface.H:152
void SetModel()
Definition: ERF_LandSurface.H:28
amrex::MultiFab * Get_Flux_Ptr(const int &lev, const int &varIdx)
Definition: ERF_LandSurface.H:86
void Init(const int &lev, const amrex::MultiFab &cons_in, const amrex::Geometry &geom, const amrex::Real &dt_advance)
Definition: ERF_LandSurface.H:43
LandSurface()
Definition: ERF_LandSurface.H:19
void Update_State_Vars_Lev(const int &lev, amrex::MultiFab &cons_in)
Definition: ERF_LandSurface.H:77
int Get_DataIdx(const int &lev, std::string &varname)
Definition: ERF_LandSurface.H:101
void Define(const int &lev, SolverChoice &sc)
Definition: ERF_LandSurface.H:36
int Get_Flux_Size()
Definition: ERF_LandSurface.H:95
amrex::MultiFab * Get_Data_Ptr(const int &lev, const int &varIdx)
Definition: ERF_LandSurface.H:83
std::string plot_file_lsm
Definition: ERF_LandSurface.H:155
void Update_Micro_Vars_Lev(const int &lev, amrex::MultiFab &cons_in)
Definition: ERF_LandSurface.H:71
@ ng
Definition: ERF_Morrison.H:48
Definition: ERF_DataStruct.H:123