Merge CLUBB-MF into stormspeed for improved high resolution convection

.gitmodules

@@ -101,11 +101,11 @@
 
 [submodule "clubb"]
 	path = src/physics/clubb
-	url = https://github.com/larson-group/clubb_release
-        fxrequired = AlwaysRequired
-        fxsparse = ../.clubb_sparse_checkout
-        fxtag = clubb_4ncar_20240605_73d60f6_gpufixes_posinf
-        fxDONOTUSEurl = https://github.com/larson-group/clubb_release
+    url = https://github.com/adamrher/clubb_release
+	fxrequired = AlwaysRequired
+    fxsparse = ../.clubb_sparse_checkout
+	fxtag = d224307f798b654f5312a9f035568c8a99ca400c
+    fxDONOTUSEurl = https://github.com/adamrher/clubb_release
 
 [submodule "cism"]
 path = components/cism

bld/build-namelist

@@ -3146,6 +3146,7 @@ if (defined $cam_physpkg) {
         "This variable is set by build-namelist based on information\n".
         "from the configure cache file.\n";
 }
+
 $cam_physpkg = "'" . "$phys" . "'";  # add quotes to this string value
 $nl->set_variable_value('phys_ctl_nl', 'cam_physpkg', $cam_physpkg);
 
@@ -3646,15 +3647,39 @@ if ($clubb_sgs  =~ /$TRUE/io) {
    add_default($nl, 'clubb_wpxp_Ri_exp');
    add_default($nl, 'clubb_z_displace');
 
+   #Turn on HB scheme where CLUBB not active
+   add_default($nl, 'do_hb_above_clubb');
+
    #CLUBB+MF options
    add_default($nl, 'do_clubb_mf');
    add_default($nl, 'do_clubb_mf_diag');
+   add_default($nl, 'do_clubb_mf_rad');
+   add_default($nl, 'do_clubb_mf_precip');
+   add_default($nl, 'do_clubb_mf_addtke');
    add_default($nl, 'clubb_mf_L0');
    add_default($nl, 'clubb_mf_ent0');
+   add_default($nl, 'clubb_mf_alphturb');
+   add_default($nl, 'clubb_mf_Lopt');
+   add_default($nl, 'clubb_mf_a0');
+   add_default($nl, 'clubb_mf_b0');
    add_default($nl, 'clubb_mf_nup');
-
-   #Turn on HB scheme where CLUBB not active
-   add_default($nl, 'do_hb_above_clubb');
+   add_default($nl, 'clubb_mf_max_L0');
+   add_default($nl, 'clubb_mf_fdd');
+   add_default($nl, 'do_clubb_mf_coldpool');
+   add_default($nl, 'clubb_mf_ddalph');
+   add_default($nl, 'clubb_mf_ddbeta');
+   add_default($nl, 'clubb_mf_pwfac');
+   add_default($nl, 'clubb_mf_ddexp');
+   add_default($nl, 'do_clubb_mf_ustar');
+   add_default($nl, 'do_clubb_mf_mixd');
+   add_default($nl, 'clubb_mf_up_ndt');
+   add_default($nl, 'clubb_mf_cp_ndt');
+   add_default($nl, 'do_clubb_mf_rhtke');
+   add_default($nl, 'do_clubb_mf_cmt');
+   add_default($nl, 'clubb_mf_kseed');
+   add_default($nl, 'do_clubb_mf_lscale_perplume');
+   add_default($nl, 'do_clubb_mf_coldpool_perplume');
+   add_default($nl, 'do_clubb_mf_coldpool_init');
 }
 
 # Tuning for wet scavenging of modal aerosols
@@ -4513,7 +4538,6 @@ if ($docosp) {
     }
 }
 
