Have CLM_CO2_TYPE default set by COMPSET _BGC% setting

[ekluzek]

Currently the XML varialbles: CCSM_BGC, DATM_CO2_TSERIES, and CLM_CO2_TYPE all have to be coordinated in order for the model to funciton correctly. But, since they are manged independently it's easy for them to be inconsistent. And currently they are inconsistent...

See

ESCOMP/CMEPS#617

and the subissue:

ESCOMP/CMEPS#698

that proposes having components set the defaults by listening to the _BGC% setting in the compset _BGC% setting.

[ekluzek]

Currently CLM_CO2_TYPE looks like this:

    <values>
      <value compset="_CAM"        >diagnostic</value>
      <value compset="_BGC%BDRD"   >diagnostic</value>
      <value compset="_BGC%BPRP"   >prognostic</value>
      <value compset="HIST.*_DATM" >diagnostic</value>
      <value compset="1850.*_DATM%CPLHIST" >diagnostic</value>
      <value compset="SSP.*_DATM"  >diagnostic</value>
    </values>

instead of being set by compsets, it would change to being set by CCSM_BGC and look something like:

    <valuesi match="last">
      <value ccsm_bgc="none" >constant</value>
      <value ccsm_bgc="CO2A|CO2B|CO2C" >diagnostic</value>
      <value ccsm_bgc="CO2A|CO2B|CO2C" compset="_BGC%BP">prognostic</value>
    </values>

Which is robust and wouldn't change very often, nor change as the compsets are modified

And compsets would have changes like this:

diff --git a/cime_config/config_compsets.xml b/cime_config/config_compsets.xml
index a49f2a46b..74169d304 100644
--- a/cime_config/config_compsets.xml
+++ b/cime_config/config_compsets.xml
@@ -49,12 +49,12 @@
 
   <compset>
     <alias>IHist1PtClm60BgcRsGs</alias>
-    <lname>HIST_DATM%1PT_CLM60%BGC_SICE_SOCN_SROF_SGLC_SWAV</lname>
+    <lname>HIST_DATM%1PT_CLM60%BGC_SICE_SOCN_SROF_SGLC_SWAV_BGC%BDRD</lname>
   </compset>
 
     <compset>
     <alias>IHist1PtClm60FatesRsGs</alias>
-    <lname>HIST_DATM%1PT_CLM60%FATES_SICE_SOCN_SROF_SGLC_SWAV</lname>
+    <lname>HIST_DATM%1PT_CLM60%FATES_SICE_SOCN_SROF_SGLC_SWAV_BGC%BDRD</lname>
   </compset>
 
   <compset>
@@ -180,7 +180,7 @@
 
   <compset>
     <alias>I1850Clm60SpCrujra</alias>
-    <lname>1850_DATM%CRUJRA2024b_CLM60%SP_SICE_SOCN_MOSART_DGLC%NOEVOLVE_SWAV</lname>
+    <lname>1850_DATM%CRUJRA2024b_CLM60%SP_SICE_SOCN_MOSART_DGLC%NOEVOLVE_SWAV_BGC%BDRD</lname>
     <science_support grid="f09_t232"/>
     <science_support grid="f09_f09_mt232"/>
     <science_support grid="ne30pg3_t232"/>

This also makes the compsets more robust in that they specify the CCSM_BGC behavior and can then be used to distinquish if CO2 should be prognostic or diagnostic.

[ekluzek]

This isn't really "large", but marking it as that, because it requires coordination across CESM (MOM, CTSM, CAM, CMEPS, and DATM).

[wwieder]

This needs to be coordinated across components