Complete CCPPIzation of Hack shallow convection; dycore tests change to ne3pg3; FCAM4 test

.gitmodules

@@ -20,7 +20,7 @@
 [submodule "ncar-physics"]
         path          = src/physics/ncar_ccpp
 	url           = https://github.com/ESCOMP/atmospheric_physics
-	fxtag         = 37224423f62d9a71922cb6fe9beca1516d9403a4
+	fxtag         = atmos_phys0_10_001
         fxrequired    = AlwaysRequired
         fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 [submodule "ccs_config"]

cime_config/config_component.xml

@@ -122,8 +122,8 @@
     <default_value></default_value>
     <values match="last" modifier='additive'>
       <value compset="_CAM70">--physics-suites cam7</value>
-<!--      <value compset="_CAM40">-phys cam4</value>
-      <value compset="_CAM50">-phys cam5</value>
+      <value compset="_CAM40">--physics-suites cam4</value>
+<!--  <value compset="_CAM50">-phys cam5</value>
       <value compset="_CAM60">-phys cam6</value> -->
 
       <!-- Modifiers for CAM runs -->

cime_config/config_compsets.xml

@@ -109,6 +109,11 @@
     <lname>2000_CAM70_SLND_SICE_SOCN_SROF_SGLC_SWAV</lname>
   </compset>
 
+  <compset>
+    <alias>FCAM4</alias>
+    <lname>2000_CAM40_SLND_SICE_SOCN_SROF_SGLC_SWAV</lname>
+  </compset>
+
   <compset>
     <alias>F2010climo</alias>
     <lname>2010_CAM60_CLM50%SP_CICE%PRES_DOCN%DOM_MOSART_CISM2%NOEVOLVE_SWAV</lname>

cime_config/testdefs/testlist_cam.xml

@@ -52,6 +52,15 @@
       <option name="comment">Test for Zhang McFarlane physics</option>
     </options>
   </test>
+  <test compset="FPHYStest" grid="ne5_ne5_mg37" name="SMS_Ln2" testmods="cam/outfrq_hack_shallow_derecho">
+    <machines>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">Test for Hack shallow convection scheme</option>
+    </options>
+  </test>
 
   <!-- Derecho dycore tests -->
   <test compset="FKESSLER" grid="mpasa480_mpasa480" name="SMS_Ln9" testmods="cam/outfrq_kessler_mpas_derecho">
@@ -64,7 +73,7 @@
       <option name="comment">Test for MPAS dycore (with Kessler physics)</option>
     </options>
   </test>
-  <test compset="FKESSLER" grid="ne5pg3_ne5pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
+  <test compset="FKESSLER" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
     <machines>
       <machine name="derecho" compiler="intel" category="aux_sima"/>
       <machine name="derecho" compiler="gnu" category="aux_sima"/>
@@ -74,7 +83,7 @@
       <option name="comment">Test for SE-CSLAM dycore (with Kessler physics)</option>
     </options>
   </test>
-  <test compset="FHS94" grid="ne5pg3_ne5pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
+  <test compset="FHS94" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
     <machines>
       <machine name="derecho" compiler="intel" category="aux_sima"/>
       <machine name="derecho" compiler="gnu" category="aux_sima"/>
@@ -84,7 +93,7 @@
       <option name="comment">Test for SE-CSLAM dycore (with Held-Suarez physics)</option>
     </options>
   </test>
-  <test compset="FTJ16" grid="ne5pg3_ne5pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
+  <test compset="FTJ16" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam">
     <machines>
       <machine name="derecho" compiler="intel" category="aux_sima"/>
       <machine name="derecho" compiler="gnu" category="aux_sima"/>
@@ -96,7 +105,7 @@
   </test>
 
   <!-- CAM7 physics tests -->
-  <test compset="FCAM7" grid="ne5pg3_ne5pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam_analy_ic">
+  <test compset="FCAM7" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam_analy_ic">
     <machines>
       <machine name="derecho" compiler="intel" category="aux_sima"/>
       <machine name="derecho" compiler="gnu" category="aux_sima"/>
@@ -106,4 +115,16 @@
       <option name="comment">CAM7 test with SE-CSLAM dycore</option>
     </options>
   </test>
+
+  <!-- CAM4 physics tests -->
+  <test compset="FCAM4" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam_analy_ic">
+    <machines>
+      <machine name="derecho" compiler="intel" category="aux_sima"/>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">CAM4 test with SE-CSLAM dycore</option>
+    </options>
+  </test>
 </testlist>

cime_config/testdefs/testmods_dirs/cam/outfrq_hack_shallow_derecho/shell_commands

@@ -0,0 +1 @@
+ ./xmlchange CAM_CONFIG_OPTS="--dyn none --physics-suites convect_shallow_hack"

cime_config/testdefs/testmods_dirs/cam/outfrq_hack_shallow_derecho/user_nl_cam

