ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
surface_flux_eb Struct Reference

EB surface-layer model with prescribed surface fluxes and constant roughness. More...

#include <ERF_EBMOSTStress.H>

Collaboration diagram for surface_flux_eb:

Public Member Functions

 surface_flux_eb (amrex::Real Tflux, amrex::Real Qvflux, bool cons_qflux)
 Construct a prescribed-flux EB functor. More...
 
AMREX_GPU_DEVICE AMREX_FORCE_INLINE void iterate_flux (const int &i, const int &j, const int &k, const int &max_iters, const amrex::Array4< const amrex::Real > &zref_arr, const amrex::Array4< const amrex::Real > &z0_arr, const amrex::Array4< const amrex::Real > &umm_arr, const amrex::Array4< const amrex::Real > &tm_arr, const amrex::Array4< const amrex::Real > &tvm_arr, const amrex::Array4< const amrex::Real > &qvm_arr, const amrex::Array4< amrex::Real > &u_star_arr, const amrex::Array4< amrex::Real > &w_star_arr, const amrex::Array4< amrex::Real > &t_star_arr, const amrex::Array4< amrex::Real > &q_star_arr, const amrex::Array4< amrex::Real > &t_surf_arr, const amrex::Array4< amrex::Real > &q_surf_arr, const amrex::Array4< amrex::Real > &olen_arr, const amrex::Array4< amrex::Real > &pblh_arr, const amrex::Array4< amrex::Real > &, const amrex::Array4< amrex::Real > &, const amrex::Array4< amrex::Real > &) const
 Iterate MOST stability functions and update implied surface values. More...
 

Private Attributes

most_data mdata
 
bool spec_qflux
 
similarity_funs sfuns
 
const amrex::Real tol = amrex::Real(1.0e-5)
 
const amrex::Real alpha = amrex::Real(0.5)
 
const amrex::Real WSMIN = amrex::Real(0.1)
 

Detailed Description

EB surface-layer model with prescribed surface fluxes and constant roughness.

Constructor & Destructor Documentation

◆ surface_flux_eb()

surface_flux_eb::surface_flux_eb ( amrex::Real  Tflux,
amrex::Real  Qvflux,
bool  cons_qflux 
)
inline

Construct a prescribed-flux EB functor.

Parameters
TfluxPrescribed surface temperature flux.
QvfluxPrescribed surface moisture flux.
cons_qfluxWhether the moisture flux is prescribed directly.
225  {
226  mdata.surf_temp_flux = Tflux;
227  mdata.surf_moist_flux = Qvflux;
228  spec_qflux = cons_qflux;
229  }
amrex::Real surf_moist_flux
Moisture flux.
Definition: ERF_MOSTUtils.H:19
amrex::Real surf_temp_flux
Heat flux TODO: decide whether this is <θ'w'> or <θv'w'> under moist conditions.
Definition: ERF_MOSTUtils.H:18
most_data mdata
Definition: ERF_EBMOSTStress.H:317
bool spec_qflux
Definition: ERF_EBMOSTStress.H:318

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_flux_eb::iterate_flux ( const int &  i,
const int &  j,
const int &  k,
const int &  max_iters,
const amrex::Array4< const amrex::Real > &  zref_arr,
const amrex::Array4< const amrex::Real > &  z0_arr,
const amrex::Array4< const amrex::Real > &  umm_arr,
const amrex::Array4< const amrex::Real > &  tm_arr,
const amrex::Array4< const amrex::Real > &  tvm_arr,
const amrex::Array4< const amrex::Real > &  qvm_arr,
const amrex::Array4< amrex::Real > &  u_star_arr,
const amrex::Array4< amrex::Real > &  w_star_arr,
const amrex::Array4< amrex::Real > &  t_star_arr,
const amrex::Array4< amrex::Real > &  q_star_arr,
const amrex::Array4< amrex::Real > &  t_surf_arr,
const amrex::Array4< amrex::Real > &  q_surf_arr,
const amrex::Array4< amrex::Real > &  olen_arr,
const amrex::Array4< amrex::Real > &  pblh_arr,
const amrex::Array4< amrex::Real > &  ,
const amrex::Array4< amrex::Real > &  ,
const amrex::Array4< amrex::Real > &   
) const
inline

Iterate MOST stability functions and update implied surface values.

