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

#include <ERF_MOSTStress.H>

Collaboration diagram for surface_temp:

Public Member Functions

 surface_temp (amrex::Real Tflux, amrex::Real Qvflux, bool cons_qflux, int face_dir, bool face_is_low)
 
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
 

Private Attributes

most_data mdata
 
bool spec_qflux {false}
 
similarity_funs sfuns
 
int dir
 
bool is_low = true
 
const amrex::Real tol = amrex::Real(1.0e-3)
 
const amrex::Real alpha = myhalf
 
const amrex::Real WSMIN = most_min_wind_speed
 

Detailed Description

Surface temperature with constant roughness

Constructor & Destructor Documentation

◆ surface_temp()

surface_temp::surface_temp ( amrex::Real  Tflux,
amrex::Real  Qvflux,
bool  cons_qflux,
int  face_dir,
bool  face_is_low 
)
inline

Construct specified-temperature, constant-roughness MOST data.

Parameters
[in]Tfluxprescribed heat flux
[in]Qvfluxprescribed moisture flux
[in]cons_qfluxwhether the moisture flux is specified
[in]face_dirface direction (x,y,z)
[in]face_is_lowface orientation (low or high face: 0 or 1)
1194  {
1195  mdata.surf_temp_flux = Tflux;
1196  mdata.surf_moist_flux = Qvflux;
1197  spec_qflux = cons_qflux;
1198  dir = face_dir;
1199  is_low = face_is_low;
1200  }
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
int dir
Definition: ERF_MOSTStress.H:1355
bool spec_qflux
Definition: ERF_MOSTStress.H:1353
bool is_low
Definition: ERF_MOSTStress.H:1356
most_data mdata
Definition: ERF_MOSTStress.H:1352

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_temp::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 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.
1235  {
1236  amrex::Real Rib = zero;
1237  amrex::Real zeta = zero;
1238  amrex::Real zeta_old = zero;
1239  amrex::Real psi_m = zero;
1240  amrex::Real psi_h = zero;
1241  amrex::Real CmPsim = zero;
1242  amrex::Real CmPsih = zero;
1243  amrex::Real zref = zref_arr(i,j,k);
1244  amrex::Real z0 = z0_arr(i,j,k);
1245  // NOTE: umm here will be either mean x/y velocity if on a Z-face, x/z velocity if on a Y-face, or y/z velocity if on an X-face
1246  amrex::Real umm = std::max(umm_arr(i,j,k), WSMIN);
1247  amrex::Real C = std::log(zref / z0);
1248 
1249  // First iteration we assume neutral (L -> inf)
1250  if (u_star_arr(i,j,k) == bogus_large_value) { olen_arr(i,j,k) = amrex::Real(1.0e3); }
1251  zeta = zref / olen_arr(i,j,k);
1252 
1253  amrex::Real t_surf = t_surf_arr(i,j,k);
1254  amrex::Real t_mean = tm_arr(i,j,k);
1255 
1256  // Water vapor in the atmosphere and at the surface
1257  const amrex::Real qv_a_raw = qvm_arr(i,j,k);
1258  const amrex::Real qv_s_raw = q_surf_arr(i,j,k);
1259  amrex::Real qv_s, qv_a;
1260  if (qv_s_raw > zero) {
1261  qv_s = qv_s_raw;
1262  } else {
1263  // First iteration and no qv_surf was specified
1264  // Use mean since there will be no flux
1265  qv_s = qv_a_raw;
1266  }
1267  qv_a = qv_a_raw;
1268 
1269  amrex::Real thv_s = t_surf_arr(i,j,k) * (one + epsv*qv_s);
1270  amrex::Real thv_a = tm_arr(i,j,k) * (one + epsv*qv_a);
1271 
1272  if (dir == 2 && !is_low) {
1273  // On the hi-Z face, swap surf and mean values to force unstable condition
1274  thv_a = thv_s;
1275  thv_s = tm_arr(i,j,k) * (one + epsv*qv_a);
1276  t_mean = t_surf;
1277  t_surf = tm_arr(i,j,k);
1278  qv_a = qv_s;
1279  qv_s = qv_a_raw;
1280  }
1281 
1282  // update w* and Umagmean from Beljaars (1995)
1283  if (w_star_arr) {
1284  // NOTE: Thv flux is lagged, similar to WRF
1285  psi_m = sfuns.calc_psi_m2(zeta);
1286  psi_h = sfuns.calc_psi_h2(zeta);
1287  amrex::Real ustar = mdata.kappa * umm / most_bracket(C, psi_m);
1288  amrex::Real tstar = mdata.kappa * (tm_arr(i,j,k) - t_surf_arr(i,j,k)) / most_bracket(C, psi_h);
1290  -ustar * mdata.kappa * (qv_a - qv_s) / most_bracket(C, psi_h);
1291  amrex::Real tflux = -ustar*tstar*(one + epsv*qvm_arr(i,j,k)) + epsv*tm_arr(i,j,k)*qflux;
1292  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,k));
1293  amrex::Real wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
1294  umm = std::sqrt(umm_arr(i,j,k)*umm_arr(i,j,k) + wstar*wstar);
1295  umm = std::max(umm, WSMIN);
1296  }
1297 
1298  // Bulk Richardson number w/ moisture
1299  Rib = ( (mdata.gravity * zref) / t_mean ) *
1300  ( (thv_a - thv_s) / (umm * umm) );
1301  Rib = std::min(std::max(Rib,-amrex::Real(4.0)),amrex::Real(4.0));
1302 
1303  // Fixed point iteration on zeta
1304  const amrex::Real zeta_start = zeta;
1305  int iter = 0;
1306  do {
1307  // Transfer curr to old
1308  zeta_old = zeta;
1309 
1310  // Stability functions
1311  psi_m = sfuns.calc_psi_m2(zeta_old);
1312  psi_h = sfuns.calc_psi_h2(zeta_old);
1313 
1314  // Limiting
1315  CmPsim = most_bracket(C, psi_m);
1316  CmPsih = most_bracket(C, psi_h);
1317 
1318  // Update with under relaxation
1319  zeta = (one - alpha) * zeta_old + alpha * Rib * CmPsim * CmPsim / CmPsih;
1320 
1321  ++iter;
1322  } while ( (std::abs(zeta - zeta_old) > tol) && (iter <= max_iters) );
1323  if (iter > max_iters ||
1324  !most_rib_zeta_is_root(sfuns, C, Rib, zeta, amrex::Real(10.0) * tol)) {
1325  // The relaxed iteration stalls, or stops where no root is near, where its residual
1326  // nearly touches zero (z0 comparable to zref); solve the same equation by bracketing
1327  zeta = most_rib_zeta_bracketed(sfuns, C, Rib, zeta_start, tol);
1328  CmPsim = most_bracket(C, sfuns.calc_psi_m2(zeta));
1329  CmPsih = most_bracket(C, sfuns.calc_psi_h2(zeta));
1330  }
1331 
1332  // Populate the stored MOST arrays
1333  olen_arr(i,j,k) = zref / zeta;
1334  u_star_arr(i,j,k) = mdata.kappa * umm / CmPsim;
1335  t_star_arr(i,j,k) = mdata.kappa * (t_mean - t_surf) / CmPsih;
1336  if (spec_qflux) {
1337  q_surf_arr(i,j,k) = mdata.surf_moist_flux * CmPsih /
1338  (u_star_arr(i,j,k) * mdata.kappa) + qv_a_raw;
1339  q_star_arr(i,j,k) = -mdata.surf_moist_flux / u_star_arr(i,j,k);
1340  } else {
1341  // q_star follows the raw atmospheric/surface contrast. The
1342  // existing high-z orientation reverses this contrast, matching
1343  // the corresponding thermodynamic and flux calculations above.
1344  const amrex::Real qv_delta = (dir == 2 && !is_low)
1345  ? (qv_s_raw - qv_a_raw)
1346  : (qv_a_raw - qv_s_raw);
1347  q_star_arr(i,j,k) = mdata.kappa * qv_delta / CmPsih;
1348  }
1349  }
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_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_rib_zeta_bracketed(const similarity_funs &sfuns, amrex::Real C, amrex::Real Rib, amrex::Real zeta0, amrex::Real tol)
Definition: ERF_MOSTUtils.H:330
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 bool most_rib_zeta_is_root(const similarity_funs &sfuns, amrex::Real C, amrex::Real Rib, amrex::Real zeta, amrex::Real delta)
Definition: ERF_MOSTUtils.H:300
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
@ tstar
Definition: ERF_SLM.H:29
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_h2(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:104
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_m2(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:79
similarity_funs sfuns
Definition: ERF_MOSTStress.H:1354
const amrex::Real tol
Definition: ERF_MOSTStress.H:1358
const amrex::Real alpha
Definition: ERF_MOSTStress.H:1359
const amrex::Real WSMIN
Definition: ERF_MOSTStress.H:1360
Here is the call graph for this function:

Member Data Documentation

◆ alpha

const amrex::Real surface_temp::alpha = myhalf
private

Referenced by iterate_flux().

◆ dir

int surface_temp::dir
private

Referenced by iterate_flux(), and surface_temp().

◆ is_low

bool surface_temp::is_low = true
private

Referenced by iterate_flux(), and surface_temp().

◆ mdata

most_data surface_temp::mdata
private

Referenced by iterate_flux(), and surface_temp().

◆ sfuns

similarity_funs surface_temp::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_temp::spec_qflux {false}
private

Referenced by iterate_flux(), and surface_temp().

◆ tol

const amrex::Real surface_temp::tol = amrex::Real(1.0e-3)
private

Referenced by iterate_flux().

◆ WSMIN

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

Referenced by iterate_flux().


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