1 #ifndef ERF_SURFACELAYER_H
2 #define ERF_SURFACELAYER_H
8 #include "AMReX_Geometry.H"
9 #include "AMReX_ParmParse.H"
10 #include "AMReX_FArrayBox.H"
11 #include "AMReX_MultiFab.H"
12 #include "AMReX_iMultiFab.H"
13 #include "AMReX_MFInterpolater.H"
38 bool has_custom_roughness)
40 return terrain_type != TerrainType::EB ||
41 !(use_sst || use_tsk || use_coupled_sst || has_lsm_tsurf ||
42 has_lsm_fluxes || has_custom_roughness);
84 const amrex::Vector<amrex::Geometry>& geom,
85 bool& use_rot_surface_flux,
86 std::string a_pp_prefix,
87 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
88 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& z_phys_nd,
89 const amrex::Vector<amrex::Vector<amrex::Real>>& zlevels_stag,
90 const MeshType& a_mesh_type,
91 const TerrainType& a_terrain_type,
94 double start_low_time,
95 double final_low_time,
96 double low_time_interval = 0.0,
97 const amrex::Vector<const eb_*>& eb_vec = {},
109 m_ma(face, geom, (z_phys_nd[0] !=
nullptr), a_pp_prefix, a_mesh_type, a_terrain_type,
110 zlevels_stag, eb_vec),
122 amrex::ParmParse
pp(a_pp_prefix);
127 if (use_rot_surface_flux) {
130 std::string flux_string_in;
131 std::string flux_string{
"moeng"};
132 auto read_flux =
pp.queryAdd(
"surface_layer.flux_type", flux_string_in);
134 flux_string = amrex::toLower(flux_string_in);
136 if (flux_string ==
"moeng") {
138 }
else if (flux_string ==
"rico") {
140 }
else if (flux_string ==
"bulk_coeff") {
142 }
else if (flux_string ==
"custom") {
145 amrex::Abort(
"Undefined MOST flux type!");
154 "BULK_COEFF, CUSTOM, and RICO surface-layer fluxes are supported only on the z-low face.");
160 std::string pblh_string_in;
161 std::string pblh_string{
"none"};
162 auto read_pblh =
pp.queryAdd(
"most.pblh_calc", pblh_string_in);
164 pblh_string = amrex::toLower(pblh_string_in);
166 if (pblh_string ==
"none") {
168 }
else if (pblh_string ==
"mynn25") {
170 }
else if (pblh_string ==
"mynnedmf") {
172 }
else if (pblh_string ==
"ysu") {
174 }
else if (pblh_string ==
"mrf") {
177 amrex::Abort(
"Undefined PBLH calc type!");
183 "MOST PBL-height calculation and wstar correction are supported only on the z-low face.");
191 amrex::Abort(
"erf.most.include_wstar requires a PBL height: set "
192 "erf.most.pblh_calc (MYNN25 is the only scheme implemented)");
197 amrex::Print() <<
" Using fluxes from surface model!" << std::endl;
230 "Specified custom MOST qv flux without moisture model!");
232 amrex::Print() <<
"Using specified ustar, tstar, qstar for MOST = "
243 amrex::Print() <<
"Using specified Cd, Ch, Cq for MOST = "
245 <<
m_Cq << std::endl;
257 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
263 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
291 "HEAT_FLUX and ADIABATIC surface-layer fluxes are supported only on the z-low face.");
301 std::string bogus_input;
302 if (
pp.queryAdd(
"most.roughness_type", bogus_input) > 0) {
303 amrex::Abort(
"most.roughness_type is deprecated; use "
304 "most.roughness_type_land and/or most.roughness_type_sea");
308 std::string rough_land_string_in;
309 std::string rough_land_string{
"constant"};
310 auto read_rough_land =
311 pp.queryAdd(
"most.roughness_type_land", rough_land_string_in);
312 if (read_rough_land) {
313 rough_land_string = amrex::toLower(rough_land_string_in);
315 if (rough_land_string ==
"constant") {
318 amrex::Abort(
"Undefined MOST roughness type for land!");
323 amrex::Print() <<
"The smooth-flow limit will be included for variable roughness models over sea: " <<
smooth_flow_visc <<
"\n";
326 std::string rough_sea_string_in;
327 std::string rough_sea_string{
"charnock"};
328 auto read_rough_sea =
pp.queryAdd(
"most.roughness_type_sea", rough_sea_string_in);
329 if (read_rough_sea) {
330 rough_sea_string = amrex::toLower(rough_sea_string_in);
332 if (rough_sea_string ==
"charnock") {
334 pp.queryAdd(
"most.charnock_constant",
cnk_a);
336 amrex::Print() <<
"If there is water, Charnock relation with C_a="
337 <<
cnk_a <<
" will be used" << std::endl;
339 amrex::Print() <<
"If there is water, Charnock relation with variable "
340 "Charnock parameter (COARE3.0) will be used" << std::endl;
342 }
else if (rough_sea_string ==
"coare3.0") {
344 amrex::Print() <<
"If there is water, Charnock relation with variable "
345 "Charnock parameter (COARE3.0) will be used" << std::endl;
347 }
else if (rough_sea_string ==
"donelan") {
349 }
else if (rough_sea_string ==
"modified_charnock") {
351 pp.queryAdd(
"most.modified_charnock_depth",
depth);
353 amrex::Print() <<
"Specified depth of " <<
depth
354 <<
" is outside the valid range of [10 100], resetting to bounds now."
359 }
else if (rough_sea_string ==
"wave_coupled") {
361 }
else if (rough_sea_string ==
"constant") {
364 amrex::Abort(
"Undefined MOST roughness type for sea!");
381 "RANS surface-layer k updates are supported only on the z-low face.");
413 const amrex::Vector<amrex::MultiFab*>& mfv,
414 std::unique_ptr<amrex::MultiFab>& Theta_prim,
415 std::unique_ptr<amrex::MultiFab>& Qv_prim,
416 std::unique_ptr<amrex::MultiFab>& Qr_prim,
417 std::unique_ptr<amrex::MultiFab>& z_phys_nd,
418 amrex::MultiFab* Hwave,
419 amrex::MultiFab* Lwave,
420 amrex::MultiFab* eddyDiffs,
421 amrex::Vector<amrex::MultiFab*> lsm_data,
422 amrex::Vector<std::string> lsm_data_name,
423 amrex::Vector<amrex::MultiFab*> lsm_flux,
424 amrex::Vector<std::string> lsm_flux_name,
425 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& sst_lev,
426 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& tsk_lev,
427 amrex::Vector<std::unique_ptr<amrex::iMultiFab>>& lmask_lev)
431 Theta_prim, Qv_prim, Qr_prim,
435 amrex::MultiFab& mf = *(mfv[0]);
441 const int nghost = 0;
443 amrex::ParallelDescriptor::ReduceIntMin(lmask_min);
449 "Variable sea roughness surface-layer fluxes are supported only on the z-low face.");
451 std::string rough_sea_string{
"charnock"};
452 pp.queryAdd(
"most.roughness_type_sea", rough_sea_string);
453 amrex::Print() <<
"Variable sea roughness (type " << rough_sea_string
488 int nt_tot_sst = sst_lev.size();
490 for (
int nt(0); nt < nt_tot_sst; ++nt) {
493 int nt_tot_tsk =
static_cast<int>(tsk_lev.size());
495 for (
int nt(0); nt < nt_tot_tsk; ++nt) {
498 int nt_tot_lmask =
static_cast<int>(lmask_lev.size());
500 for (
int nt(0); nt < nt_tot_lmask; ++nt) {
515 amrex::Abort(
"Only one of most.use_sfc_fluxes and most.use_sfc_sst may be enabled");
522 amrex::Abort(
"Text-file surface forcing is not supported with EB terrain");
526 "most.use_sfc_fluxes and most.use_sfc_sst are supported only on the z-low face.");
529 std::string sfc_file =
"";
530 pp.queryAdd(
"most.sfc_file", sfc_file);
531 if (sfc_file.empty()) {
532 amrex::Abort(
"most.sfc_file must be set when using text-file surface forcing");
539 if (
static_cast<int>(
sfc.size()) < min_cols) {
540 amrex::Abort(
"Surface forcing file does not contain the required number of columns");
545 for (
int i = 0; i < static_cast<int>(
sfc[0].size()); ++i) {
546 sfc[0][i] = 86400.0 * (
sfc[0][i] - start_day);
551 amrex::Abort(
"most.use_sfc_sst cannot be combined with prescribed heat flux or surf_heating_rate");
554 amrex::Abort(
"most.use_sfc_sst cannot be combined with prescribed moisture flux");
557 amrex::Print() <<
"Using MOST with prescribed SST from most.sfc_file '" << sfc_file <<
"' over sea" << std::endl;
562 amrex::Print() <<
"Using MOST with prescribed time-varying surface fluxes from '" << sfc_file <<
"'" << std::endl;
567 int ndata =
static_cast<int>(lsm_data.size());
568 int nflux =
static_cast<int>(lsm_flux.size());
573 for (
int n(0); n < ndata; ++n) {
576 const std::string lc_name = amrex::toLower(lsm_data_name[n]);
577 if (lc_name ==
"tsurf" || lc_name ==
"theta" || lc_name ==
"t_surf") {
583 amrex::Abort(
"most.use_sfc_sst cannot be combined with an ocean LSM t_surf input");
585 int n_valid_lsm_flux = 0;
586 bool has_soil_t_flux =
false;
587 for (
int n(0); n < nflux; ++n) {
592 has_soil_t_flux =
true;
596 (n_valid_lsm_flux==1 && has_soil_t_flux)));
604 bool read_z0 =
false;
607 int count =
pp.countval(
"most.roughness_file_name");
610 pp.query(
"most.roughness_file_name", fname, lev);
612 }
else if (count == 1) {
614 pp.queryAdd(
"most.roughness_file_name", fname);
626 "Custom MOST roughness is supported only on the z-low face.");
636 "EB SurfaceLayer does not support planar SST/TSK, coupled SST, LSM surface "
637 "temperature or fluxes, or custom/file-driven roughness; no mapping exists "
638 "from those planar inputs to arbitrary EB cut cells.");
644 const int dir =
m_face.coordDir();
647 sm_index =
m_geom[lev].Domain().smallEnd(dir);
649 sm_index =
m_geom[lev].Domain().bigEnd(dir);
652 amrex::BoxArray ba = mf.boxArray();
653 amrex::BoxArray ba_flux;
654 amrex::IntVect
ng{1,1,0};
661 const int dom_lo_z =
m_geom[lev].Domain().smallEnd(2);
662 const int dom_hi_z =
m_geom[lev].Domain().bigEnd(2);
663 for (
int ibox = 0; ibox < ba.size(); ++ibox) {
665 ba[ibox].smallEnd(2) == dom_lo_z && ba[ibox].bigEnd(2) == dom_hi_z,
666 "Surface layer boundaries on x/y faces require Cartesian grids that "
667 "span the full level z domain; partial-height refined grids and grids "
668 "decomposed in z are not supported. Set erf.max_grid_size_z accordingly.");
675 ng = amrex::IntVect{1,1,1};
678 amrex::BoxList bl2d = ba.boxList();
679 for (
auto& b : bl2d) {
680 b.setRange(dir,sm_index);
682 ba_flux = amrex::BoxArray(std::move(bl2d));
687 ng = amrex::IntVect{1,1,0};
694 const amrex::DistributionMapping& dm = mf.DistributionMap();
701 const int ksurface =
m_face.isLow()
702 ?
m_geom[lev].Domain().smallEnd(2)
703 :
m_geom[lev].Domain().bigEnd(2);
709 z_0[lev].define(ba_flux, dm, ncomp,
ng);
717 u_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
720 w_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
723 t_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
726 q_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
729 olen[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
732 pblh[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
735 t_surf[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
738 q_surf[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
741 const amrex::iMultiFab& surface_mask = *
m_lmask_lev[lev][0];
743 surface_mask.boxArray().size() == mf.boxArray().size(),
744 "Surface-layer mask and state must have the same number of boxes.");
746 surface_mask.DistributionMap() == mf.DistributionMap(),
747 "Surface-layer mask and state must have identical ownership.");
749 surface_mask.boxArray().size() ==
u_star[lev]->boxArray().size(),
750 "Surface-layer mask and parameters must have the same number of boxes.");
752 surface_mask.DistributionMap() ==
u_star[lev]->DistributionMap(),
753 "Surface-layer mask and parameters must have identical ownership.");
768 amrex::Print() <<
"Using MOST with specified surface temperature ";
771 }
else if (!use_sst && !use_tsk) {
772 amrex::Print() <<
"(land: T0, sea: none)";
779 amrex::Print() <<
"(land: TSK, ";
781 amrex::Print() <<
"(land: T0, ";
783 if (use_tsk && !use_sst) {
784 amrex::Print() <<
"sea: TSK)";
786 amrex::Print() <<
"sea: SST)";
794 amrex::Print() <<
" + coupled ocean SST where covered";
796 amrex::Print() << std::endl;
813 const double& elapsed_time,
814 const double& elapsed_time_since_start_low,
815 amrex::MultiFab& cons_in,
816 const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
817 const std::unique_ptr<amrex::MultiFab>& walldist,
818 int max_iters = 100);
829 template <
typename FluxIter>
831 const int& max_iters,
832 amrex::MultiFab& cons_in,
833 const FluxIter& most_flux,
846 amrex::MultiFab&
cons,
847 const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
891 amrex::Vector<const amrex::MultiFab*> mfs,
892 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
893 amrex::MultiFab* xheat_flux,
894 amrex::MultiFab* yheat_flux,
895 amrex::MultiFab* zheat_flux,
896 amrex::MultiFab* xqv_flux,
897 amrex::MultiFab* yqv_flux,
898 amrex::MultiFab* zqv_flux,
899 const amrex::MultiFab* z_phys);
915 amrex::Vector<const amrex::MultiFab*> mfs,
916 amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_lev,
917 amrex::MultiFab* xheat_flux,
918 amrex::MultiFab* yheat_flux,
919 amrex::MultiFab* zheat_flux,
920 amrex::MultiFab* xqv_flux,
921 amrex::MultiFab* yqv_flux,
922 amrex::MultiFab* zqv_flux);
939 template <
typename FluxCalc>
941 amrex::Vector<const amrex::MultiFab*> mfs,
942 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
943 amrex::MultiFab* xheat_flux,
944 amrex::MultiFab* yheat_flux,
945 amrex::MultiFab* zheat_flux,
946 amrex::MultiFab* xqv_flux,
947 amrex::MultiFab* yqv_flux,
948 amrex::MultiFab* zqv_flux,
949 const amrex::MultiFab* z_phys,
950 const FluxCalc& flux_comp);
966 template <
typename FluxCalc>
968 amrex::Vector<const amrex::MultiFab*> mfs,
969 amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_lev,
970 amrex::MultiFab* xheat_flux,
971 amrex::MultiFab* yheat_flux,
972 amrex::MultiFab* zheat_flux,
973 amrex::MultiFab* xqv_flux,
974 amrex::MultiFab* yqv_flux,
975 amrex::MultiFab* zqv_flux,
976 const FluxCalc& flux_comp);
985 amrex::MultiFab& cons_in);
1004 const amrex::MultiFab& cons_in,
1005 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1018 const amrex::MultiFab& cons_in,
1019 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1034 const amrex::MultiFab& cons_in,
1035 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1053 const amrex::MultiFab& cons_in,
1054 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1064 const amrex::MultiFab& cons_in,
1065 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1067 void set_pblh (
const int& lev,
const amrex::MultiFab& pblh_in);
1101 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
1102 amrex::MultiFab* z_phys_cc,
1123 template <
typename PBLHeightEstimator>
1125 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
1126 amrex::MultiFab* z_phys_cc,
1127 const PBLHeightEstimator& est,
1137 const std::string& fname);
1154 int nlevs =
static_cast<int>(
t_surf.size());
1155 for (
int lev = 0; lev < nlevs; lev++) {
1156 if (!
t_surf[lev]) {
continue; }
1158 amrex::Print() <<
"Surface temp at t=" << time <<
": "
1174 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars_old,
1175 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Theta_prim,
1176 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
1177 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qr_prim)
1330 return "the surface layer is on EB terrain";
1335 return "erf.use_rotate_surface_flux is set";
1338 return "the surface layer does not compute its heat flux from a surface "
1339 "temperature (set erf.most.surf_temp, not a flux or custom/bulk fluxes)";
1342 return "erf.most.surf_heating_rate is set";
1345 return "a land-surface or surface model supplies the surface temperature";
1388 if (!temperature.empty()) {
return temperature; }
1390 return "the run has no moisture model";
1393 return "the surface layer does not compute its moisture flux from a surface "
1394 "mixing ratio (set erf.most.surf_moist, not a flux)";
1415 pp.remove(
"most.z0");
1483 amrex::MultiFab*
get_z0 (
const int& lev) {
return &
z_0[lev]; }
1506 int lmask_min = amrex::ReduceMin(lmask, nghost, [=] AMREX_GPU_HOST_DEVICE(
1507 amrex::Box
const& bx, amrex::Array4<int const>
const& lm_arr) ->
int
1509 int locmin = std::numeric_limits<int>::max();
1510 const auto lo = lbound(bx);
1511 const auto hi = ubound(bx);
1512 for (
int j =
lo.y; j <=
hi.y; ++j) {
1513 for (
int i =
lo.x; i <=
hi.x; ++i) {
1514 locmin = std::min(locmin, lm_arr(i, j, 0));
1558 amrex::MultiFab* sst_ptr,
1559 amrex::iMultiFab* valid_ptr) {
1594 static amrex::Vector<amrex::Vector<amrex::Real>>
1595 read_cols (
const std::string& fname,
const int skip_nlines = 1);
1607 amrex::MultiFab* selected_field =
nullptr);
1681 amrex::Vector<amrex::MultiFab>
z_0;
1696 amrex::Vector<amrex::Vector<amrex::Real>>
sfc;
1718 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
u_star;
1719 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
w_star;
1720 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_star;
1721 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_star;
1722 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
olen;
1723 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
pblh;
1724 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_surf;
1725 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_surf;
1740 amrex::DistributionMapping
dm;
1751 const amrex::BoxArray& ba,
1752 const amrex::DistributionMapping& dm);
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
constexpr amrex::Real RdoCp
Definition: ERF_Constants.H:53
Defines EB Monin-Obukhov surface-layer flux functors.
Declares the embedded-boundary factory manager used by ERF levels.
Real z0
Definition: ERF_InitCustomPertVels_ScalarAdvDiff.H:8
AMREX_ALWAYS_ASSERT(bx.length()[2]==khi+1)
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(m_cloud_chamber_config.active, "Cloud Chamber: initializer reached without a parsed configuration")
pp get("wavelength", wavelength)
constexpr amrex::Real one
Definition: ERF_NumericalConstants.H:37
constexpr amrex::Real zero
Definition: ERF_NumericalConstants.H:36
amrex::Real Real
Definition: ERF_ShocInterface.H:19
AMREX_ASSERT_WITH_MESSAGE(wbar_cutoff_min > wbar_cutoff_max, "ERROR: wbar_cutoff_min < wbar_cutoff_max")
Definition: ERF_MOSTAverage.H:16
bool set_plane_average(const int &lev, const amrex::Vector< amrex::Real > &pavg)
Definition: ERF_MOSTAverage.H:315
amrex::Vector< amrex::Real > get_plane_average(const int &lev) const
Definition: ERF_MOSTAverage.H:301
bool do_time_averaging() const
Definition: ERF_MOSTAverage.H:265
amrex::MultiFab * get_zref(const int &lev) const
Definition: ERF_MOSTAverage.H:329
void set_time_avg_initialized(const int &lev)
Definition: ERF_MOSTAverage.H:289
int get_navg() const
Definition: ERF_MOSTAverage.H:270
const amrex::MultiFab * get_average(const int &lev, const int &comp) const
Definition: ERF_MOSTAverage.H:251
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:441
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:171
bool time_avg_is_initialized(const int &lev) const
Definition: ERF_MOSTAverage.H:278
Definition: ERF_SurfaceLayer.H:60
ThetaCalcType theta_type
Definition: ERF_SurfaceLayer.H:1640
int lmask_min_reduce(amrex::iMultiFab &lmask, const int &nghost)
Definition: ERF_SurfaceLayer.H:1503
amrex::Vector< std::string > m_lsm_data_name
Definition: ERF_SurfaceLayer.H:1780
bool m_include_wstar
Definition: ERF_SurfaceLayer.H:1657
amrex::Real interpolate_sfc_column(const amrex::Real &time, int col) const
Definition: ERF_SurfaceLayer.cpp:465
bool specified_rho_surf
Definition: ERF_SurfaceLayer.H:1677
void set_q_surf(const int &lev, const amrex::Real qsurf)
Definition: ERF_SurfaceLayer.H:1455
void update_fluxes(const int &lev, const double &elapsed_time, const double &elapsed_time_since_start_low, amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd, const std::unique_ptr< amrex::MultiFab > &walldist, int max_iters=100)
Definition: ERF_SurfaceLayer.cpp:24
bool m_rotate
Definition: ERF_SurfaceLayer.H:1651
amrex::Real sfc_tflux
Definition: ERF_SurfaceLayer.H:1698
PBLHeightCalcType pblh_type
Definition: ERF_SurfaceLayer.H:1644
amrex::Vector< amrex::Vector< amrex::iMultiFab * > > m_lmask_lev
Definition: ERF_SurfaceLayer.H:1760
double m_final_low_time
Definition: ERF_SurfaceLayer.H:1654
amrex::Vector< PlanarBoundary > m_planar_bndry
Definition: ERF_SurfaceLayer.H:1730
amrex::iMultiFab * get_lmask(const int &lev)
Definition: ERF_SurfaceLayer.H:1495
bool use_moisture
Definition: ERF_SurfaceLayer.H:1687
amrex::Vector< PBLHColumns > m_pblh_columns
Definition: ERF_SurfaceLayer.H:1749
amrex::MultiFab * get_q_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:1447
bool m_has_lsm_tsurf
Definition: ERF_SurfaceLayer.H:1689
amrex::MultiFab * get_w_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1194
amrex::Real m_Cq
Definition: ERF_SurfaceLayer.H:1708
amrex::Vector< const eb_ * > m_eb_vec
Definition: ERF_SurfaceLayer.H:1711
RoughCalcType rough_type_land
Definition: ERF_SurfaceLayer.H:1642
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:2577
void fill_pblh_from_coarser(const int &lev)
Definition: ERF_SurfaceLayer.cpp:2807
SurfaceModel * m_surf_model
Definition: ERF_SurfaceLayer.H:1715
amrex::Real sfc_qflux
Definition: ERF_SurfaceLayer.H:1697
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_surf
Definition: ERF_SurfaceLayer.H:1724
bool m_use_sfc_fluxes
Definition: ERF_SurfaceLayer.H:1693
amrex::Real z0_const
Definition: ERF_SurfaceLayer.H:1658
bool use_sfc_fluxes() const
Definition: ERF_SurfaceLayer.H:1426
amrex::Vector< std::unique_ptr< amrex::MultiFab > > surface_diagnostic_source
Definition: ERF_SurfaceLayer.H:1756
amrex::Real cnk_a
Definition: ERF_SurfaceLayer.H:1678
amrex::Real m_Ch
Definition: ERF_SurfaceLayer.H:1707
amrex::Real surf_temp
Definition: ERF_SurfaceLayer.H:1667
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:1173
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< int > m_skin_moisture_resistances_lev
Definition: ERF_SurfaceLayer.H:1776
amrex::Vector< std::unique_ptr< amrex::MultiFab > > q_star
Definition: ERF_SurfaceLayer.H:1721
int m_lsm_tsurf_indx
Definition: ERF_SurfaceLayer.H:1690
double m_start_low_time
Definition: ERF_SurfaceLayer.H:1653
bool mac_avg_is_initialized(const int &lev) const
Definition: ERF_SurfaceLayer.H:1262
bool mac_avg_is_time_averaged() const
Definition: ERF_SurfaceLayer.H:1250
amrex::Real rico_qsat_z0
Definition: ERF_SurfaceLayer.H:1685
bool m_has_lsm_fluxes
Definition: ERF_SurfaceLayer.H:1688
bool m_update_k_rans
Definition: ERF_SurfaceLayer.H:1786
amrex::Vector< amrex::MultiFab * > m_Lwave_lev
Definition: ERF_SurfaceLayer.H:1783
void get_lsm_tsurf(const int &lev)
Definition: ERF_SurfaceLayer.cpp:2139
void fill_qsurf_with_qsat(const int &lev, const amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_SurfaceLayer.cpp:1976
amrex::MultiFab * get_olen(const int &lev)
Definition: ERF_SurfaceLayer.H:1227
bool computes_w_star() const
Definition: ERF_SurfaceLayer.H:1200
amrex::Vector< amrex::MultiFab > z_0
Definition: ERF_SurfaceLayer.H:1681
void fill_tsurf_with_coupled_sst(const int &lev, const amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_SurfaceLayer.cpp:2188
amrex::Real surf_moist_flux
Definition: ERF_SurfaceLayer.H:1672
bool smooth_flow_visc
Definition: ERF_SurfaceLayer.H:1679
amrex::Vector< const amrex::MultiFab * > m_skin_moisture_lev
Definition: ERF_SurfaceLayer.H:1775
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:1643
void update_coupled_sst_ptr(const int lev, amrex::MultiFab *sst_ptr, amrex::iMultiFab *valid_ptr)
Definition: ERF_SurfaceLayer.H:1557
std::string skin_temperature_conflict() const
Definition: ERF_SurfaceLayer.H:1327
void init_tke_from_ustar(const int &lev, amrex::MultiFab &cons, const std::unique_ptr< amrex::MultiFab > &z_phys_nd, const amrex::Real tkefac=one, const amrex::Real zscale=amrex::Real(700.0))
Definition: ERF_SurfaceLayer.cpp:2868
std::string m_pp_prefix
Definition: ERF_SurfaceLayer.H:1649
amrex::Real surface_sum(const int &lev, const amrex::MultiFab &mf, int comp=0) const
Definition: ERF_SurfaceLayer.cpp:428
amrex::Real surf_moist
Definition: ERF_SurfaceLayer.H:1671
amrex::Vector< std::unique_ptr< amrex::MultiFab > > w_star
Definition: ERF_SurfaceLayer.H:1719
bool m_ignore_sst
Definition: ERF_SurfaceLayer.H:1709
int get_num_mac_avg() const
Definition: ERF_SurfaceLayer.H:1255
amrex::Real roughness() const
Definition: ERF_SurfaceLayer.H:1421
amrex::Vector< amrex::Vector< amrex::Real > > sfc
Definition: ERF_SurfaceLayer.H:1696
std::string skin_moisture_conflict() const
Definition: ERF_SurfaceLayer.H:1385
amrex::MultiFab * get_u_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1187
double m_low_time_interval
Definition: ERF_SurfaceLayer.H:1655
amrex::GpuArray< int, AMREX_SPACEDIM *2 > m_surface_layer_faces
Definition: ERF_SurfaceLayer.H:1652
void compute_fluxes(const int &lev, const int &max_iters, amrex::MultiFab &cons_in, const FluxIter &most_flux, bool is_land)
bool set_mac_plane_avg(const int &lev, const amrex::Vector< amrex::Real > &pavg)
Definition: ERF_SurfaceLayer.H:1294
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_data_lev
Definition: ERF_SurfaceLayer.H:1778
void set_t_surf(const int &lev, const amrex::Real tsurf)
Definition: ERF_SurfaceLayer.H:1440
amrex::Real custom_qstar
Definition: ERF_SurfaceLayer.H:1675
amrex::Vector< std::unique_ptr< amrex::MultiFab > > u_star
Definition: ERF_SurfaceLayer.H:1718
void update_tsk_ptr(const int lev, const int itime, amrex::MultiFab *tsk_ptr)
Definition: ERF_SurfaceLayer.H:1541
bool surf_model_fluxes
Definition: ERF_SurfaceLayer.H:1717
amrex::Real custom_rhosurf
Definition: ERF_SurfaceLayer.H:1676
amrex::Vector< std::unique_ptr< amrex::MultiFab > > q_surf
Definition: ERF_SurfaceLayer.H:1725
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_sst_lev
Definition: ERF_SurfaceLayer.H:1758
FluxCalcType
Definition: ERF_SurfaceLayer.H:1609
@ MOENG
Moeng functional form.
@ BULK_COEFF
Bulk transfer coefficient functional form.
@ CUSTOM
Custom constant flux functional form.
@ ROTATE
Terrain rotation flux functional form.
amrex::Real m_rdOcp
Definition: ERF_SurfaceLayer.H:1713
MoistCalcType
Definition: ERF_SurfaceLayer.H:1623
@ SURFACE_MOISTURE
Surface Qv specified.
@ MOISTURE_FLUX
Qv-flux specified.
amrex::Real depth
Definition: ERF_SurfaceLayer.H:1680
amrex::Vector< amrex::MultiFab * > m_coupled_sst_lev
Definition: ERF_SurfaceLayer.H:1768
amrex::MultiFab * get_zref(const int &lev)
Definition: ERF_SurfaceLayer.H:1469
void fill_lateral_surface_parameter_ghosts(const int &lev, amrex::MultiFab *selected_field=nullptr)
Definition: ERF_SurfaceLayer.cpp:674
amrex::Vector< const amrex::MultiFab * > m_skin_tsurf_lev
Definition: ERF_SurfaceLayer.H:1772
amrex::Vector< amrex::MultiFab * > m_Hwave_lev
Definition: ERF_SurfaceLayer.H:1782
amrex::Real default_land_surf_moist
Definition: ERF_SurfaceLayer.H:1670
void update_sfc_time_index(const amrex::Real &time)
Definition: ERF_SurfaceLayer.cpp:448
bool m_var_z0
Definition: ERF_SurfaceLayer.H:1682
amrex::Vector< amrex::iMultiFab * > m_coupled_sst_valid_lev
Definition: ERF_SurfaceLayer.H:1769
amrex::MultiFab * get_surface_diagnostic_source(const int &lev)
Definition: ERF_SurfaceLayer.H:1462
amrex::MultiFab * get_t_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1213
bool rotates_surface_fluxes() const
Definition: ERF_SurfaceLayer.H:1432
bool have_variable_sea_roughness()
Definition: ERF_SurfaceLayer.H:1488
void impose_SurfaceLayer_bcs_EB(const int &lev, amrex::Vector< const amrex::MultiFab * > mfs, amrex::Vector< 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)
Definition: ERF_SurfaceLayer.cpp:857
amrex::MultiFab * get_q_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1220
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_flux_lev
Definition: ERF_SurfaceLayer.H:1779
amrex::Vector< amrex::Real > m_skin_moisture_hs_lev
Definition: ERF_SurfaceLayer.H:1777
void fill_tsurf_with_skin_temperature(const int &lev, const amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_SurfaceLayer.cpp:2329
amrex::MultiFab * get_mac_avg_ptr(const int &lev, int comp)
Definition: ERF_SurfaceLayer.H:1277
amrex::Vector< amrex::Real > get_mac_plane_avg(const int &lev) const
Definition: ERF_SurfaceLayer.H:1285
void set_pblh(const int &lev, const amrex::MultiFab &pblh_in)
Definition: ERF_SurfaceLayer.cpp:2594
void fill_planar_boundary(const int &lev, amrex::MultiFab &mf)
Definition: ERF_SurfaceLayer.cpp:412
PBLHeightCalcType
Definition: ERF_SurfaceLayer.H:1637
bool m_z0_given
Definition: ERF_SurfaceLayer.H:1660
amrex::MultiFab * get_pblh(const int &lev)
Definition: ERF_SurfaceLayer.H:1234
bool use_surface_model
Definition: ERF_SurfaceLayer.H:1716
void compute_SurfaceLayer_bcs_EB(const int &lev, amrex::Vector< const amrex::MultiFab * > mfs, amrex::Vector< 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 FluxCalc &flux_comp)
amrex::Real rico_theta_z0
Definition: ERF_SurfaceLayer.H:1684
amrex::Real sfc_ustar
Definition: ERF_SurfaceLayer.H:1699
amrex::Real surf_temp_flux
Definition: ERF_SurfaceLayer.H:1669
amrex::Vector< amrex::Geometry > m_geom
Definition: ERF_SurfaceLayer.H:1650
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_star
Definition: ERF_SurfaceLayer.H:1720
int sfc_time_ind
Definition: ERF_SurfaceLayer.H:1695
bool computes_pblh() const
Definition: ERF_SurfaceLayer.H:1206
amrex::Real theta_ref
Definition: ERF_SurfaceLayer.H:1788
void set_skin_moisture(const int &lev, const amrex::MultiFab *moisture, bool use_resistances=false, amrex::Real hs=amrex::Real(0))
Definition: ERF_SurfaceLayer.H:1366
amrex::MultiFab * get_z0(const int &lev)
Definition: ERF_SurfaceLayer.H:1483
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_tsk_lev
Definition: ERF_SurfaceLayer.H:1759
void set_surface_layer_faces(const amrex::GpuArray< int, AMREX_SPACEDIM *2 > &active_faces)
Definition: ERF_SurfaceLayer.H:1582
void update_surf_temp(const double &time)
Definition: ERF_SurfaceLayer.H:1144
void set_coupled_sst_active(const bool active)
Definition: ERF_SurfaceLayer.H:1572
void fill_tsurf_with_sst_and_tsk(const int &lev, const double &time)
Definition: ERF_SurfaceLayer.cpp:1771
amrex::Real custom_tstar
Definition: ERF_SurfaceLayer.H:1674
static amrex::Vector< amrex::Vector< amrex::Real > > read_cols(const std::string &fname, const int skip_nlines=1)
Definition: ERF_SurfaceLayer.cpp:3099
amrex::Real surf_heating_rate
Definition: ERF_SurfaceLayer.H:1668
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< std::string > lsm_data_name, amrex::Vector< amrex::MultiFab * > lsm_flux, amrex::Vector< std::string > lsm_flux_name, 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:411
RoughCalcType
Definition: ERF_SurfaceLayer.H:1629
FluxCalcType flux_type
Definition: ERF_SurfaceLayer.H:1639
MoistCalcType moist_type
Definition: ERF_SurfaceLayer.H:1641
bool m_use_sfc_sst
Definition: ERF_SurfaceLayer.H:1694
void compute_sfc_params_from_lsm_fluxes(const int &lev, amrex::MultiFab &cons_in)
Definition: ERF_SurfaceLayer.cpp:1675
amrex::Real inv_Cmu2
Definition: ERF_SurfaceLayer.H:1787
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:793
amrex::Vector< amrex::MultiFab * > m_eddyDiffs_lev
Definition: ERF_SurfaceLayer.H:1784
amrex::Real get_zref_min(const int &lev)
Definition: ERF_SurfaceLayer.H:1476
const amrex::MultiFab * get_mac_avg(const int &lev, int comp)
Definition: ERF_SurfaceLayer.H:1242
void set_skin_temperature(const int &lev, const amrex::MultiFab *t_skin)
Definition: ERF_SurfaceLayer.H:1312
void fill_qsurf_with_skin_moisture(const int &lev, const amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_SurfaceLayer.cpp:2427
void update_sst_ptr(const int lev, const int itime, amrex::MultiFab *sst_ptr)
Definition: ERF_SurfaceLayer.H:1530
amrex::Real custom_ustar
Definition: ERF_SurfaceLayer.H:1673
amrex::Vector< std::unique_ptr< amrex::MultiFab > > olen
Definition: ERF_SurfaceLayer.H:1722
bool m_use_coupled_sst
Definition: ERF_SurfaceLayer.H:1704
void fill_tsurf_with_sfc_sst(const int &lev, const double &time, const amrex::MultiFab &cons_in, const std::unique_ptr< amrex::MultiFab > &z_phys_nd)
Definition: ERF_SurfaceLayer.cpp:1858
amrex::Orientation m_face
Definition: ERF_SurfaceLayer.H:1648
amrex::MultiFab * get_t_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:1301
SurfaceLayer(amrex::Orientation face, 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 amrex::Vector< amrex::Vector< amrex::Real >> &zlevels_stag, const MeshType &a_mesh_type, const TerrainType &a_terrain_type, const TurbChoice &a_turb_choice, amrex::Real a_rdOcp, double start_low_time, double final_low_time, double low_time_interval=0.0, const amrex::Vector< const eb_ * > &eb_vec={}, SurfaceModel *surf_model=nullptr)
Definition: ERF_SurfaceLayer.H:83
amrex::Real m_Cd
Definition: ERF_SurfaceLayer.H:1706
void set_mac_avg_initialized(const int &lev)
Definition: ERF_SurfaceLayer.H:1269
amrex::Vector< std::unique_ptr< amrex::MultiFab > > pblh
Definition: ERF_SurfaceLayer.H:1723
amrex::Real default_land_surf_temp
Definition: ERF_SurfaceLayer.H:1661
bool set_default_roughness(amrex::Real z0)
Definition: ERF_SurfaceLayer.H:1410
ThetaCalcType
Definition: ERF_SurfaceLayer.H:1617
@ SURFACE_TEMPERATURE
Surface temperature specified.
@ HEAT_FLUX
Heat-flux specified.
void define_pblh_columns(const int &lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
Definition: ERF_SurfaceLayer.cpp:2738
void read_custom_roughness(const int &lev, const std::string &fname)
Definition: ERF_SurfaceLayer.cpp:2951
TerrainType m_terrain_type
Definition: ERF_SurfaceLayer.H:1712
amrex::Vector< std::string > m_lsm_flux_name
Definition: ERF_SurfaceLayer.H:1781
MOSTAverage m_ma
Definition: ERF_SurfaceLayer.H:1714
Interface between ERF and land-surface and urban models.
Definition: ERF_SurfaceModel.H:47
bool are_fluxes()
Returns whether the interface exports fluxes rather than MOST variables.
Definition: ERF_SurfaceModel.H:471
@ tsurf
Definition: ERF_SLM.H:27
@ ng
Definition: ERF_Morrison.H:50
@ cons
Definition: ERF_IndexDefines.H:217
Definition: ERF_SurfaceLayer.H:29
bool planar_sources_supported_for_terrain(TerrainType terrain_type, bool use_sst, bool use_tsk, bool use_coupled_sst, bool has_lsm_tsurf, bool has_lsm_fluxes, bool has_custom_roughness)
Definition: ERF_SurfaceLayer.H:32
real(c_double), parameter epsilon
Definition: ERF_module_model_constants.F90:12
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real to_plot_value(SurfaceDiagnosticSource source) noexcept
Definition: ERF_SurfaceDiagnosticSource.H:45
The moisture data carried by the active microphysics scheme.
Definition: ERF_DataStruct.H:238
Definition: ERF_SurfaceLayer.H:1738
bool needed
Definition: ERF_SurfaceLayer.H:1741
amrex::BoxArray ba
Definition: ERF_SurfaceLayer.H:1739
amrex::BoxArray ba_col2d
Definition: ERF_SurfaceLayer.H:1744
amrex::MultiFab hold_col2d
Definition: ERF_SurfaceLayer.H:1747
bool full_height
Definition: ERF_SurfaceLayer.H:1742
amrex::MultiFab hold_col
Definition: ERF_SurfaceLayer.H:1746
amrex::DistributionMapping dm_col
Definition: ERF_SurfaceLayer.H:1745
amrex::DistributionMapping dm
Definition: ERF_SurfaceLayer.H:1740
amrex::BoxArray ba_col
Definition: ERF_SurfaceLayer.H:1743
Definition: ERF_TurbStruct.H:115
RANSType rans_type
Selected RANS closure.
Definition: ERF_TurbStruct.H:828
amrex::Real theta_ref
Reference potential temperature for stable stratification.
Definition: ERF_TurbStruct.H:815
bool dirichlet_k
Whether TKE uses Dirichlet boundary treatment.
Definition: ERF_TurbStruct.H:830
amrex::Real Cmu0
One-equation RANS Cmu0 coefficient.
Definition: ERF_TurbStruct.H:804