-
 my $offline_drv = $cfg->get('offline_drv');
 if ($offline_drv ne 'stub') {
 

bld/namelist_files/namelist_defaults_cam.xml

@@ -2316,9 +2316,35 @@
 <!-- CLUBB+MF options -->
 <do_clubb_mf                       > .false. </do_clubb_mf>
 <do_clubb_mf_diag                  > .false. </do_clubb_mf_diag>
+<do_clubb_mf_precip                > .false. </do_clubb_mf_precip>
+<do_clubb_mf_rad                   > .false. </do_clubb_mf_rad>
+<do_clubb_mf_addtke                > .false. </do_clubb_mf_addtke>
 <clubb_mf_L0                       > 50.0    </clubb_mf_L0>
-<clubb_mf_ent0                     > 0.22    </clubb_mf_ent0>
+<clubb_mf_ent0                     > 0.2     </clubb_mf_ent0>
+<clubb_mf_alphturb                 > 0.0     </clubb_mf_alphturb>
+<clubb_mf_Lopt                     > 0       </clubb_mf_Lopt>
+<clubb_mf_a0                       > 2.0     </clubb_mf_a0>
+<clubb_mf_b0                       > 0.5     </clubb_mf_b0>
 <clubb_mf_nup                      > 10      </clubb_mf_nup>
+<clubb_mf_max_L0                   > 10.e3   </clubb_mf_max_L0>
+<clubb_mf_fdd                      > 0.0     </clubb_mf_fdd>
+<do_clubb_mf_coldpool              > .false.  </do_clubb_mf_coldpool>
+<clubb_mf_ddalph                   > 2.e2    </clubb_mf_ddalph>
+<clubb_mf_ddbeta                   > 1.0     </clubb_mf_ddbeta>
+<clubb_mf_pwfac                    > 1.0     </clubb_mf_pwfac>
+<clubb_mf_ddexp                    > 3.0     </clubb_mf_ddexp>
+<clubb_mf_cldfrac_fac              > 1.0     </clubb_mf_cldfrac_fac>
+<do_clubb_mf_ustar                 > .false. </do_clubb_mf_ustar>
+<do_clubb_mf_mixd                  > .false. </do_clubb_mf_mixd>
+<clubb_mf_up_ndt                   > 1       </clubb_mf_up_ndt>
+<clubb_mf_cp_ndt                   > 1       </clubb_mf_cp_ndt>
+<do_clubb_mf_rhtke                 > .false. </do_clubb_mf_rhtke>
+<do_clubb_mf_cmt                   > .false. </do_clubb_mf_cmt>
+<do_clubb_mf_lscale_perplume       > .false. </do_clubb_mf_lscale_perplume>
+<do_clubb_mf_coldpool_init         > .false. </do_clubb_mf_coldpool_init>
+<do_clubb_mf_coldpool_perplume     > .false. </do_clubb_mf_coldpool_perplume>
+<clubb_mf_kseed                    > 1       </clubb_mf_kseed>
+<do_clubb_mf_aloft                 > .false. </do_clubb_mf_aloft>
 
 <!-- Set radiation intervals based on mpas hgrids -->
 <iradlw hgrid="mpasa15"  > 10 </iradlw>
@@ -2426,6 +2452,9 @@
 <cld_macmic_num_steps microphys="mg2" clubb_sgs="1" dtime="225" > 1 </cld_macmic_num_steps>
 <cld_macmic_num_steps microphys="mg3" clubb_sgs="1" dtime="450" > 2 </cld_macmic_num_steps>
 <cld_macmic_num_steps microphys="mg3" clubb_sgs="1" dtime="225" > 1 </cld_macmic_num_steps>
+<!-- ARH - SCAM time-stepping -->
+<cld_macmic_num_steps microphys="mg2" clubb_sgs="1" scam="1"    > 6 </cld_macmic_num_steps>
+<cld_macmic_num_steps microphys="mg3" clubb_sgs="1" scam="1"    > 6 </cld_macmic_num_steps>
 
 <!-- Ice nucleation -->
 <nucleate_ice_subgrid                                  >1.0D0</nucleate_ice_subgrid>
@@ -2965,7 +2994,7 @@
   'T', 'bc_a1', 'bc_a4', 'dst_a1', 'dst_a2', 'dst_a3', 'ncl_a1', 'ncl_a2', 'ncl_a3',
   'num_a1', 'num_a2', 'num_a3', 'num_a4', 'pom_a1', 'pom_a4', 'so4_a1', 'so4_a2', 'so4_a3', 'soa_a1', 'soa_a2'
 </scm_relax_fincl>
-<scm_relax_fincl   phys="cam_dev"scam="1"  >
+<scm_relax_fincl   phys="cam7"   scam="1"  >
   'T', 'bc_a1', 'bc_a4', 'dst_a1', 'dst_a2', 'dst_a3', 'ncl_a1', 'ncl_a2', 'ncl_a3',
   'num_a1', 'num_a2', 'num_a3', 'num_a4', 'pom_a1', 'pom_a4', 'so4_a1', 'so4_a2', 'so4_a3', 'soa_a1', 'soa_a2'
 </scm_relax_fincl>
@@ -3349,8 +3378,8 @@
 <se_refined_mesh hgrid="ne0np4.ARCTICGRIS.ne30x8" > .true. </se_refined_mesh>
 <se_refined_mesh hgrid="ne0np4.MIDWEST.ne30x5" > .true. </se_refined_mesh>
 
-<se_nsplit se_dyn_target="cam"                                                >  2 </se_nsplit>
-<se_nsplit se_dyn_target="cam" hgrid="ne16np4"                                >  1 </se_nsplit>
+<se_nsplit                                                                    >  2 </se_nsplit>
+<se_nsplit hgrid="ne16np4"                                                    >  1 </se_nsplit>
 
 <se_nsplit hgrid="ne5np4"   waccm_phys="1"                                    >  3  </se_nsplit>
 <se_nsplit hgrid="ne16np4"  waccmx="1" model_top="none"                       >  3  </se_nsplit>
@@ -3380,7 +3409,6 @@
 <se_nsplit hgrid="ne0np4TESTONLY.ne5x4"> 7 </se_nsplit>
 <se_nsplit waccmx="1" hgrid="ne120np4" nlev="273" > 10 </se_nsplit>
 
-
 <se_rsplit                                          > 3 </se_rsplit>
 <se_rsplit waccm_phys="1" waccmx="0"                > 2 </se_rsplit>
 <se_rsplit model_top="ht"                           > 2 </se_rsplit>

bld/namelist_files/namelist_definition.xml

@@ -3160,7 +3160,7 @@ Default: .true. for CAM6; all others => .false.
 <entry id="cldfrc2m_do_avg_aist_algs" type="logical" category="conv"
        group="cldfrc2m_nl" valid_values="" >
 For small ice cloud concentrations, take the geometric mean of the iceopt=4 and iceopt=5 area fractions
-Default: .true. for CAM_DEV; all others .false.
+Default: .true. for CAM7; all others .false.
 </entry>
 
 <entry id="zmconv_momcu" type="real" category="conv"
@@ -4385,26 +4385,182 @@ If .true. add detailed budget terms to output by default.  Note that do_clubb_mf
 Default: .false.
 </entry>
 
+<entry id="do_clubb_mf_precip" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. turn on Suselj et al 2019 microphysics.
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_rad" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. couple MF plumes to radiation
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_addtke" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. add MF contribution to TKE pbuf variable
+Default: .false.
+</entry>
+
 <entry id="clubb_mf_L0" type="real" category="conv"
        group="clubb_mf_nl" valid_values="" >
 Entrainment length scale in meters for individual plumes. Not used if
 do_clubb_mf=FALSE.
 Default: 50.0
 </entry>
 
+<entry id="clubb_mf_Lopt" type="integer" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Integer: dynamic entrainment length scale option
+Default: 0
+</entry>
+
+<entry id="clubb_mf_a0" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: linear coefficient relating ztop/cape to entrainment length scale
+Default: 2.0
+</entry>
+
+<entry id="clubb_mf_b0" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: exponential coefficient relating ztop/cape to entrainment length scale
+Default: 0.5
+</entry>
+
 <entry id="clubb_mf_ent0" type="real" category="conv"
        group="clubb_mf_nl" valid_values="" >
 Entrainment efficiency for individual plumes. Not used if
 do_clubb_mf=FALSE.
 Default: 0.22
 </entry>
 
+<entry id="clubb_mf_alphturb" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Weighting factor for CLUBB TKE on plume entrainment
+Default: 0.0
+</entry>
+
 <entry id="clubb_mf_nup" type="integer" category="conv"
        group="clubb_mf_nl" valid_values="" >
 Real: number of plumes in mass flux ensemble
 Default: 10
 </entry>
 
+<entry id="clubb_mf_max_L0" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: limiter on entrainment length scale + threshold to disable TKE enhanced entrainmnet
+Default: 10.e3
+</entry>
+
+<entry id="clubb_mf_fdd" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Fraction of autoconversion partitioned to downdrafts (zero means no downdrafts)
+Default: 0.0
+</entry>
+
+<entry id="do_clubb_mf_coldpool" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. turn on cold pool feedback parameterizations
+Default: .false.
+</entry>
+
+<entry id="clubb_mf_ddalph" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Linear enhancement factor to the downdrafts used for the cold pool calculations
+Default: 200.0
+</entry>
+
+<entry id="clubb_mf_ddbeta" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Exponent enhancement factor to the downdrafts used for the cold pool calculations
+Default: 1.0
+</entry>
+
+<entry id="clubb_mf_pwfac" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Enhancement factor for the near surface pressure drag term in downdraft equation
+Default: 1.0
+</entry>
+
+<entry id="clubb_mf_ddexp" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Elevation power law exponent for downdrafts velocities in the subcloud layer
+Default: 3.0
+</entry>
+
+<entry id="clubb_mf_cldfrac_fac" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Factor to increase the ensemble MF plume cloud fractions
+Default: 1.0
+</entry>
+
+<entry id="do_clubb_mf_ustar" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. use ustar for initializing the plume ensemble
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_mixd" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. use clubbmf mixing depth in place of the PBLH pbuf var
+Default: .false.
+</entry>
+
+<entry id="clubb_mf_up_ndt" type="integer" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: number of time-steps for running average of the convective height scale
+Default: 1
+</entry>
+
+<entry id="clubb_mf_cp_ndt" type="integer" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: number of time-steps for running average of cold pool effects
+Default: 1
+</entry>
+
+<entry id="do_clubb_mf_rhtke" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. use relative humidity thresholds to turn off TKE enhanced entrainment
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_cmt" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. turn on convective momentum transport
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_lscale_perplume" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. set unique entrainment length scale for each plume member
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_coldpool_init" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. let cold pool feedback impact plume intialization
+Default: .false.
+</entry>
+
+<entry id="do_clubb_mf_coldpool_perplume" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. set cold pool feedback to unique to each plume member
+Default: .false.
+</entry>
+
+<entry id="clubb_mf_kseed" type="integer" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: level position of state used to seed the random number generator
+Default: 1
+</entry>
+
+<entry id="do_clubb_mf_aloft" type="logical" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+If .true. turn on elevated convective initialization
+Default: .false.
+</entry>
+
 <!-- CARMA Sectional Microphysics -->
 
 <entry id="carma_model" type="char*32" category="carma"

cime_config/testdefs/testmods_dirs/cam/outfrq9s_clubbmf/user_nl_cam

@@ -1,7 +1,39 @@
 mfilt=1,1,1,1,1,1
 ndens=1,1,1,1,1,1
 nhtfrq=9,9,9,9,9,9
+!nhtfrq=1,1,1,1,1,1
 inithist='ENDOFRUN'
-do_clubb_mf=.true.
-do_clubb_mf_diag=.true.
-deep_scheme='off'
+
+deep_scheme = 'off'
+use_gw_convect_dp = .false.
+use_gw_movmtn_pbl = .false.
+
+do_clubb_mf = .true.
+do_clubb_mf_diag = .true.
+do_clubb_mf_precip = .true.
+do_clubb_mf_rad = .true.
+do_clubb_mf_addtke = .true.
+clubb_mf_nup = 25
+
+clubb_mf_ent0 = 0.2
+clubb_mf_Lopt = 6
+clubb_mf_up_ndt = 1
+clubb_mf_a0 = 0.15D0
+clubb_mf_b0 = 1.0D0
+clubb_mf_alphturb = 3.0D0
+clubb_mf_max_L0 = 1000.00D0
+do_clubb_mf_rhtke = .true.
+
+clubb_mf_fdd = 0.5
+do_clubb_mf_coldpool = .true.
+clubb_mf_cp_ndt = 1
+clubb_mf_ddalph = 12.
+clubb_mf_ddbeta = 1.0
+clubb_mf_ddexp = 3.0
+
+do_clubb_mf_lscale_perplume = .true.
+do_clubb_mf_coldpool_perplume = .true.
+
+do_clubb_mf_aloft = .true.
+clubb_l_predict_upwp_vpwp = .false.
+clubb_l_do_expldiff_rtm_thlm = .false.