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

#include <ERF_MOSTStress.H>

Collaboration diagram for surface_temp_wave_coupled:
Collaboration graph
[legend]

Public Member Functions

 surface_temp_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-3)
 
const amrex::Real tol_z = amrex::Real(1.0e-10)
 
const amrex::Real eps = amrex::Real(1e-15)
 
const amrex::Real alpha = myhalf
 
const amrex::Real WSMIN = most_min_wind_speed
 

Detailed Description

Surface temperature with wave-coupled roughness

Constructor & Destructor Documentation

◆ surface_temp_wave_coupled()

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

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

Parameters
[in]Tfluxprescribed heat flux
[in]Qvfluxprescribed moisture flux
[in]cons_qfluxwhether the moisture flux is specified
1937  {
1938  mdata.surf_temp_flux = Tflux;
1939  mdata.surf_moist_flux = Qvflux;
1940  mdata.visc = use_visc;
1941  spec_qflux = cons_qflux;
1942  }
most_data::surf_moist_flux
amrex::Real surf_moist_flux
Moisture flux.
Definition: ERF_MOSTUtils.H:19
most_data::visc
bool visc
Use viscous Charnock formulation.
Definition: ERF_MOSTUtils.H:26
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_temp_wave_coupled::mdata
most_data mdata
Definition: ERF_MOSTStress.H:2089
surface_temp_wave_coupled::spec_qflux
bool spec_qflux
Definition: ERF_MOSTStress.H:2090

Member Function Documentation

◆ iterate_flux()