@@ -0,0 +1,33 @@
+! these are QPC4 snapshots and require custom physical constant definitions.
+ncdata = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne5np4_hack_convect_shallow_snapshot_derecho_gnu_before_c20250220.nc'
+ncdata_check = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne5np4_hack_convect_shallow_snapshot_derecho_gnu_after_c20250220.nc'
+
+pver = 26
+user_defined_cpwv       = 1.846e3
+user_defined_gravit     = 9.79764
+user_defined_mwdry      = 28.96623324623746
+user_defined_mwh2o      = 18.01618112892741
+user_defined_rearth     = 6.37100e6
+user_defined_sday       = 86164.10063718943
+
+zmconv_c0_lnd          =  0.0035D0
+zmconv_c0_ocn          =  0.0035D0
+zmconv_capelmt         =  70.0
+zmconv_dmpdz           =  -1.0E-3
+zmconv_ke              =  5.0E-6
+zmconv_ke_lnd          =  3.0E-6
+zmconv_momcd           =  0.4000D0
+zmconv_momcu           =  0.4000D0
+zmconv_num_cin         =  5
+zmconv_parcel_pbl              = .false.
+zmconv_tau             =  3600.0
+zmconv_tiedke_add              =  0.5
+
+! snapshot is sourced from SE dycore
+hkconv_c0 = 1.0e-4
+
+! history fields for CAM4 Hack shallow convection
+hist_output_frequency;h1: 1*nsteps
+hist_max_frames;h1: 1
+hist_add_inst_fields;h1: CMFDT,CMFDQ,CMFDLIQ,CMFDICE,CMFDQR,DQP,ICWMRSH,CMFSL,CMFLQ,FREQSH,EVAPTCM,FZSNTCM,EVSNTCM,HKNTPRPD,HKNTSNPD,HKFLXPRC,HKFLXSNW,HKEIHEAT,EVAPQCM,PRECSH,CMFMCSH,CMFMC,CLDTOP,CLDBOT,PCLDTOP,PCLDBOT,ZMDLF,SHDLF
+hist_precision;h1: REAL64

src/data/ref_pres.F90

@@ -179,7 +179,7 @@ subroutine ref_pres_init(pref_edge_in, pref_mid_in, num_pr_lev_in)
       ! num_pr_lev
       call mark_as_initialized("number_of_pure_pressure_levels_at_top")
       ! trop_cloud_top_lev
-      call mark_as_initialized("index_of_pressure_at_troposhere_cloud_top")
+      call mark_as_initialized("vertical_layer_index_of_troposphere_cloud_physics_top")
       ! clim_modal_aero_top_lev
       call mark_as_initialized("index_of_air_pressure_at_top_of_aerosol_model")
       ! do_molec_press

src/data/ref_pres.meta

@@ -35,7 +35,7 @@
   dimensions = ()
   protected = True
 [ trop_cloud_top_lev ]
-  standard_name = vertical_layer_index_of_troposphere_cloud_top
+  standard_name = vertical_layer_index_of_troposphere_cloud_physics_top
   units = index
   type = integer
   dimensions = ()

src/data/registry.xml

@@ -137,6 +137,89 @@
       <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
       <ic_file_input_names>frontga pbuf_frontga</ic_file_input_names>
     </variable>
+    <!-- State quantities for shallow/deep convection -->
+    <variable local_name="qpert"
+              standard_name="convective_water_vapor_wrt_moist_air_and_condensed_water_perturbation_due_to_pbl_eddies"
+              units="kg kg-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>qpert pbuf_qpert</ic_file_input_names>
+    </variable>
+    <variable local_name="cmfmc"
+              standard_name="atmosphere_convective_mass_flux_due_to_all_convection"
+              units="kg m-2 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_interface_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>cmfmc tphysbc_cmfmc</ic_file_input_names>
+    </variable>
+    <variable local_name="cmfmc_dp"
+              standard_name="atmosphere_convective_mass_flux_due_to_deep_convection"
+              units="kg m-2 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_interface_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>cmfmc_dp pbuf_CMFMC_DP</ic_file_input_names>
+    </variable>
+    <variable local_name="cmfmc_sh"
+              standard_name="atmosphere_convective_mass_flux_due_to_shallow_convection"
+              units="kg m-2 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_interface_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>cmfmc_sh pbuf_CMFMC_SH</ic_file_input_names>
+    </variable>
+    <variable local_name="dlfzm"
+              standard_name="detrainment_of_cloud_liquid_water_wrt_moist_air_and_condensed_water_due_to_deep_convection"
+              units="kg kg-1 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>dlfzm pbuf_DLFZM</ic_file_input_names>
+    </variable>
+    <variable local_name="dlf"
+              standard_name="detrainment_of_cloud_liquid_water_wrt_moist_air_and_condensed_water_due_to_all_convection"
+              units="kg kg-1 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>dlf tphysbc_dlf</ic_file_input_names>
+    </variable>
+    <variable local_name="dlf2"
+              standard_name="detrainment_of_cloud_liquid_water_wrt_moist_air_and_condensed_water_due_to_shallow_convection"
+              units="kg kg-1 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>dlf2 tphysbc_dlf2</ic_file_input_names>
+    </variable>
+    <variable local_name="rprddp"
+              standard_name="tendency_of_precipitation_wrt_moist_air_and_condensed_water_due_to_deep_convection_excluding_subcloud_evaporation"
+              units="kg kg-1 s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>pbuf_RPRDDP</ic_file_input_names>
+    </variable>
+    <!-- note: rliq and rliq2 from CAM snapshot appear to be in m s-1 (precip) units.
+         the CCPP standard names table claim that it should be in kg m-2 s-1 units. -->
+    <variable local_name="rliq"
+              standard_name="vertically_integrated_cloud_liquid_water_tendency_due_to_all_convection_to_be_applied_later_in_time_loop"
+              units="m s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>rliq tphysbc_rliq</ic_file_input_names>
+    </variable>
+    <variable local_name="rliq2"
+              standard_name="vertically_integrated_cloud_liquid_water_tendency_due_to_shallow_convection_to_be_applied_later_in_time_loop"
+              units="m s-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>rliq2 tphysbc_rliq2</ic_file_input_names>
+    </variable>
     <!-- State helper values -->
     <variable local_name="lnpmid" standard_name="ln_air_pressure"
               units="1" type="real" kind="kind_phys"
