merge main

Author: boulderdaze

cime_config/testdefs/testlist_cam.xml

@@ -61,6 +61,16 @@
       <option name="comment">Test for Hack shallow convection scheme</option>
     </options>
   </test>
+  <test compset="FPHYStest" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln2" testmods="cam/outfrq_dme_adjust_derecho">
+    <machines>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">Test for dme_adjust scheme</option>
+    </options>
+  </test>
+
 
   <!-- Derecho dycore tests -->
   <test compset="FKESSLER" grid="mpasa480_mpasa480" name="SMS_Ln9" testmods="cam/outfrq_kessler_mpas_derecho">

cime_config/testdefs/testmods_dirs/cam/outfrq_dme_adjust_derecho/shell_commands

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

cime_config/testdefs/testmods_dirs/cam/outfrq_dme_adjust_derecho/user_nl_cam

@@ -0,0 +1,7 @@
+ncdata='/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_dme_adjust_snapshot_derecho_gnu_before_c20250416.nc'
+ncdata_check='/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_dme_adjust_snapshot_derecho_gnu_after_c20250416.nc'
+debug_output=0
+pver=32
+hist_add_inst_fields;h2: Q,PS
+hist_output_frequency;h2: nsteps
+hist_write_nstep0;h2: .true.

src/data/generate_registry_data.py

@@ -141,7 +141,7 @@ class VarBase:
     __pointer_type_str = "pointer"
 
     def __init__(self, elem_node, local_name, dimensions, known_types,
-                 type_default, units_default="", kind_default='',
+                 type_default, units_default="", kind_default='', dycore='',
                  protected=False, index_name='', local_index_name='',
                  local_index_name_str='', alloc_default='none',
                  tstep_init_default=False):
@@ -154,6 +154,7 @@ def __init__(self, elem_node, local_name, dimensions, known_types,
         self.__standard_name = elem_node.get('standard_name')
         self.__long_name = ''
         self.__initial_value = ''
+        self.__initial_value_match = 0
         self.__initial_val_vars = set()
         self.__ic_names = None
         self.__elements = []
@@ -183,7 +184,30 @@ def __init__(self, elem_node, local_name, dimensions, known_types,
             if attrib.tag == 'long_name':
                 self.__long_name = attrib.text
             elif attrib.tag == 'initial_value':
-                self.__initial_value = attrib.text
+                # Figure out if we should use this initial_value
+                #  If the number of matching attributes is greater than the
+                #  default or a previous match, pick this one
+                matches = 0
+                if not attrib.keys():
+                    self.__initial_value = attrib.text
+                # end if (no attributes, this is the default)
+                for att in attrib.keys():
+                    # Check each attribute (for now, this is only the dycore)
+                    if att == 'dyn':
+                        dycore_list = attrib.get('dyn').lower().split(',')
+                        if dycore in dycore_list:
+                            matches += 1
+                        # end if (dycore matches)
+                    # end if (check the dycore)
+                # end for
+                if matches == self.__initial_value_match and matches != 0:
+                    emsg = f"Unclear which initial_value to use for {local_name}. There are at least two configurations with {matches} matching attributes"
+                    raise CCPPError(emsg)
+                elif matches > self.__initial_value_match:
+                    # Use this initial_value (for now)
+                    self.__initial_value_match = matches
+                    self.__initial_value = attrib.text
+                # end if (number of matches)
             elif attrib.tag == 'ic_file_input_names':
                 #Separate out string into list:
                 self.__ic_names = [x.strip() for x in attrib.text.split(' ') if x]
@@ -488,16 +512,16 @@ class Variable(VarBase):
 ###############################################################################
     # pylint: disable=too-many-instance-attributes
     """Registry variable
-    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"><dimensions>ccpp_constant_one:horizontal_dimension:two</dimensions></variable>'), TypeRegistry(), VarDict("foo", "module", None), None) #doctest: +IGNORE_EXCEPTION_DETAIL
+    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"><dimensions>ccpp_constant_one:horizontal_dimension:two</dimensions></variable>'), TypeRegistry(), VarDict("foo", "module", None), 'se', None) #doctest: +IGNORE_EXCEPTION_DETAIL
     Traceback (most recent call last):
     CCPPError: Illegal dimension string, ccpp_constant_one:horizontal_dimension:two, in u, step not allowed.
-    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"><dims>horizontal_dimension</dims></variable>'), TypeRegistry(), VarDict("foo", "module", None), None) #doctest: +IGNORE_EXCEPTION_DETAIL
+    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"><dims>horizontal_dimension</dims></variable>'), TypeRegistry(), VarDict("foo", "module", None), 'se', None) #doctest: +IGNORE_EXCEPTION_DETAIL
     Traceback (most recent call last):
     CCPPError: Unknown Variable content, dims
-    >>> Variable(ET.fromstring('<variable kkind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"></variable>'), TypeRegistry(), VarDict("foo", "module", None), None) #doctest: +IGNORE_EXCEPTION_DETAIL
+    >>> Variable(ET.fromstring('<variable kkind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1"></variable>'), TypeRegistry(), VarDict("foo", "module", None), 'se', None) #doctest: +IGNORE_EXCEPTION_DETAIL
     Traceback (most recent call last):
     CCPPError: Bad variable attribute, 'kkind', for 'u'
-    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1" allocatable="target"><dimensions>horizontal_dimension vertical_dimension</dimensions></variable>'), TypeRegistry(), VarDict("foo", "module", None), None) #doctest: +IGNORE_EXCEPTION_DETAIL
+    >>> Variable(ET.fromstring('<variable kind="kind_phys" local_name="u" standard_name="east_wind" type="real" units="m s-1" allocatable="target"><dimensions>horizontal_dimension vertical_dimension</dimensions></variable>'), TypeRegistry(), VarDict("foo", "module", None), 'se', None) #doctest: +IGNORE_EXCEPTION_DETAIL
     Traceback (most recent call last):
     CCPPError: Dimension, 'vertical_dimension', not found for 'u'
     """
@@ -511,7 +535,7 @@ class Variable(VarBase):
                         "phys_timestep_init_zero", "standard_name",
                         "type", "units", "version"]
 
-    def __init__(self, var_node, known_types, vdict, logger):
+    def __init__(self, var_node, known_types, vdict, dycore, logger):
         # pylint: disable=too-many-locals
         """Initialize a Variable from registry XML"""
         local_name = var_node.get('local_name')
@@ -588,7 +612,7 @@ def __init__(self, var_node, known_types, vdict, logger):
         # Initialize the base class
         super().__init__(var_node, local_name,
                                        my_dimensions, known_types, ttype,
-                                       protected=protected)
+                                       dycore=dycore, protected=protected)
 
         for attrib in var_node:
             # Second pass, only process array elements
