Merge latest escomp/main plus shr_flux_namelist branch into noresm branch

.github/workflows/srt.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ 3.8, 3.11, 3.x ]
+        python-version: [ "3.10", 3.12, 3.x ]
     env:
       CC: mpicc
       FC: mpifort

CODEOWNERS

@@ -0,0 +1 @@
+/cesm/flux_atmocn/ @megandevlan

cesm/flux_atmocn/flux_atmocn_COARE_mod.F90

@@ -24,6 +24,7 @@ module flux_atmocn_COARE_mod
   use shr_flux_mod,  only : loc_stebol, loc_latvap, loc_g, loc_cpdair
   use shr_flux_mod,  only : td0, maxscl, alpha, use_coldair_outbreak_mod
   use shr_const_mod, only : shr_const_rgas
+  use shr_wv_sat_mod, only: shr_wv_sat_qsat_liquid ! use saturation calculation consistent with CAM
 
   implicit none
   private
@@ -44,6 +45,7 @@ subroutine flux_atmOcn_COARE(                       &
        ts, mask, seq_flux_atmocn_minwind,             &
        sen, lat, lwup, evap,                          &
        taux ,tauy, tref, qref,                        &
+       aofluxes_use_shr_wv_sat,                       &
        duu10n, ugust_out, u10res,                     &
        ustar_sv, re_sv, ssq_sv)
 
