branch with 5.3.05Y: Make sure FORTRAN code properly aborts when fire-emission is asked for and it can't be provided

bld/CLMBuildNamelist.pm

@@ -4071,7 +4071,16 @@ sub setup_logic_fire_emis {
         if ( &value_is_true( $nl_flags->{'use_fates'} ) ) {
           $log->warning("Fire emission option $var can NOT be on when FATES is also on.\n" .
                       "  DON'T use the '--fire_emis' option when '--bgc fates' is activated");
-       }
+        } elsif ( ! &value_is_true( $nl_flags->{'use_cn'} ) ) {
+          $log->fatal_error("Fire emission option $var can NOT be on when BGC SP (i.e. Satellite Phenology) is also on.\n" .
+                           "  DON'T use the '--fire_emis' option when '--bgc sp' is activated");
+        } elsif ( &value_is_true( $nl_flags->{'use_cn'}) ) {
+          my $fire_method = remove_leading_and_trailing_quotes( $nl->get_value('fire_method') );
+          if ( $fire_method eq "nofire" ) {
+             $log->fatal_error("Fire emission option $var can NOT be on with BGC and fire_method=='nofire'.\n" .
+                              "  DON'T use the '--fire_emis' option when fire_method is nofire");
+          }
+        }
      }
    }
 }
