ESCOMP · cacraigucar · Dec 3, 2020 · Sep 16, 2020 · Sep 16, 2020 · Sep 17, 2020
diff --git a/bld/build-namelist b/bld/build-namelist
@@ -3050,6 +3050,11 @@ if ($clubb_sgs  =~ /$TRUE/io) {
    add_default($nl, 'clubb_l_vert_avg_closure');
    add_default($nl, 'clubb_l_diag_Lscale_from_tau');
    add_default($nl, 'clubb_l_damp_wp2_using_em');
+   add_default($nl, 'do_clubb_mf');
+   add_default($nl, 'clubb_mf_L0');
+   add_default($nl, 'clubb_mf_ent0');
+   add_default($nl, 'clubb_mf_wa');
+   add_default($nl, 'clubb_mf_wb');
 }
 
 # Tuning for wet scavenging of modal aerosols

diff --git a/bld/namelist_files/namelist_defaults_cam.xml b/bld/namelist_files/namelist_defaults_cam.xml
@@ -1850,6 +1850,13 @@
 <clubb_l_diag_Lscale_from_tau           silhs="1" > .false. </clubb_l_diag_Lscale_from_tau>
 <clubb_l_damp_wp2_using_em              silhs="1" > .true.  </clubb_l_damp_wp2_using_em>
 
+<!-- CLUBB+MF options -->
+<do_clubb_mf                       > .false. </do_clubb_mf>
+<clubb_mf_L0                       > 50.0    </clubb_mf_L0>
+<clubb_mf_ent0                     > 0.22    </clubb_mf_ent0>
+<clubb_mf_wa                       > 1.0     </clubb_mf_wa>
+<clubb_mf_wb                       > 1.5     </clubb_mf_wb>
+
 <!-- Microphysics scheme -->
 <micro_mg_do_hail                       > .false. </micro_mg_do_hail>
 <micro_mg_do_graupel                    > .false. </micro_mg_do_graupel>

diff --git a/bld/namelist_files/namelist_definition.xml b/bld/namelist_files/namelist_definition.xml
@@ -3618,6 +3618,37 @@ energy.
 Default: true
 </entry>
 
+<!-- for CLUBB+MF -->
+<entry id="do_clubb_mf" type="logical" category="conv"
+       group="clubb_params_nl" valid_values="" >
+If TRUE run CLUBB-MF
+Default: FALSE
+</entry>
+
+<entry id="clubb_mf_L0" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: Entrainment length scale
+Default: 50.0
+</entry>
+
+<entry id="clubb_mf_ent0" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: Entrainment factor
+Default: 0.22
+</entry>
+
+<entry id="clubb_mf_wa" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: vertical velocity factor a
+Default: 1.0
+</entry>
+
+<entry id="clubb_mf_wb" type="real" category="conv"
+       group="clubb_mf_nl" valid_values="" >
+Real: vertical velocity factor b
+Default: 1.5
+</entry>
+
 <!-- CARMA Sectional Microphysics -->
 
 <entry id="carma_model" type="char*32" category="carma"

diff --git a/cime_config/usermods_dirs/scam_SAS/user_nl_cam b/cime_config/usermods_dirs/scam_SAS/user_nl_cam
@@ -1,6 +1,4 @@
 use_gw_front            = .false.
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/SAS_ideal_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-06-01-00000.nc"
 mfilt=30

diff --git a/cime_config/usermods_dirs/scam_arm95/user_nl_cam b/cime_config/usermods_dirs/scam_arm95/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/ARM95_4scam.nc"
 mfilt=1500

diff --git a/cime_config/usermods_dirs/scam_arm97/user_nl_cam b/cime_config/usermods_dirs/scam_arm97/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/ARM97_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-06-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_atex/user_nl_cam b/cime_config/usermods_dirs/scam_atex/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/ATEX_48hr_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-02-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_bomex/user_nl_cam b/cime_config/usermods_dirs/scam_bomex/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/BOMEX_5day_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-06-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_cgilsS11/user_nl_cam b/cime_config/usermods_dirs/scam_cgilsS11/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/S11_CTL_MixedLayerInit_reduced.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_cgilsS12/user_nl_cam b/cime_config/usermods_dirs/scam_cgilsS12/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/S12_CTL_MixedLayerInit_reduced.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_cgilsS6/user_nl_cam b/cime_config/usermods_dirs/scam_cgilsS6/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/S6_CTL_reduced.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_dycomsRF01/user_nl_cam b/cime_config/usermods_dirs/scam_dycomsRF01/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/DYCOMSrf01_4day_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_dycomsRF02/user_nl_cam b/cime_config/usermods_dirs/scam_dycomsRF02/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/DYCOMSrf02_48hr_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_gateIII/user_nl_cam b/cime_config/usermods_dirs/scam_gateIII/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/GATEIII_4scam_c170809.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-08-01-00000.nc"
 mfilt=1440

diff --git a/cime_config/usermods_dirs/scam_mpace/user_nl_cam b/cime_config/usermods_dirs/scam_mpace/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/MPACE_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-10-01-00000.nc"
 mfilt=1242

diff --git a/cime_config/usermods_dirs/scam_rico/user_nl_cam b/cime_config/usermods_dirs/scam_rico/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/RICO_3day_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-07-01-00000.nc"
 mfilt=2088

diff --git a/cime_config/usermods_dirs/scam_sparticus/user_nl_cam b/cime_config/usermods_dirs/scam_sparticus/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/SPARTICUS_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-04-01-00000.nc"
 mfilt=2156

