Merge pull request #3789 from CliMA/oa/noneq_implicit_flag

adding noneq implicit flag

Author: oalcabes

config/default_configs/default_config.yml

@@ -202,6 +202,9 @@ precip_model:
 cloud_model:
   help: "Cloud model [`grid_scale`, `quadrature` (default), `quadrature_sgs`]"
   value: "quadrature"
+implicit_noneq_cloud_formation:
+  help: "Whether to treat the nonequilibrium cloud condensate tendency implicitly [`true`, `false` (default)]"
+  value: false
 perf_summary:
   help: "Flag for collecting performance summary information"
   value: false

config/model_configs/amip_target_edonly_nonequil.yml

@@ -8,6 +8,7 @@ viscous_sponge: true
 dt_save_state_to_disk: "30days"
 cloud_model: "grid_scale"
 moist: "nonequil"
+implicit_noneq_cloud_formation: true
 precip_model: "1M"
 rad: "allskywithclear"
 dt_rad: "1hours"

src/prognostic_equations/implicit/implicit_tendency.jl

@@ -9,6 +9,17 @@ NVTX.@annotate function implicit_tendency!(Yₜ, Y, p, t)
     fill_with_nans!(p)
     Yₜ .= zero(eltype(Yₜ))
     implicit_vertical_advection_tendency!(Yₜ, Y, p, t)
+
+    if p.atmos.noneq_cloud_formation_mode == Implicit()
+        cloud_condensate_tendency!(
+            Yₜ,
+            Y,
+            p,
+            p.atmos.moisture_model,
+            p.atmos.precip_model,
+        )
+    end
+
     if p.atmos.sgs_adv_mode == Implicit()
         edmfx_sgs_vertical_advection_tendency!(
             Yₜ,

src/prognostic_equations/remaining_tendency.jl

@@ -123,14 +123,17 @@ NVTX.@annotate function additional_tendency!(Yₜ, Y, p, t)
     end
     edmfx_filter_tendency!(Yₜ, Y, p, t, p.atmos.turbconv_model)
     edmfx_tke_tendency!(Yₜ, Y, p, t, p.atmos.turbconv_model)
-    # Non-equilibrium cloud formation
-    cloud_condensate_tendency!(
-        Yₜ,
-        Y,
-        p,
-        p.atmos.moisture_model,
-        p.atmos.precip_model,
-    )
+
+    if p.atmos.noneq_cloud_formation_mode == Explicit()
+        cloud_condensate_tendency!(
+            Yₜ,
+            Y,
+            p,
+            p.atmos.moisture_model,
+            p.atmos.precip_model,
+        )
+    end
+
     edmfx_precipitation_tendency!(
         Yₜ,
         Y,

src/solver/type_getters.jl

@@ -23,6 +23,11 @@ function get_atmos(config::AtmosConfig, params)
     moisture_model = get_moisture_model(parsed_args)
     precip_model = get_precipitation_model(parsed_args)
     cloud_model = get_cloud_model(parsed_args)
+
+    implicit_noneq_cloud_formation =
+        parsed_args["implicit_noneq_cloud_formation"]
+    @assert implicit_noneq_cloud_formation in (true, false)
+
     ozone = get_ozone(parsed_args)
     radiation_mode = get_radiation_mode(parsed_args, FT)
     forcing_type = get_forcing_type(parsed_args)
@@ -93,6 +98,8 @@ function get_atmos(config::AtmosConfig, params)
         edmfx_model,
         precip_model,
         cloud_model,
+        noneq_cloud_formation_mode = implicit_noneq_cloud_formation ?
+                                     Implicit() : Explicit(),
         forcing_type,
         call_cloud_diagnostics_per_stage,
         turbconv_model = get_turbconv_model(FT, parsed_args, turbconv_params),

src/solver/types.jl

@@ -511,6 +511,7 @@ Base.@kwdef struct AtmosModel{
     MM,
     PM,
     CM,
+    NCFM,
     CCDPS,
     F,
     S,
@@ -544,6 +545,7 @@ Base.@kwdef struct AtmosModel{
     moisture_model::MM = nothing
     precip_model::PM = nothing
     cloud_model::CM = nothing
+    noneq_cloud_formation_mode::NCFM = nothing
     call_cloud_diagnostics_per_stage::CCDPS = nothing
     forcing_type::F = nothing
     subsidence::S = nothing