@@ -498,24 +581,83 @@
               units="fraction" type="real" kind="kind_phys"
               allocatable="allocatable">
       <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
       <ic_file_input_names>landfrac cam_in_landfrac</ic_file_input_names>
     </variable>
+    <variable local_name="icefrac"
+              standard_name="sea_ice_area_fraction"
+              units="fraction" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>icefrac cam_in_icefrac</ic_file_input_names>
+    </variable>
+    <variable local_name="snowhland"
+              standard_name="lwe_surface_snow_depth_over_land"
+              units="m" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
+      <ic_file_input_names>snowhland cam_in_snowhland</ic_file_input_names>
+    </variable>
+    <variable local_name="sst"
+              standard_name="sea_surface_temperature"
+              units="K" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension</dimensions>
+      <!-- FIXME: this is a temporary initialization to allow CAM4/CAM7 suites to run standalone,
+           while SSTs are not being provided from another Earth system component. -->
+      <initial_value>273.15_kind_phys</initial_value>
+      <ic_file_input_names>sst cam_in_sst</ic_file_input_names>
+    </variable>
 
-    <!-- Zhang McFarlane (ZM) Variables -->
+    <!-- Temporary initializations from snapshot -->
+    <!-- Note that no_deep_pbl defaults to false, but needs to be set to true for diag_TKE or UW schemes -->
     <variable local_name="pblh"
               standard_name="atmosphere_boundary_layer_thickness"
               units="m" type="real" kind="kind_phys"
               allocatable="allocatable">
       <dimensions>horizontal_dimension</dimensions>
+      <!-- FIXME: this is a temporary initialization to allow CAM4/CAM7 suites to run standalone,
+           while a PBL scheme is unavailable. -->
+      <initial_value>0.0_kind_phys</initial_value>
       <ic_file_input_names>pblh pbuf_pblh</ic_file_input_names>
     </variable>
     <variable local_name="tpert"
               standard_name="convective_temperature_perturbation_due_to_pbl_eddies"
               units="K" type="real" kind="kind_phys"
               allocatable="allocatable">
       <dimensions>horizontal_dimension</dimensions>
+      <initial_value>0.0_kind_phys</initial_value>
       <ic_file_input_names>tpert pbuf_tpert</ic_file_input_names>
     </variable>
+
+    <!-- Cloud fraction variables - need to be kept in physics state -->
+    <variable local_name="top_lev_cloudphys"
+              standard_name="vertical_layer_index_of_cloud_fraction_top"
+              units="index" type="integer">
+      <long_name>vertical layer index for top of cloud area fraction schemes</long_name>
+      <initial_value>1</initial_value>
+    </variable>
+
+    <!-- Shallow convection variables - need to be kept in physics state -->
+    <variable local_name="convect_shallow_use_shfrc"
+              standard_name="flag_for_cloud_area_fraction_to_use_shallow_convection_calculated_cloud_area_fraction"
+              units="flag" type="logical">
+      <long_name>should cloud fraction use shallow convection calculated convective cloud area fraction</long_name>
+      <!-- only true for UW and UNICON shallow schemes. set by scheme init. -->
+      <initial_value>.false.</initial_value>
+    </variable>
+    <variable local_name="shfrc"
+              standard_name="shallow_convective_cloud_area_fraction"
+              units="fraction" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <!-- only used if use_shfrc is .true. -->
+      <initial_value>0.0_kind_phys</initial_value>
+    </variable>
+
+    <!-- Zhang McFarlane (ZM) Variables -->
     <variable local_name="ql"
               standard_name="in_cloud_water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water_due_to_deep_convection"
               units="kg kg-1" type="real" kind="kind_phys"