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

#include <ERF_MOSTStress.H>

Collaboration diagram for surface_flux_wave_coupled:

Public Member Functions

 surface_flux_wave_coupled (amrex::Real Tflux, amrex::Real Qvflux, bool use_visc, bool cons_qflux)
 
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< 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 > &Hwave_arr, const amrex::Array4< amrex::Real > &Lwave_arr, const amrex::Array4< amrex::Real > &) const
 

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 eps = amrex::Real(1e-15)
 
const amrex::Real WSMIN = most_min_wind_speed
 

Detailed Description

Surface flux with wave-coupled roughness

Constructor & Destructor Documentation

◆ surface_flux_wave_coupled()

surface_flux_wave_coupled::surface_flux_wave_coupled ( amrex::Real  Tflux,
amrex::Real  Qvflux,
bool  use_visc,
bool  cons_qflux 
)
inline

Construct specified-flux, wave-coupled roughness MOST data.

Parameters
[in]Tfluxprescribed heat flux
[in]Qvfluxprescribed moisture flux
[in]cons_qfluxwhether the moisture flux is specified
1053  {
1054  mdata.surf_temp_flux = Tflux;
1055  mdata.surf_moist_flux = Qvflux;
1056  mdata.visc = use_visc;
1057  spec_qflux = cons_qflux;
1058  }
amrex::Real surf_moist_flux
Moisture flux.
Definition: ERF_MOSTUtils.H:19
bool visc
Use viscous Charnock formulation.
Definition: ERF_MOSTUtils.H:26
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_MOSTStress.H:1161
bool spec_qflux
Definition: ERF_MOSTStress.H:1162

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_flux_wave_coupled::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< 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 > &  Hwave_arr,
const amrex::Array4< amrex::Real > &  Lwave_arr,
const amrex::Array4< amrex::Real > &   
) const
inline

Iterate MOST state for one surface point.

