cam6_3_046: PUMAS Updates

.gitignore

@@ -8,6 +8,7 @@ src/physics/clubb
 src/physics/cosp2/src
 src/physics/silhs
 src/physics/pumas
+src/physics/pumas-frozen
 src/dynamics/fv3/atmos_cubed_sphere
 libraries/FMS
 libraries/mct

Externals_CAM.cfg

@@ -37,7 +37,14 @@ required = True
 local_path = src/physics/pumas
 protocol = git
 repo_url = https://github.com/ESCOMP/PUMAS
-tag = pumas_cam-release_v1.17
+tag = pumas_cam-release_v1.22
+required = True
+
+[pumas-frozen]
+local_path = src/physics/pumas-frozen
+protocol = git
+repo_url = https://github.com/ESCOMP/PUMAS
+tag = pumas_cam-release_v1.17_rename
 required = True
 
 [atmos_phys]

bld/build-namelist

@@ -2960,6 +2960,13 @@ if ($cfg->get('microphys') =~ /^mg/) {
 
     # For CESM2, the decision was made to set micro_do_sb_physics to false
     add_default($nl, 'micro_do_sb_physics', 'val'=>'.false.');
+
+    # namelist options for pumas tag release_v1.22 or later
+    #   (currently only in the cam_dev physics package)
+    if ($phys =~ /cam_dev/) {
+	add_default($nl, 'micro_mg_accre_sees_auto');
+	add_default($nl, 'micro_mg_implicit_fall');
+    }
 }
 
 # Aerosol Namelist options

bld/configure

@@ -2172,7 +2172,11 @@ sub write_filepath
        print $fh "$camsrcdir/src/physics/silhs\n";
     }
 