diff --git a/cime_config/usermods_dirs/scam_togaII/user_nl_cam b/cime_config/usermods_dirs/scam_togaII/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/TOGAII_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-12-01-00000.nc"
 mfilt=9

diff --git a/cime_config/usermods_dirs/scam_twp06/user_nl_cam b/cime_config/usermods_dirs/scam_twp06/user_nl_cam
@@ -1,5 +1,3 @@
-scmlon=$PTS_LON
-scmlat=$PTS_LAT
 iopfile="$DIN_LOC_ROOT/atm/cam/scam/iop/TWP06_4scam.nc"
 ncdata="$DIN_LOC_ROOT/atm/cam/scam/iop/CESM2.F2000climo.IOP_SITES.cam.i.0003-01-01-00000.nc"
 mfilt=1926

diff --git a/doc/ChangeLog b/doc/ChangeLog
@@ -1,5 +1,87 @@
 ===============================================================
 
+Tag name: cam6_3_001
+Originator(s): herrington, bacmeister, goldy, cacraig
+Date: 2020-09-17
+One-line Summary: Initial implementation of mass fluxes in CLUBB (CLUBB+MF) & scam bug-fix
+Github PR URL: NA
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+ - Implement CLUBB-MF functionality on trunk (#181)
+ - FSCAM is failing prealpha test (#213)
+ -   scmlat/scmlon nl's removed in prior tag, but still being set for scam cases
+
+Describe any changes made to build system: NA
+
+Describe any changes made to the namelist:
+ - created namelist group clubb_mf_nl and added namelists
+ - added a namelist entry to the clubb_params_nl group (turns mass fluxes on/off, defaults to off)
+ - removed scmlat/scmlon declarations in user_nl_cam for scam cases in cime_config/usermods_dirs/scam_xxx
+
+List any changes to the defaults for the boundary datasets: NA
+
+Describe any substantial timing or memory changes: NA
+
+Code reviewed by: cacraig, goldy
+
+List all files eliminated:
+
+List all files added and what they do:
+ - mass flux subroutine (edmf_module.F90) has been added to src/physics/cam/ 
+
+List all existing files that have been modified, and describe the changes:
+ - bld/build-namelists, bld/namelist_files/namelist_definitions.xml and bld/namelist_files/namelist_defaults.xml
+ - cime_config/usermods_dirs/scam_{xxx}/user_nl_cam, xxx = all scam cases
+ - src/control/runtime_opts.F90
+ - src/physics/cam/clubb_intr.F90
+
+If there were any failures reported from running test_driver.sh on any test
+platform, and checkin with these failures has been OK'd by the gatekeeper,
+then copy the lines from the td.*.status files for the failed tests to the
+appropriate machine below.  All failed tests must be justified.
+
+cheyenne/intel/aux_cam:
+
+izumi/nag/aux_cam:
+
+izumi/pgi/aux_cam:
+
+CAM tag used for the baseline comparison tests if different than previous
+tag:
+
+Summarize any changes to answers, i.e.,
+- what code configurations:
+- what platforms/compilers:
+- nature of change (roundoff; larger than roundoff but same climate; new
+  climate):
+ - since mass fluxes are off by default, there are bit-for-bit no changes.
+ - this has been tested by running the Bomex case for the current trunk and my branch
+
+ - unmodified branch, Bomex case (but with scmlat/scmlon declarations removed): 
+ - /glade/scratch/aherring/cam6_3_000_FSCAM_bomex_T42_T42_pe36_200917_nlev32-test/run/
+
+ - modified branch, Bomex case with mass fluxes off:
+ - /glade/scratch/aherring/cam6_3_000.clubbmf_FSCAM_bomex_T42_T42_pe36_200917_nlev32-test/run/
+
+ - where I've verified that the i/o is bit-for-bit identical in these runs.
+
+If bitwise differences were observed, how did you show they were no worse
+than roundoff?
+
+If this tag changes climate describe the run(s) done to evaluate the new
+climate in enough detail that it(they) could be reproduced, i.e.,
+- source tag (all code used must be in the repository):
+- platform/compilers:
+- configure commandline:
+- build-namelist command (or complete namelist):
+- MSS location of output:
+
+MSS location of control simulations used to validate new climate:
+
+URL for AMWG diagnostics output used to validate new climate:
+
+===============================================================
+
 Tag name: cam6_3_000
 Originator(s): goldy
 Date: 2020-09-01

diff --git a/src/control/runtime_opts.F90 b/src/control/runtime_opts.F90
@@ -65,6 +65,7 @@ subroutine read_namelist(nlfilename, single_column, scmlat, scmlon)
    use radiation_data,      only: rad_data_readnl
    use modal_aer_opt,       only: modal_aer_opt_readnl
    use clubb_intr,          only: clubb_readnl
+   use edmf_module,         only: clubb_mf_readnl
    use chemistry,           only: chem_readnl
    use prescribed_volcaero, only: prescribed_volcaero_readnl
    use prescribed_strataero,only: prescribed_strataero_readnl
@@ -139,6 +140,7 @@ subroutine read_namelist(nlfilename, single_column, scmlat, scmlon)
    call microp_driver_readnl(nlfilename)
    call microp_aero_readnl(nlfilename)
    call clubb_readnl(nlfilename)
+   call clubb_mf_readnl(nlfilename)
    call subcol_readnl(nlfilename)
    call cldfrc_readnl(nlfilename)
    call cldfrc2m_readnl(nlfilename)