ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_TwoStreamColumn.H
Go to the documentation of this file.
1 #ifndef ERF_TWO_STREAM_COLUMN_H_
2 #define ERF_TWO_STREAM_COLUMN_H_
3 
4 #include <algorithm>
5 #include <cmath>
6 #include <type_traits>
7 
8 #include <AMReX_Array4.H>
9 #include <AMReX_Box.H>
10 #include <AMReX_Geometry.H>
11 #include <AMReX_GpuControl.H>
12 #include <AMReX_Math.H>
13 #include <AMReX_REAL.H>
14 
15 #include <ERF_Constants.H>
16 #include <ERF_EOS.H>
17 #include <ERF_IndexDefines.H>
18 #include <ERF_RadStruct.H>
19 #include <ERF_TwoStreamSW.H>
20 #include <ERF_TwoStreamLW.H>
23 #include <ERF_OrbCosZenith.H>
24 #include <ERF_SurfaceTemperature.H>
25 #include <ERF_TerrainMetrics.H>
26 
27 /**
28  * @file ERF_TwoStreamColumn.H
29  * @brief Per-column two-stream radiation kernels.
30  *
31  * Everything needed to evaluate one (i,j) column of the two-stream model:
32  * temperature from the equation of state, per-column surface properties,
33  * per-layer optical depth assembly, and vertical_two_stream_sweep(), which
34  * performs the SW and LW sweeps and writes per-level heating rates.
35  *
36  * Vertical orientation follows ERF: k = kmin is the surface layer and
37  * k = kmax the top layer. SW sweeps downward from kmax to kmin; LW sweeps
38  * downward (TOA -> surface) and then upward (surface -> TOA) on layer
39  * interfaces. Layer temperature is obtained from rho*theta through the Exner
40  * function.
41  *
42  * The functions are header-only and GPU-safe so that the column physics can
43  * be exercised directly by unit tests (Tests/Unit/Radiation) as well as by
44  * the level driver in ERF_TwoStreamRadiation.cpp (TwoStreamRadiation::advance).
45  */
46 
47 /**
48  * @brief Trivially copyable subset of RadChoice used by the column kernels.
49  *
50  * RadChoice carries std::string members (diagnostics file name, call-site
51  * mode) and therefore cannot be captured by value in a GPU device lambda.
52  * The level driver builds one TwoStreamParams per call with
53  * make_two_stream_params() and passes that to vertical_two_stream_sweep()
54  * and its helpers. Field names match RadChoice.
55  */
57 {
58  bool sw_enabled = true;
59  bool lw_enabled = true;
62 
63  TauProfileType tau_profile_type = TauProfileType::Constant;
67 
72 
76  amrex::Real t_sfc_default = 300.0; // erf.rad_t_sfc
78 
79  bool tau_sw_dynamic_enable = false;
80  bool tau_lw_dynamic_enable = false;
85 
90 
91  bool aerosol_enable = false;
92  AerosolProfileType aerosol_profile_type = AerosolProfileType::Constant;
96 
97  TauModel tau_model = TauModel::PerLayer;
104 
109 
110  // The sun of this call, set by the driver from the inputs shared with
111  // RRTMGP (erf.fixed_solar_zenith_angle, erf.fixed_total_solar_irradiance,
112  // erf.rad_cons_lat/lon, erf.rad_orbital_*) and start_datetime.
113  bool solar_dynamic = false; // false: cos_zenith_fixed applies to every column
114  amrex::Real cos_zenith_fixed = 0.5; // erf.fixed_solar_zenith_angle (a cosine)
115  amrex::Real S0 = 1360.9; // top-of-atmosphere irradiance of this call [W/m^2]
116  amrex::Real calday = 1.0; // day of the year plus fraction, UTC (dynamic sun)
117  amrex::Real declin = 0.0; // solar declination [rad] (dynamic sun)
118  amrex::Real lat_cons_rad = 0.0; // erf.rad_cons_lat [rad], used where the grid has no lat field
119  amrex::Real lon_cons_rad = 0.0; // erf.rad_cons_lon [rad]
120 };
121 static_assert(std::is_trivially_copyable<TwoStreamParams>::value,
122  "TwoStreamParams must stay trivially copyable so it can be captured by device lambdas");
123 
124 /**
125  * @brief Copy the column-kernel parameters out of a RadChoice.
126  */
128  const amrex::Real rdOcp)
129 {
131  p.sw_enabled = rc.sw_enabled;
132  p.lw_enabled = rc.lw_enabled;
133  p.tau_per_layer = rc.tau_per_layer;
134  p.tau_lw_per_layer = rc.tau_lw_per_layer;
135  p.tau_profile_type = rc.tau_profile_type;
136  p.cloud_base_height_m = rc.cloud_base_height_m;
137  p.cloud_top_height_m = rc.cloud_top_height_m;
138  p.cloud_tau_per_layer = rc.cloud_tau_per_layer;
139  p.single_scattering_albedo = rc.single_scattering_albedo;
140  p.asymmetry_factor = rc.asymmetry_factor;
141  p.cloud_single_scattering_albedo = rc.cloud_single_scattering_albedo;
142  p.cloud_asymmetry_factor = rc.cloud_asymmetry_factor;
143  p.surface_albedo_sw = rc.surface_albedo_sw;
144  p.surface_albedo_sw_diffuse = rc.surface_albedo_sw_diffuse;
145  p.surface_emissivity_lw = rc.surface_emissivity_lw;
146  p.t_sfc_default = rc.rad_t_sfc;
147  p.rdOcp = rdOcp;
148  p.tau_sw_dynamic_enable = rc.tau_sw_dynamic_enable;
149  p.tau_lw_dynamic_enable = rc.tau_lw_dynamic_enable;
150  p.tau_sw_coeff_qv = rc.tau_sw_coeff_qv;
151  p.tau_sw_coeff_qc = rc.tau_sw_coeff_qc;
152  p.tau_lw_coeff_qv = rc.tau_lw_coeff_qv;
153  p.tau_lw_coeff_qc = rc.tau_lw_coeff_qc;
154  p.cloud_fraction_prog_enable = rc.cloud_fraction_prog_enable;
155  p.cloud_fraction_rh_min = rc.cloud_fraction_rh_min;
156  p.cloud_fraction_rh_max = rc.cloud_fraction_rh_max;
157  p.cloud_fraction_qc_scale = rc.cloud_fraction_qc_scale;
158  p.aerosol_enable = rc.aerosol_enable;
159  p.aerosol_profile_type = rc.aerosol_profile_type;
160  p.aerosol_tau_per_layer = rc.aerosol_tau_per_layer;
161  p.aerosol_scale_height_m = rc.aerosol_scale_height_m;
162  p.aerosol_tau_surface = rc.aerosol_tau_surface;
163  p.tau_model = rc.tau_model;
164  p.sw_kabs_dry = rc.sw_kabs_dry;
165  p.sw_kscat_dry = rc.sw_kscat_dry;
166  p.sw_kabs_vapor = rc.sw_kabs_vapor;
167  p.sw_kext_cloud = rc.sw_kext_cloud;
168  p.sw_cloud_omega = rc.sw_cloud_omega;
169  p.sw_cloud_g = rc.sw_cloud_g;
170  p.lw_mass_absorption_enable = rc.lw_mass_absorption_enable;
171  p.lw_kabs_dry = rc.lw_kabs_dry;
172  p.lw_kabs_vapor = rc.lw_kabs_vapor;
173  p.lw_kabs_cloud = rc.lw_kabs_cloud;
174  // Sun: a fixed cosine when given; the date-dependent quantities (calday,
175  // declination and the irradiance of the date) are filled by the driver.
176  p.solar_dynamic = !(rc.fixed_solar_zenith_angle > 0.0);
177  p.cos_zenith_fixed = rc.fixed_solar_zenith_angle;
178  p.S0 = (rc.fixed_total_solar_irradiance >= 0.0) ? rc.fixed_total_solar_irradiance : 1360.9;
179  p.lat_cons_rad = rc.rad_cons_lat * PI / 180.0;
180  p.lon_cons_rad = rc.rad_cons_lon * PI / 180.0;
181  return p;
182 }
183 
184 /**
185  * @brief GPU-safe helper to compute absolute temperature from (rho, rho*theta).
186  *
187  * ERF stores dry density and dry potential temperature. The pressure follows
188  * from the equation of state,
189  * p = p_0 * (R_d * rho * theta_m / p_0)^gamma, theta_m = theta * (1 + R_v/R_d * qv),
190  * and the absolute temperature is recovered through the Exner function,
191  * T = theta * (p / p_0)^(R_d / c_p),
192  * which getTgivenRandRTh() evaluates as p / (R_d * rho * (1 + R_v/R_d * qv)).
193  *
194  * @param[in] rho_theta RhoTheta component [K·kg/m^3]
195  * @param[in] rho Density [kg/m^3]
196  * @param[in] qv Water-vapor mixing ratio [kg/kg] (0 for dry air)
197  * @return Temperature [K], clamped to [100, 400]; 288.15 for unphysical input.
198  */
199 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
202  amrex::Real qv = 0.0)
203 {
204  if (!(rho > 0.0) || !amrex::Math::isfinite(rho) ||
205  !(rho_theta > 0.0) || !amrex::Math::isfinite(rho_theta)) {
206  return 288.15; // Defensive: fallback to standard T
207  }
208  if (!(qv >= 0.0) || !amrex::Math::isfinite(qv)) {
209  qv = 0.0;
210  }
211 
212  amrex::Real T = getTgivenRandRTh(rho, rho_theta, qv);
213  if (!amrex::Math::isfinite(T) || T <= 0.0) {
214  return 288.15; // Defensive: fallback
215  }
216 
217  // Defensive clipping to a sensible terrestrial range
218  T = std::max(T, amrex::Real(100.0));
219  T = std::min(T, amrex::Real(400.0));
220  return T;
221 }
222 
223 /** @brief Check whether a heterogeneous absolute surface temperature is valid. */
224 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
226 {
227  return amrex::Math::isfinite(value) && value > 0.0 && value < lsm_undefined;
228 }
229 
230 /**
231  * @brief Resolve per-column shortwave surface albedo from hetero field or fallback.
232  *
233  * Precedence:
234  * 1. If hetero_alb_sw array available and value at (i,j) is finite ∈ [0,1], use it
235  * 2. Otherwise, use rad_choice.surface_albedo_sw (already clamped by init_params)
236  * 3. Hard default: 0.3
237  *
238  * @param[in] i,j Column index
239  * @param[in] hetero_alb_sw Heterogeneous SW albedo field (may be nullptr)
240  * @param[in] rad_choice Radiation parameters with fallback surface_albedo_sw
241  * @param[in] has_hetero_alb true if hetero_alb_sw is available
242  * @return SW albedo in [0, 1]
243  */
244 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
246  int i, int j,
247  const amrex::Array4<const amrex::Real>* hetero_alb_sw,
248  const TwoStreamParams& rad_choice,
249  bool has_hetero_alb)
250 {
251  amrex::Real alb = rad_choice.surface_albedo_sw; // Default fallback (already clamped)
252 
253  if (has_hetero_alb && hetero_alb_sw != nullptr && hetero_alb_sw->contains(i, j, 0)) {
254  amrex::Real hetero_val = (*hetero_alb_sw)(i, j, 0, 0);
255  if (amrex::Math::isfinite(hetero_val) && hetero_val >= 0.0 && hetero_val <= 1.0) {
256  alb = hetero_val;
257  }
258  }
259 
260  return alb;
261 }
262 
263 /**
264  * @brief Resolve per-column longwave surface emissivity from hetero field or fallback.
265  *
266  * Precedence:
267  * 1. If hetero_emiss_lw array available and value at (i,j) is finite ∈ [0,1], use it
268  * 2. Otherwise, use rad_choice.surface_emissivity_lw (already clamped by init_params)
269  * 3. Hard default: 0.99
270  *
271  * @param[in] i,j Column index
272  * @param[in] hetero_emiss_lw Heterogeneous LW emissivity field (may be nullptr)
273  * @param[in] rad_choice Radiation parameters with fallback surface_emissivity_lw
274  * @param[in] has_hetero_emiss true if hetero_emiss_lw is available
275  * @return LW emissivity in [0, 1]
276  */
277 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
279  int i, int j,
280  const amrex::Array4<const amrex::Real>* hetero_emiss_lw,
281  const TwoStreamParams& rad_choice,
282  bool has_hetero_emiss)
283 {
284  amrex::Real emiss = rad_choice.surface_emissivity_lw; // Default fallback (already clamped)
285 
286  if (has_hetero_emiss && hetero_emiss_lw != nullptr && hetero_emiss_lw->contains(i, j, 0)) {
287  amrex::Real hetero_val = (*hetero_emiss_lw)(i, j, 0, 0); // Assume single component
288  if (amrex::Math::isfinite(hetero_val) && hetero_val >= 0.0 && hetero_val <= 1.0) {
289  emiss = hetero_val;
290  }
291  }
292 
293  return emiss;
294 }
295 
296 /**
297  * @brief Resolve the per-column surface-temperature boundary condition.
298  *
299  * The candidates remain separate until this per-cell resolver runs. This is
300  * important for an LSM field that exists globally but contains an undefined
301  * value in an individual column.
302  *
303  * Precedence for each column:
304  * 1. valid LSM absolute temperature;
305  * 2. valid prognostic SEB absolute temperature;
306  * 3. valid SurfaceLayer potential temperature (marked for Exner conversion);
307  * 4. the scalar absolute-temperature fallback, erf.rad_t_sfc.
308  *
309  * Only the SurfaceLayer candidate is converted by the caller. The LSM and
310  * prognostic SEB candidates already satisfy the absolute-temperature contract.
311  *
312  * @param[in] i,j Column index
313  * @param[in] lsm_t_sfc LSM absolute-temperature field (may be nullptr)
314  * @param[in] has_lsm_t_sfc true if the LSM field is available
315  * @param[in] seb_t_sfc prognostic SEB absolute-temperature field (may be nullptr)
316  * @param[in] has_seb_t_sfc true if the prognostic SEB field is available
317  * @param[in] surface_layer_theta SurfaceLayer potential-temperature field (may be nullptr)
318  * @param[in] has_surface_layer true if the SurfaceLayer field is available
319  * @param[in] rad_choice Radiation parameters with the fallback t_sfc_default
320  * @param[out] from_surface_layer true when the returned value is SurfaceLayer theta
321  * @return Surface temperature candidate [K]
322  */
323 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
325  int i, int j,
326  const amrex::Array4<const amrex::Real>* lsm_t_sfc,
327  bool has_lsm_t_sfc,
328  const amrex::Array4<const amrex::Real>* seb_t_sfc,
329  bool has_seb_t_sfc,
330  const amrex::Array4<const amrex::Real>* surface_layer_theta,
331  bool has_surface_layer,
332  const TwoStreamParams& rad_choice,
333  bool& from_surface_layer)
334 {
335  amrex::Real t_surf = rad_choice.t_sfc_default; // erf.rad_t_sfc (already validated)
336  from_surface_layer = false;
337 
338  if (has_lsm_t_sfc && lsm_t_sfc != nullptr && lsm_t_sfc->contains(i, j, 0)) {
339  const amrex::Real lsm_value = (*lsm_t_sfc)(i, j, 0, 0);
340  if (valid_surface_temperature(lsm_value)) {
341  return lsm_value;
342  }
343  }
344 
345  if (has_seb_t_sfc && seb_t_sfc != nullptr && seb_t_sfc->contains(i, j, 0)) {
346  const amrex::Real seb_value = (*seb_t_sfc)(i, j, 0, 0);
347  if (valid_surface_temperature(seb_value)) {
348  return seb_value;
349  }
350  }
351 
352  if (has_surface_layer && surface_layer_theta != nullptr &&
353  surface_layer_theta->contains(i, j, 0)) {
354  const amrex::Real theta = (*surface_layer_theta)(i, j, 0, 0);
356  from_surface_layer = true;
357  return theta;
358  }
359  }
360 
361  return t_surf;
362 }
363 
364 /**
365  * @brief GPU-safe helper to determine whether a layer falls within the
366  * cloud band [cloud_base_height_m, cloud_top_height_m].
367  *
368  * @param[in] z_center Height of the layer center above the surface [m].
369  * @param[in] rad_choice Radiation parameters.
370  * @return true if this layer is inside the configured cloud band.
371  */
372 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
373 bool is_cloud_level (amrex::Real z_center, const TwoStreamParams& rad_choice)
374 {
375  return (z_center >= rad_choice.cloud_base_height_m &&
376  z_center <= rad_choice.cloud_top_height_m);
377 }
378 
379 /**
380  * @brief Water-vapor mixing ratio qv = RhoQv / Rho at (i,j,k).
381  *
382  * Returns 0 when the state carries no moisture components, or when the
383  * stored values are non-finite or negative.
384  */
385 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
386 amrex::Real get_qv_from_state (int i, int j, int k,
387  const amrex::Array4<const amrex::Real>& state_arr)
388 {
389  if (state_arr.nComp() <= RhoQ1_comp) return 0.0;
390  amrex::Real rho = state_arr(i, j, k, Rho_comp);
391  amrex::Real rho_qv = state_arr(i, j, k, RhoQ1_comp);
392  if (!(rho > 0.0) || !amrex::Math::isfinite(rho) || !amrex::Math::isfinite(rho_qv)) return 0.0;
393  amrex::Real qv = rho_qv / rho;
394  return (amrex::Math::isfinite(qv) && qv > 0.0) ? qv : 0.0;
395 }
396 
397 /**
398  * @brief Inverse Exner function 1/pi at (i,j,k) from the state, with
399  * pi = (p / p_0)^(R_d/c_p) evaluated by getExnergivenRTh(). Used to convert
400  * a temperature tendency dT/dt into the potential-temperature tendency
401  * dtheta/dt = (dT/dt) / pi that the RhoTheta source term expects.
402  * Returns 1 for unphysical input.
403  */
404 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
405 amrex::Real get_inverse_exner (int i, int j, int k,
406  const amrex::Array4<const amrex::Real>& state_arr)
407 {
408  amrex::Real rho_theta = state_arr(i, j, k, RhoTheta_comp);
409  if (!(rho_theta > 0.0) || !amrex::Math::isfinite(rho_theta)) return 1.0;
410  const amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
411  const amrex::Real pi = getExnergivenRTh(rho_theta, RdoCp, qv);
412  return (amrex::Math::isfinite(pi) && pi > 0.0) ? 1.0 / pi : 1.0;
413 }
414 
415 /**
416  * @brief Cloud-water mixing ratio qc = RhoQc / Rho at (i,j,k).
417  *
418  * Returns 0 when the state carries no cloud-water component, or when the
419  * stored values are non-finite or negative.
420  */
421 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
422 amrex::Real get_qc_from_state (int i, int j, int k,
423  const amrex::Array4<const amrex::Real>& state_arr)
424 {
425  if (state_arr.nComp() <= RhoQ2_comp) return 0.0;
426  amrex::Real rho = state_arr(i, j, k, Rho_comp);
427  amrex::Real rho_qc = state_arr(i, j, k, RhoQ2_comp);
428  if (!(rho > 0.0) || !amrex::Math::isfinite(rho) || !amrex::Math::isfinite(rho_qc)) return 0.0;
429  amrex::Real qc = rho_qc / rho;
430  return (amrex::Math::isfinite(qc) && qc > 0.0) ? qc : 0.0;
431 }
432 
433 /**
434  * @brief Moisture-dependent (dynamic) per-layer optical depth.
435  *
436  * tau = tau_base + coeff_qv * qv + coeff_qc * qc
437  *
438  * clamped to [0, 100]. With both coefficients zero this returns tau_base
439  * unchanged, so the static configuration is reproduced exactly. Used for
440  * both the SW and the LW band with the respective coefficient pair.
441  *
442  * @param[in] tau_base Optical depth before the moisture contribution [unitless].
443  * @param[in] qv Water-vapor mixing ratio [kg/kg].
444  * @param[in] qc Cloud-water mixing ratio [kg/kg].
445  * @param[in] coeff_qv Optical depth per unit qv [unitless per kg/kg].
446  * @param[in] coeff_qc Optical depth per unit qc [unitless per kg/kg].
447  * @return Optical depth for this layer [unitless].
448  */
449 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
451  amrex::Real coeff_qv, amrex::Real coeff_qc)
452 {
453  if (!(qv > 0.0) || !amrex::Math::isfinite(qv)) qv = 0.0;
454  if (!(qc > 0.0) || !amrex::Math::isfinite(qc)) qc = 0.0;
455  amrex::Real tau = tau_base + coeff_qv * qv + coeff_qc * qc;
456  if (!amrex::Math::isfinite(tau)) return tau_base;
457  if (tau < 0.0) tau = 0.0;
458  if (tau > 100.0) tau = 100.0;
459  return tau;
460 }
461 
462 /**
463  * @brief GPU-safe helper to compute the per-layer optical depth at level k,
464  * given the base (clear-sky) optical depth and cloud-layer
465  * parameters.
466  *
467  * When rad_choice.tau_profile_type == Constant, returns tau_base unchanged
468  * (byte-identical). When == CloudLayer, adds
469  * rad_choice.cloud_tau_per_layer whenever the level height falls within
470  * [cloud_base_height_m, cloud_top_height_m].
471  *
472  * @param[in] z_center Height of the layer center above the surface [m].
473  * @param[in] tau_base Clear-sky optical depth per layer.
474  * @param[in] rad_choice Radiation parameters.
475  * @param[in] apply_cloud If false, always returns tau_base (used for the
476  * clear-sky column computation even when cloud_fraction > 0).
477  * @return Optical depth for this layer [unitless].
478  */
479 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
481  amrex::Real z_center, amrex::Real tau_base,
482  const TwoStreamParams& rad_choice, bool apply_cloud)
483 {
484  if (!apply_cloud || rad_choice.tau_profile_type != TauProfileType::CloudLayer) {
485  return tau_base;
486  }
487  if (is_cloud_level(z_center, rad_choice)) {
488  return tau_base + rad_choice.cloud_tau_per_layer;
489  }
490  return tau_base;
491 }
492 
493 /**
494  * @brief GPU-safe helper to select the single-scattering albedo
495  * and asymmetry factor to use for level k's diffuse SW calculation.
496  *
497  * When this column evaluation applies the cloud-layer enhancement
498  * (apply_cloud == true, tau_profile_type == CloudLayer, and level k falls
499  * within the cloud band), the cloud scattering properties
500  * (cloud_single_scattering_albedo, cloud_asymmetry_factor) are used.
501  * Otherwise, the clear-sky scattering properties (single_scattering_albedo,
502  * asymmetry_factor) are used. Both default to 0.0, so by default this
503  * function always yields omega == 0.0 and the layers neither scatter the
504  * direct beam nor reflect diffuse light; the diffuse field then consists of
505  * the surface-reflected beam only.
506  *
507  * @param[in] z_center Height of the layer center above the surface [m].
508  * @param[in] rad_choice Radiation parameters.
509  * @param[in] apply_cloud Same flag passed to tau_layer_value(); true for the
510  * cloudy-column evaluation, false for the clear-sky column evaluation.
511  * @param[out] omega Selected single-scattering albedo for this level.
512  * @param[out] g Selected asymmetry factor for this level.
513  */
514 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
516  amrex::Real z_center, const TwoStreamParams& rad_choice, bool apply_cloud,
518 {
519  bool use_cloud_props = apply_cloud &&
520  rad_choice.tau_profile_type == TauProfileType::CloudLayer &&
521  is_cloud_level(z_center, rad_choice);
522 
523  if (use_cloud_props) {
525  g = rad_choice.cloud_asymmetry_factor;
526  } else {
527  omega = rad_choice.single_scattering_albedo;
528  g = rad_choice.asymmetry_factor;
529  }
530 }
531 
532 /**
533  * @brief GPU-safe helper to diagnose prognostic cloud fraction
534  * from per-level relative humidity and cloud liquid water.
535  *
536  * Computes cloud fraction from RH and qc using:
537  * cf_rh(k) = linear ramp from 0 at rh_min to 1 at rh_max
538  * cf_qc(k) = qc_scale * qc(k)
539  * cf(k) = min(1, cf_rh + cf_qc) [saturated blend]
540  *
541  * Temperature comes from the equation of state (Exner function) and
542  * pressure from getPgivenRTh(), both evaluated with the local qv.
543  * Returns 0 when cloud_fraction_prog_enable is false.
544  *
545  * @param[in] i, j, k Grid indices
546  * @param[in] state_arr State array proxy (contains Rho, RhoTheta, qv, qc)
547  * @param[in] rad_choice Radiation parameters (prognostic cloud fraction settings)
548  * @return Diagnosed cloud fraction [0, 1] if enabled; 0 if disabled
549  */
550 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
552  int i, int j, int k,
553  const amrex::Array4<const amrex::Real>& state_arr,
554  const TwoStreamParams& rad_choice)
555 {
556  if (!rad_choice.cloud_fraction_prog_enable) {
557  return 0.0;
558  }
559 
560  const amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
561  const amrex::Real qc = get_qc_from_state(i, j, k, state_arr);
562 
563  amrex::Real rho = state_arr(i, j, k, Rho_comp);
564  amrex::Real rho_theta = state_arr(i, j, k, RhoTheta_comp);
565  // Unreachable from TwoStreamRadiation::advance, which refuses a state with
566  // a non-finite or non-positive density or rho*theta before the sweep;
567  // kept so a direct kernel caller (unit tests) cannot divide by zero.
568  if (rho <= 0.0 || !amrex::Math::isfinite(rho)) rho = 1.0;
569  if (rho_theta <= 0.0 || !amrex::Math::isfinite(rho_theta)) rho_theta = 288.15;
570 
571  // Temperature (via the Exner function) and pressure from the equation of state
573  amrex::Real P = getPgivenRTh(rho_theta, qv);
574  if (P <= 0.0 || !amrex::Math::isfinite(P)) P = p_0;
575 
577 
579  rh, qc,
580  rad_choice.cloud_fraction_rh_min,
581  rad_choice.cloud_fraction_rh_max,
582  rad_choice.cloud_fraction_qc_scale);
583 }
584 
585 /**
586  * @brief Per-column scratch the sweep keeps in a caller-provided Array4.
587  *
588  * The SW adding method and the LW sweeps need full interface profiles
589  * (direct beam, adding-method albedo and source, LW up/down fluxes) and the
590  * per-layer thickness, height and optical depths. Keeping those as
591  * fixed-size arrays inside the device lambda cost about 37 kB of local
592  * memory per GPU thread, so they live in a scratch FArrayBox that the level
593  * driver allocates once per box with NCOMP components on the box grown by
594  * one cell at its top (nlev + 1 interfaces per column), and the sweep
595  * addresses them as scratch(i, j, kmin + m, field). Each thread touches
596  * only its own column.
597  */
598 namespace TwoStreamScratch {
599  constexpr int DZ = 0; // layer thickness [m]
600  constexpr int Z = 1; // layer-centre height above the surface [m]
601  constexpr int TAU_SW = 2; // shortwave optical depth per layer
602  constexpr int F_DIR = 3; // direct beam at interfaces
603  constexpr int A = 4; // adding-method albedo at interfaces
604  constexpr int S = 5; // adding-method source at interfaces
605  constexpr int LW_UP = 6; // longwave upward flux at interfaces
606  constexpr int LW_DN = 7; // longwave downward flux at interfaces
607  constexpr int TAU_LW = 8; // longwave optical depth per layer
608  constexpr int NCOMP = 9;
609 }
610 
611 /** @brief Box of the scratch FArrayBox a sweep over box bx needs. */
612 inline amrex::Box two_stream_scratch_box (const amrex::Box& bx)
613 {
614  amrex::Box sbx(bx);
615  sbx.growHi(2, 1);
616  return sbx;
617 }
618 
619 /**
620  * @brief GPU-safe helper to assemble the total per-layer optical depth at
621  * level k for either the SW or the LW band.
622  *
623  * The contributions are applied in the same order for both bands:
624  * 1. clear-sky base value, plus the cloud-layer enhancement when the column
625  * is evaluated as "cloudy" and the level lies inside the cloud band;
626  * 2. optional moisture-dependent (dynamic) term from qv and qc;
627  * 3. optional prognostic cloud fraction, which replaces the cloud-band
628  * enhancement by cf(k) * cloud_tau_per_layer;
629  * 4. optional prescribed aerosol term (constant, exponential or table).
630  *
631  * @param[in] i, j, k Grid indices (k increases upward; kmin is the surface layer).
632  * @param[in] dz_layer Thickness of this layer [m].
633  * @param[in] z_center Height of the layer center above the surface [m]
634  * (cloud-band detection and the aerosol profile).
635  * @param[in] state_arr State array (read-only).
636  * @param[in] tau_base Clear-sky optical depth per layer for this band
637  * (for LW, replaced by the mass-path value when
638  * lw_mass_absorption_enable or tau_model = mass is set).
639  * @param[in] is_sw true for the shortwave band, false for longwave.
640  * @param[in] cloudy true for the cloudy-column evaluation.
641  * @param[in] rad_choice Radiation parameters.
642  * @return Optical depth of layer k [unitless].
643  */
644 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
646  int i, int j, int k,
647  amrex::Real dz_layer, amrex::Real z_center,
648  const amrex::Array4<const amrex::Real>& state_arr,
649  amrex::Real tau_base, bool is_sw, bool cloudy,
650  const TwoStreamParams& rad_choice)
651 {
652  // Longwave option: gray optical depth from the layer mass path,
653  // tau = rho dz (k_dry + k_vapor qv + k_cloud qc),
654  // which makes the column optical depth independent of the vertical
655  // resolution and gives water vapor and cloud water a real greenhouse
656  // effect. Replaces the fixed tau_lw_per_layer as the clear-sky base.
657  amrex::Real base = tau_base;
658  if (!is_sw && (rad_choice.lw_mass_absorption_enable || rad_choice.tau_model == TauModel::Mass)) {
659  amrex::Real rho = state_arr(i, j, k, Rho_comp);
660  if (!(rho > 0.0) || !amrex::Math::isfinite(rho)) rho = 0.0;
661  const amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
662  const amrex::Real qc = get_qc_from_state(i, j, k, state_arr);
663  base = rho * dz_layer * (rad_choice.lw_kabs_dry
664  + rad_choice.lw_kabs_vapor * qv
665  + rad_choice.lw_kabs_cloud * qc);
666  if (!amrex::Math::isfinite(base) || base < 0.0) base = 0.0;
667  }
668 
669  // Base (clear-sky) value, plus cloud-band enhancement for cloudy columns.
670  amrex::Real tau = tau_layer_value(z_center, base, rad_choice, cloudy);
671 
672  // Dynamic (moisture-dependent) contribution.
673  const bool dynamic_enabled = is_sw ? rad_choice.tau_sw_dynamic_enable
674  : rad_choice.tau_lw_dynamic_enable;
675  if (dynamic_enabled) {
676  const amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
677  const amrex::Real qc = get_qc_from_state(i, j, k, state_arr);
678  tau = is_sw ? diagnose_tau_dynamic(tau, qv, qc, rad_choice.tau_sw_coeff_qv, rad_choice.tau_sw_coeff_qc)
679  : diagnose_tau_dynamic(tau, qv, qc, rad_choice.tau_lw_coeff_qv, rad_choice.tau_lw_coeff_qc);
680  }
681 
682  // Prognostic cloud fraction: scale the cloud-band enhancement by cf(k).
683  if (rad_choice.cloud_fraction_prog_enable && cloudy &&
684  rad_choice.tau_profile_type == TauProfileType::CloudLayer &&
685  is_cloud_level(z_center, rad_choice)) {
686  // tau already holds the full cloud-band enhancement (this is a cloudy
687  // column inside the band) plus the dynamic term; scale only the
688  // enhancement by cf(k) and leave the dynamic term in place.
689  amrex::Real cf_prog = diagnose_cloud_fraction_prognostic(i, j, k, state_arr, rad_choice);
690  tau += (cf_prog - 1.0) * rad_choice.cloud_tau_per_layer;
691  }
692 
693  // Prescribed bulk aerosol contribution (added on top of everything above).
694  if (rad_choice.aerosol_enable) {
695  amrex::Real tau_aerosol = 0.0;
696  if (rad_choice.aerosol_profile_type == AerosolProfileType::Constant) {
697  tau_aerosol = diagnose_tau_aerosol_constant(rad_choice.aerosol_tau_per_layer);
698  } else if (rad_choice.aerosol_profile_type == AerosolProfileType::Exponential) {
699  tau_aerosol = diagnose_tau_aerosol_exponential(z_center, dz_layer,
700  rad_choice.aerosol_tau_surface,
701  rad_choice.aerosol_scale_height_m);
702  } else if (rad_choice.aerosol_profile_type == AerosolProfileType::Table) {
703  tau_aerosol = diagnose_tau_aerosol_table(k);
704  }
705  tau += tau_aerosol;
706  }
707 
708  return tau;
709 }
710 
711 /**
712  * @brief Optical depth, single-scattering albedo and asymmetry factor of
713  * layer k for one band, for either optical-depth model.
714  *
715  * Per-layer model (default): the optical depth comes from
716  * diagnose_layer_tau() and the scattering properties from the clear-sky or
717  * cloud-band inputs through select_scattering_props(), exactly as before.
718  *
719  * Mass model (tau_model = mass), shortwave: each constituent contributes an
720  * extinction optical depth from the layer mass path,
721  * dry absorption rho dz sw_kabs_dry (omega = 0)
722  * Rayleigh rho dz sw_kscat_dry (omega = 1, g = 0)
723  * water vapor rho dz sw_kabs_vapor qv (omega = 0)
724  * cloud water rho dz sw_kext_cloud qc (sw_cloud_omega, sw_cloud_g)
725  * plus the prescribed cloud-band enhancement (with the cloud-band scattering
726  * inputs) and the absorbing moisture-coefficient and aerosol additions. The
727  * layer properties are the extinction-weighted mixtures
728  * tau = sum tau_i,
729  * omega = sum omega_i tau_i / tau,
730  * g = sum g_i omega_i tau_i / sum omega_i tau_i.
731  * Longwave uses diagnose_layer_tau(), whose clear-sky base is the mass path
732  * rho dz (lw_kabs_dry + lw_kabs_vapor qv + lw_kabs_cloud qc) in this model.
733  *
734  * @param[in] i, j, k Grid indices (kmin is the surface layer).
735  * @param[in] dz_layer Thickness of this layer [m].
736  * @param[in] z_center Height of the layer center above the surface [m].
737  * @param[in] state_arr State array (read-only).
738  * @param[in] tau_base Per-layer-model clear-sky optical depth for this band.
739  * @param[in] is_sw true for the shortwave band, false for longwave.
740  * @param[in] cloudy true for the cloudy-column evaluation.
741  * @param[in] rad_choice Column-kernel parameters.
742  * @param[out] tau Optical depth of the layer [unitless].
743  * @param[out] omega Single-scattering albedo of the layer (0 for LW).
744  * @param[out] g Asymmetry factor of the layer (0 for LW).
745  */
746 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
748  int i, int j, int k,
749  amrex::Real dz_layer, amrex::Real z_center,
750  const amrex::Array4<const amrex::Real>& state_arr,
751  amrex::Real tau_base, bool is_sw, bool cloudy,
752  const TwoStreamParams& rad_choice,
754 {
755  omega = 0.0;
756  g = 0.0;
757  if (!is_sw || rad_choice.tau_model != TauModel::Mass) {
758  tau = diagnose_layer_tau(i, j, k, dz_layer, z_center, state_arr, tau_base, is_sw, cloudy, rad_choice);
759  if (is_sw) {
760  select_scattering_props(z_center, rad_choice, cloudy, omega, g);
761  }
762  return;
763  }
764 
765  // Shortwave mass model: constituent extinction optical depths.
766  amrex::Real rho = state_arr(i, j, k, Rho_comp);
767  if (!(rho > 0.0) || !amrex::Math::isfinite(rho)) rho = 0.0;
768  const amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
769  const amrex::Real qc = get_qc_from_state(i, j, k, state_arr);
770  const amrex::Real path = rho * dz_layer;
771 
772  const amrex::Real tau_dry_abs = path * rad_choice.sw_kabs_dry;
773  const amrex::Real tau_rayleigh = path * rad_choice.sw_kscat_dry;
774  const amrex::Real tau_vapor = path * rad_choice.sw_kabs_vapor * qv;
775  const amrex::Real tau_cloud = path * rad_choice.sw_kext_cloud * qc;
776 
777  amrex::Real ext = tau_dry_abs + tau_rayleigh + tau_vapor + tau_cloud;
778  amrex::Real sca = tau_rayleigh + rad_choice.sw_cloud_omega * tau_cloud;
779  amrex::Real gsca = rad_choice.sw_cloud_g * rad_choice.sw_cloud_omega * tau_cloud;
780 
781  // Prescribed cloud band (optionally scaled by the prognostic cloud
782  // fraction) with the cloud-band scattering inputs.
783  amrex::Real band = tau_layer_value(z_center, 0.0, rad_choice, cloudy);
784  if (rad_choice.cloud_fraction_prog_enable && cloudy &&
785  rad_choice.tau_profile_type == TauProfileType::CloudLayer &&
786  is_cloud_level(z_center, rad_choice)) {
787  band = diagnose_cloud_fraction_prognostic(i, j, k, state_arr, rad_choice) * rad_choice.cloud_tau_per_layer;
788  }
789  if (band > 0.0) {
790  ext += band;
791  sca += rad_choice.cloud_single_scattering_albedo * band;
792  gsca += rad_choice.cloud_asymmetry_factor * rad_choice.cloud_single_scattering_albedo * band;
793  }
794 
795  // Absorbing additions (moisture coefficients, aerosol): everything that
796  // diagnose_layer_tau() adds on top of a zero base, minus the band.
797  const amrex::Real additions = diagnose_layer_tau(i, j, k, dz_layer, z_center, state_arr,
798  0.0, /*is_sw=*/true, cloudy, rad_choice) - band;
799  if (additions > 0.0) ext += additions;
800 
801  if (!amrex::Math::isfinite(ext) || ext <= 0.0) {
802  tau = 0.0;
803  return;
804  }
805  tau = ext;
806  omega = sca / ext;
807  if (omega > 1.0) omega = 1.0;
808  if (omega < 0.0) omega = 0.0;
809  g = (sca > 0.0) ? gsca / sca : 0.0;
810  if (g > 1.0) g = 1.0;
811  if (g < -1.0) g = -1.0;
812 }
813 
814 /**
815  * @brief Cosine of the solar zenith angle over column (i,j) for one call.
816  *
817  * The fixed value of erf.fixed_solar_zenith_angle, or the sun's position over
818  * this column at the calendar time of the call, with the same formula RRTMGP
819  * uses (orbital_cos_zenith without the interval average). The latitude and
820  * longitude are the column's own where the grid carries them, else the
821  * erf.rad_cons_lat/lon constants. Negative when the sun is below the horizon.
822  */
823 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
825  const TwoStreamParams& rad_choice,
826  bool has_latlon,
827  const amrex::Array4<const amrex::Real>* lat_arr,
828  const amrex::Array4<const amrex::Real>* lon_arr)
829 {
830  if (rad_choice.solar_dynamic) {
831  const amrex::Real lat_rad = (has_latlon && lat_arr != nullptr && lat_arr->contains(i, j, 0))
832  ? (*lat_arr)(i, j, 0) * PI / 180.0 : rad_choice.lat_cons_rad;
833  const amrex::Real lon_rad = (has_latlon && lon_arr != nullptr && lon_arr->contains(i, j, 0))
834  ? (*lon_arr)(i, j, 0) * PI / 180.0 : rad_choice.lon_cons_rad;
835  return static_cast<amrex::Real>(
836  orbital_cos_zenith_instant(rad_choice.calday, lat_rad, lon_rad, rad_choice.declin));
837  }
838  return rad_choice.cos_zenith_fixed;
839 }
840 
841 /**
842  * @brief The radiative forcing a land-surface model integrates on, for column (i,j).
843  *
844  * Reads the interface fluxes a sweep wrote in RRTMGP's level layout (see
845  * vertical_two_stream_sweep): the surface is the lower interface of the bottom
846  * layer, index @p kmin. What a land model wants there is the *downwelling*
847  * flux -- it applies its own albedo and emissivity -- not the net flux the
848  * surface energy balance uses:
849  * - @p sw_dn: total downwelling shortwave, direct plus diffuse (component 1);
850  * - @p lw_dn: downwelling longwave (component 3);
851  * - @p coszen: cosine of the solar zenith angle, floored at zero, since a
852  * sun below the horizon delivers nothing and a land model reads a negative
853  * value as a (meaningless) grazing angle.
854  * Call it after any clear/cloudy blending of @p rad_flux, so the fields match
855  * the fluxes that heat the atmosphere.
856  */
857 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
858 void two_stream_land_forcing (int i, int j, int kmin,
859  const amrex::Array4<const amrex::Real>& rad_flux,
860  amrex::Real cos_zenith,
861  amrex::Real& sw_dn,
862  amrex::Real& lw_dn,
863  amrex::Real& coszen)
864 {
865  sw_dn = rad_flux(i, j, kmin, 1);
866  lw_dn = rad_flux(i, j, kmin, 3);
867  coszen = (cos_zenith > amrex::Real(0.0)) ? cos_zenith : amrex::Real(0.0);
868 }
869 
870 /**
871  * @brief GPU-safe per-column vertical integration kernel for two-stream
872  * radiation, computing either the clear-sky or cloudy-column fluxes and
873  * per-level heating rates, depending on the `cloudy` flag.
874  *
875  * **Vertical orientation.** ERF's vertical index increases upward: k = kmin
876  * is the layer adjacent to the surface and k = kmax is the layer adjacent to
877  * the top of the domain (TOA for this model). Layer k spans the interfaces
878  * m = k - kmin (bottom) and m = k - kmin + 1 (top), so interface m = 0 is the
879  * surface and m = nlev is the TOA.
880  *
881  * Per (i,j) column:
882  * 1. SW: Beer-Lambert direct beam on the interfaces, then the two-stream
883  * diffuse field (upward and downward streams) by the adding method with
884  * the surface albedo as the lower boundary condition; the per-level SW
885  * heating rate from the net-flux divergence is written to
886  * qheating_arr(i,j,k,0).
887  * 2. LW: sweep downward from the TOA (F_down = 0) to the surface, then upward
888  * from the surface (F_up = eps * sigma * T_s^4 + (1 - eps) * F_down) to
889  * the TOA, storing both interface profiles. The per-level LW heating rate from the net-flux
890  * divergence is written to qheating_arr(i,j,k,1).
891  * 3. Scalar diagnostics (max heating rate, surface fluxes) are returned for
892  * the reduction in the caller.
893  *
894  * Layer temperature is obtained from (rho, rho*theta, qv) through the
895  * equation of state, i.e. including the Exner function, so LW emission uses
896  * absolute temperature rather than potential temperature.
897  *
898  * Integrates per-column heterogeneous surface properties (albedo,
899  * emissivity, surface temperature) from optional fields with robust fallback
900  * to RadChoice scalar parameters.
901  *
902  * @param[in] i, j Column indices
903  * @param[in] bx Computational box (cell-centered, full vertical extent)
904  * @param[in] dz_uniform Uniform vertical cell size [m], used when z_phys_cc
905  * is unavailable. Passed in rather than taken from a Geometry
906  * because Geometry::CellSize() is host-only and this runs on device.
907  * @param[in] state_arr Array proxy to state data (read-only)
908  * @param[in] rad_choice Column-kernel parameters (TwoStreamParams, built from RadChoice)
909  * @param[in] cloudy If true and tau_profile_type == CloudLayer, apply the
910  * cloud-layer optical depth enhancement (and cloud scattering properties).
911  * @param[out] qheating_arr Component 0 receives the SW and component 1 the
912  * LW radiative tendency of potential temperature, dtheta/dt = (dT/dt) / pi
913  * [K/s], at every level k in [kmin, kmax]. This is the convention the
914  * RhoTheta source term (ERF_MakeSources.cpp) and the RRTMGP path use.
915  * @param[out] max_heating_rate Maximum |Q_sw|+|Q_lw| of the stored theta tendencies in this column
916  * @param[out] sw_surface_flux SW absorbed by the surface, (1 - alb_dir) F_dir + (1 - alb_dif) F_dif [W/m^2]
917  * @param[out] sw_up_toa Upwelling (reflected) SW at the top of the atmosphere [W/m^2]
918  * @param[out] lw_net_surface Net LW (up - down) at the surface [W/m^2]
919  * @param[out] lw_up_toa Upwelling LW at the top of the atmosphere (outgoing longwave) [W/m^2]
920  * @param[out] sw_down_toa Incident SW at the top of the atmosphere, S0 cos(zenith) or zero at night [W/m^2]
921  * @param[in] z_phys_nd Optional nodal physical heights (layer interfaces on a nonuniform grid)
922  * @param[in] has_hetero_alb_sw true if hetero_alb_sw is available
923  * @param[in] hetero_alb_sw Optional per-column SW surface albedo field
924  * @param[in] has_hetero_emiss_lw true if hetero_emiss_lw is available
925  * @param[in] hetero_emiss_lw Optional per-column LW surface emissivity field
926  * @param[in] has_lsm_t_sfc true if the LSM absolute-temperature field is available
927  * @param[in] lsm_t_sfc Optional LSM absolute surface-temperature field [K]
928  * @param[in] has_seb_t_sfc true if the prognostic SEB absolute-temperature field is available
929  * @param[in] seb_t_sfc Optional prognostic SEB absolute surface-temperature field [K]
930  * @param[in] has_surface_layer true if the SurfaceLayer potential-temperature field is available
931  * @param[in] surface_layer_theta Optional SurfaceLayer potential-temperature field [K]
932  * @param[in] has_latlon true if per-column latitude and longitude fields are available
933  * @param[in] lat_arr Optional per-column latitude [degrees] (dynamic sun)
934  * @param[in] lon_arr Optional per-column longitude [degrees, east positive] (dynamic sun)
935  * @param[out] rad_flux_out Optional 4-component flux output in RRTMGP's level layout:
936  * at index k the lower interface of layer k, and at kmax + 1 the top-of-atmosphere
937  * interface (the array must extend one cell above the column); component 0 is the
938  * upward SW, 1 the downward SW (direct plus diffuse), 2 the upward LW and 3 the
939  * downward LW [W/m^2]
940  * @param[out] cos_zenith_out Optional: the cosine of the solar zenith angle this column
941  * was swept with (two_stream_cos_zenith, before any flooring), so a caller that needs the
942  * sun the sweep used reads it rather than evaluating it again
943  */
944 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
946  int i, int j,
947  const amrex::Box& bx,
948  amrex::Real dz_uniform,
949  const amrex::Array4<const amrex::Real>& state_arr,
950  const TwoStreamParams& rad_choice,
951  bool cloudy,
952  const amrex::Array4<amrex::Real>& qheating_arr,
953  amrex::Real& max_heating_rate,
954  amrex::Real& sw_surface_flux,
955  amrex::Real& sw_up_toa,
956  amrex::Real& lw_net_surface,
957  amrex::Real& lw_up_toa,
958  amrex::Real& sw_down_toa,
959  const amrex::Array4<const amrex::Real>& z_phys_nd,
960  const amrex::Array4<amrex::Real>& scratch,
961  bool has_hetero_alb_sw = false,
962  const amrex::Array4<const amrex::Real>* hetero_alb_sw = nullptr,
963  bool has_hetero_emiss_lw = false,
964  const amrex::Array4<const amrex::Real>* hetero_emiss_lw = nullptr,
965  bool has_lsm_t_sfc = false,
966  const amrex::Array4<const amrex::Real>* lsm_t_sfc = nullptr,
967  bool has_seb_t_sfc = false,
968  const amrex::Array4<const amrex::Real>* seb_t_sfc = nullptr,
969  bool has_surface_layer = false,
970  const amrex::Array4<const amrex::Real>* surface_layer_theta = nullptr,
971  bool has_latlon = false,
972  const amrex::Array4<const amrex::Real>* lat_arr = nullptr,
973  const amrex::Array4<const amrex::Real>* lon_arr = nullptr,
974  const amrex::Array4<amrex::Real>* rad_flux_out = nullptr,
975  amrex::Real* cos_zenith_out = nullptr)
976 {
977  // Grid bounds: kmin is the surface layer, kmax the top layer.
978  const int kmin = bx.smallEnd(2);
979  const int kmax = bx.bigEnd(2);
980  const int nlev = kmax - kmin + 1;
981 
982  // The scratch box must hold nlev + 1 interface entries for this column,
983  // and so must the flux output when it is wanted.
984  AMREX_ASSERT(scratch.contains(i, j, kmin) && scratch.contains(i, j, kmax + 1));
985  AMREX_ASSERT(rad_flux_out == nullptr ||
986  (rad_flux_out->contains(i, j, kmin) && rad_flux_out->contains(i, j, kmax + 1)));
987 
988  // Per-column scratch accessors (see TwoStreamScratch). Layer fields are
989  // indexed by layer m in [0, nlev), interface fields by m in [0, nlev].
990  auto dz_level = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::DZ); };
991  auto z_level = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::Z); };
992  auto tau_sw_level = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::TAU_SW); };
993  auto F_dir = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::F_DIR); };
994  auto A = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::A); };
995  auto S = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::S); };
996  auto F_lw_up_iface = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::LW_UP); };
997  auto F_lw_down_iface = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::LW_DN); };
998  auto tau_lw_level = [&] (int m) -> amrex::Real& { return scratch(i, j, kmin + m, TwoStreamScratch::TAU_LW); };
999 
1000  // Physical constants
1001  const amrex::Real sigma = stefan_boltzmann; // Stefan-Boltzmann [W/(m^2·K^4)]
1002  const amrex::Real cp_air = Cp_d; // Dry-air specific heat at constant pressure [J/(kg·K)]
1003 
1004  // ------------------------------------------------------------------
1005  // Layer thickness dz_level(m) and layer-centre height z_level(m) above
1006  // the surface. On a stretched or terrain-following grid both come from
1007  // the interface heights: the height of face k over cell (i,j) is the
1008  // mean of its four nodes in z_phys_nd, so the thickness is the distance
1009  // between the layer's two interfaces (not the centre-to-centre spacing,
1010  // which differs by the stretch ratio) and the top layer gets its own
1011  // thickness. Without z_phys_nd the spacing is uniform. The heating
1012  // divergence dF/(rho cp dz) and the mass path rho dz both use this
1013  // thickness; z_level locates the cloud band and the aerosol profile.
1014  // ------------------------------------------------------------------
1015  if (z_phys_nd) {
1016  auto z_face = [&] (int k) -> amrex::Real {
1017  return 0.25 * (z_phys_nd(i, j, k) + z_phys_nd(i + 1, j, k) +
1018  z_phys_nd(i, j + 1, k) + z_phys_nd(i + 1, j + 1, k));
1019  };
1020  const amrex::Real z_surface = z_face(kmin);
1021  for (int m = 0; m < nlev; ++m) {
1022  const amrex::Real z_lo = z_face(kmin + m);
1023  const amrex::Real z_hi = z_face(kmin + m + 1);
1024  const amrex::Real dz_computed = z_hi - z_lo;
1025  dz_level(m) = (dz_computed > 0.0 && amrex::Math::isfinite(dz_computed)) ? dz_computed : dz_uniform;
1026  z_level(m) = 0.5 * (z_lo + z_hi) - z_surface;
1027  }
1028  } else {
1029  for (int m = 0; m < nlev; ++m) {
1030  dz_level(m) = dz_uniform;
1031  z_level(m) = (static_cast<amrex::Real>(m) + 0.5) * dz_uniform;
1032  }
1033  }
1034 
1035  const amrex::Real cos_zenith = two_stream_cos_zenith(i, j, rad_choice, has_latlon, lat_arr, lon_arr);
1036  if (cos_zenith_out != nullptr) { *cos_zenith_out = cos_zenith; }
1037 
1038  // Top-of-atmosphere irradiance of this call (fixed, or 1360.9 W/m^2
1039  // times the Earth-Sun distance factor of the date; set by the driver).
1040  const amrex::Real S0 = rad_choice.S0;
1041  const amrex::Real tau_sw_base = rad_choice.tau_per_layer;
1042  const amrex::Real tau_lw_base = rad_choice.tau_lw_per_layer;
1043 
1044  amrex::Real local_max_heating = 0.0;
1045 
1046  // Zero-initialize this column's heating rate output (covers the
1047  // sw_enabled=false and lw_enabled=false cases), and the interface fluxes
1048  // when they are wanted (a disabled band or night leaves zeros).
1049  for (int k = kmin; k <= kmax; ++k) {
1050  qheating_arr(i, j, k, 0) = 0.0;
1051  qheating_arr(i, j, k, 1) = 0.0;
1052  }
1053  if (rad_flux_out != nullptr) {
1054  for (int k = kmin; k <= kmax + 1; ++k) {
1055  for (int comp = 0; comp < 4; ++comp) { (*rad_flux_out)(i, j, k, comp) = 0.0; }
1056  }
1057  }
1058  sw_down_toa = (rad_choice.sw_enabled && cos_zenith > 0.0) ? S0 * cos_zenith : 0.0;
1059 
1060  // ========================================================================
1061  // SHORTWAVE. Interfaces m = 0 (surface) .. nlev (TOA); layer m lies
1062  // between interfaces m and m+1.
1063  // 1. Direct beam F_dir(m) by Beer-Lambert from the TOA downward.
1064  // 2. Adding method, upward pass: A(m) is the albedo of everything below
1065  // interface m for diffuse light, S(m) the upward diffuse flux at m
1066  // produced by the direct beam illuminating everything below m. The
1067  // surface starts the recursion with A(0) = diffuse albedo and
1068  // S(0) = direct albedo * F_dir(0).
1069  // 3. Downward pass from the TOA (no incident diffuse flux): diffuse
1070  // downward d(m), diffuse upward u(m) = A(m) d(m) + S(m), and the net
1071  // flux F_dir + d - u whose divergence gives the heating rate.
1072  // ========================================================================
1073  amrex::Real tau_sw_cum = 0.0; // Column SW optical depth accumulated from the top
1074  amrex::Real sw_surface_absorbed = 0.0; // absorbed direct + diffuse at the surface
1075  amrex::Real sw_up_at_toa = 0.0; // u(nlev)
1076  // Direct-beam albedo (per column, LSM field or fallback) and diffuse albedo
1077  // (surface_albedo_sw_diffuse, or the direct value when negative).
1078  const amrex::Real alb_dir = resolve_surface_albedo_sw(i, j, hetero_alb_sw, rad_choice, has_hetero_alb_sw);
1079  const amrex::Real alb_dif = (rad_choice.surface_albedo_sw_diffuse >= 0.0)
1080  ? rad_choice.surface_albedo_sw_diffuse : alb_dir;
1081 
1082  if (rad_choice.sw_enabled && cos_zenith > 0.0) {
1083 
1084  // 1. Per-layer optical depth and the direct beam on the interfaces.
1085  F_dir(nlev) = S0 * cos_zenith;
1086  for (int k = kmax; k >= kmin; --k) {
1087  const int m = k - kmin;
1088  amrex::Real omega_m = 0.0, g_m = 0.0;
1089  diagnose_layer_optics(i, j, k, dz_level(m), z_level(m), state_arr, tau_sw_base,
1090  /*is_sw=*/true, cloudy, rad_choice, tau_sw_level(m), omega_m, g_m);
1091  tau_sw_cum += tau_sw_level(m);
1092  F_dir(m) = compute_sw_direct_flux(tau_sw_cum, S0, cos_zenith);
1093  }
1094 
1095  // Two-stream properties of layer m (evaluated in both passes).
1096  auto layer_props = [&](int m) {
1097  amrex::Real tau_m = 0.0, omega = 0.0, g = 0.0;
1098  diagnose_layer_optics(i, j, kmin + m, dz_level(m), z_level(m), state_arr, tau_sw_base,
1099  /*is_sw=*/true, cloudy, rad_choice, tau_m, omega, g);
1100  return compute_sw_layer_two_stream(tau_sw_level(m), omega, g, cos_zenith);
1101  };
1102 
1103  // 2. Upward pass of the adding method.
1104  A(0) = alb_dif;
1105  S(0) = alb_dir * F_dir(0);
1106  for (int m = 0; m < nlev; ++m) {
1107  const TwoStreamLayerSW L = layer_props(m);
1108  amrex::Real denom = 1.0 - L.R_dif * A(m);
1109  if (denom < 1.0e-12) denom = 1.0e-12;
1110  A(m + 1) = L.R_dif + L.T_dif * L.T_dif * A(m) / denom;
1111  S(m + 1) = L.R_dir * F_dir(m + 1)
1112  + L.T_dif * (S(m) + A(m) * L.T_dir * F_dir(m + 1)) / denom;
1113  }
1114 
1115  // 3. Downward pass: fluxes on the interfaces and layer heating rates.
1116  amrex::Real d_above = 0.0; // No diffuse flux incident at the TOA
1117  amrex::Real u_above = S(nlev);
1118  sw_up_at_toa = u_above;
1119  amrex::Real F_net_above = F_dir(nlev) + d_above - u_above;
1120  if (rad_flux_out != nullptr) {
1121  (*rad_flux_out)(i, j, kmax + 1, 0) = u_above; // SW up at the top of the atmosphere
1122  (*rad_flux_out)(i, j, kmax + 1, 1) = F_dir(nlev); // SW down at the top: the incident beam
1123  }
1124  for (int k = kmax; k >= kmin; --k) {
1125  const int m = k - kmin;
1126  const TwoStreamLayerSW L = layer_props(m);
1127  amrex::Real denom = 1.0 - L.R_dif * A(m);
1128  if (denom < 1.0e-12) denom = 1.0e-12;
1129 
1130  const amrex::Real d_m = (L.T_dif * d_above + L.T_dir * F_dir(m + 1) + L.R_dif * S(m)) / denom;
1131  const amrex::Real u_m = A(m) * d_m + S(m);
1132  const amrex::Real F_net_m = F_dir(m) + d_m - u_m;
1133  if (rad_flux_out != nullptr) {
1134  (*rad_flux_out)(i, j, k, 0) = u_m; // SW up at the lower interface of layer k
1135  (*rad_flux_out)(i, j, k, 1) = F_dir(m) + d_m; // SW down, direct plus diffuse
1136  }
1137 
1138  amrex::Real rho = state_arr(i, j, k, Rho_comp);
1139  if (rho <= 0.0 || !amrex::Math::isfinite(rho)) rho = 1.0;
1140 
1141  // dT/dt from the flux divergence, stored as dtheta/dt = (dT/dt)/pi
1142  // (the RhoTheta source term and RRTMGP use the same convention).
1143  const amrex::Real Q_sw = compute_sw_heating_rate(F_net_above, F_net_m,
1144  dz_level(m), rho, cp_air)
1145  * get_inverse_exner(i, j, k, state_arr);
1146  qheating_arr(i, j, k, 0) = Q_sw;
1147  local_max_heating = std::max(local_max_heating, std::abs(Q_sw));
1148 
1149  d_above = d_m;
1150  F_net_above = F_net_m;
1151  if (m == 0) {
1152  sw_surface_absorbed = (1.0 - alb_dir) * F_dir(0) + (1.0 - alb_dif) * d_m;
1153  }
1154  }
1155  }
1156 
1157  // ========================================================================
1158  // LONGWAVE: interface flux profiles, index m = 0 at the surface and
1159  // m = nlev at the TOA.
1160  // ========================================================================
1161 
1162  if (rad_choice.lw_enabled) {
1163  // Downward sweep: TOA -> surface. Also caches the per-layer LW optical
1164  // depth for the upward sweep.
1165  F_lw_down_iface(nlev) = 0.0; // No incoming LW from space
1166  for (int k = kmax; k >= kmin; --k) {
1167  const int m = k - kmin;
1168 
1169  amrex::Real rho = state_arr(i, j, k, Rho_comp);
1170  amrex::Real rho_theta = state_arr(i, j, k, RhoTheta_comp);
1171  if (rho <= 0.0 || !amrex::Math::isfinite(rho)) rho = 1.0;
1172  if (rho_theta <= 0.0 || !amrex::Math::isfinite(rho_theta)) rho_theta = 288.15;
1173  amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
1174  amrex::Real T_layer = get_temperature_from_rhotheta(rho_theta, rho, qv);
1175 
1176  tau_lw_level(m) = diagnose_layer_tau(i, j, k, dz_level(m), z_level(m),
1177  state_arr, tau_lw_base, /*is_sw=*/false, cloudy,
1178  rad_choice);
1179 
1180  F_lw_down_iface(m) = compute_lw_flux_down(F_lw_down_iface(m + 1), T_layer, sigma, tau_lw_level(m));
1181  }
1182 
1183  // Upward sweep: surface -> TOA. The surface emits eps * sigma * T_s^4
1184  // and reflects the fraction (1 - eps) of the downwelling flux that
1185  // reaches it (gray surface, Kirchhoff's law).
1186  {
1187  bool t_sfc_from_surface_layer = false;
1188  amrex::Real t_surface = resolve_surface_temp_k(
1189  i, j, lsm_t_sfc, has_lsm_t_sfc, seb_t_sfc, has_seb_t_sfc,
1190  surface_layer_theta, has_surface_layer, rad_choice,
1191  t_sfc_from_surface_layer);
1192  // The surface layer carries a potential temperature (MOST works in
1193  // theta); the emission needs the temperature, so convert with the
1194  // physical surface pressure diagnosed from the lowest atmospheric
1195  // cell.
1196  if (t_sfc_from_surface_layer) {
1197  const amrex::Real rho = state_arr(i, j, kmin, Rho_comp);
1198  const amrex::Real rho_theta = state_arr(i, j, kmin, RhoTheta_comp);
1199  const amrex::Real qv = get_qv_from_state(i, j, kmin, state_arr);
1200  const amrex::Real delta_z = z_level(0);
1202  rho, rho_theta, qv, delta_z);
1204  t_surface, pressure, rad_choice.rdOcp, t_surface)) {
1205  t_surface = rad_choice.t_sfc_default;
1206  }
1207  }
1208  amrex::Real emiss_lw = resolve_surface_emissivity_lw(i, j, hetero_emiss_lw, rad_choice, has_hetero_emiss_lw);
1209  F_lw_up_iface(0) = emiss_lw * compute_thermal_intensity(t_surface, sigma)
1210  + (1.0 - emiss_lw) * F_lw_down_iface(0);
1211  }
1212  for (int k = kmin; k <= kmax; ++k) {
1213  const int m = k - kmin;
1214 
1215  amrex::Real rho = state_arr(i, j, k, Rho_comp);
1216  amrex::Real rho_theta = state_arr(i, j, k, RhoTheta_comp);
1217  if (rho <= 0.0 || !amrex::Math::isfinite(rho)) rho = 1.0;
1218  if (rho_theta <= 0.0 || !amrex::Math::isfinite(rho_theta)) rho_theta = 288.15;
1219  amrex::Real qv = get_qv_from_state(i, j, k, state_arr);
1220  amrex::Real T_layer = get_temperature_from_rhotheta(rho_theta, rho, qv);
1221 
1222  F_lw_up_iface(m + 1) = compute_lw_flux_up(F_lw_up_iface(m), T_layer, sigma, tau_lw_level(m));
1223  }
1224 
1225  // Per-level LW heating rate from the net-flux divergence across
1226  // each layer (bottom interface m, top interface m+1).
1227  for (int k = kmin; k <= kmax; ++k) {
1228  const int m = k - kmin;
1229  amrex::Real rho = state_arr(i, j, k, Rho_comp);
1230  if (rho <= 0.0 || !amrex::Math::isfinite(rho)) rho = 1.0;
1231  if (rad_flux_out != nullptr) {
1232  (*rad_flux_out)(i, j, k, 2) = F_lw_up_iface(m); // LW up at the lower interface of layer k
1233  (*rad_flux_out)(i, j, k, 3) = F_lw_down_iface(m); // LW down
1234  if (k == kmax) {
1235  (*rad_flux_out)(i, j, kmax + 1, 2) = F_lw_up_iface(nlev); // outgoing LW at the top
1236  (*rad_flux_out)(i, j, kmax + 1, 3) = F_lw_down_iface(nlev); // zero: nothing comes in from space
1237  }
1238  }
1239 
1240  amrex::Real F_net_top = F_lw_up_iface(m + 1) - F_lw_down_iface(m + 1);
1241  amrex::Real F_net_bot = F_lw_up_iface(m) - F_lw_down_iface(m);
1242 
1243  // dT/dt from the net-flux divergence, stored as dtheta/dt = (dT/dt)/pi.
1244  amrex::Real Q_lw = compute_lw_heating_rate(F_net_top, F_net_bot, dz_level(m), rho, cp_air)
1245  * get_inverse_exner(i, j, k, state_arr);
1246  qheating_arr(i, j, k, 1) = Q_lw;
1247 
1248  amrex::Real Q_sw_here = qheating_arr(i, j, k, 0);
1249  local_max_heating = std::max(local_max_heating, std::abs(Q_sw_here) + std::abs(Q_lw));
1250  }
1251  }
1252 
1253  // ========================================================================
1254  // SURFACE AND DIAGNOSTICS
1255  // ========================================================================
1256  if (rad_choice.sw_enabled) {
1257  // Absorbed direct plus diffuse (see the SW block above)
1258  sw_surface_flux = sw_surface_absorbed;
1259  sw_up_toa = sw_up_at_toa;
1260  } else {
1261  sw_surface_flux = 0.0;
1262  sw_up_toa = 0.0;
1263  }
1264 
1265  if (rad_choice.lw_enabled) {
1266  amrex::Real F_lw_up_sfc = F_lw_up_iface(0);
1267  amrex::Real F_lw_down_sfc = F_lw_down_iface(0);
1268  lw_up_toa = F_lw_up_iface(nlev);
1269  lw_net_surface = F_lw_up_sfc - F_lw_down_sfc;
1270  } else {
1271  lw_net_surface = 0.0;
1272  lw_up_toa = 0.0;
1273  }
1274 
1275  max_heating_rate = local_max_heating;
1276 }
1277 
1278 #endif // ERF_TWO_STREAM_COLUMN_H_
Prescribed bulk aerosol/turbidity optical depth diagnosis.
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_constant(amrex::Real tau_aerosol_const)
Diagnose aerosol optical depth for Constant profile.
Definition: ERF_AerosolOpticalDepth.H:42
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_exponential(amrex::Real z_level, amrex::Real dz, amrex::Real tau_surface, amrex::Real scale_height_m)
Diagnose aerosol optical depth for Exponential profile.
Definition: ERF_AerosolOpticalDepth.H:77
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_aerosol_table(int k)
Diagnose aerosol optical depth for the Table profile.
Definition: ERF_AerosolOpticalDepth.H:123
constexpr amrex::Real Cp_d
Definition: ERF_Constants.H:48
constexpr amrex::Real p_0
Definition: ERF_Constants.H:65
constexpr amrex::Real lsm_undefined
Definition: ERF_Constants.H:28
constexpr amrex::Real RdoCp
Definition: ERF_Constants.H:53
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getTgivenRandRTh(const amrex::Real rho, const amrex::Real rhotheta, const amrex::Real qv=amrex::Real(0))
Definition: ERF_EOS.H:46
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getExnergivenRTh(const amrex::Real rhotheta, const amrex::Real rdOcp, const amrex::Real qv=amrex::Real(0))
Definition: ERF_EOS.H:156
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real getPgivenRTh(const amrex::Real rhotheta, const amrex::Real qv=amrex::Real(0))
Definition: ERF_EOS.H:81
#define Rho_comp
Definition: ERF_IndexDefines.H:42
#define RhoTheta_comp
Definition: ERF_IndexDefines.H:43
#define RhoQ2_comp
Definition: ERF_IndexDefines.H:49
#define RhoQ1_comp
Definition: ERF_IndexDefines.H:48
const Real rdOcp
Definition: ERF_InitCustomPert_ABL.H:72
if(KE_decay_height > 0 &&state_pert.nComp() > RhoKE_comp)
Definition: ERF_InitCustomPert_ABL.H:76
amrex::Real sigma
Definition: ERF_InitCustomPert_DataAssimilation_ISV.H:11
constexpr amrex::Real PI
Definition: ERF_NumericalConstants.H:46
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE double orbital_cos_zenith_instant(double jday, double lat, double lon, double declin)
Definition: ERF_OrbCosZenith.H:507
Prognostic cloud fraction diagnosis from relative humidity and cloud water.
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_relative_humidity(amrex::Real qv, amrex::Real T, amrex::Real P)
Compute relative humidity from water vapor mixing ratio.
Definition: ERF_PrognosticCloudFraction.H:36
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_cloud_fraction_from_rh_qc(amrex::Real rh, amrex::Real qc, amrex::Real rh_min, amrex::Real rh_max, amrex::Real qc_scale)
Diagnose cloud fraction from relative humidity and cloud water.
Definition: ERF_PrognosticCloudFraction.H:98
Radiation model type and control parameters.
amrex::Real Real
Definition: ERF_ShocInterface.H:19
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real two_stream_cos_zenith(int i, int j, const TwoStreamParams &rad_choice, bool has_latlon, const amrex::Array4< const amrex::Real > *lat_arr, const amrex::Array4< const amrex::Real > *lon_arr)
Cosine of the solar zenith angle over column (i,j) for one call.
Definition: ERF_TwoStreamColumn.H:824
TwoStreamParams make_two_stream_params(const RadChoice &rc, const amrex::Real rdOcp)
Copy the column-kernel parameters out of a RadChoice.
Definition: ERF_TwoStreamColumn.H:127
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real get_inverse_exner(int i, int j, int k, const amrex::Array4< const amrex::Real > &state_arr)
Inverse Exner function 1/pi at (i,j,k) from the state, with pi = (p / p_0)^(R_d/c_p) evaluated by get...
Definition: ERF_TwoStreamColumn.H:405
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real resolve_surface_albedo_sw(int i, int j, const amrex::Array4< const amrex::Real > *hetero_alb_sw, const TwoStreamParams &rad_choice, bool has_hetero_alb)
Resolve per-column shortwave surface albedo from hetero field or fallback.
Definition: ERF_TwoStreamColumn.H:245
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void two_stream_land_forcing(int i, int j, int kmin, const amrex::Array4< const amrex::Real > &rad_flux, amrex::Real cos_zenith, amrex::Real &sw_dn, amrex::Real &lw_dn, amrex::Real &coszen)
The radiative forcing a land-surface model integrates on, for column (i,j).
Definition: ERF_TwoStreamColumn.H:858
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_cloud_fraction_prognostic(int i, int j, int k, const amrex::Array4< const amrex::Real > &state_arr, const TwoStreamParams &rad_choice)
GPU-safe helper to diagnose prognostic cloud fraction from per-level relative humidity and cloud liqu...
Definition: ERF_TwoStreamColumn.H:551
amrex::Box two_stream_scratch_box(const amrex::Box &bx)
Box of the scratch FArrayBox a sweep over box bx needs.
Definition: ERF_TwoStreamColumn.H:612
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real get_qv_from_state(int i, int j, int k, const amrex::Array4< const amrex::Real > &state_arr)
Water-vapor mixing ratio qv = RhoQv / Rho at (i,j,k).
Definition: ERF_TwoStreamColumn.H:386
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void diagnose_layer_optics(int i, int j, int k, amrex::Real dz_layer, amrex::Real z_center, const amrex::Array4< const amrex::Real > &state_arr, amrex::Real tau_base, bool is_sw, bool cloudy, const TwoStreamParams &rad_choice, amrex::Real &tau, amrex::Real &omega, amrex::Real &g)
Optical depth, single-scattering albedo and asymmetry factor of layer k for one band,...
Definition: ERF_TwoStreamColumn.H:747
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real tau_layer_value(amrex::Real z_center, amrex::Real tau_base, const TwoStreamParams &rad_choice, bool apply_cloud)
GPU-safe helper to compute the per-layer optical depth at level k, given the base (clear-sky) optical...
Definition: ERF_TwoStreamColumn.H:480
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real get_qc_from_state(int i, int j, int k, const amrex::Array4< const amrex::Real > &state_arr)
Cloud-water mixing ratio qc = RhoQc / Rho at (i,j,k).
Definition: ERF_TwoStreamColumn.H:422
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_tau_dynamic(amrex::Real tau_base, amrex::Real qv, amrex::Real qc, amrex::Real coeff_qv, amrex::Real coeff_qc)
Moisture-dependent (dynamic) per-layer optical depth.
Definition: ERF_TwoStreamColumn.H:450
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool is_cloud_level(amrex::Real z_center, const TwoStreamParams &rad_choice)
GPU-safe helper to determine whether a layer falls within the cloud band [cloud_base_height_m,...
Definition: ERF_TwoStreamColumn.H:373
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool valid_surface_temperature(amrex::Real value)
Check whether a heterogeneous absolute surface temperature is valid.
Definition: ERF_TwoStreamColumn.H:225
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real get_temperature_from_rhotheta(amrex::Real rho_theta, amrex::Real rho, amrex::Real qv=0.0)
GPU-safe helper to compute absolute temperature from (rho, rho*theta).
Definition: ERF_TwoStreamColumn.H:200
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void select_scattering_props(amrex::Real z_center, const TwoStreamParams &rad_choice, bool apply_cloud, amrex::Real &omega, amrex::Real &g)
GPU-safe helper to select the single-scattering albedo and asymmetry factor to use for level k's diff...
Definition: ERF_TwoStreamColumn.H:515
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real resolve_surface_emissivity_lw(int i, int j, const amrex::Array4< const amrex::Real > *hetero_emiss_lw, const TwoStreamParams &rad_choice, bool has_hetero_emiss)
Resolve per-column longwave surface emissivity from hetero field or fallback.
Definition: ERF_TwoStreamColumn.H:278
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real diagnose_layer_tau(int i, int j, int k, amrex::Real dz_layer, amrex::Real z_center, const amrex::Array4< const amrex::Real > &state_arr, amrex::Real tau_base, bool is_sw, bool cloudy, const TwoStreamParams &rad_choice)
GPU-safe helper to assemble the total per-layer optical depth at level k for either the SW or the LW ...
Definition: ERF_TwoStreamColumn.H:645
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real resolve_surface_temp_k(int i, int j, const amrex::Array4< const amrex::Real > *lsm_t_sfc, bool has_lsm_t_sfc, const amrex::Array4< const amrex::Real > *seb_t_sfc, bool has_seb_t_sfc, const amrex::Array4< const amrex::Real > *surface_layer_theta, bool has_surface_layer, const TwoStreamParams &rad_choice, bool &from_surface_layer)
Resolve the per-column surface-temperature boundary condition.
Definition: ERF_TwoStreamColumn.H:324
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void vertical_two_stream_sweep(int i, int j, const amrex::Box &bx, amrex::Real dz_uniform, const amrex::Array4< const amrex::Real > &state_arr, const TwoStreamParams &rad_choice, bool cloudy, const amrex::Array4< amrex::Real > &qheating_arr, amrex::Real &max_heating_rate, amrex::Real &sw_surface_flux, amrex::Real &sw_up_toa, amrex::Real &lw_net_surface, amrex::Real &lw_up_toa, amrex::Real &sw_down_toa, const amrex::Array4< const amrex::Real > &z_phys_nd, const amrex::Array4< amrex::Real > &scratch, bool has_hetero_alb_sw=false, const amrex::Array4< const amrex::Real > *hetero_alb_sw=nullptr, bool has_hetero_emiss_lw=false, const amrex::Array4< const amrex::Real > *hetero_emiss_lw=nullptr, bool has_lsm_t_sfc=false, const amrex::Array4< const amrex::Real > *lsm_t_sfc=nullptr, bool has_seb_t_sfc=false, const amrex::Array4< const amrex::Real > *seb_t_sfc=nullptr, bool has_surface_layer=false, const amrex::Array4< const amrex::Real > *surface_layer_theta=nullptr, bool has_latlon=false, const amrex::Array4< const amrex::Real > *lat_arr=nullptr, const amrex::Array4< const amrex::Real > *lon_arr=nullptr, const amrex::Array4< amrex::Real > *rad_flux_out=nullptr, amrex::Real *cos_zenith_out=nullptr)
GPU-safe per-column vertical integration kernel for two-stream radiation, computing either the clear-...
Definition: ERF_TwoStreamColumn.H:945
Longwave (thermal) radiation using gray-gas two-stream model.
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_lw_flux_down(amrex::Real F_down_above, amrex::Real T_layer, amrex::Real sigma, amrex::Real tau_lw)
Compute downwelling LW flux in one layer of a two-stream sweep.
Definition: ERF_TwoStreamLW.H:188
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_thermal_intensity(amrex::Real T, amrex::Real sigma)
Compute thermal (LW) intensity for a given temperature.
Definition: ERF_TwoStreamLW.H:93
constexpr amrex::Real stefan_boltzmann
Stefan-Boltzmann constant [W/(m^2 K^4)] used by the two-stream LW model.
Definition: ERF_TwoStreamLW.H:11
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_lw_heating_rate(amrex::Real F_net_top, amrex::Real F_net_bot, amrex::Real dz, amrex::Real rho, amrex::Real cp)
Compute LW heating rate from net flux divergence.
Definition: ERF_TwoStreamLW.H:236
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_lw_flux_up(amrex::Real F_up_below, amrex::Real T_layer, amrex::Real sigma, amrex::Real tau_lw)
Compute upwelling LW flux in one layer of a two-stream sweep.
Definition: ERF_TwoStreamLW.H:156
Shortwave (solar) radiation kernels: Beer-Lambert direct beam and the two-stream layer solution for t...
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_sw_direct_flux(amrex::Real tau_cumulative, amrex::Real S0, amrex::Real cos_zenith)
Compute Beer-Lambert direct-beam flux at a given optical depth.
Definition: ERF_TwoStreamSW.H:72
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real compute_sw_heating_rate(amrex::Real flux_top, amrex::Real flux_bot, amrex::Real dz, amrex::Real rho, amrex::Real cp)
Compute the shortwave heating rate of a layer from the net (downward positive) flux at its top and bo...
Definition: ERF_TwoStreamSW.H:101
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE TwoStreamLayerSW compute_sw_layer_two_stream(amrex::Real tau, amrex::Real omega, amrex::Real g, amrex::Real cos_zenith)
Compute the two-stream layer solution for shortwave radiation.
Definition: ERF_TwoStreamSW.H:176
@ P
Definition: ERF_IndexDefines.H:207
@ rho
Definition: ERF_Kessler.H:25
@ theta
Definition: ERF_Kessler.H:26
@ qv
Definition: ERF_Kessler.H:31
@ omega
Definition: ERF_Morrison.H:55
@ qc
Definition: ERF_SatAdj.H:42
@ T
Definition: ERF_IndexDefines.H:131
constexpr std::array< amrex::Real, num_veg_params > rc
Definition: ERF_SLM_DefaultParams.H:22
Per-column scratch the sweep keeps in a caller-provided Array4.
Definition: ERF_TwoStreamColumn.H:598
constexpr int F_DIR
Definition: ERF_TwoStreamColumn.H:602
constexpr int A
Definition: ERF_TwoStreamColumn.H:603
constexpr int Z
Definition: ERF_TwoStreamColumn.H:600
constexpr int NCOMP
Definition: ERF_TwoStreamColumn.H:608
constexpr int TAU_LW
Definition: ERF_TwoStreamColumn.H:607
constexpr int LW_UP
Definition: ERF_TwoStreamColumn.H:605
constexpr int LW_DN
Definition: ERF_TwoStreamColumn.H:606
constexpr int S
Definition: ERF_TwoStreamColumn.H:604
constexpr int DZ
Definition: ERF_TwoStreamColumn.H:599
constexpr int TAU_SW
Definition: ERF_TwoStreamColumn.H:601
@ p
Definition: ERF_WSM6.H:280
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pressure_at_surface(const amrex::Real rho, const amrex::Real rho_theta, const amrex::Real qv, const amrex::Real delta_z)
Definition: ERF_SurfaceTemperature.H:36
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE bool theta_to_temperature(const amrex::Real theta, const amrex::Real pressure, const amrex::Real rdOcp, amrex::Real &temperature)
Definition: ERF_SurfaceTemperature.H:60
real(c_double), parameter g
Definition: ERF_module_model_constants.F90:19
real(c_double), parameter, private pi
Definition: ERF_module_mp_morr_two_moment.F90:100
Container holding radiation-related choices and parameters.
Definition: ERF_RadStruct.H:86
Two-stream reflectance and transmittance of one homogeneous layer.
Definition: ERF_TwoStreamSW.H:132
amrex::Real T_dir
Definition: ERF_TwoStreamSW.H:136
amrex::Real T_dif
Definition: ERF_TwoStreamSW.H:134
amrex::Real R_dif
Definition: ERF_TwoStreamSW.H:133
amrex::Real R_dir
Definition: ERF_TwoStreamSW.H:135
Trivially copyable subset of RadChoice used by the column kernels.
Definition: ERF_TwoStreamColumn.H:57
amrex::Real cos_zenith_fixed
Definition: ERF_TwoStreamColumn.H:114
bool lw_mass_absorption_enable
Definition: ERF_TwoStreamColumn.H:105
amrex::Real lw_kabs_cloud
Definition: ERF_TwoStreamColumn.H:108
amrex::Real aerosol_tau_per_layer
Definition: ERF_TwoStreamColumn.H:93
amrex::Real sw_cloud_omega
Definition: ERF_TwoStreamColumn.H:102
amrex::Real cloud_single_scattering_albedo
Definition: ERF_TwoStreamColumn.H:70
amrex::Real sw_kabs_vapor
Definition: ERF_TwoStreamColumn.H:100
bool tau_sw_dynamic_enable
Definition: ERF_TwoStreamColumn.H:79
amrex::Real cloud_top_height_m
Definition: ERF_TwoStreamColumn.H:65
bool aerosol_enable
Definition: ERF_TwoStreamColumn.H:91
amrex::Real cloud_base_height_m
Definition: ERF_TwoStreamColumn.H:64
amrex::Real surface_emissivity_lw
Definition: ERF_TwoStreamColumn.H:75
amrex::Real aerosol_tau_surface
Definition: ERF_TwoStreamColumn.H:95
TauModel tau_model
Definition: ERF_TwoStreamColumn.H:97
bool sw_enabled
Definition: ERF_TwoStreamColumn.H:58
amrex::Real tau_lw_coeff_qv
Definition: ERF_TwoStreamColumn.H:83
amrex::Real cloud_tau_per_layer
Definition: ERF_TwoStreamColumn.H:66
TauProfileType tau_profile_type
Definition: ERF_TwoStreamColumn.H:63
amrex::Real surface_albedo_sw
Definition: ERF_TwoStreamColumn.H:73
amrex::Real tau_lw_per_layer
Definition: ERF_TwoStreamColumn.H:61
amrex::Real single_scattering_albedo
Definition: ERF_TwoStreamColumn.H:68
amrex::Real S0
Definition: ERF_TwoStreamColumn.H:115
amrex::Real lat_cons_rad
Definition: ERF_TwoStreamColumn.H:118
amrex::Real sw_kext_cloud
Definition: ERF_TwoStreamColumn.H:101
amrex::Real sw_kabs_dry
Definition: ERF_TwoStreamColumn.H:98
amrex::Real sw_kscat_dry
Definition: ERF_TwoStreamColumn.H:99
amrex::Real tau_sw_coeff_qc
Definition: ERF_TwoStreamColumn.H:82
amrex::Real cloud_fraction_qc_scale
Definition: ERF_TwoStreamColumn.H:89
amrex::Real tau_lw_coeff_qc
Definition: ERF_TwoStreamColumn.H:84
bool lw_enabled
Definition: ERF_TwoStreamColumn.H:59
amrex::Real aerosol_scale_height_m
Definition: ERF_TwoStreamColumn.H:94
amrex::Real t_sfc_default
Definition: ERF_TwoStreamColumn.H:76
amrex::Real surface_albedo_sw_diffuse
Definition: ERF_TwoStreamColumn.H:74
amrex::Real cloud_fraction_rh_max
Definition: ERF_TwoStreamColumn.H:88
amrex::Real rdOcp
Definition: ERF_TwoStreamColumn.H:77
bool cloud_fraction_prog_enable
Definition: ERF_TwoStreamColumn.H:86
amrex::Real tau_per_layer
Definition: ERF_TwoStreamColumn.H:60
amrex::Real cloud_asymmetry_factor
Definition: ERF_TwoStreamColumn.H:71
amrex::Real calday
Definition: ERF_TwoStreamColumn.H:116
amrex::Real declin
Definition: ERF_TwoStreamColumn.H:117
amrex::Real lon_cons_rad
Definition: ERF_TwoStreamColumn.H:119
bool solar_dynamic
Definition: ERF_TwoStreamColumn.H:113
amrex::Real sw_cloud_g
Definition: ERF_TwoStreamColumn.H:103
amrex::Real lw_kabs_vapor
Definition: ERF_TwoStreamColumn.H:107
AerosolProfileType aerosol_profile_type
Definition: ERF_TwoStreamColumn.H:92
amrex::Real tau_sw_coeff_qv
Definition: ERF_TwoStreamColumn.H:81
amrex::Real asymmetry_factor
Definition: ERF_TwoStreamColumn.H:69
bool tau_lw_dynamic_enable
Definition: ERF_TwoStreamColumn.H:80
amrex::Real lw_kabs_dry
Definition: ERF_TwoStreamColumn.H:106
amrex::Real cloud_fraction_rh_min
Definition: ERF_TwoStreamColumn.H:87