Merge pull request #401 from CliMA/aj/ml_total_activated

Add total activated number to ML extension

ext/EmulatorModelsExt.jl

@@ -61,6 +61,35 @@ function AA.N_activated_per_mode(
     end
 end
 
+"""
+    total_N_activated(machine, ap, ad, aip, tps, T, p, w, q)
+
+  - `machine` - ML model
+  - `ap` - a struct with aerosol activation parameters
+  - `ad` - aerosol distribution struct
+  - `aip` - a struct with air properties
+  - `tps` - a struct with thermodynamics parameters
+  - `T` - air temperature
+  - `p` - air pressure
+  - `w` - vertical velocity
+  - `q` - phase partition
+
+Returns the total number of activated aerosol particles by using a trained emulator.
+"""
+function AA.total_N_activated(
+    machine::MLJ.Machine,
+    ap::CMP.AerosolActivationParameters,
+    ad::CMP.AerosolDistributionType,
+    aip::CMP.AirProperties,
+    tps::TDP.ThermodynamicsParameters,
+    T::FT,
+    p::FT,
+    w::FT,
+    q::TD.PhasePartition{FT},
+) where {FT}
+    return sum(AA.N_activated_per_mode(machine, ap, ad, aip, tps, T, p, w, q))
+end
+
 """
     AerosolActivationParameters(ekp_params)
 

test/aerosol_activation_emulators.jl

@@ -328,6 +328,9 @@ function test_emulator(
     TT.@test AA.N_activated_per_mode(mach, ap, ad, aip, tps, T, p, w, q)[2] ≈
              AA.N_activated_per_mode(ap, ad, aip, tps, T, p, w, q)[2] rtol =
         rtols[2]
+    TT.@test AA.total_N_activated(mach, ap, ad, aip, tps, T, p, w, q) ≈
+             AA.total_N_activated(ap, ad, aip, tps, T, p, w, q) rtol = rtols[2]
+
 end
 
 @info "Aerosol activation test"