256  {
257  int iter = 0;
259  amrex::Real wstar = zero;
260  amrex::Real tflux = zero;
261  amrex::Real qflux = zero;
262  amrex::Real zeta = zero;
263  amrex::Real psi_m = zero;
264  amrex::Real psi_h = zero;
266  amrex::Real zref = zref_arr(i,j,0);
267  amrex::Real C = std::log(zref / z0_arr(i,j,k));
268  amrex::Real zeta_fold = sfuns.calc_zeta_fold(C);
269  bool at_fold = false;
270  amrex::Real umm = std::max(umm_arr(i,j,0), WSMIN);
271  if (u_star_arr(i,j,k) == bogus_large_value) {
272  u_star_arr(i,j,k) = mdata.kappa * umm / most_bracket(C, zero);
273  } else {
274  Olen = olen_arr(i,j,k);
275  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
276  psi_m = sfuns.calc_psi_m(zeta);
277  psi_h = sfuns.calc_psi_h(zeta);
278  }
279  most_aitken accel;
280  do {
281  ustar = u_star_arr(i,j,k);
282  qflux = (spec_qflux) ? mdata.surf_moist_flux :
283  -(qvm_arr(i,j,0) - q_surf_arr(i,j,k)) * ustar * mdata.kappa /
284  most_bracket(C, psi_h); // <w'Qv'>
285  tflux = mdata.surf_temp_flux*(one + epsv*qvm_arr(i,j,0)) + qflux*epsv*tm_arr(i,j,0);
286  if (w_star_arr) {
287  // update w* and Umagmean
288  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,0));
289  wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
290  umm = std::sqrt(umm_arr(i,j,0)*umm_arr(i,j,0) + wstar*wstar);
291  umm = std::max(umm, WSMIN);
292  }
293  Olen = -ustar * ustar * ustar * tvm_arr(i,j,0) / (mdata.kappa * mdata.gravity * tflux);
294  // Stable side bounded at the fold, where the prescribed flux stops having a solution
295  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
296  psi_m = sfuns.calc_psi_m(zeta);
297  psi_h = sfuns.calc_psi_h(zeta);
298  {
299  amrex::Real ustar_new = mdata.kappa * umm / most_bracket(C, psi_m);
300  u_star_arr(i,j,k) = (one - alpha) * ustar + alpha * ustar_new;
301  }
302  ++iter;
303  u_star_arr(i,j,k) = accel.update(u_star_arr(i,j,k), iter);
304  } while ((accel.extrapolated || std::abs(u_star_arr(i,j,k) - ustar) > tol) &&
305  iter <= max_iters);
306  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter <= max_iters,
307  "Maximum number of MOST iterations reached.");
308 
309  // Populate the stored MOST arrays; below the fold, apply the flux the wind can carry
310  most_flux_outputs(mdata, spec_qflux, at_fold, zeta_fold, C, psi_h, u_star_arr(i,j,k), zref,
311  tm_arr(i,j,0), tvm_arr(i,j,0), qvm_arr(i,j,0), qflux, Olen,
312  t_surf_arr(i,j,k), t_star_arr(i,j,k), q_surf_arr(i,j,k), q_star_arr(i,j,k));
313  olen_arr(i,j,k) = Olen;
314  }
constexpr amrex::Real epsv
Definition: ERF_Constants.H:56
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(axis >=0 &&axis< AMREX_SPACEDIM, "prob.axis must be 0, 1 or 2")
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_bracket(amrex::Real C, amrex::Real psi)
Definition: ERF_MOSTUtils.H:255
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void most_flux_outputs(const most_data &mdata, bool spec_qflux, bool at_fold, amrex::Real zeta_fold, amrex::Real C, amrex::Real psi_h, amrex::Real ustar, amrex::Real zref, amrex::Real tm, amrex::Real tvm, amrex::Real qvm, amrex::Real qflux, amrex::Real &olen, amrex::Real &t_surf, amrex::Real &t_star, amrex::Real &q_surf, amrex::Real &q_star)
Definition: ERF_MOSTUtils.H:492
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_clamp_zeta(amrex::Real zeta, amrex::Real zeta_fold, bool &at_fold)
Definition: ERF_MOSTUtils.H:396
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_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_wstar(const amrex::Real &ust, const amrex::Real &tst, const amrex::Real &qst, const amrex::Real &pblh, const amrex::Real &th, const amrex::Real &thv, const amrex::Real &qv=amrex::Real(0))
Definition: ERF_Wstar.H:27
@ ustar
Definition: ERF_SLM.H:28
Definition: ERF_MOSTUtils.H:530
bool extrapolated
whether the last update returned an extrapolated value
Definition: ERF_MOSTUtils.H:564
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real update(amrex::Real u_new, int iter)
Definition: ERF_MOSTUtils.H:540
amrex::Real kappa
von Karman constant
Definition: ERF_MOSTUtils.H:16
amrex::Real gravity
Acceleration due to gravity (m/s^2)
Definition: ERF_MOSTUtils.H:17
const amrex::Real Bjr_beta
Definition: ERF_MOSTUtils.H:32
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_m(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:132
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_zeta_fold(amrex::Real C) const
Definition: ERF_MOSTUtils.H:227
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_h(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:151
const amrex::Real WSMIN
Definition: ERF_EBMOSTStress.H:322
similarity_funs sfuns
Definition: ERF_EBMOSTStress.H:319
const amrex::Real tol
Definition: ERF_EBMOSTStress.H:320
const amrex::Real alpha
Definition: ERF_EBMOSTStress.H:321
Here is the call graph for this function:

Member Data Documentation

◆ alpha

const amrex::Real surface_flux_eb::alpha = amrex::Real(0.5)
private

Referenced by iterate_flux().

◆ mdata

most_data surface_flux_eb::mdata
private

Referenced by iterate_flux(), and surface_flux_eb().

◆ sfuns

similarity_funs surface_flux_eb::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_flux_eb::spec_qflux
private

Referenced by iterate_flux(), and surface_flux_eb().

◆ tol

const amrex::Real surface_flux_eb::tol = amrex::Real(1.0e-5)
private

Referenced by iterate_flux().

◆ WSMIN

const amrex::Real surface_flux_eb::WSMIN = amrex::Real(0.1)
private

Referenced by iterate_flux().


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