ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
Public Member Functions | Private Attributes | List of all members
surface_flux Struct Reference

#include <ERF_MOSTStress.H>

Collaboration diagram for surface_flux:
Collaboration graph
[legend]

Public Member Functions

 surface_flux (amrex::Real Tflux, amrex::Real Qvflux, 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< 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
 
similarity_funs sfuns
 
const amrex::Real tol = amrex::Real(1.0e-5)
 
const amrex::Real WSMIN = most_min_wind_speed
 
const amrex::Real USTARMIN = most_min_ustar
 
const amrex::Real alpha = amrex::Real(0.5)
 

Detailed Description

Surface flux with constant roughness

Constructor & Destructor Documentation

◆ surface_flux()

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

Construct specified-flux, constant-roughness MOST data.

Parameters
[in]Tfluxprescribed heat flux
[in]Qvfluxprescribed moisture flux
[in]cons_qfluxwhether the moisture flux is specified
514  {
515  mdata.surf_temp_flux = Tflux;
516  mdata.surf_moist_flux = Qvflux;
517  spec_qflux = cons_qflux;
518  }
most_data::surf_moist_flux
amrex::Real surf_moist_flux
Moisture flux.
Definition: ERF_MOSTUtils.H:19
most_data::surf_temp_flux
amrex::Real surf_temp_flux
Heat flux TODO: decide whether this is <θ'w'> or <θv'w'> under moist conditions.
Definition: ERF_MOSTUtils.H:18
surface_flux::mdata
most_data mdata
Definition: ERF_MOSTStress.H:617
surface_flux::spec_qflux
bool spec_qflux
Definition: ERF_MOSTStress.H:618

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_flux::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.
553  {
554  int iter = 0;
555  amrex::Real ustar = zero;
556  amrex::Real wstar = zero;
557  amrex::Real tflux = zero;
558  amrex::Real qflux = zero;
559  amrex::Real zeta = zero;
560  amrex::Real psi_m = zero;
561  amrex::Real psi_h = zero;
562  amrex::Real Olen = zero;
563  amrex::Real zref = zref_arr(i,j,k);
564  amrex::Real C = std::log(zref / z0_arr(i,j,k));
565  amrex::Real zeta_fold = sfuns.calc_zeta_fold(C);
566  bool at_fold = false;
567  amrex::Real umm = std::max(umm_arr(i,j,k), WSMIN);
568  if (u_star_arr(i,j,k) == bogus_large_value) {
569  u_star_arr(i,j,k) = mdata.kappa * umm / most_bracket(C, zero);
570  } else {
571  Olen = olen_arr(i,j,k);
572  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
573  psi_m = sfuns.calc_psi_m(zeta);
574  psi_h = sfuns.calc_psi_h(zeta);
575  }
576  most_aitken accel;
577  do {
578  ustar = u_star_arr(i,j,k);
579  qflux = (spec_qflux) ? mdata.surf_moist_flux :
580  -(qvm_arr(i,j,k) - q_surf_arr(i,j,k)) * ustar * mdata.kappa /
581  most_bracket(C, psi_h); // <w'Qv'>
582  tflux = mdata.surf_temp_flux*(one + epsv*qvm_arr(i,j,k)) + qflux*epsv*tm_arr(i,j,k);
583  if (w_star_arr) {
584  // update w* and Umagmean
585  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,k));
586  wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
587  amrex::Real umm_new = std::sqrt(umm_arr(i,j,k)*umm_arr(i,j,k) + wstar*wstar);
588  umm = (one - alpha) * umm + alpha * umm_new;
589  umm = std::max(umm, WSMIN);
590  }
591  amrex::Real ustar_floor = amrex::max(ustar, USTARMIN);
592  Olen = -ustar_floor * ustar_floor * ustar_floor * tvm_arr(i,j,k) /
593  (mdata.kappa * mdata.gravity * tflux);
594  // Stable side bounded at the fold, where the prescribed flux stops having a solution
595  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
596  psi_m = sfuns.calc_psi_m(zeta);
597  psi_h = sfuns.calc_psi_h(zeta);
598  {
599  amrex::Real ustar_new = mdata.kappa * umm / most_bracket(C, psi_m);
600  u_star_arr(i,j,k) = (one - alpha) * ustar + alpha * ustar_new;
601  }
602  ++iter;
603  u_star_arr(i,j,k) = accel.update(u_star_arr(i,j,k), iter);
604  } while ((accel.extrapolated || std::abs(u_star_arr(i,j,k) - ustar) > tol) &&
605  iter <= max_iters);
606  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter <= max_iters,
607  "Maximum number of MOST iterations reached.");
608 
609  // Populate the stored MOST arrays; below the fold, apply the flux the wind can carry
610  most_flux_outputs(mdata, spec_qflux, at_fold, zeta_fold, C, psi_h, u_star_arr(i,j,k), zref,
611  tm_arr(i,j,k), tvm_arr(i,j,k), qvm_arr(i,j,k), qflux, Olen,
612  t_surf_arr(i,j,k), t_star_arr(i,j,k), q_surf_arr(i,j,k), q_star_arr(i,j,k));
613  olen_arr(i,j,k) = Olen;
614  }
epsv
constexpr amrex::Real epsv
Definition: ERF_Constants.H:56
bogus_large_value
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
AMREX_ALWAYS_ASSERT_WITH_MESSAGE
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(axis >=0 &&axis< AMREX_SPACEDIM, "prob.axis must be 0, 1 or 2")
most_bracket
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_bracket(amrex::Real C, amrex::Real psi)
Definition: ERF_MOSTUtils.H:255
most_flux_outputs
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
most_clamp_zeta
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
one
constexpr amrex::Real one
Definition: ERF_NumericalConstants.H:37
zero
constexpr amrex::Real zero
Definition: ERF_NumericalConstants.H:36
Real
amrex::Real Real
Definition: ERF_ShocInterface.H:19
calc_wstar
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
LsmVar_SLM::ustar
@ ustar
Definition: ERF_SLM.H:28
most_aitken
Definition: ERF_MOSTUtils.H:530
most_aitken::extrapolated
bool extrapolated
whether the last update returned an extrapolated value
Definition: ERF_MOSTUtils.H:564
most_aitken::update
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real update(amrex::Real u_new, int iter)
Definition: ERF_MOSTUtils.H:540
most_data::kappa
amrex::Real kappa
von Karman constant
Definition: ERF_MOSTUtils.H:16
most_data::gravity
amrex::Real gravity
Acceleration due to gravity (m/s^2)
Definition: ERF_MOSTUtils.H:17
most_data::Bjr_beta
const amrex::Real Bjr_beta
Definition: ERF_MOSTUtils.H:32
similarity_funs::calc_psi_m
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_m(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:132
similarity_funs::calc_zeta_fold
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_zeta_fold(amrex::Real C) const
Definition: ERF_MOSTUtils.H:227
similarity_funs::calc_psi_h
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_h(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:151
surface_flux::sfuns
similarity_funs sfuns
Definition: ERF_MOSTStress.H:619
surface_flux::USTARMIN
const amrex::Real USTARMIN
Definition: ERF_MOSTStress.H:622
surface_flux::WSMIN
const amrex::Real WSMIN
Definition: ERF_MOSTStress.H:621
surface_flux::tol
const amrex::Real tol
Definition: ERF_MOSTStress.H:620
surface_flux::alpha
const amrex::Real alpha
Definition: ERF_MOSTStress.H:623
Here is the call graph for this function:

Member Data Documentation

◆ alpha

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

Referenced by iterate_flux().

◆ mdata

most_data surface_flux::mdata
private

Referenced by iterate_flux(), and surface_flux().

◆ sfuns

similarity_funs surface_flux::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_flux::spec_qflux
private

Referenced by iterate_flux(), and surface_flux().

◆ tol

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

Referenced by iterate_flux().

◆ USTARMIN

const amrex::Real surface_flux::USTARMIN = most_min_ustar
private

Referenced by iterate_flux().

◆ WSMIN

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

Referenced by iterate_flux().

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