migrate FATES to use the normal BGC call sequence

bld/CLMBuildNamelist.pm

@@ -2892,20 +2892,25 @@ sub setup_logic_supplemental_nitrogen {
                 'suplnitro', 'use_cn'=>$nl_flags->{'use_cn'}, 'use_crop'=>$nl_flags->{'use_crop'});
   }
 
+  if ( $nl_flags->{'bgc_mode'} ne "sp" && $nl_flags->{'bgc_mode'} eq "fates" ) {
+    add_default($opts, $nl_flags->{'inputdata_rootdir'}, $definition, $defaults, $nl,
+                'suplnitro', 'use_fates'=>$nl_flags->{'use_fates'});
+  }
+
   #
   # Error checking for suplnitro
   #
   my $suplnitro = $nl->get_value('suplnitro');
   if ( defined($suplnitro) ) {
     if ( $nl_flags->{'bgc_mode'} eq "sp" ) {
-      $log->fatal_error("supplemental Nitrogen (suplnitro) is set, but neither CN nor CNDV is active!");
+      $log->fatal_error("supplemental Nitrogen (suplnitro) is set, but neither CN nor CNDV nor FATES is active!");
     }
     if ( ! &value_is_true($nl_flags->{'use_crop'}) && $suplnitro =~ /PROG_CROP_ONLY/i ) {
       $log->fatal_error("supplemental Nitrogen is set to run over prognostic crops, but prognostic crop is NOT active!");
     }
 
     if ( $suplnitro =~ /ALL/i ) {
-      if ( $nl_flags->{'bgc_spinup'} eq "on" ) {
+      if ( $nl_flags->{'bgc_spinup'} eq "on" && $nl_flags->{'bgc_mode'} ne "fates" ) {
         $log->warning("There is no need to use a bgc_spinup mode when supplemental Nitrogen is on for all PFT's, as these modes spinup Nitrogen" );
       }
     }

bld/namelist_files/namelist_defaults_ctsm.xml

@@ -146,7 +146,7 @@ attributes from the config_cache.xml file (with keys converted to upper-case).
 
 <!-- Supplmental Nitrogen mode -->
 <suplnitro use_cn=".true." >NONE</suplnitro>
-<suplnitro use_fates=".true." >NONE</suplnitro>
+<suplnitro use_fates=".true." >ALL</suplnitro>
 
 <!-- Albedo for glaciers -->
 <albice phys="clm5_1" >0.50,0.30</albice>

src/biogeochem/CNAnnualUpdateMod.F90

@@ -10,6 +10,7 @@ module CNAnnualUpdateMod
   use CNvegStateType      , only : cnveg_state_type
   use PatchType           , only : patch
   use filterColMod        , only : filter_col_type, col_filter_from_filter_and_logical_array
+  use ColumnType          , only : col
   !
   implicit none
   private
@@ -55,20 +56,23 @@ subroutine CNAnnualUpdate(bounds, num_soilc, filter_soilc, num_soilp, filter_soi
 
     do fc = 1,num_soilc
        c = filter_soilc(fc)
-       cnveg_state_inst%annsum_counter_col(c) = cnveg_state_inst%annsum_counter_col(c) + dt
-       if (cnveg_state_inst%annsum_counter_col(c) >= secspyear) then
-          end_of_year(c) = .true.
-          cnveg_state_inst%annsum_counter_col(c) = 0._r8
-       else
-          end_of_year(c) = .false.
+       if(.not.col%is_fates(c))then
+          cnveg_state_inst%annsum_counter_col(c) = cnveg_state_inst%annsum_counter_col(c) + dt
+          if (cnveg_state_inst%annsum_counter_col(c) >= secspyear) then
+             end_of_year(c) = .true.
+             cnveg_state_inst%annsum_counter_col(c) = 0._r8
+          else
+             end_of_year(c) = .false.
+          end if
        end if
     end do
+
 
     do fp = 1,num_soilp
        p = filter_soilp(fp)
        c = patch%column(p)
 
-       if (end_of_year(c)) then
+       if (end_of_year(c) .and. .not.col%is_fates(c)) then
 
           ! update annual plant ndemand accumulator
           cnveg_state_inst%annsum_potential_gpp_patch(p)  = cnveg_state_inst%tempsum_potential_gpp_patch(p)
@@ -94,20 +98,22 @@ subroutine CNAnnualUpdate(bounds, num_soilc, filter_soilc, num_soilp, filter_soi
     end do
 
     ! Get column-level averages, just for the columns that have reached their personal end-of-year
-    filter_endofyear_c = col_filter_from_filter_and_logical_array( &
-         bounds = bounds, &
-         num_orig = num_soilc, &
-         filter_orig = filter_soilc, &
-         logical_col = end_of_year(bounds%begc:bounds%endc))
-
-    call p2c(bounds, filter_endofyear_c%num, filter_endofyear_c%indices, &
-         cnveg_carbonflux_inst%annsum_npp_patch(bounds%begp:bounds%endp), &
-         cnveg_carbonflux_inst%annsum_npp_col(bounds%begc:bounds%endc))
-
-    call p2c(bounds, filter_endofyear_c%num, filter_endofyear_c%indices, &
-         cnveg_state_inst%annavg_t2m_patch(bounds%begp:bounds%endp), &
-         cnveg_state_inst%annavg_t2m_col(bounds%begc:bounds%endc))
-
+    if(num_soilp>0)then
+       filter_endofyear_c = col_filter_from_filter_and_logical_array( &
+            bounds = bounds, &
+            num_orig = num_soilc, &
+            filter_orig = filter_soilc, &
+            logical_col = end_of_year(bounds%begc:bounds%endc))
+
+       call p2c(bounds, filter_endofyear_c%num, filter_endofyear_c%indices, &
+            cnveg_carbonflux_inst%annsum_npp_patch(bounds%begp:bounds%endp), &
+            cnveg_carbonflux_inst%annsum_npp_col(bounds%begc:bounds%endc))
+
+       call p2c(bounds, filter_endofyear_c%num, filter_endofyear_c%indices, &
+            cnveg_state_inst%annavg_t2m_patch(bounds%begp:bounds%endp), &
+            cnveg_state_inst%annavg_t2m_col(bounds%begc:bounds%endc))
+    end if
+
  end subroutine CNAnnualUpdate
 
 end module CNAnnualUpdateMod