1 #ifndef ERF_SURFACELAYER_H
2 #define ERF_SURFACELAYER_H
4 #include "AMReX_Geometry.H"
5 #include "AMReX_ParmParse.H"
6 #include "AMReX_FArrayBox.H"
7 #include "AMReX_MultiFab.H"
8 #include "AMReX_iMultiFab.H"
9 #include "AMReX_Interpolater.H"
35 bool& use_rot_surface_flux,
36 std::string a_pp_prefix,
37 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
38 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& z_phys_nd,
39 const TerrainType& a_terrain_type,
40 amrex::Real start_bdy_time = 0.0,
41 amrex::Real bdy_time_interval = 0.0)
46 m_ma(geom, (z_phys_nd[0] != nullptr), a_pp_prefix, a_terrain_type)
52 amrex::ParmParse
pp(
"erf");
56 if (use_rot_surface_flux) {
59 std::string flux_string_in;
60 std::string flux_string{
"moeng"};
61 auto read_flux =
pp.query(
"surface_layer.flux_type", flux_string_in);
63 flux_string = amrex::toLower(flux_string_in);
65 if (flux_string ==
"donelan") {
67 }
else if (flux_string ==
"moeng") {
69 }
else if (flux_string ==
"custom") {
72 amrex::Abort(
"Undefined MOST flux type!");
79 std::string pblh_string_in;
80 std::string pblh_string{
"none"};
81 auto read_pblh =
pp.query(
"most.pblh_calc", pblh_string_in);
83 pblh_string = amrex::toLower(pblh_string_in);
85 if (pblh_string ==
"none") {
87 }
else if (pblh_string ==
"mynn25") {
89 }
else if (pblh_string ==
"mynnedmf") {
91 }
else if (pblh_string ==
"ysu") {
93 }
else if (pblh_string ==
"mrf") {
96 amrex::Abort(
"Undefined PBLH calc type!");
100 auto erf_st =
pp.query(
"most.surf_temp",
surf_temp);
118 "Specified custom MOST qv flux without moisture model!");
120 amrex::Print() <<
"Using specified ustar, tstar, qstar for MOST = "
131 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
137 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
162 std::string bogus_input;
163 if (
pp.query(
"most.roughness_type", bogus_input) > 0) {
164 amrex::Abort(
"most.roughness_type is deprecated; use "
165 "most.roughness_type_land and/or most.roughness_type_sea");
169 std::string rough_land_string_in;
170 std::string rough_land_string{
"constant"};
171 auto read_rough_land =
172 pp.query(
"most.roughness_type_land", rough_land_string_in);
173 if (read_rough_land) {
174 rough_land_string = amrex::toLower(rough_land_string_in);
176 if (rough_land_string ==
"constant") {
179 amrex::Abort(
"Undefined MOST roughness type for land!");
183 std::string rough_sea_string_in;
184 std::string rough_sea_string{
"charnock"};
185 auto read_rough_sea =
pp.query(
"most.roughness_type_sea", rough_sea_string_in);
186 if (read_rough_sea) {
187 rough_sea_string = amrex::toLower(rough_sea_string_in);
189 if (rough_sea_string ==
"charnock") {
191 pp.query(
"most.charnock_constant",
cnk_a);
192 pp.query(
"most.charnock_viscosity",
cnk_visc);
194 amrex::Print() <<
"If there is water, Charnock relation with C_a="
196 <<
" will be used" << std::endl;
198 amrex::Print() <<
"If there is water, Charnock relation with variable "
199 "Charnock parameter (COARE3.0)"
200 << (
cnk_visc ?
" and viscosity" :
"") <<
" will be used"
203 }
else if (rough_sea_string ==
"coare3.0") {
205 amrex::Print() <<
"If there is water, Charnock relation with variable "
206 "Charnock parameter (COARE3.0)"
207 << (
cnk_visc ?
" and viscosity" :
"") <<
" will be used"
210 }
else if (rough_sea_string ==
"donelan") {
212 }
else if (rough_sea_string ==
"modified_charnock") {
214 pp.query(
"most.modified_charnock_depth",
depth);
215 }
else if (rough_sea_string ==
"wave_coupled") {
217 }
else if (rough_sea_string ==
"constant") {
220 amrex::Abort(
"Undefined MOST roughness type for sea!");
226 const amrex::Vector<amrex::MultiFab*>& mfv,
227 std::unique_ptr<amrex::MultiFab>& Theta_prim,
228 std::unique_ptr<amrex::MultiFab>& Qv_prim,
229 std::unique_ptr<amrex::MultiFab>& Qr_prim,
230 std::unique_ptr<amrex::MultiFab>& z_phys_nd,
231 amrex::MultiFab* Hwave,
232 amrex::MultiFab* Lwave,
233 amrex::MultiFab* eddyDiffs,
234 amrex::Vector<amrex::MultiFab*> lsm_data,
235 amrex::Vector<amrex::MultiFab*> lsm_flux,
236 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& sst_lev,
237 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& tsk_lev,
238 amrex::Vector<std::unique_ptr<amrex::iMultiFab>>& lmask_lev)
242 Theta_prim, Qv_prim, Qr_prim,
246 amrex::MultiFab& mf = *(mfv[0]);
248 amrex::ParmParse
pp(
"erf");
252 const int nghost = 0;
254 amrex::ParallelDescriptor::ReduceIntMin(lmask_min);
258 std::string rough_sea_string{
"charnock"};
259 pp.query(
"most.roughness_type_sea", rough_sea_string);
260 amrex::Print() <<
"Variable sea roughness (type " << rough_sea_string
265 if ((lev == 0) || (lev > nlevs - 1)) {
290 int nt_tot_sst = sst_lev.size();
292 for (
int nt(0); nt < nt_tot_sst; ++nt) {
295 int nt_tot_tsk = tsk_lev.size();
297 for (
int nt(0); nt < nt_tot_tsk; ++nt) {
300 int nt_tot_lmask = lmask_lev.size();
302 for (
int nt(0); nt < nt_tot_lmask; ++nt) {
312 int nvar = lsm_data.size();
315 for (
int n(0); n < nvar; ++n) {
322 bool read_z0 =
false;
325 read_z0 =
pp.query(
"most.roughness_file_name", fname);
331 amrex::BoxArray ba = mf.boxArray();
332 amrex::BoxList bl2d = ba.boxList();
333 for (
auto& b : bl2d) {
336 amrex::BoxArray ba2d(std::move(bl2d));
337 const amrex::DistributionMapping& dm = mf.DistributionMap();
339 amrex::IntVect
ng = mf.nGrowVect();
344 amrex::Arena* Arena_Used = amrex::The_Arena();
346 Arena_Used = amrex::The_Pinned_Arena();
348 amrex::Box bx = amrex::grow(
m_geom[lev].Domain(),
ng);
351 z_0[lev].resize(bx, 1, Arena_Used);
359 u_star[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
360 u_star[lev]->setVal(1.E34);
362 w_star[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
363 w_star[lev]->setVal(1.E34);
365 t_star[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
368 q_star[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
371 olen[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
372 olen[lev]->setVal(1.E34);
374 pblh[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
375 pblh[lev]->setVal(1.E34);
377 t_surf[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
380 q_surf[lev] = std::make_unique<amrex::MultiFab>(ba2d, dm, ncomp,
ng);
397 const amrex::Real& time,
398 int max_iters = 500);
400 template <
typename FluxIter>
402 const int& max_iters,
403 const FluxIter& most_flux,
407 amrex::Vector<const amrex::MultiFab*> mfs,
408 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
409 amrex::MultiFab* xheat_flux,
410 amrex::MultiFab* yheat_flux,
411 amrex::MultiFab* zheat_flux,
412 amrex::MultiFab* xqv_flux,
413 amrex::MultiFab* yqv_flux,
414 amrex::MultiFab* zqv_flux,
415 const amrex::MultiFab* z_phys);
417 template <
typename FluxCalc>
419 amrex::Vector<const amrex::MultiFab*> mfs,
420 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
421 amrex::MultiFab* xheat_flux,
422 amrex::MultiFab* yheat_flux,
423 amrex::MultiFab* zheat_flux,
424 amrex::MultiFab* xqv_flux,
425 amrex::MultiFab* yqv_flux,
426 amrex::MultiFab* zqv_flux,
427 const amrex::MultiFab* z_phys,
428 const FluxCalc& flux_comp);
431 const amrex::Real& time);
437 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
438 amrex::MultiFab* z_phys_cc,
441 template <
typename PBLHeightEstimator>
443 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
444 amrex::MultiFab* z_phys_cc,
445 const PBLHeightEstimator& est,
449 const std::string& fname);
454 int nlevs =
m_geom.size();
455 for (
int lev = 0; lev < nlevs; lev++) {
457 amrex::Print() <<
"Surface temp at t=" << time <<
": "
464 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars_old,
465 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Theta_prim,
466 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
467 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qr_prim)
495 amrex::FArrayBox*
get_z0 (
const int& lev) {
return &
z_0[lev]; }
504 int lmask_min = amrex::ReduceMin(lmask, nghost, [=] AMREX_GPU_HOST_DEVICE(
505 amrex::Box
const& bx, amrex::Array4<int const>
const& lm_arr) ->
int
507 int locmin = std::numeric_limits<int>::max();
508 const auto lo = lbound(bx);
509 const auto hi = ubound(bx);
510 for (
int j = lo.y; j <= hi.y; ++j) {
511 for (
int i = lo.x; i <= hi.x; ++i) {
512 locmin = std::min(locmin, lm_arr(i, j, 0));
581 amrex::Vector<amrex::FArrayBox>
z_0;
587 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
u_star;
588 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
w_star;
589 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_star;
590 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_star;
591 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
olen;
592 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
pblh;
593 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_surf;
594 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_surf;
596 amrex::Vector<amrex::Vector<amrex::MultiFab*>>
m_sst_lev;
597 amrex::Vector<amrex::Vector<amrex::MultiFab*>>
m_tsk_lev;
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp(amrex::Real y)
Definition: ERF_MicrophysicsUtils.H:230
Definition: ERF_MOSTAverage.H:14
amrex::Real get_zref() const
Definition: ERF_MOSTAverage.H:104
const amrex::MultiFab * get_average(const int &lev, const int &comp) const
Definition: ERF_MOSTAverage.H:101
void update_field_ptrs(const int &lev, amrex::Vector< amrex::Vector< amrex::MultiFab >> &vars_old, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Theta_prim, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Qv_prim, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Qr_prim)
Definition: ERF_MOSTAverage.cpp:246
void make_MOSTAverage_at_level(const int &lev, const amrex::Vector< amrex::MultiFab * > &vars_old, std::unique_ptr< amrex::MultiFab > &Theta_prim, std::unique_ptr< amrex::MultiFab > &Qv_prim, std::unique_ptr< amrex::MultiFab > &Qr_prim, std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_MOSTAverage.cpp:70
Definition: ERF_SurfaceLayer.H:30
ThetaCalcType theta_type
Definition: ERF_SurfaceLayer.H:551
int lmask_min_reduce(amrex::iMultiFab &lmask, const int &nghost)
Definition: ERF_SurfaceLayer.H:501
bool m_include_wstar
Definition: ERF_SurfaceLayer.H:564
bool specified_rho_surf
Definition: ERF_SurfaceLayer.H:577
bool m_rotate
Definition: ERF_SurfaceLayer.H:560
PBLHeightCalcType pblh_type
Definition: ERF_SurfaceLayer.H:555
amrex::Vector< amrex::Vector< amrex::iMultiFab * > > m_lmask_lev
Definition: ERF_SurfaceLayer.H:598
amrex::iMultiFab * get_lmask(const int &lev)
Definition: ERF_SurfaceLayer.H:499
bool use_moisture
Definition: ERF_SurfaceLayer.H:584
amrex::MultiFab * get_q_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:491
SurfaceLayer(const amrex::Vector< amrex::Geometry > &geom, bool &use_rot_surface_flux, std::string a_pp_prefix, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Qv_prim, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &z_phys_nd, const TerrainType &a_terrain_type, amrex::Real start_bdy_time=0.0, amrex::Real bdy_time_interval=0.0)
Definition: ERF_SurfaceLayer.H:34
amrex::MultiFab * get_w_star(const int &lev)
Definition: ERF_SurfaceLayer.H:474
void update_surf_temp(const amrex::Real &time)
Definition: ERF_SurfaceLayer.H:451
RoughCalcType rough_type_land
Definition: ERF_SurfaceLayer.H:553
void update_pblh(const int &lev, amrex::Vector< amrex::Vector< amrex::MultiFab >> &vars, amrex::MultiFab *z_phys_cc, const MoistureComponentIndices &moisture_indices)
Definition: ERF_SurfaceLayer.cpp:558
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_surf
Definition: ERF_SurfaceLayer.H:593
amrex::Real z0_const
Definition: ERF_SurfaceLayer.H:565
amrex::Real cnk_a
Definition: ERF_SurfaceLayer.H:578
amrex::Vector< amrex::FArrayBox > z_0
Definition: ERF_SurfaceLayer.H:581
amrex::Real surf_temp
Definition: ERF_SurfaceLayer.H:567
void update_mac_ptrs(const int &lev, amrex::Vector< amrex::Vector< amrex::MultiFab >> &vars_old, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Theta_prim, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Qv_prim, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Qr_prim)
Definition: ERF_SurfaceLayer.H:463
void make_SurfaceLayer_at_level(const int &lev, int nlevs, const amrex::Vector< amrex::MultiFab * > &mfv, std::unique_ptr< amrex::MultiFab > &Theta_prim, std::unique_ptr< amrex::MultiFab > &Qv_prim, std::unique_ptr< amrex::MultiFab > &Qr_prim, std::unique_ptr< amrex::MultiFab > &z_phys_nd, amrex::MultiFab *Hwave, amrex::MultiFab *Lwave, amrex::MultiFab *eddyDiffs, amrex::Vector< amrex::MultiFab * > lsm_data, amrex::Vector< amrex::MultiFab * > lsm_flux, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &sst_lev, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &tsk_lev, amrex::Vector< std::unique_ptr< amrex::iMultiFab >> &lmask_lev)
Definition: ERF_SurfaceLayer.H:224
void compute_pblh(const int &lev, amrex::Vector< amrex::Vector< amrex::MultiFab >> &vars, amrex::MultiFab *z_phys_cc, const PBLHeightEstimator &est, const MoistureComponentIndices &moisture_indice)
amrex::Vector< std::unique_ptr< amrex::MultiFab > > q_star
Definition: ERF_SurfaceLayer.H:590
amrex::Real m_start_bdy_time
Definition: ERF_SurfaceLayer.H:561
amrex::Vector< amrex::MultiFab * > m_Lwave_lev
Definition: ERF_SurfaceLayer.H:602
void get_lsm_tsurf(const int &lev)
Definition: ERF_SurfaceLayer.cpp:525
amrex::MultiFab * get_olen(const int &lev)
Definition: ERF_SurfaceLayer.H:480
amrex::Real surf_moist_flux
Definition: ERF_SurfaceLayer.H:572
void compute_SurfaceLayer_bcs(const int &lev, amrex::Vector< const amrex::MultiFab * > mfs, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::MultiFab *xheat_flux, amrex::MultiFab *yheat_flux, amrex::MultiFab *zheat_flux, amrex::MultiFab *xqv_flux, amrex::MultiFab *yqv_flux, amrex::MultiFab *zqv_flux, const amrex::MultiFab *z_phys, const FluxCalc &flux_comp)
RoughCalcType rough_type_sea
Definition: ERF_SurfaceLayer.H:554
void update_fluxes(const int &lev, const amrex::Real &time, int max_iters=500)
Definition: ERF_SurfaceLayer.cpp:12
amrex::Real surf_moist
Definition: ERF_SurfaceLayer.H:571
amrex::Vector< std::unique_ptr< amrex::MultiFab > > w_star
Definition: ERF_SurfaceLayer.H:588
amrex::MultiFab * get_u_star(const int &lev)
Definition: ERF_SurfaceLayer.H:472
amrex::Real m_bdy_time_interval
Definition: ERF_SurfaceLayer.H:562
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_data_lev
Definition: ERF_SurfaceLayer.H:599
amrex::Real custom_qstar
Definition: ERF_SurfaceLayer.H:575
amrex::Vector< std::unique_ptr< amrex::MultiFab > > u_star
Definition: ERF_SurfaceLayer.H:587
amrex::Real custom_rhosurf
Definition: ERF_SurfaceLayer.H:576
amrex::Vector< std::unique_ptr< amrex::MultiFab > > q_surf
Definition: ERF_SurfaceLayer.H:594
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_sst_lev
Definition: ERF_SurfaceLayer.H:596
FluxCalcType
Definition: ERF_SurfaceLayer.H:521
@ MOENG
Moeng functional form.
@ CUSTOM
Custom constant flux functional form.
@ ROTATE
Terrain rotation flux functional form.
@ DONELAN
Donelan functional form.
MoistCalcType
Definition: ERF_SurfaceLayer.H:534
@ SURFACE_MOISTURE
Surface Qv specified.
@ MOISTURE_FLUX
Qv-flux specified.
amrex::Real depth
Definition: ERF_SurfaceLayer.H:580
amrex::Vector< amrex::MultiFab * > m_Hwave_lev
Definition: ERF_SurfaceLayer.H:601
amrex::Real default_land_surf_moist
Definition: ERF_SurfaceLayer.H:570
bool m_var_z0
Definition: ERF_SurfaceLayer.H:582
amrex::MultiFab * get_t_star(const int &lev)
Definition: ERF_SurfaceLayer.H:476
bool have_variable_sea_roughness()
Definition: ERF_SurfaceLayer.H:497
void compute_fluxes(const int &lev, const int &max_iters, const FluxIter &most_flux, bool is_land)
Definition: ERF_SurfaceLayer.cpp:178
amrex::MultiFab * get_q_star(const int &lev)
Definition: ERF_SurfaceLayer.H:478
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_flux_lev
Definition: ERF_SurfaceLayer.H:600
PBLHeightCalcType
Definition: ERF_SurfaceLayer.H:548
amrex::MultiFab * get_pblh(const int &lev)
Definition: ERF_SurfaceLayer.H:482
void fill_tsurf_with_sst_and_tsk(const int &lev, const amrex::Real &time)
Definition: ERF_SurfaceLayer.cpp:452
amrex::Real surf_temp_flux
Definition: ERF_SurfaceLayer.H:569
amrex::Vector< amrex::Geometry > m_geom
Definition: ERF_SurfaceLayer.H:559
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_star
Definition: ERF_SurfaceLayer.H:589
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_tsk_lev
Definition: ERF_SurfaceLayer.H:597
amrex::Real custom_tstar
Definition: ERF_SurfaceLayer.H:574
bool cnk_visc
Definition: ERF_SurfaceLayer.H:579
amrex::Real surf_heating_rate
Definition: ERF_SurfaceLayer.H:568
RoughCalcType
Definition: ERF_SurfaceLayer.H:540
FluxCalcType flux_type
Definition: ERF_SurfaceLayer.H:550
MoistCalcType moist_type
Definition: ERF_SurfaceLayer.H:552
void impose_SurfaceLayer_bcs(const int &lev, amrex::Vector< const amrex::MultiFab * > mfs, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::MultiFab *xheat_flux, amrex::MultiFab *yheat_flux, amrex::MultiFab *zheat_flux, amrex::MultiFab *xqv_flux, amrex::MultiFab *yqv_flux, amrex::MultiFab *zqv_flux, const amrex::MultiFab *z_phys)
Definition: ERF_SurfaceLayer.cpp:245
amrex::Vector< amrex::MultiFab * > m_eddyDiffs_lev
Definition: ERF_SurfaceLayer.H:603
const amrex::MultiFab * get_mac_avg(const int &lev, int comp)
Definition: ERF_SurfaceLayer.H:484
amrex::Real custom_ustar
Definition: ERF_SurfaceLayer.H:573
amrex::Vector< std::unique_ptr< amrex::MultiFab > > olen
Definition: ERF_SurfaceLayer.H:591
amrex::FArrayBox * get_z0(const int &lev)
Definition: ERF_SurfaceLayer.H:495
amrex::MultiFab * get_t_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:489
amrex::Vector< std::unique_ptr< amrex::MultiFab > > pblh
Definition: ERF_SurfaceLayer.H:592
amrex::Real default_land_surf_temp
Definition: ERF_SurfaceLayer.H:566
amrex::Real get_zref()
Definition: ERF_SurfaceLayer.H:493
ThetaCalcType
Definition: ERF_SurfaceLayer.H:528
@ SURFACE_TEMPERATURE
Surface temperature specified.
@ HEAT_FLUX
Heat-flux specified.
void read_custom_roughness(const int &lev, const std::string &fname)
Definition: ERF_SurfaceLayer.cpp:585
MOSTAverage m_ma
Definition: ERF_SurfaceLayer.H:586
@ ng
Definition: ERF_Morrison.H:48
real(c_double), parameter epsilon
Definition: ERF_module_model_constants.F90:12
Definition: ERF_DataStruct.H:99