merge noresm cmeps1.1.57_noresm_v0

cime_config/buildnml

@@ -37,11 +37,14 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
     config["CPL_I2O_PER_CAT"] = case.get_value("CPL_I2O_PER_CAT")
     config["DRV_THREADING"] = case.get_value("DRV_THREADING")
     config["CPL_ALBAV"] = case.get_value("CPL_ALBAV")
+    config["CPL_EPBAL"] = case.get_value("CPL_EPBAL")
     config["BUDGETS"] = case.get_value("BUDGETS")
     config["MACH"] = case.get_value("MACH")
     config["MPILIB"] = case.get_value("MPILIB")
     config["OS"] = case.get_value("OS")
     config["TESTCASE"] = case.get_value("TESTCASE")
+    config["ocn_multilev"] = ".false."
+    config["set_histaux_l2x1yrg"] = ".false."
     if not config["TESTCASE"]:
         config["TESTCASE"] = "UNSET"
     config["glc_nec"] = (
@@ -53,9 +56,14 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
     for val in ("HIST", "REST", "STOP"):
         config[val.lower()+"_option"] = case.get_value(val+"_OPTION")
 
-
     config["comp_ocn"] = case.get_value("COMP_OCN")
 
+    config["set_histaux_l2x1yrg"] = (
+        ".true." if case.get_value("COMP_OCN") == 'blom' and case.get_value("COMP_LND") == 'clm' else ".false."
+    )
+    config["ocn_multilev"] = (
+        ".true." if case.get_value("COMP_OCN") == 'blom' or 'DOCN%MULTILEV' in case.get_value("COMPSET") else ".false."
+    )
 
     atm_grid = case.get_value("ATM_GRID")
     lnd_grid = case.get_value("LND_GRID")
@@ -122,11 +130,29 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
     elif case.get_value("RUN_TYPE") == "branch":
         config["run_type"] = "branch"
 
+        # For a branch run the driver must read the reference case's restart, so
+        # the driver restart pointer must be set explicitly to the dated
+        # rpointer.cpl of that reference case. buildnml does not modify xml
+        # variables, so rather than set DRV_RESTART_POINTER we check that it
+        # matches the expected dated pointer (built from RUN_REFDATE and
+        # RUN_REFTOD) and, if not, fail with the exact xmlchange command needed.
+        # (On a continue run CIME sets DRV_RESTART_POINTER automatically, and a
+        # hybrid run does not read the driver restart, so neither is checked.)
+        if not case.get_value("CONTINUE_RUN"):
+            expected_pointer = "rpointer.cpl.{}-{}".format(
+                case.get_value("RUN_REFDATE"), case.get_value("RUN_REFTOD")
+            )
+            expect(
+                case.get_value("DRV_RESTART_POINTER") == expected_pointer,
+                "For a branch run the driver restart pointer must be set to the "
+                "dated rpointer.cpl of the reference case. Set it with:\n"
+                "  ./xmlchange DRV_RESTART_POINTER={}".format(expected_pointer),
+            )
+
     # determine coupling mode
     config["coupling_mode"] = case.get_value("COUPLING_MODE")
 
     # determine wav_ice_coupling
-    config["wav_ice_coupling"] = "off"
     if config["coupling_mode"] == "cesm" or config["coupling_mode"] == "noresm":
         if config['COMP_WAV'] == 'ww3' and config['COMP_ICE'] == 'cice':
             config["wav_ice_coupling"] = "on"
@@ -143,6 +169,15 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
     # ----------------------------------------------------
     nmlgen.init_defaults(infile, config, skip_default_for_groups=["modelio"])
 
+    # ----------------------------------------------------
+    # Error checks
+    # ----------------------------------------------------
+    # double check if ocn2glc_coupling is set correctly
+    ocn2glc_coupling = nmlgen.get_value("ocn2glc_coupling")
+    if ocn2glc_coupling == ".true.":
+        expect(case.get_value("COMP_OCN") == 'blom' or 'DOCN%MULTILEV' in case.get_value("COMPSET"),
+               "ocn2glc_coupling is only allowed currently if the ocean component is BLOM or if DOCN%MULTILEV is in the compset")
+
     # --------------------------------
     # Overwrite: set brnch_retain_casename
     # --------------------------------
@@ -238,6 +273,24 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
     run_startdate = "".join(str(x) for x in case.get_value("RUN_STARTDATE").split("-"))
     nmlgen.set_value("start_ymd", value=run_startdate)
 
+    # --------------------------------
+    # Overwrite: budget_table_version if atm computes enthalpy
+    # --------------------------------
+    component_computes_enthalpy_flux = nmlgen.get_value("component_computes_enthalpy_flux")
+    if 'atm' in component_computes_enthalpy_flux:
+        nmlgen.set_value("budget_table_version", value="v2")
+        expect(
+            case.get_value("COMP_ATM") != "cam" and
+            case.get_value("COMP_OCN") == "mom6",
+            "Only CAM and BLOM are currently allowed if cam computes enthalpy fluxes"
+            )
+    elif component_computes_enthalpy_flux == "med":
+            expect(
+            case.get_value("COMP_ATM") != "cam" and
+            case.get_value("COMP_OCN") != "mom6",
+            "Only CAM and MOM6 are currently allowed if mediator computes enthalpy fluxes"
+            )
+
     # --------------------------------
     # Overwrite: set tprof_option and tprof_n - if tprof_total is > 0
     # --------------------------------
@@ -552,6 +605,65 @@ def _create_drv_namelists(case, infile, confdir, nmlgen, files):
         drv_flds_in = os.path.join(caseroot, "CaseDocs", "drv_flds_in")
         nmlgen.write_output_file(drv_flds_in)
 
+        # now read drv_flds_in and determine if lnd sends extra
+        # non-water tracers to runoff component
+        add_tracer_field = False
+        with open(drv_flds_in, "r", encoding="utf-8") as namelist_file:
+            for line in namelist_file.readlines():
+                if 'lnd2rof_tracers' in  line and 'lnd2rof_tracers_inparm' not in line:
+                    add_tracer_field = True
+
+        append_line = False
+        if add_tracer_field:
+            user_nl_cpl = os.path.join(caseroot, "user_nl_cpl")
+            append_line = True
+            with open(user_nl_cpl) as user_file:
+                for line in user_file.readlines():
+                    if 'Flrl_rofsur_nonh2o' in line:
+                        append_line = False
+        if append_line:
+            print("NOTE: Adding the following line to user_nl_cpl")
+            print(   "histaux_lnd2med_file2_flds = \'Flrl_rofsur:Flrl_rofi:Flrl_rofgwl:Flrl_rofsub:Flrl_rofsur_nonh2o\'\n")
+            with open(user_nl_cpl, 'a') as user_file:
+                user_file.write("histaux_lnd2med_file2_flds = \'Flrl_rofsur:Flrl_rofi:Flrl_rofgwl:Flrl_rofsub:Flrl_rofsur_nonh2o\'\n")
+
+###############################################################################
+def _add_water_tracers(water_tracers_xml, nmlgen):
+    ###############################################################################
+
+    if not water_tracers_xml.strip():
+        water_tracers = []
+    else:
+        water_tracers = water_tracers_xml.split(":")
+    tracer_names = []
+    tracer_species = []
+    tracer_initial_ratios = []
+
+    for tracer in water_tracers:
+        # Each item in the list consists of a name and then, optionally, a '%' followed by
+        # the isotope species for this tracer. For standard water tracers (i.e., tracers
+        # of bulk water), the list item will only contain the name (without a '%').
+        expect(
+            tracer.count("%") <= 1,
+            f"Invalid WATER_TRACERS element, '{tracer}': Each element of WATER_TRACERS must contain at most 1 '%' separator",
+        )
+        parts = tracer.split("%")
+        tracer_names.append(parts[0])
+        if len(parts) > 1:
+            tracer_species.append(parts[1])
+            # We could check the validity of the species name here (confirming that it's
+            # one of the handled species), but that would lead to this allowed list being
+            # replicated in multiple places (here as well as in the Fortran), which would
+            # make it more difficult to add new species later. So we're deferring this
+            # check to runtime.
+        else:
+            tracer_species.append("-")
+        tracer_initial_ratios.append("1.0")
+
+    nmlgen.add_default("water_tracer_names", ":".join(tracer_names))
+    nmlgen.add_default("water_tracer_species", ":".join(tracer_species))
+    nmlgen.add_default("water_tracer_initial_ratios", ":".join(tracer_initial_ratios))
+
 
 ###############################################################################
 def _add_water_tracers(water_tracers_xml, nmlgen):

cime_config/config_component.xml

@@ -38,7 +38,7 @@
   <entry id="COUPLING_MODE">
     <type>char</type>
     <valid_values>cesm,noresm</valid_values>
-    <default_value>cesm</default_value>
+    <default_value>noresm</default_value>
     <group>run_coupling</group>
     <file>env_run.xml</file>
     <desc>coupling mode</desc>
@@ -1412,10 +1412,7 @@
     <default_value>idmap</default_value>
     <group>run_domain</group>
     <file>env_run.xml</file>
-    <desc>lnd2rof flux (conservative) mapping file. (This mapping file is used for both consd and consf mappings; as discussed in
-    https://github.com/ESCOMP/CMEPS/issues/408, the results of these two mappings are the same within roundoff in CMEPS due to the
-    normalization that is done when applying the mapping weights. For simplicity, and because land mesh files generally don't have
-    a mask, this mapping file should be generated with '--norm_type dstarea'.)</desc>
+    <desc>lnd2rof flux mapping file</desc>
   </entry>
 
   <entry id="ROF2LND_FMAPNAME">

cime_config/config_component_cesm.xml

@@ -122,7 +122,7 @@
     <desc>Activates additional CO2-related fields to be exchanged between components. Possible values are:
 
     CO2A: sets the driver namelist variable flds_co2a = .true.; this adds
-    prognostic CO2 and diagnostic CO2 at the lowest model level to be sent from
+    diagnostic CO2 at the lowest model level to be sent from
     the atmosphere to the land and ocean.
 
     CO2B: sets the driver namelist variable flds_co2b = .true.; this adds
@@ -301,7 +301,14 @@
       <!-- N compsets -->
       <!-- =================================================== -->
       <value compset="_DATM.*_BLOM">24</value>
+      <value compset="_DATM.*_BLOM" grid="oi%tnx2">18</value>
       <value compset="_BLOM" grid="oi%tnx0.25v">48</value>
+      <!-- =================================================== -->
+      <!-- WW3Test compset -->
+      <!-- =================================================== -->
+      <value compset="_DATM.*_WW3" grid="w025">72</value>
+      <value compset="_DATM.*_WW3" grid="wtx0.66v1">72</value>
+      <!-- otherwise ww3 buildnml won't be happy. -->
     </values>
     <group>run_coupling</group>
     <file>env_run.xml</file>
@@ -342,6 +349,9 @@
     <values match="last">
       <value compset="_MOM6">24</value>
       <value compset="_BLOM">24</value>
+      <value compset="_BLOM" grid="oi%tnx2">18</value>
+      <!-- quick fix for coupled with 2 deg ocn-->
+      <value compset="_BLOM.*_MOSART" grid="oi%tnx2">24</value>
       <value compset="_DLND.*_CISM\d">1</value>
       <value compset="_NEMO">24</value>
     </values>