AMREX_GPU_DEVICE AMREX_FORCE_INLINE void surface_temp_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.
1977  {
1978  amrex::Real Rib = zero;
1979  amrex::Real zeta = zero;
1980  amrex::Real zeta_old = zero;
1981  amrex::Real psi_m = zero;
1982  amrex::Real psi_h = zero;
1983  amrex::Real CmPsim = zero;
1984  amrex::Real CmPsih = zero;
1985  amrex::Real z0 = z0_arr(i,j,k);
1986  amrex::Real z0_old = z0;
1987  amrex::Real ustar = zero;
1988  amrex::Real zref = zref_arr(i,j,k);
1989  amrex::Real umm = std::max(umm_arr(i,j,k), WSMIN);
1990  amrex::Real C = std::log(zref / z0);
1991 
1992  // First iteration we assume neutral (L -> inf)
1993  if (u_star_arr(i,j,k) == bogus_large_value) {
1994  olen_arr(i,j,k) = amrex::Real(1.0e3);
1995  }
1996  zeta = zref / olen_arr(i,j,k);
1997 
1998  // Water vapor in atmos and surface
1999  amrex::Real qv_s, qv_a;
2000  if (q_surf_arr(i,j,k) > zero) {
2001  qv_s = q_surf_arr(i,j,k);
2002  } else {
2003  // First iteration and no qv_surf was specified
2004  // Use mean since there will be no flux
2005  qv_s = qvm_arr(i,j,k);
2006  }
2007  qv_a = qvm_arr(i,j,k);
2008 
2009  // update w* and Umagmean from Beljaars (1995)
2010  if (w_star_arr) {
2011  // NOTE: Thv flux is lagged, similar to WRF
2012  psi_m = sfuns.calc_psi_m2(zeta);
2013  psi_h = sfuns.calc_psi_h2(zeta);
2014  ustar = mdata.kappa * umm / most_bracket(C, psi_m);
2015  amrex::Real tstar = mdata.kappa * (tm_arr(i,j,k) - t_surf_arr(i,j,k)) / most_bracket(C, psi_h);
2016  amrex::Real qflux = (spec_qflux) ? mdata.surf_moist_flux :
2017  -ustar * mdata.kappa * (qv_a - qv_s) / most_bracket(C, psi_h);
2018  amrex::Real tflux = -ustar*tstar*(one + epsv*qvm_arr(i,j,k)) + epsv*tm_arr(i,j,k)*qflux;
2019  w_star_arr(i,j,k) = calc_wstar(tflux, pblh_arr(i,j,k), tvm_arr(i,j,k));
2020  amrex::Real wstar = mdata.Bjr_beta * w_star_arr(i,j,k);
2021  umm = std::sqrt(umm_arr(i,j,k)*umm_arr(i,j,k) + wstar*wstar);
2022  umm = std::max(umm, WSMIN);
2023  }
2024 
2025  // Bulk Richardson number w/ moisture
2026  amrex::Real thv_s = t_surf_arr(i,j,k) * (one + epsv*qv_s);
2027  amrex::Real thv_a = tm_arr(i,j,k) * (one + epsv*qv_a);
2028  Rib = ( (mdata.gravity * zref) / tm_arr(i,j,k) ) *
2029  ( (thv_a - thv_s) / (umm * umm) );
2030  Rib = std::min(std::max(Rib,-amrex::Real(4.0)),amrex::Real(4.0));
2031 
2032  // Fixed point iteration on zeta
2033  int iter = 0;
2034  do {
2035  // Transfer curr to old
2036  zeta_old = zeta;
2037 
2038  // Stability functions
2039  psi_m = sfuns.calc_psi_m2(zeta_old);
2040  psi_h = sfuns.calc_psi_h2(zeta_old);
2041 
2042  // Fixed point iteration on roughness
2043  int iter_z = 0;
2044  do {
2045  // Transfer curr to old
2046  z0_old = z0;
2047 
2048  // Update
2049  C = std::log(zref / z0_old);
2050  CmPsim = most_bracket(C, psi_m);
2051  ustar = mdata.kappa * umm / CmPsim;
2052  // NOTE: air_viscosity should take T and not Th!
2053  z0 = WaveCoupled_roughness(Hwave_arr(i,j,k), Lwave_arr(i,j,k), eps, ustar,
2054  air_viscosity(tm_arr(i,j,k)), mdata.visc);
2055 
2056  ++iter_z;
2057  } while ( (std::abs(z0 - z0_old) > tol_z) && (iter_z <= max_iters) );
2058  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter_z < max_iters,
2059  "Maximum number of MOST roughness iterations reached.");
2060  C = std::log(zref / z0);
2061 
2062  // Limiting
2063  CmPsim = most_bracket(C, psi_m);
2064  CmPsih = most_bracket(C, psi_h);
2065 
2066  // Update with under relaxation
2067  zeta = (amrex::Real(1.0) - alpha) * zeta_old + alpha * Rib * CmPsim * CmPsim / CmPsih;
2068 
2069  ++iter;
2070  } while ( (std::abs(zeta - zeta_old) > tol) && (iter <= max_iters) );
2071  AMREX_ALWAYS_ASSERT_WITH_MESSAGE(iter <= max_iters,
2072  "Maximum number of MOST iterations reached.");
2073 
2074  // Populate the stored MOST arrays
2075  z0_arr(i,j,k) = z0;
2076  olen_arr(i,j,k) = zref / zeta;
2077  u_star_arr(i,j,k) = mdata.kappa * umm / CmPsim;
2078  t_star_arr(i,j,k) = mdata.kappa * (tm_arr(i,j,k) - t_surf_arr(i,j,k)) / CmPsih;
2079  if (spec_qflux) {
2080  q_surf_arr(i,j,k) = mdata.surf_moist_flux * CmPsih /
2081  (u_star_arr(i,j,k) * mdata.kappa) + qvm_arr(i,j,k);
2082  q_star_arr(i,j,k) = -mdata.surf_moist_flux / u_star_arr(i,j,k);
2083  } else {
2084  q_star_arr(i,j,k) = mdata.kappa * (qvm_arr(i,j,k) - q_surf_arr(i,j,k)) / CmPsih;
2085  }
2086  }
epsv
constexpr amrex::Real epsv
Definition: ERF_Constants.H:56
bogus_large_value
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
z0
Real z0
Definition: ERF_InitCustomPertVels_ScalarAdvDiff.H:12
AMREX_ALWAYS_ASSERT_WITH_MESSAGE
AMREX_ALWAYS_ASSERT_WITH_MESSAGE(axis >=0 &&axis< AMREX_SPACEDIM, "prob.axis must be 0, 1 or 2")
WaveCoupled_roughness
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
most_bracket
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real most_bracket(amrex::Real C, amrex::Real psi)
Definition: ERF_MOSTUtils.H:255
air_viscosity
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real air_viscosity(amrex::Real T_degK)
Definition: ERF_MOSTUtils.H:581
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
LsmVar_SLM::tstar
@ tstar
Definition: ERF_SLM.H:29
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_h2
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_h2(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:104
similarity_funs::calc_psi_m2
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real calc_psi_m2(amrex::Real zeta) const
Definition: ERF_MOSTUtils.H:79
surface_temp_wave_coupled::tol_z
const amrex::Real tol_z
Definition: ERF_MOSTStress.H:2097
surface_temp_wave_coupled::eps
const amrex::Real eps
Definition: ERF_MOSTStress.H:2098
surface_temp_wave_coupled::tol
const amrex::Real tol
Definition: ERF_MOSTStress.H:2092
surface_temp_wave_coupled::alpha
const amrex::Real alpha
Definition: ERF_MOSTStress.H:2100
surface_temp_wave_coupled::sfuns
similarity_funs sfuns
Definition: ERF_MOSTStress.H:2091
surface_temp_wave_coupled::WSMIN
const amrex::Real WSMIN
Definition: ERF_MOSTStress.H:2101
Here is the call graph for this function:

Member Data Documentation

◆ alpha

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

Referenced by iterate_flux().

◆ eps

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

Referenced by iterate_flux().

◆ mdata

most_data surface_temp_wave_coupled::mdata
private

Referenced by iterate_flux(), and surface_temp_wave_coupled().

◆ sfuns

similarity_funs surface_temp_wave_coupled::sfuns
private

Referenced by iterate_flux().

◆ spec_qflux

bool surface_temp_wave_coupled::spec_qflux
private

Referenced by iterate_flux(), and surface_temp_wave_coupled().

◆ tol

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

Referenced by iterate_flux().

◆ tol_z

const amrex::Real surface_temp_wave_coupled::tol_z = amrex::Real(1.0e-10)
private

Referenced by iterate_flux().

◆ WSMIN

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

Referenced by iterate_flux().

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