Calling sequence
i, j, k, max_iters, zref_arr, z0_arr, umm_arr, tm_arr, tvm_arr, qvm_arr, u_star_arr, w_star_arr, t_star_arr, q_star_arr, t_surf_arr, q_surf_arr, olen_arr, pblh_arr, Hwave_arr, Lwave_arr, eta_arr.
1093  {
1094  int iter = 0;
1096  amrex::Real wstar = zero;
1097  amrex::Real tflux = zero;
1098  amrex::Real qflux = zero;
1099  amrex::Real z0 = zero;
1100  amrex::Real zeta = zero;
1101  amrex::Real psi_m = zero;
1102  amrex::Real psi_h = zero;
1103  amrex::Real Olen = zero;
1104  amrex::Real zref = zref_arr(i,j,k);
1105  amrex::Real C = std::log(zref / z0_arr(i,j,k));
1106  amrex::Real zeta_fold = sfuns.calc_zeta_fold(C);
1107  bool at_fold = false;
1108  amrex::Real umm = std::max(umm_arr(i,j,k), WSMIN);
1109  if (u_star_arr(i,j,k) == bogus_large_value) {
1110  u_star_arr(i,j,k) = mdata.kappa * umm / most_bracket(C, zero);
1111  } else {
1112  Olen = olen_arr(i,j,k);
1113  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
1114  psi_m = sfuns.calc_psi_m(zeta);
1115  psi_h = sfuns.calc_psi_h(zeta);
1116  }
1117  most_aitken accel;
1118  do {
1119  ustar = u_star_arr(i,j,k);
1120  // NOTE: air_viscosity should take T and not Th!
1121  z0 = WaveCoupled_roughness(Hwave_arr(i,j,k), Lwave_arr(i,j,k), eps, ustar,
1122  air_viscosity(tm_arr(i,j,k)), mdata.visc);
1123  C = std::log(zref / z0);
1124  zeta_fold = sfuns.calc_zeta_fold(C);
1125  qflux = (spec_qflux) ? mdata.surf_moist_flux :
1126  -(qvm_arr(i,j,k) - q_surf_arr(i,j,k)) * ustar * mdata.kappa /
1127  most_bracket(C, psi_h); // <w'Qv'>
1128  tflux = mdata.surf_temp_flux*(one + epsv*qvm_arr(i,j,k)) + qflux*epsv*tm_arr(i,j,k);
1129  if (w_star_arr) {
1130  // update w* and Umagmean
1131  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,k));
1132  wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
1133  umm = std::sqrt(umm_arr(i,j,k)*umm_arr(i,j,k) + wstar*wstar);
1134  umm = std::max(umm, WSMIN);
1135  }
1136  Olen = -ustar * ustar * ustar * tvm_arr(i,j,k) / (mdata.kappa * mdata.gravity * tflux);
1137  // Stable side bounded at the fold, where the prescribed flux stops having a solution
1138  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
1139  psi_m = sfuns.calc_psi_m(zeta);
1140  psi_h = sfuns.calc_psi_h(zeta);
1141  {
1142  amrex::Real ustar_new = mdata.kappa * umm / most_bracket(C, psi_m);
1143  u_star_arr(i,j,k) = (one - alpha) * ustar + alpha * ustar_new;
1144  }
1145  ++iter;
1146  u_star_arr(i,j,k) = accel.update(u_star_arr(i,j,k), iter);
1147  } while ((accel.extrapolated || std::abs(u_star_arr(i,j,k) - ustar) > tol) &&
1148  iter <= max_iters);
1149  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter <= max_iters,
1150  "Maximum number of MOST iterations reached.");
1151 
1152  // Populate the stored MOST arrays; below the fold, apply the flux the wind can carry
1153  z0_arr(i,j,k) = z0;
1154  most_flux_outputs(mdata, spec_qflux, at_fold, zeta_fold, C, psi_h, u_star_arr(i,j,k), zref,
1155  tm_arr(i,j,k), tvm_arr(i,j,k), qvm_arr(i,j,k), qflux, Olen,
1156  t_surf_arr(i,j,k), t_star_arr(i,j,k), q_surf_arr(i,j,k), q_star_arr(i,j,k));
1157  olen_arr(i,j,k) = Olen;
1158  }
constexpr amrex::Real epsv
Definition: ERF_Constants.H:56
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
Real z0
Definition: ERF_InitCustomPertVels_ScalarAdvDiff.H:12
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(axis >=0 &&axis< AMREX_SPACEDIM, "prob.axis must be 0, 1 or 2")
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real WaveCoupled_roughness(amrex::Real Hwave, amrex::Real Lwave, amrex::Real eps, amrex::Real ustar, amrex::Real nu, bool visc)
Definition: ERF_MOSTUtils.H:708
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_DEVICE AMREX_FORCE_INLINE amrex::Real air_viscosity(amrex::Real T_degK)
Definition: ERF_MOSTUtils.H:581
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_MOSTStress.H:1171
const amrex::Real alpha
Definition: ERF_MOSTStress.H:1165
similarity_funs sfuns
Definition: ERF_MOSTStress.H:1163
const amrex::Real tol
Definition: ERF_MOSTStress.H:1164
const amrex::Real eps
Definition: ERF_MOSTStress.H:1169
Here is the call graph for this function:

Member Data Documentation

◆ alpha

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

Referenced by iterate_flux().

◆ eps

const amrex::Real surface_flux_wave_coupled::eps = amrex::Real(1e-15)
private

Referenced by iterate_flux().

◆ mdata

most_data surface_flux_wave_coupled::mdata
private

◆ sfuns

similarity_funs surface_flux_wave_coupled::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_flux_wave_coupled::spec_qflux
private

◆ tol

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

Referenced by iterate_flux().

◆ WSMIN

const amrex::Real surface_flux_wave_coupled::WSMIN = most_min_wind_speed
private

Referenced by iterate_flux().


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