cam6_4_207: merge new clubb_mf into cam6_4_203

.gitmodules

@@ -45,7 +45,7 @@
 	path = src/dynamics/fv3
 	url = https://github.com/ESCOMP/CAM_FV3_interface.git
         fxrequired = AlwaysRequired
-        fxtag = fv3int_061924
+        fxtag = fv3int_100726
 	fxDONOTUSEurl = https://github.com/ESCOMP/CAM_FV3_interface.git
 
 [submodule "geoschem"]

bld/build-namelist

@@ -3323,12 +3323,38 @@ if (($chem ne 'none') and ($chem ne 'terminator') and !($chem =~ /geoschem/)) {
     add_default($nl, 'chem_use_chemtrop');
 }
 
+# CLUBB_SGS
+my $do_clubb_sgs = $nl->get_value('do_clubb_sgs');
+if (defined $do_clubb_sgs) {
+    die "CAM Namelist ERROR: User may not specify the value of do_clubb_sgs.\n".
+        "This variable is set by build-namelist based on information\n".
+        "from the configure cache file.\n";
+}
+add_default($nl, 'do_clubb_sgs');
+my $clubb_sgs = $nl->get_value('do_clubb_sgs');
+
 # Deep convection scheme
 add_default($nl, 'deep_scheme');
+
 my $deep_scheme = $nl->get_value('deep_scheme');
