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"
37 bool has_custom_roughness)
39 return terrain_type != TerrainType::EB ||
40 !(use_sst || use_tsk || use_coupled_sst || has_lsm_tsurf ||
41 has_lsm_fluxes || has_custom_roughness);
82 const amrex::Vector<amrex::Geometry>& geom,
83 bool& use_rot_surface_flux,
84 std::string a_pp_prefix,
85 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
86 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& z_phys_nd,
87 const amrex::Vector<amrex::Vector<amrex::Real>>& zlevels_stag,
88 const MeshType& a_mesh_type,
89 const TerrainType& a_terrain_type,
92 double start_low_time,
93 double final_low_time,
94 double low_time_interval = 0.0,
95 const amrex::Vector<const eb_*>& eb_vec = {})
106 m_ma(face, geom, (z_phys_nd[0] !=
nullptr), a_pp_prefix, a_mesh_type, a_terrain_type,
107 zlevels_stag, eb_vec)
118 amrex::ParmParse
pp(a_pp_prefix);
122 if (use_rot_surface_flux) {
125 std::string flux_string_in;
126 std::string flux_string{
"moeng"};
127 auto read_flux =
pp.queryAdd(
"surface_layer.flux_type", flux_string_in);
129 flux_string = amrex::toLower(flux_string_in);
131 if (flux_string ==
"moeng") {
133 }
else if (flux_string ==
"rico") {
135 }
else if (flux_string ==
"bulk_coeff") {
137 }
else if (flux_string ==
"custom") {
140 amrex::Abort(
"Undefined MOST flux type!");
149 "BULK_COEFF, CUSTOM, and RICO surface-layer fluxes are supported only on the z-low face.");
155 std::string pblh_string_in;
156 std::string pblh_string{
"none"};
157 auto read_pblh =
pp.queryAdd(
"most.pblh_calc", pblh_string_in);
159 pblh_string = amrex::toLower(pblh_string_in);
161 if (pblh_string ==
"none") {
163 }
else if (pblh_string ==
"mynn25") {
165 }
else if (pblh_string ==
"mynnedmf") {
167 }
else if (pblh_string ==
"ysu") {
169 }
else if (pblh_string ==
"mrf") {
172 amrex::Abort(
"Undefined PBLH calc type!");
178 "MOST PBL-height calculation and wstar correction are supported only on the z-low face.");
186 amrex::Abort(
"erf.most.include_wstar requires a PBL height: set "
187 "erf.most.pblh_calc (MYNN25 is the only scheme implemented)");
219 "Specified custom MOST qv flux without moisture model!");
221 amrex::Print() <<
"Using specified ustar, tstar, qstar for MOST = "
232 amrex::Print() <<
"Using specified Cd, Ch, Cq for MOST = "
234 <<
m_Cq << std::endl;
246 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
252 amrex::Abort(
"Can only specify one of surf_temp_flux or surf_heating_rate");
280 "HEAT_FLUX and ADIABATIC surface-layer fluxes are supported only on the z-low face.");
290 std::string bogus_input;
291 if (
pp.queryAdd(
"most.roughness_type", bogus_input) > 0) {
292 amrex::Abort(
"most.roughness_type is deprecated; use "
293 "most.roughness_type_land and/or most.roughness_type_sea");
297 std::string rough_land_string_in;
298 std::string rough_land_string{
"constant"};
299 auto read_rough_land =
300 pp.queryAdd(
"most.roughness_type_land", rough_land_string_in);
301 if (read_rough_land) {
302 rough_land_string = amrex::toLower(rough_land_string_in);
304 if (rough_land_string ==
"constant") {
307 amrex::Abort(
"Undefined MOST roughness type for land!");
312 amrex::Print() <<
"The smooth-flow limit will be included for variable roughness models over sea: " <<
smooth_flow_visc <<
"\n";
315 std::string rough_sea_string_in;
316 std::string rough_sea_string{
"charnock"};
317 auto read_rough_sea =
pp.queryAdd(
"most.roughness_type_sea", rough_sea_string_in);
318 if (read_rough_sea) {
319 rough_sea_string = amrex::toLower(rough_sea_string_in);
321 if (rough_sea_string ==
"charnock") {
323 pp.queryAdd(
"most.charnock_constant",
cnk_a);
325 amrex::Print() <<
"If there is water, Charnock relation with C_a="
326 <<
cnk_a <<
" will be used" << std::endl;
328 amrex::Print() <<
"If there is water, Charnock relation with variable "
329 "Charnock parameter (COARE3.0) will be used" << std::endl;
331 }
else if (rough_sea_string ==
"coare3.0") {
333 amrex::Print() <<
"If there is water, Charnock relation with variable "
334 "Charnock parameter (COARE3.0) will be used" << std::endl;
336 }
else if (rough_sea_string ==
"donelan") {
338 }
else if (rough_sea_string ==
"modified_charnock") {
340 pp.queryAdd(
"most.modified_charnock_depth",
depth);
342 amrex::Print() <<
"Specified depth of " <<
depth
343 <<
" is outside the valid range of [10 100], resetting to bounds now."
348 }
else if (rough_sea_string ==
"wave_coupled") {
350 }
else if (rough_sea_string ==
"constant") {
353 amrex::Abort(
"Undefined MOST roughness type for sea!");
370 "RANS surface-layer k updates are supported only on the z-low face.");
402 const amrex::Vector<amrex::MultiFab*>& mfv,
403 std::unique_ptr<amrex::MultiFab>& Theta_prim,
404 std::unique_ptr<amrex::MultiFab>& Qv_prim,
405 std::unique_ptr<amrex::MultiFab>& Qr_prim,
406 std::unique_ptr<amrex::MultiFab>& z_phys_nd,
407 amrex::MultiFab* Hwave,
408 amrex::MultiFab* Lwave,
409 amrex::MultiFab* eddyDiffs,
410 amrex::Vector<amrex::MultiFab*> lsm_data,
411 amrex::Vector<std::string> lsm_data_name,
412 amrex::Vector<amrex::MultiFab*> lsm_flux,
413 amrex::Vector<std::string> lsm_flux_name,
414 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& sst_lev,
415 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& tsk_lev,
416 amrex::Vector<std::unique_ptr<amrex::iMultiFab>>& lmask_lev)
420 Theta_prim, Qv_prim, Qr_prim,
424 amrex::MultiFab& mf = *(mfv[0]);
430 const int nghost = 0;
432 amrex::ParallelDescriptor::ReduceIntMin(lmask_min);
438 "Variable sea roughness surface-layer fluxes are supported only on the z-low face.");
440 std::string rough_sea_string{
"charnock"};
441 pp.queryAdd(
"most.roughness_type_sea", rough_sea_string);
442 amrex::Print() <<
"Variable sea roughness (type " << rough_sea_string
477 int nt_tot_sst = sst_lev.size();
479 for (
int nt(0); nt < nt_tot_sst; ++nt) {
482 int nt_tot_tsk =
static_cast<int>(tsk_lev.size());
484 for (
int nt(0); nt < nt_tot_tsk; ++nt) {
487 int nt_tot_lmask =
static_cast<int>(lmask_lev.size());
489 for (
int nt(0); nt < nt_tot_lmask; ++nt) {
504 amrex::Abort(
"Only one of most.use_sfc_fluxes and most.use_sfc_sst may be enabled");
508 amrex::Abort(
"Text-file surface forcing is not supported with EB terrain");
512 "most.use_sfc_fluxes and most.use_sfc_sst are supported only on the z-low face.");
515 std::string sfc_file =
"";
516 pp.queryAdd(
"most.sfc_file", sfc_file);
517 if (sfc_file.empty()) {
518 amrex::Abort(
"most.sfc_file must be set when using text-file surface forcing");
525 if (
static_cast<int>(
sfc.size()) < min_cols) {
526 amrex::Abort(
"Surface forcing file does not contain the required number of columns");
531 for (
int i = 0; i < static_cast<int>(
sfc[0].size()); ++i) {
532 sfc[0][i] = 86400.0 * (
sfc[0][i] - start_day);
537 amrex::Abort(
"most.use_sfc_sst cannot be combined with prescribed heat flux or surf_heating_rate");
540 amrex::Abort(
"most.use_sfc_sst cannot be combined with prescribed moisture flux");
543 amrex::Print() <<
"Using MOST with prescribed SST from most.sfc_file '" << sfc_file <<
"' over sea" << std::endl;
548 amrex::Print() <<
"Using MOST with prescribed time-varying surface fluxes from '" << sfc_file <<
"'" << std::endl;
553 int ndata =
static_cast<int>(lsm_data.size());
554 int nflux =
static_cast<int>(lsm_flux.size());
559 for (
int n(0); n < ndata; ++n) {
562 const std::string lc_name = amrex::toLower(lsm_data_name[n]);
563 if (lc_name ==
"theta" || lc_name ==
"t_surf") {
569 amrex::Abort(
"most.use_sfc_sst cannot be combined with an ocean LSM t_surf input");
571 int n_valid_lsm_flux = 0;
572 bool has_soil_t_flux =
false;
573 for (
int n(0); n < nflux; ++n) {
578 has_soil_t_flux =
true;
582 (n_valid_lsm_flux==1 && has_soil_t_flux)));
590 bool read_z0 =
false;
593 int count =
pp.countval(
"most.roughness_file_name");
596 pp.query(
"most.roughness_file_name", fname, lev);
598 }
else if (count == 1) {
600 pp.queryAdd(
"most.roughness_file_name", fname);
612 "Custom MOST roughness is supported only on the z-low face.");
622 "EB SurfaceLayer does not support planar SST/TSK, coupled SST, LSM surface "
623 "temperature or fluxes, or custom/file-driven roughness; no mapping exists "
624 "from those planar inputs to arbitrary EB cut cells.");
630 const int dir =
m_face.coordDir();
633 sm_index =
m_geom[lev].Domain().smallEnd(dir);
635 sm_index =
m_geom[lev].Domain().bigEnd(dir);
638 amrex::BoxArray ba = mf.boxArray();
639 amrex::BoxArray ba_flux;
640 amrex::IntVect
ng{1,1,0};
647 const int dom_lo_z =
m_geom[lev].Domain().smallEnd(2);
648 const int dom_hi_z =
m_geom[lev].Domain().bigEnd(2);
649 for (
int ibox = 0; ibox < ba.size(); ++ibox) {
651 ba[ibox].smallEnd(2) == dom_lo_z && ba[ibox].bigEnd(2) == dom_hi_z,
652 "Surface layer boundaries on x/y faces require Cartesian grids that "
653 "span the full level z domain; partial-height refined grids and grids "
654 "decomposed in z are not supported. Set erf.max_grid_size_z accordingly.");
661 ng = amrex::IntVect{1,1,1};
664 amrex::BoxList bl2d = ba.boxList();
665 for (
auto& b : bl2d) {
666 b.setRange(dir,sm_index);
668 ba_flux = amrex::BoxArray(std::move(bl2d));
673 ng = amrex::IntVect{1,1,0};
680 const amrex::DistributionMapping& dm = mf.DistributionMap();
687 const int ksurface =
m_face.isLow()
688 ?
m_geom[lev].Domain().smallEnd(2)
689 :
m_geom[lev].Domain().bigEnd(2);
695 z_0[lev].define(ba_flux, dm, ncomp,
ng);
703 u_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
706 w_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
709 t_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
712 q_star[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
715 olen[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
718 pblh[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
721 t_surf[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
724 q_surf[lev] = std::make_unique<amrex::MultiFab>(ba_flux, dm, ncomp,
ng);
727 const amrex::iMultiFab& surface_mask = *
m_lmask_lev[lev][0];
729 surface_mask.boxArray().size() == mf.boxArray().size(),
730 "Surface-layer mask and state must have the same number of boxes.");
732 surface_mask.DistributionMap() == mf.DistributionMap(),
733 "Surface-layer mask and state must have identical ownership.");
735 surface_mask.boxArray().size() ==
u_star[lev]->boxArray().size(),
736 "Surface-layer mask and parameters must have the same number of boxes.");
738 surface_mask.DistributionMap() ==
u_star[lev]->DistributionMap(),
739 "Surface-layer mask and parameters must have identical ownership.");
754 amrex::Print() <<
"Using MOST with specified surface temperature ";
757 }
else if (!use_sst && !use_tsk) {
758 amrex::Print() <<
"(land: T0, sea: none)";
765 amrex::Print() <<
"(land: TSK, ";
767 amrex::Print() <<
"(land: T0, ";
769 if (use_tsk && !use_sst) {
770 amrex::Print() <<
"sea: TSK)";
772 amrex::Print() <<
"sea: SST)";
780 amrex::Print() <<
" + coupled ocean SST where covered";
782 amrex::Print() << std::endl;
799 const double& elapsed_time,
800 const double& elapsed_time_since_start_low,
801 amrex::MultiFab& cons_in,
802 const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
803 const std::unique_ptr<amrex::MultiFab>& walldist,
804 int max_iters = 100);
815 template <
typename FluxIter>
817 const int& max_iters,
818 amrex::MultiFab& cons_in,
819 const FluxIter& most_flux,
832 amrex::MultiFab&
cons,
833 const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
877 amrex::Vector<const amrex::MultiFab*> mfs,
878 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
879 amrex::MultiFab* xheat_flux,
880 amrex::MultiFab* yheat_flux,
881 amrex::MultiFab* zheat_flux,
882 amrex::MultiFab* xqv_flux,
883 amrex::MultiFab* yqv_flux,
884 amrex::MultiFab* zqv_flux,
885 const amrex::MultiFab* z_phys);
901 amrex::Vector<const amrex::MultiFab*> mfs,
902 amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_lev,
903 amrex::MultiFab* xheat_flux,
904 amrex::MultiFab* yheat_flux,
905 amrex::MultiFab* zheat_flux,
906 amrex::MultiFab* xqv_flux,
907 amrex::MultiFab* yqv_flux,
908 amrex::MultiFab* zqv_flux);
925 template <
typename FluxCalc>
927 amrex::Vector<const amrex::MultiFab*> mfs,
928 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
929 amrex::MultiFab* xheat_flux,
930 amrex::MultiFab* yheat_flux,
931 amrex::MultiFab* zheat_flux,
932 amrex::MultiFab* xqv_flux,
933 amrex::MultiFab* yqv_flux,
934 amrex::MultiFab* zqv_flux,
935 const amrex::MultiFab* z_phys,
936 const FluxCalc& flux_comp);
952 template <
typename FluxCalc>
954 amrex::Vector<const amrex::MultiFab*> mfs,
955 amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_lev,
956 amrex::MultiFab* xheat_flux,
957 amrex::MultiFab* yheat_flux,
958 amrex::MultiFab* zheat_flux,
959 amrex::MultiFab* xqv_flux,
960 amrex::MultiFab* yqv_flux,
961 amrex::MultiFab* zqv_flux,
962 const FluxCalc& flux_comp);
971 amrex::MultiFab& cons_in);
990 const amrex::MultiFab& cons_in,
991 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1004 const amrex::MultiFab& cons_in,
1005 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1015 const amrex::MultiFab& cons_in,
1016 const std::unique_ptr<amrex::MultiFab>& z_phys_nd);
1018 void set_pblh(
const int& lev,
const amrex::MultiFab& pblh_in);
1052 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
1053 amrex::MultiFab* z_phys_cc,
1065 template <
typename PBLHeightEstimator>
1067 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars,
1068 amrex::MultiFab* z_phys_cc,
1069 const PBLHeightEstimator& est,
1079 const std::string& fname);
1096 int nlevs =
static_cast<int>(
t_surf.size());
1097 for (
int lev = 0; lev < nlevs; lev++) {
1098 if (!
t_surf[lev]) {
continue; }
1100 amrex::Print() <<
"Surface temp at t=" << time <<
": "
1116 amrex::Vector<amrex::Vector<amrex::MultiFab>>& vars_old,
1117 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Theta_prim,
1118 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qv_prim,
1119 amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Qr_prim)
1287 amrex::MultiFab*
get_z0 (
const int& lev) {
return &
z_0[lev]; }
1310 int lmask_min = amrex::ReduceMin(lmask, nghost, [=] AMREX_GPU_HOST_DEVICE(
1311 amrex::Box
const& bx, amrex::Array4<int const>
const& lm_arr) ->
int
1313 int locmin = std::numeric_limits<int>::max();
1314 const auto lo = lbound(bx);
1315 const auto hi = ubound(bx);
1316 for (
int j =
lo.y; j <=
hi.y; ++j) {
1317 for (
int i =
lo.x; i <=
hi.x; ++i) {
1318 locmin = std::min(locmin, lm_arr(i, j, 0));
1362 amrex::MultiFab* sst_ptr,
1363 amrex::iMultiFab* valid_ptr) {
1398 static amrex::Vector<amrex::Vector<amrex::Real>>
1399 read_cols(
const std::string& fname,
const int skip_nlines = 1);
1411 amrex::MultiFab* selected_field =
nullptr);
1483 amrex::Vector<amrex::MultiFab>
z_0;
1498 amrex::Vector<amrex::Vector<amrex::Real>>
sfc;
1517 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
u_star;
1518 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
w_star;
1519 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_star;
1520 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_star;
1521 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
olen;
1522 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
pblh;
1523 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
t_surf;
1524 amrex::Vector<std::unique_ptr<amrex::MultiFab>>
q_surf;
1539 amrex::DistributionMapping
dm;
1549 const amrex::BoxArray& ba,
1550 const amrex::DistributionMapping& dm);
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:17
constexpr amrex::Real RdoCp
Definition: ERF_Constants.H:41
Defines EB Monin-Obukhov surface-layer flux functors.
Declares the embedded-boundary factory manager used by ERF levels.
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:30
constexpr amrex::Real zero
Definition: ERF_NumericalConstants.H:29
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:59
ThetaCalcType theta_type
Definition: ERF_SurfaceLayer.H:1444
int lmask_min_reduce(amrex::iMultiFab &lmask, const int &nghost)
Definition: ERF_SurfaceLayer.H:1307
amrex::Vector< std::string > m_lsm_data_name
Definition: ERF_SurfaceLayer.H:1570
bool m_include_wstar
Definition: ERF_SurfaceLayer.H:1461
amrex::Real interpolate_sfc_column(const amrex::Real &time, int col) const
Definition: ERF_SurfaceLayer.cpp:397
bool specified_rho_surf
Definition: ERF_SurfaceLayer.H:1479
void set_q_surf(const int &lev, const amrex::Real qsurf)
Definition: ERF_SurfaceLayer.H:1266
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:23
bool m_rotate
Definition: ERF_SurfaceLayer.H:1455
amrex::Real sfc_tflux
Definition: ERF_SurfaceLayer.H:1500
PBLHeightCalcType pblh_type
Definition: ERF_SurfaceLayer.H:1448
amrex::Vector< amrex::Vector< amrex::iMultiFab * > > m_lmask_lev
Definition: ERF_SurfaceLayer.H:1558
double m_final_low_time
Definition: ERF_SurfaceLayer.H:1458
amrex::Vector< PlanarBoundary > m_planar_bndry
Definition: ERF_SurfaceLayer.H:1529
amrex::iMultiFab * get_lmask(const int &lev)
Definition: ERF_SurfaceLayer.H:1299
bool use_moisture
Definition: ERF_SurfaceLayer.H:1489
amrex::Vector< PBLHColumns > m_pblh_columns
Definition: ERF_SurfaceLayer.H:1547
amrex::MultiFab * get_q_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:1258
bool m_has_lsm_tsurf
Definition: ERF_SurfaceLayer.H:1491
amrex::MultiFab * get_w_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1136
amrex::Real m_Cq
Definition: ERF_SurfaceLayer.H:1510
amrex::Vector< const eb_ * > m_eb_vec
Definition: ERF_SurfaceLayer.H:1513
RoughCalcType rough_type_land
Definition: ERF_SurfaceLayer.H:1446
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:2216
amrex::Real sfc_qflux
Definition: ERF_SurfaceLayer.H:1499
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_surf
Definition: ERF_SurfaceLayer.H:1523
bool m_use_sfc_fluxes
Definition: ERF_SurfaceLayer.H:1495
amrex::Real z0_const
Definition: ERF_SurfaceLayer.H:1462
amrex::Vector< std::unique_ptr< amrex::MultiFab > > surface_diagnostic_source
Definition: ERF_SurfaceLayer.H:1554
amrex::Real cnk_a
Definition: ERF_SurfaceLayer.H:1480
amrex::Real m_Ch
Definition: ERF_SurfaceLayer.H:1509
amrex::Real surf_temp
Definition: ERF_SurfaceLayer.H:1469
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:1115
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:1520
int m_lsm_tsurf_indx
Definition: ERF_SurfaceLayer.H:1492
double m_start_low_time
Definition: ERF_SurfaceLayer.H:1457
bool mac_avg_is_initialized(const int &lev) const
Definition: ERF_SurfaceLayer.H:1204
bool mac_avg_is_time_averaged() const
Definition: ERF_SurfaceLayer.H:1192
amrex::Real rico_qsat_z0
Definition: ERF_SurfaceLayer.H:1487
bool m_has_lsm_fluxes
Definition: ERF_SurfaceLayer.H:1490
bool m_update_k_rans
Definition: ERF_SurfaceLayer.H:1576
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={})
Definition: ERF_SurfaceLayer.H:81
amrex::Vector< amrex::MultiFab * > m_Lwave_lev
Definition: ERF_SurfaceLayer.H:1573
void get_lsm_tsurf(const int &lev)
Definition: ERF_SurfaceLayer.cpp:2035
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:1883
amrex::Real get_zref(const int &lev)
Definition: ERF_SurfaceLayer.H:1280
amrex::MultiFab * get_olen(const int &lev)
Definition: ERF_SurfaceLayer.H:1169
bool computes_w_star() const
Definition: ERF_SurfaceLayer.H:1142
amrex::Vector< amrex::MultiFab > z_0
Definition: ERF_SurfaceLayer.H:1483
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:2079
amrex::Real surf_moist_flux
Definition: ERF_SurfaceLayer.H:1474
bool smooth_flow_visc
Definition: ERF_SurfaceLayer.H:1481
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:1447
void update_coupled_sst_ptr(const int lev, amrex::MultiFab *sst_ptr, amrex::iMultiFab *valid_ptr)
Definition: ERF_SurfaceLayer.H:1361
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:2428
std::string m_pp_prefix
Definition: ERF_SurfaceLayer.H:1453
amrex::Real surface_sum(const int &lev, const amrex::MultiFab &mf, int comp=0) const
Definition: ERF_SurfaceLayer.cpp:360
amrex::Real surf_moist
Definition: ERF_SurfaceLayer.H:1473
amrex::Vector< std::unique_ptr< amrex::MultiFab > > w_star
Definition: ERF_SurfaceLayer.H:1518
bool m_ignore_sst
Definition: ERF_SurfaceLayer.H:1511
int get_num_mac_avg() const
Definition: ERF_SurfaceLayer.H:1197
amrex::Vector< amrex::Vector< amrex::Real > > sfc
Definition: ERF_SurfaceLayer.H:1498
amrex::MultiFab * get_u_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1129
double m_low_time_interval
Definition: ERF_SurfaceLayer.H:1459
amrex::GpuArray< int, AMREX_SPACEDIM *2 > m_surface_layer_faces
Definition: ERF_SurfaceLayer.H:1456
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:1236
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_data_lev
Definition: ERF_SurfaceLayer.H:1568
void set_t_surf(const int &lev, const amrex::Real tsurf)
Definition: ERF_SurfaceLayer.H:1251
amrex::Real custom_qstar
Definition: ERF_SurfaceLayer.H:1477
amrex::Vector< std::unique_ptr< amrex::MultiFab > > u_star
Definition: ERF_SurfaceLayer.H:1517
void update_tsk_ptr(const int lev, const int itime, amrex::MultiFab *tsk_ptr)
Definition: ERF_SurfaceLayer.H:1345
amrex::Real custom_rhosurf
Definition: ERF_SurfaceLayer.H:1478
amrex::Vector< std::unique_ptr< amrex::MultiFab > > q_surf
Definition: ERF_SurfaceLayer.H:1524
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_sst_lev
Definition: ERF_SurfaceLayer.H:1556
FluxCalcType
Definition: ERF_SurfaceLayer.H:1413
@ 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:1515
MoistCalcType
Definition: ERF_SurfaceLayer.H:1427
@ SURFACE_MOISTURE
Surface Qv specified.
@ MOISTURE_FLUX
Qv-flux specified.
amrex::Real depth
Definition: ERF_SurfaceLayer.H:1482
amrex::Vector< amrex::MultiFab * > m_coupled_sst_lev
Definition: ERF_SurfaceLayer.H:1566
void fill_lateral_surface_parameter_ghosts(const int &lev, amrex::MultiFab *selected_field=nullptr)
Definition: ERF_SurfaceLayer.cpp:606
amrex::Vector< amrex::MultiFab * > m_Hwave_lev
Definition: ERF_SurfaceLayer.H:1572
amrex::Real default_land_surf_moist
Definition: ERF_SurfaceLayer.H:1472
void update_sfc_time_index(const amrex::Real &time)
Definition: ERF_SurfaceLayer.cpp:380
bool m_var_z0
Definition: ERF_SurfaceLayer.H:1484
amrex::Vector< amrex::iMultiFab * > m_coupled_sst_valid_lev
Definition: ERF_SurfaceLayer.H:1567
amrex::MultiFab * get_surface_diagnostic_source(const int &lev)
Definition: ERF_SurfaceLayer.H:1273
amrex::MultiFab * get_t_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1155
bool have_variable_sea_roughness()
Definition: ERF_SurfaceLayer.H:1292
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:789
amrex::MultiFab * get_q_star(const int &lev)
Definition: ERF_SurfaceLayer.H:1162
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_lsm_flux_lev
Definition: ERF_SurfaceLayer.H:1569
amrex::MultiFab * get_mac_avg_ptr(const int &lev, int comp)
Definition: ERF_SurfaceLayer.H:1219
amrex::Vector< amrex::Real > get_mac_plane_avg(const int &lev) const
Definition: ERF_SurfaceLayer.H:1227
void set_pblh(const int &lev, const amrex::MultiFab &pblh_in)
Definition: ERF_SurfaceLayer.cpp:2233
void fill_planar_boundary(const int &lev, amrex::MultiFab &mf)
Definition: ERF_SurfaceLayer.cpp:344
PBLHeightCalcType
Definition: ERF_SurfaceLayer.H:1441
amrex::MultiFab * get_pblh(const int &lev)
Definition: ERF_SurfaceLayer.H:1176
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:1486
amrex::Real sfc_ustar
Definition: ERF_SurfaceLayer.H:1501
amrex::Real surf_temp_flux
Definition: ERF_SurfaceLayer.H:1471
amrex::Vector< amrex::Geometry > m_geom
Definition: ERF_SurfaceLayer.H:1454
amrex::Vector< std::unique_ptr< amrex::MultiFab > > t_star
Definition: ERF_SurfaceLayer.H:1519
int sfc_time_ind
Definition: ERF_SurfaceLayer.H:1497
bool computes_pblh() const
Definition: ERF_SurfaceLayer.H:1148
amrex::Real theta_ref
Definition: ERF_SurfaceLayer.H:1578
amrex::MultiFab * get_z0(const int &lev)
Definition: ERF_SurfaceLayer.H:1287
amrex::Vector< amrex::Vector< amrex::MultiFab * > > m_tsk_lev
Definition: ERF_SurfaceLayer.H:1557
void set_surface_layer_faces(const amrex::GpuArray< int, AMREX_SPACEDIM *2 > &active_faces)
Definition: ERF_SurfaceLayer.H:1386
void update_surf_temp(const double &time)
Definition: ERF_SurfaceLayer.H:1086
void set_coupled_sst_active(const bool active)
Definition: ERF_SurfaceLayer.H:1376
void fill_tsurf_with_sst_and_tsk(const int &lev, const double &time)
Definition: ERF_SurfaceLayer.cpp:1682
amrex::Real custom_tstar
Definition: ERF_SurfaceLayer.H:1476
static amrex::Vector< amrex::Vector< amrex::Real > > read_cols(const std::string &fname, const int skip_nlines=1)
Definition: ERF_SurfaceLayer.cpp:2639
amrex::Real surf_heating_rate
Definition: ERF_SurfaceLayer.H:1470
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:400
RoughCalcType
Definition: ERF_SurfaceLayer.H:1433
FluxCalcType flux_type
Definition: ERF_SurfaceLayer.H:1443
MoistCalcType moist_type
Definition: ERF_SurfaceLayer.H:1445
bool m_use_sfc_sst
Definition: ERF_SurfaceLayer.H:1496
void compute_sfc_params_from_lsm_fluxes(const int &lev, amrex::MultiFab &cons_in)
Definition: ERF_SurfaceLayer.cpp:1595
amrex::Real inv_Cmu2
Definition: ERF_SurfaceLayer.H:1577
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:725
amrex::Vector< amrex::MultiFab * > m_eddyDiffs_lev
Definition: ERF_SurfaceLayer.H:1574
const amrex::MultiFab * get_mac_avg(const int &lev, int comp)
Definition: ERF_SurfaceLayer.H:1184
void update_sst_ptr(const int lev, const int itime, amrex::MultiFab *sst_ptr)
Definition: ERF_SurfaceLayer.H:1334
amrex::Real custom_ustar
Definition: ERF_SurfaceLayer.H:1475
amrex::Vector< std::unique_ptr< amrex::MultiFab > > olen
Definition: ERF_SurfaceLayer.H:1521
bool m_use_coupled_sst
Definition: ERF_SurfaceLayer.H:1506
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:1769
amrex::Orientation m_face
Definition: ERF_SurfaceLayer.H:1452
amrex::MultiFab * get_t_surf(const int &lev)
Definition: ERF_SurfaceLayer.H:1243
amrex::Real m_Cd
Definition: ERF_SurfaceLayer.H:1508
void set_mac_avg_initialized(const int &lev)
Definition: ERF_SurfaceLayer.H:1211
amrex::Vector< std::unique_ptr< amrex::MultiFab > > pblh
Definition: ERF_SurfaceLayer.H:1522
amrex::Real default_land_surf_temp
Definition: ERF_SurfaceLayer.H:1463
ThetaCalcType
Definition: ERF_SurfaceLayer.H:1421
@ 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:2363
void read_custom_roughness(const int &lev, const std::string &fname)
Definition: ERF_SurfaceLayer.cpp:2511
TerrainType m_terrain_type
Definition: ERF_SurfaceLayer.H:1514
amrex::Vector< std::string > m_lsm_flux_name
Definition: ERF_SurfaceLayer.H:1571
MOSTAverage m_ma
Definition: ERF_SurfaceLayer.H:1516
@ ng
Definition: ERF_Morrison.H:50
@ cons
Definition: ERF_IndexDefines.H:214
Definition: ERF_SurfaceLayer.H:28
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:31
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:223
Definition: ERF_SurfaceLayer.H:1537
bool needed
Definition: ERF_SurfaceLayer.H:1540
amrex::BoxArray ba
Definition: ERF_SurfaceLayer.H:1538
amrex::BoxArray ba_col2d
Definition: ERF_SurfaceLayer.H:1542
amrex::MultiFab hold_col2d
Definition: ERF_SurfaceLayer.H:1545
amrex::MultiFab hold_col
Definition: ERF_SurfaceLayer.H:1544
amrex::DistributionMapping dm_col
Definition: ERF_SurfaceLayer.H:1543
amrex::DistributionMapping dm
Definition: ERF_SurfaceLayer.H:1539
amrex::BoxArray ba_col
Definition: ERF_SurfaceLayer.H:1541
Definition: ERF_TurbStruct.H:115
RANSType rans_type
Selected RANS closure.
Definition: ERF_TurbStruct.H:754
amrex::Real theta_ref
Reference potential temperature for stable stratification.
Definition: ERF_TurbStruct.H:743
bool dirichlet_k
Whether TKE uses Dirichlet boundary treatment.
Definition: ERF_TurbStruct.H:756
amrex::Real Cmu0
One-equation RANS Cmu0 coefficient.
Definition: ERF_TurbStruct.H:732