@@ -1090,7 +1114,7 @@ def __init__(self, ddt_node, known_types, var_dict, dycore):
                 varname = attrib.text
                 include_var = True
                 attrib_dycores = [x.strip().lower() for x in
-                                  attrib.get('dycore', default="").split(',')
+                                  attrib.get('dyn', default="").split(',')
                                   if x]
                 if attrib_dycores and (dycore not in attrib_dycores):
                     include_var = False
@@ -1226,6 +1250,7 @@ def __init__(self, file_node, known_types, dycore,
         self.__use_statements = []
         self.__generate_code = gen_code
         self.__file_path = file_path
+        self.__dycore = dycore
         for obj in file_node:
             if obj.tag in ['variable', 'array']:
                 self.add_variable(obj, logger)
@@ -1252,7 +1277,7 @@ def add_variable(self, var_node, logger):
         """Create a Variable from <var_node> and add to this File's
         variable dictionary"""
         newvar = Variable(var_node, self.__known_types, self.__var_dict,
-                          logger)
+                          self.__dycore, logger)
         self.__var_dict.add_variable(newvar)
 
     def add_ddt(self, newddt, logger=None):

src/data/ref_pres.F90

@@ -94,13 +94,11 @@ subroutine ref_pres_readnl(nlfile)
          end if
       end if
 
-      if (npes > 1) then
-         ! Broadcast namelist variables
-         call mpi_bcast(trop_cloud_top_press,      1,  mpi_real8, masterprocid, mpicom, ierr)
-         call mpi_bcast(clim_modal_aero_top_press, 1,  mpi_real8, masterprocid, mpicom, ierr)
-         call mpi_bcast(do_molec_press,            1,  mpi_real8, masterprocid, mpicom, ierr)
-         call mpi_bcast(molec_diff_bot_press,      1,  mpi_real8, masterprocid, mpicom, ierr)
-      endif
+      ! Broadcast namelist variables
+      call mpi_bcast(trop_cloud_top_press,      1,  mpi_real8, masterprocid, mpicom, ierr)
+      call mpi_bcast(clim_modal_aero_top_press, 1,  mpi_real8, masterprocid, mpicom, ierr)
+      call mpi_bcast(do_molec_press,            1,  mpi_real8, masterprocid, mpicom, ierr)
+      call mpi_bcast(molec_diff_bot_press,      1,  mpi_real8, masterprocid, mpicom, ierr)
 
    end subroutine ref_pres_readnl
 

src/data/registry.xml

@@ -349,7 +349,7 @@
               units="flag" type="logical">
       <long_name>flag indicating if dynamical core energy is not consistent with CAM physics and to perform adjustment of temperature and temperature tendency</long_name>
       <initial_value>.false.</initial_value>
-      <initial_value dycore="SE,MPAS">.true.</initial_value>
+      <initial_value dyn="SE,MPAS">.true.</initial_value>
     </variable>
     <!-- Timestep properties -->
     <variable local_name="is_first_timestep"
@@ -392,7 +392,7 @@
               standard_name="dycore_calculates_geopotential_using_logarithms"
               units="flag" type="logical" access="protected">
       <initial_value>.false.</initial_value>
-      <initial_value dycore="SE,FV">.true.</initial_value>
+      <initial_value dyn="SE,FV">.true.</initial_value>
     </variable>
     <ddt type="physics_state">
       <data>air_temperature</data>
