Merge pull request #567 from CliMA/aj/0M_updates

Add more interface options to 0M

Author: trontrytel

Project.toml

@@ -1,7 +1,7 @@
 name = "CloudMicrophysics"
 uuid = "6a9e3e04-43cd-43ba-94b9-e8782df3c71b"
 authors = ["Climate Modeling Alliance"]
-version = "0.22.12"
+version = "0.22.13"
 
 [deps]
 ClimaParams = "5c42b081-d73a-476f-9059-fd94b934656c"

src/Microphysics0M.jl

@@ -15,29 +15,40 @@ import CloudMicrophysics.Parameters as CMP
 export remove_precipitation
 
 """
+    remove_precipitation(params_0M, q_liq, q_ice; q_vap_sat)
     remove_precipitation(params_0M, q; q_vap_sat)
 
  - `params_0M` - a struct with 0-moment parameters
- - `q` - current PhasePartition
+ - `q` - current Thermodynamics.PhasePartition or `q_liq` and `q_ice` specific contents
  - `q_vap_sat` - specific humidity at saturation
 
 Returns the `q_tot` tendency due to the removal of precipitation.
 The tendency is obtained assuming a relaxation with a constant timescale
 to a state with precipitable water removed.
 The threshold for when to remove `q_tot` is defined either by the
 condensate specific content or supersaturation.
-The thresholds and the relaxation timescale are defined in
-ClimaParams.
+The thresholds and the relaxation timescale are defined `Parameters0M` struct.
 """
 remove_precipitation(
     (; τ_precip, qc_0)::CMP.Parameters0M,
+    q_liq,
+    q_ice,
+) = -max(0, (q_liq + q_ice - qc_0)) / τ_precip
+remove_precipitation(
+    params::CMP.Parameters0M,
     q::TD.PhasePartition,
-) = -max(0, (q.liq + q.ice - qc_0)) / τ_precip
+) = remove_precipitation(params, q.liq, q.ice)
 
 remove_precipitation(
     (; τ_precip, S_0)::CMP.Parameters0M,
+    q_liq,
+    q_ice,
+    q_vap_sat,
+) = -max(0, (q_liq + q_ice - S_0 * q_vap_sat)) / τ_precip
+remove_precipitation(
+    params::CMP.Parameters0M,
     q::TD.PhasePartition,
     q_vap_sat,
-) = -max(0, (q.liq + q.ice - S_0 * q_vap_sat)) / τ_precip
+) = remove_precipitation(params, q.liq, q.ice, q_vap_sat)
 
 end #module Microphysics0M.jl

test/gpu_tests.jl

@@ -173,7 +173,8 @@ end
         q = TD.PhasePartition(FT(qt[i]), ql, qi)
 
         output[1, i] = CM0.remove_precipitation(p0m, q)
-        output[2, i] = -max(0, ql + qi - p0m.qc_0) / p0m.τ_precip
+        output[2, i] = CM0.remove_precipitation(p0m, ql, qi)
+        output[3, i] = -max(0, ql + qi - p0m.qc_0) / p0m.τ_precip
     end
 end
 
@@ -890,7 +891,7 @@ function test_gpu(FT)
     end
 
     @testset "0-moment microphysics kernels" begin
-        dims = (3, 2)
+        dims = (3, 3)
         (; output, ndrange) = setup_output(dims, FT)
 
         liquid_frac = ArrayType([FT(0), FT(0.5), FT(1)])
@@ -902,6 +903,7 @@ function test_gpu(FT)
 
         # test 0-moment rain removal is callable and returns a reasonable value
         @test all(isequal(Array(output)[1, :], Array(output)[2, :]))
+        @test all(isequal(Array(output)[1, :], Array(output)[3, :]))
     end
 
     @testset "1-moment microphysics kernels" begin

test/microphysics0M_tests.jl

@@ -21,7 +21,10 @@ function test_microphysics0M(FT)
         # no rain if no cloud
         q = TD.PhasePartition(q_tot)
         TT.@test CM0.remove_precipitation(p0m, q) ≈ FT(0)
+        TT.@test CM0.remove_precipitation(p0m, FT(0), FT(0)) ≈ FT(0)
         TT.@test CM0.remove_precipitation(p0m, q, q_vap_sat) ≈ FT(0)
+        TT.@test CM0.remove_precipitation(p0m, FT(0), FT(0), q_vap_sat) ≈ FT(0)
+
 
         # rain based on qc threshold
         for lf in frac
@@ -32,6 +35,8 @@ function test_microphysics0M(FT)
 
             TT.@test CM0.remove_precipitation(p0m, q) ≈
                      -max(0, q_liq + q_ice - qc_0) / τ_precip
+            TT.@test CM0.remove_precipitation(p0m, q_liq, q_ice) ≈
+                     -max(0, q_liq + q_ice - qc_0) / τ_precip
         end
 
         # rain based on supersaturation threshold
@@ -43,6 +48,8 @@ function test_microphysics0M(FT)
 
             TT.@test CM0.remove_precipitation(p0m, q, q_vap_sat) ≈
                      -max(0, q_liq + q_ice - S_0 * q_vap_sat) / τ_precip
+            TT.@test CM0.remove_precipitation(p0m, q_liq, q_ice, q_vap_sat) ≈
+                     -max(0, q_liq + q_ice - S_0 * q_vap_sat) / τ_precip
         end
     end
 end

test/performance_tests.jl

@@ -290,6 +290,7 @@ function benchmark_test(FT)
 
     # 0-moment
     bench_press(FT, CM0.remove_precipitation, (p0m, q), 12)
+    bench_press(FT, CM0.remove_precipitation, (p0m, q_liq, q_ice), 12)
 
     # 1-moment
     bench_press(