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

#include <ERF_MOSTStress.H>

Collaboration diagram for surface_flux_charnock:

Public Member Functions

 surface_flux_charnock (amrex::Real Tflux, amrex::Real Qvflux, amrex::Real cnk_a, 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 > &, 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 alpha = amrex::Real(0.5)
 
const amrex::Real WSMIN = most_min_wind_speed
 

Detailed Description

Surface flux with charnock roughness

Constructor & Destructor Documentation

◆ surface_flux_charnock()

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

Construct specified-flux, Charnock-roughness MOST data.

Parameters
[in]Tfluxprescribed heat flux
[in]Qvfluxprescribed moisture flux
[in]cnk_aCharnock parameter
[in]cnk_viscwhether to include viscous roughness
[in]cons_qfluxwhether the moisture flux is specified
646  {
647  mdata.surf_temp_flux = Tflux;
648  mdata.surf_moist_flux = Qvflux;
649  mdata.Cnk_a = cnk_a;
650  mdata.visc = use_visc;
651  spec_qflux = cons_qflux;
652  }
amrex::Real surf_moist_flux
Moisture flux.
Definition: ERF_MOSTUtils.H:19
amrex::Real Cnk_a
Standard Charnock constant https://doi.org/amrex::Real(10.1175)/JAMC-D-17-amrex::Real(0137....
Definition: ERF_MOSTUtils.H:21
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:761
bool spec_qflux
Definition: ERF_MOSTStress.H:762

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_flux_charnock::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 > &  ,
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.
687  {
688  int iter = 0;
690  amrex::Real wstar = zero;
691  amrex::Real tflux = zero;
692  amrex::Real qflux = zero;
693  amrex::Real z0 = zero;
694  amrex::Real zeta = zero;
695  amrex::Real psi_m = zero;
696  amrex::Real psi_h = zero;
698  amrex::Real zref = zref_arr(i,j,k);
699  amrex::Real C = std::log(zref / z0_arr(i,j,k));
700  amrex::Real zeta_fold = sfuns.calc_zeta_fold(C);
701  bool at_fold = false;
702  amrex::Real umm = std::max(umm_arr(i,j,k), WSMIN);
703  if (u_star_arr(i,j,k) == bogus_large_value) {
704  u_star_arr(i,j,k) = mdata.kappa * umm / most_bracket(C, zero);
705  } else {
706  Olen = olen_arr(i,j,k);
707  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
708  psi_m = sfuns.calc_psi_m(zeta);
709  psi_h = sfuns.calc_psi_h(zeta);
710  }
711  most_aitken accel;
712  do {
713  ustar = u_star_arr(i,j,k);
714  if (mdata.Cnk_a > 0) {
715  // NOTE: air_viscosity should take T and not Th!
717  air_viscosity(tm_arr(i,j,k)), mdata.visc);
718  } else {
719  // NOTE: air_viscosity should take T and not Th!
720  z0 = COARE3_roughness(zref, umm, ustar,
721  air_viscosity(tm_arr(i,j,k)), mdata.visc);
722  }
723  C = std::log(zref / z0);
724  zeta_fold = sfuns.calc_zeta_fold(C);
725  qflux = (spec_qflux) ? mdata.surf_moist_flux :
726  -(qvm_arr(i,j,k) - q_surf_arr(i,j,k)) * ustar * mdata.kappa /
727  most_bracket(C, psi_h); // <w'Qv'>
728  tflux = mdata.surf_temp_flux*(one + epsv*qvm_arr(i,j,k)) + qflux*epsv*tm_arr(i,j,k);
729  if (w_star_arr) {
730  // update w* and Umagmean
731  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,k));
732  wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
733  umm = std::sqrt(umm_arr(i,j,k)*umm_arr(i,j,k) + wstar*wstar);
734  umm = std::max(umm, WSMIN);
735  }
736  Olen = -ustar * ustar * ustar * tvm_arr(i,j,k) / (mdata.kappa * mdata.gravity * tflux);
737  // Stable side bounded at the fold, where the prescribed flux stops having a solution
738  zeta = most_clamp_zeta(zref / Olen, zeta_fold, at_fold);
739  psi_m = sfuns.calc_psi_m(zeta);
740  psi_h = sfuns.calc_psi_h(zeta);
741  {
742  amrex::Real ustar_new = mdata.kappa * umm / most_bracket(C, psi_m);
743  u_star_arr(i,j,k) = (one - alpha) * ustar + alpha * ustar_new;
744  }
745  ++iter;
746  u_star_arr(i,j,k) = accel.update(u_star_arr(i,j,k), iter);
747  } while ((accel.extrapolated || std::abs(u_star_arr(i,j,k) - ustar) > tol) &&
748  iter <= max_iters);
749  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter <= max_iters,
750  "Maximum number of MOST iterations reached.");
751 
752  // Populate the stored MOST arrays; below the fold, apply the flux the wind can carry
753  z0_arr(i,j,k) = z0;
754  most_flux_outputs(mdata, spec_qflux, at_fold, zeta_fold, C, psi_h, u_star_arr(i,j,k), zref,
755  tm_arr(i,j,k), tvm_arr(i,j,k), qvm_arr(i,j,k), qflux, Olen,
756  t_surf_arr(i,j,k), t_star_arr(i,j,k), q_surf_arr(i,j,k), q_star_arr(i,j,k));
757  olen_arr(i,j,k) = Olen;
758  }
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_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_bracket(amrex::Real C, amrex::Real psi)
Definition: ERF_MOSTUtils.H:255
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real COARE3_roughness(amrex::Real zref, amrex::Real umm, amrex::Real ustar, amrex::Real nu, bool visc)
Definition: ERF_MOSTUtils.H:645
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
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real Charnock_roughness(amrex::Real ustar, amrex::Real Cnk_a, amrex::Real nu, bool visc)
Definition: ERF_MOSTUtils.H:600
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 tol
Definition: ERF_MOSTStress.H:764
similarity_funs sfuns
Definition: ERF_MOSTStress.H:763
const amrex::Real WSMIN
Definition: ERF_MOSTStress.H:766
const amrex::Real alpha
Definition: ERF_MOSTStress.H:765
Here is the call graph for this function:

Member Data Documentation

◆ alpha

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

Referenced by iterate_flux().

◆ mdata

most_data surface_flux_charnock::mdata
private

◆ sfuns

similarity_funs surface_flux_charnock::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_flux_charnock::spec_qflux
private

◆ tol

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

Referenced by iterate_flux().

◆ WSMIN

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

Referenced by iterate_flux().


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