@@ -697,5 +697,34 @@
       <dimensions>horizontal_dimension vertical_layer_dimension number_of_ccpp_constituents</dimensions>
       <initial_value>1</initial_value>
     </variable>
+
+    <!-- dme_adjust Variables -->
+    <variable local_name="qini"
+              standard_name="water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water_before_physics"
+              units="kg kg-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>QINI pbuf_QINI</ic_file_input_names>
+    </variable>
+    <variable local_name="liqini"
+              standard_name="total_liquid_water_mixing_ratio_wrt_moist_air_and_condensed_water_before_physics"
+              units="kg kg-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>TOTLIQINI pbuf_TOTLIQINI</ic_file_input_names>
+    </variable>
+    <variable local_name="iceini"
+              standard_name="total_ice_water_mixing_ratio_wrt_moist_air_and_condensed_water_before_physics"
+              units="kg kg-1" type="real" kind="kind_phys"
+              allocatable="allocatable">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>TOTICEINI pbuf_TOTICEINI</ic_file_input_names>
+    </variable>
+    <variable local_name="is_moist_dycore"
+              standard_name="is_moist_basis_dycore"
+              units="flag" type="logical" access="protected">
+      <initial_value>.true.</initial_value>
+      <initial_value dyn="SE,MPAS"> .false. </initial_value>
+    </variable>
   </file>
 </registry>

src/data/registry_v1_0.xsd

@@ -96,7 +96,7 @@
 
   <xs:attribute name="access"                  type="access_type"/>
   <xs:attribute name="allocatable"             type="allocation_type"/>
-  <xs:attribute name="dycore"                  type="dycore_type"/>
+  <xs:attribute name="dyn"                     type="dycore_type"/>
   <xs:attribute name="extends"                 type="fortran_id_type"/>
   <xs:attribute name="kind"                    type="fortran_id_type"/>
   <xs:attribute name="local_name"              type="fortran_id_type"/>
@@ -130,7 +130,10 @@
   <xs:complexType name="initial_value">
     <xs:simpleContent>
       <xs:extension base="xs:string">
-        <xs:attribute ref="dycore" use="optional" default=""/>
+	<!--- If adding a new attribute, also modify generate_registry_data.py
+		to check the attribute
+	-->
+        <xs:attribute ref="dyn" use="optional" default=""/>
       </xs:extension>
     </xs:simpleContent>
   </xs:complexType>
@@ -192,7 +195,7 @@
   <xs:complexType name="data_type">
     <xs:simpleContent>
       <xs:extension base="standard_name_type">
-        <xs:attribute ref="dycore" use="optional" default=""/>
+        <xs:attribute ref="dyn" use="optional" default=""/>
       </xs:extension>
     </xs:simpleContent>
   </xs:complexType>

src/dynamics/utils/vert_coord.F90

@@ -67,10 +67,8 @@ subroutine vert_coord_readnl(nlfile)
          end if
       end if
 
-      if (npes > 1) then
-         ! Broadcast namelist variables
-         call mpi_bcast(pver, 1, mpi_integer, masterprocid, mpicom, ierr)
-      endif
+      ! Broadcast namelist variables
+      call mpi_bcast(pver, 1, mpi_integer, masterprocid, mpicom, ierr)
 
    end subroutine vert_coord_readnl
 

src/physics/utils/physics_grid.F90

@@ -285,14 +285,12 @@ subroutine phys_grid_init(hdim1_d_in, hdim2_d_in, dycore_name_in, &
                           file=__FILE__, line=__LINE__)
 
          ! We need a global minimum longitude and latitude
-         if (npes > 1) then
-            temp = lonmin
-            call MPI_allreduce(temp, lonmin, 1, MPI_INTEGER, MPI_MIN,         &
-                 mpicom, ierr)
-            temp = latmin
-            call MPI_allreduce(temp, latmin, 1, MPI_INTEGER, MPI_MIN,         &
-                 mpicom, ierr)
-         end if
+         temp = lonmin
+         call MPI_allreduce(temp, lonmin, 1, MPI_INTEGER, MPI_MIN,         &
+              mpicom, ierr)
+         temp = latmin
+         call MPI_allreduce(temp, latmin, 1, MPI_INTEGER, MPI_MIN,         &
+              mpicom, ierr)
          ! Create lon coord map which only writes from one of each unique lon
          where(latvals == latmin)
             coord_map(:) = grid_map(3, :)

test/existing-test-failures.txt

@@ -1,4 +1 @@
-SMS_Ln9.ne5pg3_ne5pg3_mg37.FCAM7.derecho_intel.cam-outfrq_se_cslam_analy_ic (Overall: FAIL) details:
-SMS_Ln9.ne5pg3_ne5pg3_mg37.FCAM7.derecho_gnu.cam-outfrq_se_cslam_analy_ic (Overall: FAIL) details:
-- CAM7 suite will not work without a PBL scheme
-- CAM7 suite will not work with snapshot fields in registry.xml even if initial_value is defined (CAM-SIMA#359)
+All tests are currently passing