Merge pull request ESCOMP#1180 from jimmielin/hplin/check_energy

cam6_4_050:  Implement CCPPized check_energy_chng and check_energy_fix

.gitmodules

@@ -36,7 +36,7 @@
 [submodule "atmos_phys"]
 	path = src/atmos_phys
 	url = https://github.com/ESCOMP/atmospheric_physics
-        fxtag = atmos_phys0_06_000
+        fxtag = atmos_phys0_07_001
         fxrequired = AlwaysRequired
 	fxDONOTUSEurl = https://github.com/ESCOMP/atmospheric_physics
 

bld/configure

@@ -2341,6 +2341,7 @@ sub write_filepath
     print $fh "$camsrcdir/src/atmos_phys/schemes/tropopause_find\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/zhang_mcfarlane\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/dry_adiabatic_adjust\n";
+    print $fh "$camsrcdir/src/atmos_phys/schemes/check_energy\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/utilities\n";
 
     # Dynamics package and test utilities

doc/ChangeLog

@@ -1,3 +1,79 @@
+===============================================================
+Tag name: cam6_4_050
+Originator(s): jimmielin
+Date: 31 Dec 2024
+One-line Summary: Implement CCPPized check_energy_chng and check_energy_fix
+Github PR URL: https://github.com/ESCOMP/CAM/pull/1180
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+- CCPPize check_energy_chng and check_energy_fix (https://github.com/ESCOMP/CAM/issues/1138)
+  CAM interfaces have been kept in check_energy.F90 instead of a new module because check_tracers is not yet CCPPized, there are other non-CCPPized routines in module, and for compatibility with FV3 external calls
+- Save air_composition cp_or_cv_dycore into state snapshot
+- Separate out "energy_formula_physics"/"energy_formula_dycore" definitions used in get_hydrostatic_energy from dyn_tests_utils "vcoord" for an eventual change in SIMA.
+
+Describe any changes made to build system: N/A
+
+Describe any changes made to the namelist: N/A
+
+List any changes to the defaults for the boundary datasets: N/A
+
+Describe any substantial timing or memory changes: N/A
+
+Code reviewed by: nusbaume, cacraigucar
+
+List all files eliminated: N/A
+
+List all files added and what they do:
+- separate out energy formula definitions used in get_hydrostatic_energy from dyn_tests_utils "vcoord"
+A       src/utils/cam_thermo_formula.F90
+
+List all existing files that have been modified, and describe the changes:
+
+Update atmos_phys external with CCPPized check_energy
+M       .gitmodules
+M       bld/configure
+M       src/atmos_phys
+
+Save cp_or_cv_dycore in state snapshot
+M       src/control/cam_snapshot_common.F90
+
+New CAM interfaces to CCPPized routines, when available
+M       src/physics/cam/check_energy.F90
+
+Update calls to CCPPized routines, when available
+M       src/physics/cam/physpkg.F90
+M       src/physics/cam/zm_conv_intr.F90
+M       src/physics/cam7/physpkg.F90
+M       src/physics/simple/physpkg.F90
+M       src/physics/spcam/crm_physics.F90
+M       src/physics/spcam/spcam_drivers.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.
+
+derecho/intel/aux_cam:
+
+SMS_D_Ln9.f19_f19_mg17.FXHIST.derecho_intel.cam-outfrq9s_amie (Overall: FAIL)
+SMS_D_Ln9_P1280x1.ne0CONUSne30x8_ne0CONUSne30x8_mt12.FCHIST.derecho_intel.cam-outfrq9s (Overall: FAIL)
+ - pre-existing failures due to build-namelist error requiring CLM/CTSM external update.
+
+ERP_Ln9.f09_f09_mg17.FCSD_HCO.derecho_intel.cam-outfrq9s (Overall: FAIL)
+SMS_Ld1.f09_f09_mg17.FCHIST_GC.derecho_intel.cam-outfrq1d (Overall: PASS)
+ - pre-existing failure due to HEMCO not having reproducible results issues #1018 and #856
+
+derecho/nvhpc/aux_cam: All PASS
+
+izumi/nag/aux_cam:
+
+DAE.f45_f45_mg37.FHS94.izumi_nag.cam-dae (Overall: FAIL)
+ - pre-existing failure -- issue #670
+
+izumi/gnu/aux_cam: All PASS
+
+Summarize any changes to answers: B4B
+
 ===============================================================
 
 Tag name: cam6_4_049

src/control/cam_snapshot_common.F90

@@ -81,7 +81,7 @@ module cam_snapshot_common
 integer :: cam_snapshot_before_num, cam_snapshot_after_num
 
 ! Note the maximum number of variables for each type
-type (snapshot_type)    ::  state_snapshot(29)
+type (snapshot_type)    ::  state_snapshot(30)
 type (snapshot_type)    ::  cnst_snapshot(pcnst)
 type (snapshot_type)    ::  tend_snapshot(6)
 type (snapshot_type)    ::  cam_in_snapshot(30)
@@ -283,6 +283,9 @@ subroutine cam_state_snapshot_init(cam_snapshot_before_num_in, cam_snapshot_afte
    call snapshot_addfld( nstate_var, state_snapshot,  cam_snapshot_before_num, cam_snapshot_after_num, &
      'state%te_cur_dyn',  'state_te_cur_dyn',   'unset',            horiz_only)
 
+   call snapshot_addfld( nstate_var, state_snapshot,  cam_snapshot_before_num, cam_snapshot_after_num, &
+     'air_composition_cp_or_cv_dycore',  'cp_or_cv_dycore',   'J kg-1 K-1',  'lev')
+
 end subroutine cam_state_snapshot_init
 
 subroutine cam_cnst_snapshot_init(cam_snapshot_before_num, cam_snapshot_after_num)
@@ -741,6 +744,7 @@ end subroutine snapshot_addfld
 subroutine state_snapshot_all_outfld(lchnk, file_num, state)
 
    use physics_types,    only: phys_te_idx, dyn_te_idx
+   use air_composition,  only: cp_or_cv_dycore
 
    integer,              intent(in)  :: lchnk
    integer,              intent(in)  :: file_num
@@ -843,6 +847,11 @@ subroutine state_snapshot_all_outfld(lchnk, file_num, state)
       case ('state%te_cur_dyn')
          call outfld(state_snapshot(i)%standard_name, state%te_cur(:, dyn_te_idx), pcols, lchnk)
 
+      case ('air_composition_cp_or_cv_dycore')
+         ! this field is not part of physics state (it is in air_composition)
+         ! but describes the atmospheric thermodynamic state and thus saved within the snapshot
+         call outfld(state_snapshot(i)%standard_name, cp_or_cv_dycore(:,:,lchnk), pcols, lchnk)
+
       case default
          call endrun('ERROR in state_snapshot_all_outfld: no match found for '//trim(state_snapshot(i)%ddt_string))