Merge pull request #1265 from cacraigucar/cam_dme_adj

cam6_4_083: CCPP'ize dme_adjust

Author: cacraigucar

.gitmodules

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

bld/configure

@@ -2172,7 +2172,8 @@ 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/conservation_adjust/check_energy\n";
+    print $fh "$camsrcdir/src/atmos_phys/schemes/conservation_adjust/dme_adjust\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/hack_shallow\n";
     print $fh "$camsrcdir/src/atmos_phys/schemes/utilities\n";
 

doc/ChangeLog

@@ -1,3 +1,76 @@
+
+===============================================================
+
+Tag name: cam6_4_083
+Originator(s): cacraig
+Date: April 7, 2025
+One-line Summary: CCPP'ize dme_adjust
+Github PR URL: https://github.com/ESCOMP/pull/1265
+
+Purpose of changes (include the issue number and title text for each relevant GitHub issue):
+ - Conversion of physics_dme_adjust to CCPP: https://github.com/ESCOMP/issues/1090
+
+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: jimmielin
+
+List all files eliminated: N/A
+
+List all files added and what they do: N/A
+
+List all existing files that have been modified, and describe the changes:
+M       .gitmodules
+          - Update atmos_phys external to bring in dme_adjust code
+
+M       bld/configure
+          - Introduce conservation_adjust subdirectory and add dme_adjust directory in it
+
+M       src/atmos_phys
+          - update submodule
+
+M       src/physics/cam/physics_types.F90
+          - changes to support calling dme_adjust from CCPP'ized code
+
+M       src/physics/cam/physpkg.F90
+M       src/physics/cam7/physpkg.F90
+          - add snapshot logic for dme_adjust
+
+
+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: all BFB except:
+  ERP_Ln9.f09_f09_mg17.FCSD_HCO.derecho_intel.cam-outfrq9s (Overall: FAIL) details:
+  SMS_Ld1.f09_f09_mg17.FCHIST_GC.derecho_intel.cam-outfrq1d (Overall: DIFF) details:
+    - pre-existing failures due to HEMCO not having reproducible results (issues #1018 and #856)
+
+  SMS_Lh12.f09_f09_mg17.FCSD_HCO.derecho_intel.cam-outfrq3h (Overall: DIFF) details:
+    - pre-existing failures due to HEMCO not having reproducible results (issues #1018 and #856)
+    This test actually passed this time around, but intermittently does not pass, so keeping in the list
+
+  SMS_D_Ln9_P1280x1.ne0CONUSne30x8_ne0CONUSne30x8_mt12.FCHIST.derecho_intel.cam-outfrq9s (Overall: FAIL) details:
+    - pre-existing failures due to build-namelist error requiring CLM/CTSM external update
+
+derecho/nvhpc/aux_cam:
+  ERS_Ln9.ne30pg3_ne30pg3_mg17.F2000dev.derecho_nvhpc.cam-outfrq9s_gpu_default (Overall: FAIL) details:
+      FAIL ERS_Ln9.ne30pg3_ne30pg3_mg17.F2000dev.derecho_nvhpc.cam-outfrq9s_gpu_default RUN time=19
+         - This job fails, but does not appear to be due to changes in the code.  Both a run made using
+	   the head of cam_development and a job run using cam6_4_079 failed in the same way.
+	   No issue has been opened yet as we expect this might be a temporary machine problem
+
+izumi/nag/aux_cam: all BFB
+
+izumi/gnu/aux_cam: all BFB
+
+===============================================================
 ===============================================================
 
 Tag name: cam6_4_082

src/atmos_phys

@@ -1206,9 +1206,11 @@ end subroutine physics_cnst_limit
 
 !===============================================================================
   subroutine physics_dme_adjust(state, tend, qini, liqini, iceini, dt)
-    use air_composition, only: dry_air_species_num,thermodynamic_active_species_num
-    use air_composition, only: thermodynamic_active_species_idx
-    use dycore,          only: dycore_is
+    use air_composition,           only: dry_air_species_num,thermodynamic_active_species_num
+    use air_composition,           only: thermodynamic_active_species_idx
+    use dycore,                    only: dycore_is
+    use dme_adjust,                only: dme_adjust_run
+    use ccpp_constituent_prop_mod, only: ccpp_const_props
     !-----------------------------------------------------------------------
     !
     ! Purpose: Adjust the dry mass in each layer back to the value of physics input state
@@ -1259,6 +1261,12 @@ subroutine physics_dme_adjust(state, tend, qini, liqini, iceini, dt)
 
     real(r8),allocatable :: cpairv_loc(:,:)
     integer :: m_cnst
+
+    logical :: is_dycore_moist
+
+    character(len=512)   :: errmsg
+    integer              :: errflg
+
     !
     !-----------------------------------------------------------------------
 
@@ -1269,19 +1277,19 @@ subroutine physics_dme_adjust(state, tend, qini, liqini, iceini, dt)
     lchnk = state%lchnk
     ncol  = state%ncol
 
-    ! adjust dry mass in each layer back to input value, while conserving
-    ! constituents, momentum, and total energy
-    state%ps(:ncol) = state%pint(:ncol,1)
-
     !
     ! original code for backwards compatability with FV
     !
     if (.not.(dycore_is('MPAS') .or. dycore_is('SE'))) then
       do k = 1, pver
-        
+
+        ! adjust dry mass in each layer back to input value, while conserving
+        ! constituents, momentum, and total energy
+        state%ps(:ncol) = state%pint(:ncol,1)
+
         ! adjusment factor is just change in water vapor
         fdq(:ncol) = 1._r8 + state%q(:ncol,k,1) - qini(:ncol,k)
-        
+
         ! adjust constituents to conserve mass in each layer
         do m = 1, pcnst
           state%q(:ncol,k,m) = state%q(:ncol,k,m) / fdq(:ncol)
@@ -1294,26 +1302,14 @@ subroutine physics_dme_adjust(state, tend, qini, liqini, iceini, dt)
         state%rpdel (:ncol,k  ) = 1._r8/ state%pdel(:ncol,k  )
       end do
     else
-      do k = 1, pver
-        tot_water(:ncol,1) = qini(:ncol,k) +liqini(:ncol,k)+iceini(:ncol,k) !initial total H2O
-        tot_water(:ncol,2) = 0.0_r8
-        do m_cnst=dry_air_species_num+1,thermodynamic_active_species_num
-          m = thermodynamic_active_species_idx(m_cnst)
-          tot_water(:ncol,2) = tot_water(:ncol,2)+state%q(:ncol,k,m)
-        end do
-        fdq(:ncol) = 1._r8 + tot_water(:ncol,2) - tot_water(:ncol,1)
-        ! adjust constituents to conserve mass in each layer
-        do m = 1, pcnst
-          state%q(:ncol,k,m) = state%q(:ncol,k,m) / fdq(:ncol)
-        end do
-        ! compute new total pressure variables
-        state%pdel  (:ncol,k  ) = state%pdel(:ncol,k  ) * fdq(:ncol)
-        state%ps(:ncol)         = state%ps(:ncol)       + state%pdel(:ncol,k)
-        state%pint  (:ncol,k+1) = state%pint(:ncol,k  ) + state%pdel(:ncol,k)
-        state%lnpint(:ncol,k+1) = log(state%pint(:ncol,k+1))
-        state%rpdel (:ncol,k  ) = 1._r8/ state%pdel(:ncol,k  )
-        !note that mid-level variables (e.g. pmid) are not recomputed
-      end do
+      is_dycore_moist = .true.
+      call dme_adjust_run (state%ncol, pver, pcnst, state%ps(:ncol), state%pint(:ncol,:), state%pdel(:ncol,:), &
+                           state%lnpint(:ncol,:), state%rpdel(:ncol,:), &
+                           ccpp_const_props, state%q(:ncol,:,:), qini(:ncol,:), liqini(:ncol,:), iceini(:ncol,:), &
+                           is_dycore_moist, errmsg, errflg)
+      if (errflg /= 0) then
+         call endrun('physics_dme_adjust: '//errmsg)
+      end if
     endif
     if ( waccmx_is('ionosphere') .or. waccmx_is('neutral') ) then
       zvirv(:,:) = shr_const_rwv / rairv(:,:,state%lchnk) - 1._r8

src/physics/cam/physics_types.F90

@@ -1930,7 +1930,15 @@ subroutine tphysac (ztodt,   cam_in,  &
         tmp_trac(:ncol,:pver,:pcnst) = state%q(:ncol,:pver,:pcnst)
         tmp_pdel(:ncol,:pver)        = state%pdel(:ncol,:pver)
         tmp_ps(:ncol)                = state%ps(:ncol)
+        if (trim(cam_take_snapshot_before) == "physics_dme_adjust") then
+          call cam_snapshot_all_outfld_tphysac(cam_snapshot_before_num, state, tend, cam_in, cam_out, pbuf,&
+               fh2o, surfric, obklen, flx_heat)
+        end if
         call physics_dme_adjust(state, tend, qini, totliqini, toticeini, ztodt)
+        if (trim(cam_take_snapshot_after) == "physics_dme_adjust") then
+          call cam_snapshot_all_outfld_tphysac(cam_snapshot_after_num, state, tend, cam_in, cam_out, pbuf,&
+               fh2o, surfric, obklen, flx_heat)
+        end if
         call tot_energy_phys(state, 'phAM')
         call tot_energy_phys(state, 'dyAM', vc=vc_dycore)
         ! Restore pre-"physics_dme_adjust" tracers
@@ -1947,7 +1955,7 @@ subroutine tphysac (ztodt,   cam_in,  &
       call set_dry_to_wet(state, convert_cnst_type='dry')
 
       if (trim(cam_take_snapshot_before) == "physics_dme_adjust") then
-        call cam_snapshot_all_outfld_tphysac(cam_snapshot_after_num, state, tend, cam_in, cam_out, pbuf,&
+        call cam_snapshot_all_outfld_tphysac(cam_snapshot_before_num, state, tend, cam_in, cam_out, pbuf,&
                     fh2o, surfric, obklen, flx_heat)
       end if
       call physics_dme_adjust(state, tend, qini, totliqini, toticeini, ztodt)

src/physics/cam/physpkg.F90

@@ -2396,7 +2396,15 @@ subroutine tphysac (ztodt,   cam_in,  &
         tmp_trac(:ncol,:pver,:pcnst) = state%q(:ncol,:pver,:pcnst)
         tmp_pdel(:ncol,:pver)        = state%pdel(:ncol,:pver)
         tmp_ps(:ncol)                = state%ps(:ncol)
+        if (trim(cam_take_snapshot_before) == "physics_dme_adjust") then
+           call cam_snapshot_all_outfld_tphysac(cam_snapshot_before_num, state, tend, cam_in, cam_out, pbuf,&
+                      fh2o, surfric, obklen, flx_heat, cmfmc, dlf, det_s, det_ice, net_flx)
+        end if
         call physics_dme_adjust(state, tend, qini, totliqini, toticeini, ztodt)
+        if (trim(cam_take_snapshot_after) == "physics_dme_adjust") then
+          call cam_snapshot_all_outfld_tphysac(cam_snapshot_after_num, state, tend, cam_in, cam_out, pbuf,&
+               fh2o, surfric, obklen, flx_heat, cmfmc, dlf, det_s, det_ice, net_flx)
+        end if
         call tot_energy_phys(state, 'phAM')
         call tot_energy_phys(state, 'dyAM', vc=vc_dycore)
         ! Restore pre-"physics_dme_adjust" tracers