+$deep_scheme =~ s/['"]//g;  # Strip quotes for exact XML attribute matching
+
+# CLUBB+MF dependency checks
+if ($deep_scheme =~ /CLUBB_MF/) {
+    if ($clubb_sgs !~ /$TRUE/io) {
+        die "CAM Namelist ERROR: deep_scheme='CLUBB_MF' but do_clubb_sgs is not active.\n" .
+            "CLUBB+MF requires the CLUBB_SGS package to be enabled.\n";
+    }
+    # CLUBB+MF is only valid cam7 physics
+    if ($phys !~ /cam7/) {
+        die "CAM Namelist ERROR: deep_scheme='CLUBB_MF' but the physics package is '$phys'.\n" .
+            "CLUBB+MF is only supported with cam7 physics (configure with -phys cam7).\n";
+    }
+}
 
 # Aerosol convective processes
-if (($phys =~ /cam6/ or $phys =~ /cam7/) and $deep_scheme =~ /ZM/) {
+if ((($phys =~ /cam6/ or $phys =~ /cam7/) and $deep_scheme =~ /ZM/)
+    or $deep_scheme =~ /CLUBB_MF/) {
     add_default($nl, 'convproc_do_aer', 'val'=>'.true.');
     add_default($nl, 'convproc_do_evaprain_atonce', 'val'=>'.true.');
     add_default($nl, 'convproc_pom_spechygro', 'val'=>'0.2D0');
@@ -3439,11 +3465,11 @@ if ($cfg->get('microphys') =~ /^mg/) {
 
 # Aerosol Namelist options
 add_default($nl, 'microp_aero_npccn_scale');
-add_default($nl, 'microp_aero_wsub_scale');
-add_default($nl, 'microp_aero_wsubi_scale');
 add_default($nl, 'microp_aero_wsub_min');
 add_default($nl, 'microp_aero_wsub_min_asf');
 add_default($nl, 'microp_aero_wsubi_min');
+add_default($nl, 'microp_aero_wsub_scale');
+add_default($nl, 'microp_aero_wsubi_scale');
 
 # Ice nucleation options
 if (!$simple_phys) {
@@ -3534,13 +3560,6 @@ if ($use_subcol_microp =~ /$TRUE/io) {
 }
 
 # CLUBB_SGS
-my $do_clubb_sgs = $nl->get_value('do_clubb_sgs');
-if (defined $do_clubb_sgs) {
-    die "CAM Namelist ERROR: User may not specify the value of do_clubb_sgs.\n".
-        "This variable is set by build-namelist based on information\n".
-        "from the configure cache file.\n";
-}
-add_default($nl, 'do_clubb_sgs');
 my $clubb_sgs = $nl->get_value('do_clubb_sgs');
 if ($clubb_sgs  =~ /$TRUE/io) {
    my $clubb_do_adv = $cfg->get('clubb_do_adv');
@@ -3657,7 +3676,6 @@ if ($clubb_sgs  =~ /$TRUE/io) {
    add_default($nl, 'clubb_l_call_pdf_closure_twice');
    add_default($nl, 'clubb_l_damp_wp2_using_em');
    add_default($nl, 'clubb_l_damp_wp3_Skw_squared');
-   add_default($nl, 'clubb_l_do_expldiff_rtm_thlm');
    add_default($nl, 'clubb_l_e3sm_config');
    add_default($nl, 'clubb_l_enable_relaxed_clipping');
    add_default($nl, 'clubb_l_godunov_upwind_wpxp_ta');
@@ -3673,7 +3691,6 @@ if ($clubb_sgs  =~ /$TRUE/io) {
    add_default($nl, 'clubb_l_mono_flux_lim_um');
    add_default($nl, 'clubb_l_mono_flux_lim_vm');
    add_default($nl, 'clubb_l_partial_upwind_wp3');
-   add_default($nl, 'clubb_l_predict_upwp_vpwp');
    add_default($nl, 'clubb_l_ho_nontrad_coriolis');
    add_default($nl, 'clubb_l_ho_trad_coriolis');
    add_default($nl, 'clubb_l_rcm_supersat_adj');
@@ -3705,15 +3722,50 @@ if ($clubb_sgs  =~ /$TRUE/io) {
    add_default($nl, 'clubb_wpxp_Ri_exp');
    add_default($nl, 'clubb_z_displace');
 
-   #CLUBB+MF options
-   add_default($nl, 'do_clubb_mf');
-   add_default($nl, 'do_clubb_mf_diag');
-   add_default($nl, 'clubb_mf_L0');
-   add_default($nl, 'clubb_mf_ent0');
-   add_default($nl, 'clubb_mf_nup');
+   add_default($nl, 'clubb_l_predict_upwp_vpwp', 'deep_scheme'=>$deep_scheme);
+   add_default($nl, 'clubb_l_do_expldiff_rtm_thlm', 'deep_scheme'=>$deep_scheme);
 
    #Turn on HB scheme where CLUBB not active
    add_default($nl, 'do_hb_above_clubb');
+
+   # CLUBB-MF options
+   if ($deep_scheme =~ /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');
+       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, 'clubb_mf_pwmin');
+       add_default($nl, 'clubb_mf_pwmax');
+       add_default($nl, 'clubb_mf_cldfrac_fac');
+       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');
+       add_default($nl, 'do_clubb_mf_aloft');
+       add_default($nl, 'do_clubb_mf_aspd');
+       add_default($nl, 'do_clubb_mf_pblcull');
+       add_default($nl, 'do_clubb_mf_invswitch');
+   }
 }
 
 # Tuning for wet scavenging of modal aerosols
@@ -4022,7 +4074,8 @@ if ($waccm_phys or
     add_default($nl, 'use_gw_front'     , 'val'=>'.false.');
 }
 # Check if deep convection scheme used.  If not set use_gw_convect_dp=.false.
-if ($deep_scheme =~ /off/) {
+# CLUBB_MF does not (yet) provide TTEND_DP, so treat it like 'off' here
+if ($deep_scheme =~ /off/ or $deep_scheme =~ /CLUBB_MF/) {
     $use_gw_convect_dp = '.false.';
 }
 add_default($nl, 'use_gw_convect_dp', 'val'=>$use_gw_convect_dp);

bld/namelist_files/namelist_defaults_cam.xml

@@ -2255,9 +2255,10 @@
 <clubb_l_damp_wp3_Skw_squared                     > .false. </clubb_l_damp_wp3_Skw_squared>
 <clubb_l_diagnose_correlations                    > .false. </clubb_l_diagnose_correlations>
 <clubb_l_diffuse_rtm_and_thlm                     > .false. </clubb_l_diffuse_rtm_and_thlm>
-<clubb_l_do_expldiff_rtm_thlm                        > .false. </clubb_l_do_expldiff_rtm_thlm>
-<clubb_l_do_expldiff_rtm_thlm clubb_sgs="1"          > .true.  </clubb_l_do_expldiff_rtm_thlm>
-<clubb_l_do_expldiff_rtm_thlm clubb_sgs="1" silhs="1"> .false.  </clubb_l_do_expldiff_rtm_thlm>
+<clubb_l_do_expldiff_rtm_thlm                                       > .false. </clubb_l_do_expldiff_rtm_thlm>
+<clubb_l_do_expldiff_rtm_thlm clubb_sgs="1"                         > .true.  </clubb_l_do_expldiff_rtm_thlm>
+<clubb_l_do_expldiff_rtm_thlm clubb_sgs="1" silhs="1"               > .false.  </clubb_l_do_expldiff_rtm_thlm>
+<clubb_l_do_expldiff_rtm_thlm clubb_sgs="1" deep_scheme="CLUBB_MF"  > .false.  </clubb_l_do_expldiff_rtm_thlm>
 <clubb_l_e3sm_config                              > .false. </clubb_l_e3sm_config>
 <clubb_l_enable_relaxed_clipping                  > .false. </clubb_l_enable_relaxed_clipping>
 <clubb_l_fix_w_chi_eta_correlations               > .true.  </clubb_l_fix_w_chi_eta_correlations>
@@ -2277,6 +2278,7 @@
 <clubb_l_partial_upwind_wp3                       > .false. </clubb_l_partial_upwind_wp3>
 <clubb_l_predict_upwp_vpwp                        > .false. </clubb_l_predict_upwp_vpwp>
 <clubb_l_predict_upwp_vpwp phys="cam7"            > .true.  </clubb_l_predict_upwp_vpwp>
+<clubb_l_predict_upwp_vpwp phys="cam7" deep_scheme="CLUBB_MF" > .false. </clubb_l_predict_upwp_vpwp>
 <clubb_l_ho_nontrad_coriolis                      > .false. </clubb_l_ho_nontrad_coriolis>
 <clubb_l_ho_trad_coriolis                         > .false. </clubb_l_ho_trad_coriolis>
 <clubb_l_prescribed_avg_deltaz                    > .false. </clubb_l_prescribed_avg_deltaz>
@@ -2368,11 +2370,41 @@
 
 
 <!-- CLUBB+MF options -->
-<do_clubb_mf                       > .false. </do_clubb_mf>
 <do_clubb_mf_diag                  > .false. </do_clubb_mf_diag>
-<clubb_mf_L0                       > 50.0    </clubb_mf_L0>
-<clubb_mf_ent0                     > 0.22    </clubb_mf_ent0>
-<clubb_mf_nup                      > 10      </clubb_mf_nup>
+<do_clubb_mf_precip                > .true.  </do_clubb_mf_precip>
+<do_clubb_mf_rad                   > .true.  </do_clubb_mf_rad>
+<do_clubb_mf_addtke                > .false. </do_clubb_mf_addtke>
+<clubb_mf_L0                       > 200.0   </clubb_mf_L0>
+<clubb_mf_ent0                     > 0.2     </clubb_mf_ent0>
+<clubb_mf_alphturb                 > 3.0     </clubb_mf_alphturb>
+<clubb_mf_Lopt                     > 6       </clubb_mf_Lopt>
+<clubb_mf_a0                       > 0.15    </clubb_mf_a0>
+<clubb_mf_b0                       > 1.0     </clubb_mf_b0>
+<clubb_mf_nup                      > 25      </clubb_mf_nup>
+<clubb_mf_max_L0                   > 1.e3    </clubb_mf_max_L0>
+<clubb_mf_fdd                      > 0.5     </clubb_mf_fdd>
+<do_clubb_mf_coldpool              > .true.  </do_clubb_mf_coldpool>
+<clubb_mf_ddalph                   > 12.0    </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_pwmin                    > 1.5     </clubb_mf_pwmin>
+<clubb_mf_pwmax                    > 3.0     </clubb_mf_pwmax>
+<clubb_mf_cldfrac_fac	           > 10.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       > .true.  </do_clubb_mf_lscale_perplume>
+<do_clubb_mf_coldpool_init         > .false. </do_clubb_mf_coldpool_init>
+<do_clubb_mf_coldpool_perplume     > .true.  </do_clubb_mf_coldpool_perplume>
+<clubb_mf_kseed                    > 1       </clubb_mf_kseed>
+<do_clubb_mf_aloft                 > .true.  </do_clubb_mf_aloft>
+<do_clubb_mf_aspd                  > .false. </do_clubb_mf_aspd>
+<do_clubb_mf_pblcull               > .false. </do_clubb_mf_pblcull>
+<do_clubb_mf_invswitch             > .true.  </do_clubb_mf_invswitch>
 
 <!-- Set radiation intervals based on mpas hgrids -->
 <iradlw hgrid="mpasa15"  > 10 </iradlw>