Rename edmf_coriolis to scm_coriolis (since it's not EDMF specific); some added docstrings

Entr/Detr cleanup and docs

Split out function for calculation of gradient Ri

Docstrings throughout prognostic_equations; renamed horizontal_advection to horizontal_dynamics

gm_sgs_closures.jl docstrings

Remaining tendency docstrings

edmf_boundary_condition.jl cleanup and docs

Docstrings for forcing; replaced a hard-coded internal energy of vapor
by call to thermodynamics

Co-authored-by: Tapio Schneider <[email protected]>

Author: costachris

config/default_configs/default_config.yml

@@ -341,8 +341,8 @@ implicit_sgs_nh_pressure:
 implicit_sgs_mass_flux:
   help: "Whether to treat the subgrid-scale mass flux tendency implicitly or explicitly in grid-mean equations. Currently updraft only with Jacobian terms 0. [`false` (default), `true`]. Setting it to true only works if both implicit_sgs_advection and implicit_diffusion are set to true."
   value: false
-edmf_coriolis:
-  help: "EDMF coriolis [`nothing` (default), `Bomex`,`LifeCycleTan2018`,`Rico`,`ARM_SGP`,`DYCOMS_RF01`,`DYCOMS_RF02`,`GABLS`]"
+scm_coriolis:
+  help: "SCM Coriolis [`nothing` (default), `Bomex`,`LifeCycleTan2018`,`Rico`,`ARM_SGP`,`DYCOMS_RF01`,`DYCOMS_RF02`,`GABLS`]"
   value: ~
 edmfx_filter:
   help: "If set to true, it switches on the relaxation of negative velocity in EDMFX.  [`true`, `false` (default)]"
@@ -352,10 +352,10 @@ edmfx_nh_pressure:
   in the pressure closure. The buoyancy term is always applied. [`true`, `false` (default)]"
   value: false
 edmfx_entr_model:
-  help: "EDMFX entrainment closure.  [`nothing` (default), `PiGroups`, `Generalized`, `GeneralizedHarmonics`]"
+  help: "EDMFX entrainment closure.  [`nothing` (default), `PiGroups`, `Generalized`]"
   value: ~
 edmfx_detr_model:
-  help: "EDMFX detrainment closure.  [`nothing` (default), `PiGroups`, `Generalized`, `GeneralizedHarmonics`]"
+  help: "EDMFX detrainment closure.  [`nothing` (default), `PiGroups`, `Generalized`]"
   value: ~
 edmfx_upwinding:
   help: "EDMFX upwinding mode [`none` (default), `first_order`, `third_order`]"

config/model_configs/diagnostic_edmfx_bomex_box.yml

@@ -1,6 +1,6 @@
 initial_condition: "Bomex"
 subsidence: "Bomex"
-edmf_coriolis: "Bomex"
+scm_coriolis: "Bomex"
 ls_adv: "Bomex"
 surface_setup: "Bomex"
 turbconv: "diagnostic_edmfx"

config/model_configs/diagnostic_edmfx_bomex_stretched_box.yml

@@ -1,6 +1,6 @@
 initial_condition: "Bomex"
 subsidence: "Bomex"
-edmf_coriolis: "Bomex"
+scm_coriolis: "Bomex"
 ls_adv: "Bomex"
 surface_setup: "Bomex"
 turbconv: "diagnostic_edmfx"

config/model_configs/diagnostic_edmfx_dycoms_rf01_box.yml

@@ -1,6 +1,6 @@
 initial_condition: DYCOMS_RF01
 subsidence: DYCOMS
-edmf_coriolis: DYCOMS_RF01
+scm_coriolis: DYCOMS_RF01
 rad: DYCOMS
 surface_setup: DYCOMS_RF01
 turbconv: diagnostic_edmfx

config/model_configs/diagnostic_edmfx_dycoms_rf01_explicit_box.yml

@@ -1,6 +1,6 @@
 initial_condition: DYCOMS_RF01
 subsidence: DYCOMS
-edmf_coriolis: DYCOMS_RF01
+scm_coriolis: DYCOMS_RF01
 rad: DYCOMS
 surface_setup: DYCOMS_RF01
 turbconv: diagnostic_edmfx

config/model_configs/diagnostic_edmfx_dycoms_rf02_box.yml

@@ -1,6 +1,6 @@
 initial_condition: DYCOMS_RF02
 subsidence: DYCOMS
-edmf_coriolis: DYCOMS_RF02
+scm_coriolis: DYCOMS_RF02
 rad: DYCOMS
 surface_setup: DYCOMS_RF02
 turbconv: diagnostic_edmfx

config/model_configs/diagnostic_edmfx_gabls_box.yml

@@ -1,5 +1,5 @@
 initial_condition: GABLS
-edmf_coriolis: GABLS
+scm_coriolis: GABLS
 surface_setup: GABLS
 turbconv: diagnostic_edmfx
 implicit_diffusion: true

config/model_configs/prognostic_edmfx_bomex_box.yml

@@ -1,6 +1,6 @@
 initial_condition: "Bomex"
 subsidence: "Bomex"
-edmf_coriolis: "Bomex"
+scm_coriolis: "Bomex"
 ls_adv: "Bomex"
 surface_setup: "Bomex"
 turbconv: "prognostic_edmfx"

config/model_configs/prognostic_edmfx_bomex_column.yml

@@ -1,6 +1,6 @@
 initial_condition: "Bomex"
 subsidence: "Bomex"
-edmf_coriolis: "Bomex"
+scm_coriolis: "Bomex"
 ls_adv: "Bomex"
 surface_setup: "Bomex"
 turbconv: "prognostic_edmfx"

config/model_configs/prognostic_edmfx_bomex_fixtke_column.yml

@@ -1,6 +1,6 @@
 initial_condition: "Bomex"
 subsidence: "Bomex"
-edmf_coriolis: "Bomex"
+scm_coriolis: "Bomex"
 ls_adv: "Bomex"
 surface_setup: "Bomex"
 turbconv: "prognostic_edmfx"