@@ -52,6 +54,7 @@ subroutine flux_atmOcn_COARE(                       &
     real(R8) , intent(in) :: spval
     integer  , intent(in) :: nMax        ! data vector length
     integer  , intent(in) :: mask (nMax) ! ocn domain mask       0 <=> out of domain
+    logical  , intent(in) :: aofluxes_use_shr_wv_sat ! use shr_wv_sat_mod to calculate qsat for atm-ocn flux calculations
     real(R8) , intent(in) :: zbot (nMax) ! atm level height      (m)
     real(R8) , intent(in) :: ubot (nMax) ! atm u wind            (m/s)
     real(R8) , intent(in) :: vbot (nMax) ! atm v wind            (m/s)
@@ -106,6 +109,8 @@ subroutine flux_atmOcn_COARE(                       &
     real(R8)    :: hsb,hlb         ! sens & lat heat flxs at zbot
     real(R8)    :: tau             ! stress at zbot
     real(R8)    :: trf,qrf,urf,vrf ! reference-height quantities
+    real(r8)    :: esat_val        ! value of esat (saturation vapor pressure) at this point
+    real(r8)    :: qsat_val        ! value of qsat (saturation specific humidity) at this point
 
     !--- local functions --------------------------------
     real(R8)    :: qsat   ! function: the saturation humididty of air (kg/m^3)
@@ -146,7 +151,16 @@ subroutine flux_atmOcn_COARE(                       &
                 vmag=vmag*vscl
              endif
           endif
-          ssq = 0.98_R8 * qsat(ts(n)) / rbot(n)   ! sea surf hum (kg/kg)
+
+          if (aofluxes_use_shr_wv_sat) then
+             ! This version uses a qsat calculation method consistent with what's used in CAM
+             call shr_wv_sat_qsat_liquid(ts(n), pslv(n), esat_val, qsat_val)
+             ssq = 0.98_R8 * qsat_val   ! sea surf hum (kg/kg)
+          else
+             ! This version uses the qsat calculation method that was used for many years,
+             ! prior to Aug 2025, and which is still being used by default in NorESM
+             ssq = 0.98_R8 * qsat(ts(n)) / rbot(n)   ! sea surf hum (kg/kg)
+          end if
 
           call cor30a(ubot(n),vbot(n),tbot(n),qbot(n),rbot(n), & ! in atm params
                us(n),vs(n),ts(n),ssq,                          & ! in surf params

cesm/flux_atmocn/flux_atmocn_Diurnal_mod.F90

@@ -26,7 +26,6 @@ module flux_atmocn_diurnal_mod
    use shr_const_mod,         only : shr_const_ocn_ref_sal, shr_const_zsrflyr, shr_const_rgas
    use shr_sys_mod,           only : shr_sys_abort
    use flux_atmocn_COARE_mod, only : cor30a
-   use shr_wv_sat_mod,        only : shr_wv_sat_qsat_liquid ! use saturation calculation consistent with CAM
 
    implicit none
    private
@@ -236,7 +235,8 @@ subroutine flux_atmOcn_diurnal(                      &
     real(R8)    :: tdiff(nMax)               ! tbot - ts
     real(R8)    :: vscl
 
-    ! NOTE: this should use the shr_wv_sat_qsat_liquid if this routine is ever used in production
+    ! NOTE: this should use the shr_wv_sat_qsat_liquid if this routine is ever used in
+    ! production (see https://github.com/ESCOMP/CMEPS/issues/624)
     qsat(Tk)   = 640380.0_R8 / exp(5107.4_R8/Tk)
     cdn(Umps)  =   0.0027_R8 / Umps + 0.000142_R8 + 0.0000764_R8 * Umps
     psimhu(xd) = log((1.0_R8+xd*(2.0_R8+xd))*(1.0_R8+xd*xd)/8.0_R8) - 2.0_R8*atan(xd) + 1.571_R8
@@ -354,10 +354,9 @@ subroutine flux_atmOcn_diurnal(                      &
              speed(n)   = 0.0_R8
           endif
 
-          ! This should be changed to use the subroutine below
+          ! This should be changed to use shr_wv_sat_qsat_liquid (see
+          ! https://github.com/ESCOMP/CMEPS/issues/624)
           ssq = 0.98_R8 * qsat(tBulk(n)) / rbot(n)   ! sea surf hum (kg/kg)
-          ! call shr_wv_sat_qsat_liquid(tBulk(n), pslv(n), qsat, ssq)
-          ! ssq    = 0.98_R8 * ssq                   ! sea surf hum (kg/kg)
 
           delt   = thbot(n) - tBulk(n)               ! pot temp diff (K)
           delq   = qbot(n) - ssq                     ! spec hum dif (kg/kg)
@@ -503,10 +502,9 @@ subroutine flux_atmOcn_diurnal(                      &
 
              !--need to update ssq,delt,delq as function of tBulk ----
 
-             ! This should be changed to use the subroutine below
+             ! This should be changed to use shr_wv_sat_qsat_liquid (see
+             ! https://github.com/ESCOMP/CMEPS/issues/624)
              ssq = 0.98_R8 * qsat(tBulk(n)) / rbot(n)      ! sea surf hum (kg/kg)
-             ! call shr_wv_sat_qsat_liquid(tBulk(n), pslv(n), qsat, ssq)
-             ! ssq    = 0.98_R8 * ssq                      ! sea surf hum (kg/kg)
 
              delt   = thbot(n) - tBulk(n)                  ! pot temp diff (K)
              delq   = qbot(n) - ssq                        ! spec hum dif (kg/kg)

cesm/flux_atmocn/flux_atmocn_Large.F90

@@ -25,6 +25,7 @@ module flux_atmOcn_large_mod
   use shr_flux_mod,   only: flux_con_tol, flux_con_max_iter
   use shr_flux_mod,   only: alpha, maxscl, td0
   use shr_sys_mod,    only: shr_sys_abort
+  use shr_wv_sat_mod, only: shr_wv_sat_qsat_liquid ! use saturation calculation consistent with CAM
 
   implicit none
   public
@@ -41,7 +42,8 @@ subroutine flux_atmOcn_large(              &
        ts, mask,  seq_flux_atmocn_minwind,   &
        sen, lat, lwup, evap,                 &
        taux, tauy, tref, qref,               &
-       add_gusts, duu10n, ugust_out, u10res, &
+       add_gusts, aofluxes_use_shr_wv_sat,   &
+       duu10n, ugust_out, u10res, &
        ustar_sv, re_sv, ssq_sv)
 
     !--- input arguments --------------------------------
@@ -50,6 +52,7 @@ subroutine flux_atmOcn_large(              &
     integer  ,intent(in) :: nMax        ! data vector length
     integer  ,intent(in) :: mask (nMax) ! ocn domain mask       0 <=> out of domain
     logical  ,intent(in) :: add_gusts
+    logical  ,intent(in) :: aofluxes_use_shr_wv_sat ! use shr_wv_sat_mod to calculate qsat for atm-ocn flux calculations
     real(R8) ,intent(in) :: zbot (nMax) ! atm level height (m)
     real(R8) ,intent(in) :: ubot (nMax) ! atm u wind (m/s)
     real(R8) ,intent(in) :: vbot (nMax) ! atm v wind (m/s)
@@ -120,6 +123,8 @@ subroutine flux_atmOcn_large(              &
     real(R8) :: cp     ! specific heat of moist air
     real(R8) :: fac    ! vertical interpolation factor
     real(R8) :: wind0  ! resolved large-scale 10m wind (no gust added)
+    real(r8) :: esat_val ! value of esat (saturation vapor pressure) at this point
+    real(r8) :: qsat_val ! value of qsat (saturation specific humidity) at this point
 
     !--- local functions --------------------------------
     real(R8) :: qsat   ! function: the saturation humididty of air (kg/m^3)
@@ -209,7 +214,15 @@ subroutine flux_atmOcn_large(              &
              endif
           endif
 
-          ssq    = 0.98_R8 * qsat(ts(n)) / rbot(n)   ! sea surf hum (kg/kg)
+          if (aofluxes_use_shr_wv_sat) then
+             ! This version uses a qsat calculation method consistent with what's used in CAM
+             call shr_wv_sat_qsat_liquid(ts(n), pslv(n), esat_val, qsat_val)
+             ssq    = 0.98_R8 * qsat_val                ! sea surf hum (kg/kg)
+          else
+             ! This version uses the qsat calculation method that was used for many years,
+             ! prior to Aug 2025, and which is still being used by default in NorESM
+             ssq    = 0.98_R8 * qsat(ts(n)) / rbot(n)   ! sea surf hum (kg/kg)
+          end if
           delt   = thbot(n) - ts(n)                  ! pot temp diff (K)
           delq   = qbot(n) - ssq                     ! spec hum dif (kg/kg)
           alz    = log(zbot(n)/zref)

cesm/flux_atmocn/flux_atmocn_driver_mod.F90

@@ -25,14 +25,16 @@ subroutine flux_atmOcn_driver(logunit, nMax, &
        sen, lat, lwup, evap,                   &
        taux, tauy, tref, qref,                 &
        ocn_surface_flux_scheme,                &
-       add_gusts, duu10n, ugust_out, u10res,   &
+       add_gusts, aofluxes_use_shr_wv_sat,     &
+       duu10n, ugust_out, u10res,              &
        ustar_sv, re_sv, ssq_sv, missval)
 
     !--- input arguments --------------------------------
     integer  , intent(in) :: logunit
     integer  , intent(in) :: nMax        ! data vector length
     integer  , intent(in) :: mask (nMax) ! ocn domain mask       0 <=> out of domain
     logical  , intent(in) :: add_gusts
+    logical  , intent(in) :: aofluxes_use_shr_wv_sat ! use shr_wv_sat_mod to calculate qsat for atm-ocn flux calculations
     real(R8) , intent(in) :: zbot (nMax) ! atm level height (m)
     real(R8) , intent(in) :: ubot (nMax) ! atm u wind (m/s)
     real(R8) , intent(in) :: vbot (nMax) ! atm v wind (m/s)
@@ -94,7 +96,8 @@ subroutine flux_atmOcn_driver(logunit, nMax, &
             ts, mask,  seq_flux_atmocn_minwind,   &
             sen, lat, lwup,  evap,                &
             taux, tauy, tref, qref,               &
-            add_gusts, duu10n, ugust_out, u10res, &
+            add_gusts, aofluxes_use_shr_wv_sat,   &
+            duu10n, ugust_out, u10res, &
             ustar_sv=ustar_sv, re_sv=re_sv, ssq_sv=ssq_sv)
 
     else if (ocn_surface_flux_scheme == ocn_flux_scheme_coare) then
@@ -107,6 +110,7 @@ subroutine flux_atmOcn_driver(logunit, nMax, &
             ts, mask,  seq_flux_atmocn_minwind, &
             sen, lat, lwup, evap,               &
             taux, tauy, tref, qref,             &
+            aofluxes_use_shr_wv_sat,            &
             duu10n, ugust_out, u10res,          &
             ustar_sv=ustar_sv, re_sv=re_sv, ssq_sv=ssq_sv)
 

cesm/nuopc_cap_share/shr_lnd2rof_tracers_mod.F90

@@ -5,13 +5,12 @@ module shr_lnd2rof_tracers_mod
   ! lnd -> river communications
   !========================================================================
 
-  use ESMF         , only : ESMF_VMGetCurrent, ESMF_VM, ESMF_VMGet
+  use ESMF         , only : ESMF_VMGetCurrent, ESMF_VM, ESMF_VMGet, ESMF_VMBroadcast
   use ESMF         , only : ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU, ESMF_SUCCESS
   use shr_sys_mod  , only : shr_sys_abort
   use shr_log_mod  , only : shr_log_getLogUnit
   use shr_kind_mod , only : r8 => shr_kind_r8, cs => shr_kind_cs
   use shr_nl_mod   , only : shr_nl_find_group_name
-  use shr_mpi_mod  , only : shr_mpi_bcast
 
   implicit none
   private
@@ -34,7 +33,6 @@ subroutine shr_lnd2rof_tracers_readnl(NLFilename, lnd2rof_tracer_list)
 
     !----- local -----
     type(ESMF_VM)      :: vm
-    integer            :: i                      ! Indices
     integer            :: unitn                  ! namelist unit number
     integer            :: ierr                   ! error code
     logical            :: exists                 ! if file exists or not
@@ -84,8 +82,9 @@ subroutine shr_lnd2rof_tracers_readnl(NLFilename, lnd2rof_tracer_list)
           close( unitn )
        end if
     end if
-    call shr_mpi_bcast( lnd2rof_tracers, mpicom )
-
+    call ESMF_VMBroadcast(vm, lnd2rof_tracers, CS, 0, rc=rc)
+    if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return
+
     if (lnd2rof_tracers /= ' ') then
        lnd2rof_tracer_list = trim(lnd2rof_tracers)
     end if

cesm/share_wrappers/wtracers_mod.F90

@@ -0,0 +1,18 @@
+module wtracers_mod
+
+   !-----------------------------------------------------------------------------
+   ! This module wraps shr_wtracers_mod from the CESM_share repository to avoid direct
+   ! dependencies on this share code from CMEPS.
+   !
+   ! See also the version of wtracers_mod in the ufs directory for when we do not have
+   ! access to the CESM_share library.
+   !-----------------------------------------------------------------------------
+
+   use shr_wtracers_mod, only : wtracers_is_wtracer_field => shr_wtracers_is_wtracer_field
+
+   implicit none
+   private
+
+   public :: wtracers_is_wtracer_field  ! return true if the given field name is a water tracer field
+
+end module wtracers_mod

cime_config/buildexe

@@ -94,6 +94,7 @@ def _main_func():
         if not skip_mediator:
             out.write(os.path.join(cmeps_dir, "mediator") + "\n")
             out.write(os.path.join(cmeps_dir, "cesm", "flux_atmocn") + "\n")
+        out.write(os.path.join(cmeps_dir, "cesm", "share_wrappers") + "\n")
         out.write(os.path.join(cmeps_dir, "cesm", "driver") + "\n")
 
     # build model executable

cime_config/buildnml

@@ -726,7 +726,7 @@ def buildnml(case, caseroot, component):
                 major = line[-2] if "MAJOR" in line else major
                 minor = line[-2] if "MINOR" in line else minor
         logger.debug("ESMF version major {} minor {}".format(major, minor))
-        expect(int(major) >= 8 and int(minor) >=4, "ESMF version should be 8.4.1 or newer")
+        expect(int(major) >= 9 or (int(major) >= 8 and int(minor) >=4), "ESMF version should be 8.4.1 or newer")
 
     confdir = os.path.join(case.get_value("CASEBUILD"), "cplconf")
     if not os.path.isdir(confdir):

cime_config/config_component.xml

@@ -2310,15 +2310,6 @@
     <desc>determine if per ice thickness category fields are passed from ice to ocean - DO NOT EDIT (set by MOM6)</desc>
   </entry>
 
-  <entry id="INFO_DBUG">
-    <type>integer</type>
-    <valid_values>0,1,2,3,4,5,6,7,8,9</valid_values>
-    <default_value>1</default_value>
-    <group>run_flags</group>
-    <file>env_run.xml</file>
-    <desc>level of debug output, 0=minimum, 1=normal, 2=more, 3=too much</desc>
-  </entry>
-
   <!-- Prerun/postrun custom script options -->
 
   <entry id="PRERUN_SCRIPT">

cime_config/namelist_definition_drv.xml

@@ -900,15 +900,27 @@
     </values>
   </entry>
 
-  <entry id="info_debug" modify_via_xml="INFO_DBUG">
+  <entry id="dbug_flag">
     <type>integer</type>
     <category>expdef</category>
     <group>MED_attributes</group>
     <desc>
-      Level of debug output, 0=minimum, 1=normal, 2=more, 3=too much (default: 1)
+      Level of debug output; higher values give progressively more output
+
+      Some example values (other values are also accepted)
+      - 0: no extra debug output
+      - 1: a bit of debug output
+      - 2: a bit more debug output
+      - 6: a moderate amount of debug output
+      - 11: a lot of debug output
+      - 21: a huge amount of debug output
+
+      Note that setting this to moderate - high values can lead to overwhelming amounts of output.
+
+      (Default: 0)
     </desc>
     <values>
-      <value>$INFO_DBUG</value>
+      <value>0</value>
     </values>
   </entry>
 
@@ -961,15 +973,34 @@
     <group>MED_attributes</group>
     <desc>
       atm/ocn flux calculation scheme
-      0 : LARGE algorithm
-      1 : COARE algorithm
-      2 : UA algorithm
+
+      0: Large and Pond
+      1: COARE algorithm
+      2: UA algorithm
     </desc>
     <values>
       <value>0</value>
       <value COMP_OCN="blom" COMP_ATM="cam">1</value>
     </values>
   </entry>
+  <entry id="aofluxes_use_shr_wv_sat">
+    <type>logical</type>
+    <category>control</category>
+    <group>MED_attributes</group>
+    <desc>
+      If true, use shr_wv_sat_mod to calculate qsat for atm-ocn flux calculations.
+
+      If false, use the older inline calculation of qsat, which uses a different
+      formulation.
+
+      (Currently only relevant for ocn_surface_flux_scheme = 0 or 1.)
+    </desc>
+    <values>
+      <!-- Once CIME_MODEL distinguishes between NorESM and CESM, this value will differ
+      between these two. -->
+      <value>.false.</value>
+    </values>
+  </entry>
   <entry id="add_gusts">
     <type>logical</type>
     <category>control</category>

mediator/CMakeLists.txt

@@ -1,6 +1,7 @@
 project(cmeps Fortran)
 
 set(SRCFILES esmFldsExchange_cesm_mod.F90 med_fraction_mod.F90
+              med_field_info_mod.F90
               med_methods_mod.F90 med_phases_prep_ice_mod.F90
               med_phases_restart_mod.F90 esmFldsExchange_hafs_mod.F90
               med_internalstate_mod.F90 med_phases_aofluxes_mod.F90