@@ -4235,7 +4244,7 @@ sub setup_logic_lai_streams {
   if ( &value_is_true($nl_flags->{'use_crop'}) && &value_is_true($nl->get_value('use_lai_streams'))  ) {
     $log->fatal_error("turning use_lai_streams on is incompatable with use_crop set to true.");
   }
-  if ( $nl_flags->{'bgc_mode'} eq "sp" || ($nl_flags->{'bgc_mode'} eq "fates" && &value_is_true($nl->get_value('use_fates_sp')) )) {
+  if ( $nl_flags->{'bgc_mode'} eq "sp" || ($nl_flags->{'bgc_mode'} eq "fates" && &value_is_true($nl_flags->{'use_fates_sp'}) )) {
      if ( &value_is_true($nl->get_value('use_lai_streams')) ) {
        add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, 'use_lai_streams');
        add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl, 'lai_mapalgo',
@@ -4745,29 +4754,26 @@ sub setup_logic_fates {
         # For FATES SP mode make sure no-competetiion, and fixed-biogeography are also set
         # And also check for other settings that can't be trigged on as well
         #
-        my $var = "use_fates_sp";
-        if ( defined($nl->get_value($var))  ) {
-           if ( &value_is_true($nl->get_value($var)) ) {
-              my @list = ( "use_fates_nocomp", "use_fates_fixed_biogeog" );
-              foreach my $var ( @list ) {
-                 if ( ! &value_is_true($nl->get_value($var)) ) {
-                    $log->fatal_error("$var is required when FATES SP is on (use_fates_sp)" );
-                 }
-              }
-              # spit-fire can't be on with FATES SP mode is active
-              if ( $nl->get_value('fates_spitfire_mode') > 0 ) {
-                    $log->fatal_error('fates_spitfire_mode can NOT be set to greater than 0 when use_fates_sp is true');
-              }
+        if ( &value_is_true($nl_flags->{'use_fates_sp'}) ) {
+           my @list = ( "use_fates_nocomp", "use_fates_fixed_biogeog" );
+           foreach my $var ( @list ) {
+                if ( ! &value_is_true($nl->get_value($var)) ) {
+                   $log->fatal_error("$var is required when FATES SP is on (use_fates_sp)" );
+                }
+           }
+           # spit-fire can't be on with FATES SP mode is active
+           if ( $nl->get_value('fates_spitfire_mode') > 0 ) {
+                 $log->fatal_error('fates_spitfire_mode can NOT be set to greater than 0 when use_fates_sp is true');
+           }
 
-              # fates landuse can't be on with FATES SP mode is active
-              if ( &value_is_true($nl->get_value('use_fates_luh')) ) {
-                   $log->fatal_error('use_fates_luh can NOT be true when use_fates_sp is true');
-              }
+           # fates landuse can't be on with FATES SP mode is active
+           if ( &value_is_true($nl->get_value('use_fates_luh')) ) {
+                $log->fatal_error('use_fates_luh can NOT be true when use_fates_sp is true');
+           }
 
-              # hydro isn't currently supported to work when FATES SP mode is active
-              if (&value_is_true( $nl->get_value('use_fates_planthydro') )) {
-                    $log->fatal_error('fates sp mode is currently not supported to work with fates hydro');
-              }
+           # hydro isn't currently supported to work when FATES SP mode is active
+           if (&value_is_true( $nl->get_value('use_fates_planthydro') )) {
+                 $log->fatal_error('fates sp mode is currently not supported to work with fates hydro');
            }
         }
         my $var = "use_fates_inventory_init";
@@ -4792,6 +4798,13 @@ sub setup_logic_fates {
             }
           }
         }
+        # Check that both FaTES-SP and FATES ST3 aren't both on
+        my $var = "use_fates_ed_st3";
+        if ( defined($nl->get_value($var))  ) {
+           if ( &value_is_true($nl->get_value($var)) && &value_is_true($nl_flags->{'use_fates_sp'}) ) {
+              $log->fatal_error("$var can NOT also be true with use_fates_sp true" );
+           }
+        }
         # check that fates landuse change mode has the necessary luh2 landuse timeseries data
         # and add the default if not defined.  Do not add default if use_fates_potentialveg is true.
         # If fixed biogeography is on, make sure that flandusepftdat is avilable.

bld/unit_testers/build-namelist_test.pl

@@ -163,10 +163,10 @@ sub cat_and_create_namelistinfile {
 #
 # Figure out number of tests that will run
 #
-my $ntests = 3276;
+my $ntests = 3285;
 
 if ( defined($opts{'compare'}) ) {
-   $ntests += 1987;
+   $ntests += 2161;
 }
 plan( tests=>$ntests );
 
@@ -288,7 +288,7 @@ sub cat_and_create_namelistinfile {
 &make_config_cache($phys);
 my @mfiles = ( "lnd_in", "drv_flds_in", $tempfile );
 my $mfiles = NMLTest::CompFiles->new( $cwd, @mfiles );
-foreach my $options ( "-drydep", "-megan", "-drydep -megan", "-fire_emis", "-drydep -megan -fire_emis" ) {
+foreach my $options ( "-drydep --bgc sp", "-megan --bgc sp", "-drydep -megan --bgc bgc", "-fire_emis --bgc bgc", "-drydep -megan -fire_emis --bgc bgc" ) {
    &make_env_run();
    eval{ system( "$bldnml -envxml_dir . $options > $tempfile 2>&1 " ); };
    is( $@, '', "options: $options" );
@@ -576,8 +576,8 @@ sub cat_and_create_namelistinfile {
                       "--res 1.9x2.5 --bgc bgc --use_case 1850-2100_SSP2-4.5_transient --namelist '&a start_ymd=19101023/'",
                       "-namelist \"&a dust_emis_method='Zender_2003', zender_soil_erod_source='lnd' /'\"",
                       "-bgc bgc -use_case 2000_control -namelist \"&a fire_method='nofire'/\" -crop",
-                      "-res 0.9x1.25 -bgc sp -use_case 1850_noanthro_control -drydep -fire_emis",
-                      "-res 0.9x1.25 -bgc bgc -use_case 1850_noanthro_control -drydep -fire_emis -light_res 360x720",
+                      "-res 0.9x1.25 -bgc sp -use_case 1850_noanthro_control -drydep",
+                      "-res 0.9x1.25 -bgc bgc -use_case 1850_noanthro_control -drydep -fire_emis -megan -light_res 360x720",
                       "--bgc bgc --light_res none --namelist \"&a fire_method='nofire'/\"",
                       "--bgc fates --light_res 360x720 --no-megan --namelist \"&a fates_spitfire_mode=2/\"",
                       "--bgc fates --light_res none --no-megan --namelist \"&a fates_spitfire_mode=1/\"",
@@ -1093,6 +1093,10 @@ sub cat_and_create_namelistinfile {
                                      namelst=>"suplnitro='NONE'",
                                      phys=>"clm6_0",
                                    },
+     "FATESwBothSpST3"           =>{ options=>"--bgc fates --envxml_dir . --no-megan",
+                                     namelst=>"use_fates_sp = TRUE, use_fates_ed_st3 = TRUE",
+                                     phys=>"clm6_0",
+                                   },
      "FireNoneButBGCfireon"    =>{ options=>"-bgc bgc -envxml_dir . -light_res none",
                                      namelst=>"fire_method='li2021gswpfrc'",
                                      phys=>"clm6_0",
@@ -1145,6 +1149,14 @@ sub cat_and_create_namelistinfile {
                                     namelst=>"",
                                     phys=>"clm4_5",
                                  },
+     "useFIREEMISwithNOFIRE"     =>{ options=>"--bgc bgc --envxml_dir . --fire_emis",
+                                    namelst=>"fire_method='nofire'",
+                                    phys=>"clm6_0",
+                                 },
+     "useFIREEMISwithSP"         =>{ options=>"--bgc sp --envxml_dir . --fire_emis",
+                                    namelst=>"",
+                                    phys=>"clm6_0",
+                                 },
      "useDRYDEPwithFATES"        =>{ options=>"--bgc fates --envxml_dir . --no-megan --drydep",
                                      namelst=>"",
                                      phys=>"clm4_5",

cime_config/config_component.xml

@@ -241,12 +241,24 @@
     <type>char</type>
     <default_value></default_value>
     <values>
-      <!--- All versions -->
-      <value compset="_CLM[^_]*%SP"       >-bgc sp</value>
-      <value compset="_CLM[^_]*BGC"       >-bgc bgc</value>
-      <value compset="_CLM[^_]*BGC-CROP"  >-bgc bgc -crop</value>
-      <value compset="_CLM[^_]*FATES"     >-bgc fates -no-megan</value>
-      <value compset="_CLM[^_]*FATES-SP"  >-bgc fates -no-megan</value>
+      <!--- All versions with DATM -->
+      <value compset="DATM[^_]*_CLM[^_]*%SP"       >-bgc sp</value>
+      <value compset="DATM[^_]*_CLM[^_]*BGC"       >-bgc bgc</value>
+      <value compset="DATM[^_]*_CLM[^_]*BGC-CROP"  >-bgc bgc -crop</value>
+
+      <!-- FATES currently can't use MEGAN, drydep, or fire-emission whether coupled to CAM or NOT-->
+      <value compset="CLM[^_]*FATES" >--bgc fates --no-megan --no-drydep --no-fire_emis</value>
+
+      <!-- ======================================= Coupled to CAM Options ======================================
+        All versions with CAM - turn off sending test drv_flds_in namelists from CTSM
+
+        When coupled to CAM - expect CAM to determine these drv_flds settings
+        See issue #2713 for more information on this.
+      -->
+      <value compset="CAM[^_]*_CLM[^_]*%SP"       >--bgc sp --no-megan --no-drydep --no-fire_emis</value>
+      <value compset="CAM[^_]*_CLM[^_]*BGC"       >--bgc bgc --no-megan --no-drydep --no-fire_emis</value>
+      <value compset="CAM[^_]*_CLM[^_]*BGC-CROP"  >--bgc bgc --crop --no-megan --no-drydep --no-fire_emis</value>
+      <!-- ======================================= End of Coupled to CAM Options ===============================  -->
 
       <!-- Options specific for CLM4.5 -->
       <value compset="_CLM45%[^_]*BGCDV"	 >-bgc bgc -dynamic_vegetation</value>