-    print $fh "$camsrcdir/src/physics/pumas\n";
+    if ($phys_pkg eq 'cam_dev') {
+	print $fh "$camsrcdir/src/physics/pumas\n";
+    } else {
+	print $fh "$camsrcdir/src/physics/pumas-frozen\n";
+    }
 
     # Superparameterization
     if ($phys_pkg eq 'spcam_m2005' or $phys_pkg eq 'spcam_sam1mom') {

bld/namelist_files/namelist_defaults_cam.xml

@@ -2028,6 +2028,8 @@
 <micro_mg_max_nicons                  >  1.D8    </micro_mg_max_nicons>
 <micro_mg_max_nicons  microphys="mg2"  > 1.D8    </micro_mg_max_nicons>
 
+<micro_mg_implicit_fall   phys="cam_dev" > .true. </micro_mg_implicit_fall>
+<micro_mg_accre_sees_auto phys="cam_dev" > .true. </micro_mg_accre_sees_auto>
 
 <cld_macmic_num_steps>                                            1 </cld_macmic_num_steps>
 <cld_macmic_num_steps microphys="mg2" clubb_sgs="1"             > 3 </cld_macmic_num_steps>

bld/namelist_files/namelist_definition.xml

@@ -2738,6 +2738,19 @@ If .true., ensure non-zero precipitation fallspeed (rain,snow and graupel) if pr
 Default: .false.
 </entry>
 
+<entry id="micro_mg_implicit_fall" type="logical" category="microphys"
+       group="micro_mg_nl" valid_values="" >
+If .true., use implicit fall speed (sedimentation) routine for all hydrometeors. Improves numerical stability of precipitation
+Default: .true.
+</entry>
+
+<entry id="micro_mg_accre_sees_auto" type="logical" category="microphys"
+       group="micro_mg_nl" valid_values="" >
+If true, then the autoconverted liquid is added to rain and removed from cloud before accretion is estimated.
+Default: .true.
+</entry>
+
+
 <!-- Aerosol microphysics -->
 <entry id="microp_aero_bulk_scale" type="real" category="microphys"
        group="microp_aero_nl" valid_values="" >

doc/ChangeLog

@@ -1,5 +1,110 @@
 ===============================================================
 
+Tag name: cam6_3_046
+Originator(s): katec, andrewgettelman
+Date: 26 Jan 2022
+One-line Summary: PUMAS v1 release to cam_dev
+Github PR URL:https://github.com/ESCOMP/CAM/pull/409
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+
+Fixes issue #408 (PUMAS/MG Science updates and bug fixes), and ESCOMP/PUMAS issues #20 and #28
+1. Fixes issue Possible removal of ice number limiter....doesn't work with new ice nucleation.
+2. adds in vapor deposition onto snow as a process
+3. Fall speed correction for rain/snow/graupel
+4. Option for implicit fall speed
+5. Option for the accretion to see newly autoconverted rain (liquid only)
+-- As part of this update to PUMAS we have renamed many micro_mg files and subroutines to
+	micro_pumas instead. This occured for the previous pumas code and this new update.
+
+Describe any changes made to build system:
+
+The previous code is now in a subdirectory called "pumas-frozen" and the newly released
+	pumas_v1 code is in the "pumas" directory, but only available with the cam_dev
+	configure option.
+
+Describe any changes made to the namelist:
+
+Two new namelist options: micro_mg_accre_sees_auto and micro_mg_implicit_fall. Both are
+	set to "true" as default but only available (applicable) in cam_dev pumas
+	configurations.
+
+List any changes to the defaults for the boundary datasets:
+
+None
+
+Describe any substantial timing or memory changes:
+
+None
+
+Code reviewed by: JulioTBacmeister, nusbaume, gold2718, fvitt, cacraigucar, pverwhee
+
+List all files eliminated:
+- micro_mg_cam.F90 renamed to micro_pumas_cam.F90
+
+List all files added and what they do:
+- micro_pumas_cam.F90 added to src/physics/cam_dev/
+
+List all existing files that have been modified, and describe the changes:
+M	.gitignore
+- Added a line for moving the preview PUMAS to a new directory in src/physics/pumas-frozen
+
+M	Externals_CAM.cfg
+- Update PUMAS externals tag to pumas_cam-release_v1.22, add
+	new external directory for previous PUMAS code in src/physics/pumas-frozen,
+	update tag for previous code to branch tag pumas_cam-release_v1.17_rename
+
+M	bld/build-namelist
+- add_default calls for new namelist options (only available to cam_dev physics)
+
+M	bld/configure
+- Build filepath for pumas depends on cam_dev configure option.
+	src/physics/pumas build with cam_dev, otherwise src/physics/pumas-frozen
+	is used in the build.
+
+M	bld/namelist_files/namelist_defaults_cam.xml
+- New namelist options default to true in cam_dev physics (not applicable otherwise)
+
+M	bld/namelist_files/namelist_definition.xml
+- Define two new namelist options micro_mg_implicit_fall and micro_mg_accre_sees_auto
+
+M	src/physics/cam/macrop_driver.F90
+- Rename micro_mg to micro_pumas
+
+M	src/physics/cam/micro_pumas_cam.F90
+- Rename micro_mg to micro_pumas, including micro_mg_tend3_0 -> micro_pumas_tend
+
+M 	src/physics/cam/microp_driver.F90
+- Rename micro_mg to micro_pumas
+
+M	src/physics/cam/nucleate_ice.F90
+- Remove preexisting_ice
+
+M	src/physics/cam/nucleate_ice_cam.F90
+- Change number conentrations to number concentration tendencies in history files
+
+M	src/physics/cam/physpkg.F90
+- Rename micro_mg to micro_pumas
+
+M	src/physics/cam/zm_microphysics.F90
+- Rename micro_mg to micro_pumas
+
+M	src/physics/cam_dev/physpkg.F90
+- Rename micro_mg to micro_pumas
+
+M	src/physics/spcam/crm_physics.F90
+- Rename micro_mg to micro_pumas
+
+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:
+
+
+===============================================================
+
 Tag name: cam6_3_045
 Originator(s): fvitt, billsacks
 Date: 19 Jan 2022

src/physics/cam/macrop_driver.F90

@@ -1131,7 +1131,7 @@ end subroutine macrop_driver_tend
 subroutine liquid_macro_tend(npccn,t,p,qv,qc,nc,xxlv,deltat,stend,qvtend,qctend,nctend,vlen)
 
   use wv_sat_methods, only: wv_sat_qsat_ice_vect, wv_sat_qsat_water_vect
-  use micro_mg_utils, only: rhow
+  use micro_pumas_utils, only: rhow
   use physconst,      only: rair
   use cldfrc2m,       only: rhmini_const, rhmaxi_const