sima0_12_000: Implement tracer_data in CAM-SIMA; registry entries for prescribed ozone/BAM; NaN check in physics data check

cime_config/testdefs/testlist_cam.xml

@@ -179,6 +179,17 @@
     </options>
   </test>
 
+  <!-- tracer_data chemistry and aerosols input utility test -->
+  <test compset="FPHYStest" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln2" testmods="cam/outfrq_trcdata_bam_derecho">
+    <machines>
+      <machine name="derecho" compiler="gnu" category="aux_sima"/>
+    </machines>
+    <options>
+      <option name="wallclock">00:10:00</option>
+      <option name="comment">Test for tracer_data chemistry and aerosols input utilities using prescribed ozone and BAM bulk aerosol input datasets</option>
+    </options>
+  </test>
+
   <!-- CAM7 physics tests -->
   <test compset="FCAM7" grid="ne3pg3_ne3pg3_mg37" name="SMS_Ln9" testmods="cam/outfrq_se_cslam_analy_ic">
     <machines>

cime_config/testdefs/testmods_dirs/cam/outfrq_trcdata_bam_derecho/shell_commands

@@ -0,0 +1,2 @@
+./xmlchange CAM_CONFIG_OPTS="--dyn none --physics-suites tracer_data_test"
+./xmlchange RUN_STARTDATE="1979-01-01"

cime_config/testdefs/testmods_dirs/cam/outfrq_trcdata_bam_derecho/user_nl_cam

@@ -0,0 +1,53 @@
+! these snapshots were constructed to specifically test whether the data read into the
+! physics buffer by tracer_data in CAM will match the data read by CAM-SIMA bit-for-bit.
+! this was done by
+! (1) taking a FHIST_C4 snapshot (which has prescribed_ozone and aero)
+! in this case a ne3pg3_fhistc4_gw_drag_cam4_oro snapshot,
+! (2) using nco to zero out the prescribed ozone and aero fields from the snapshot data,
+! to create the "before" snapshot.
+! (3) the "after" snapshot is the original snapshot file (which has non-zero values for prescribed
+! ozone and aerosols)
+! the test will pass iff. the tracer_data utility in CAM-SIMA and the prescribed_ozone/aerosols schemes
+! can populate the prescribed fields bit-for-bit compared to the original snapshot file.
+
+ncdata = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc4_tracer_data_0xprescribed-ozone-aero_from_cam4_oro_snapshot_derecho_gnu_after_c20251028.nc'
+ncdata_check = '/glade/campaign/cesm/community/amwg/sima_baselines/cam_sima_test_snapshots/cam_ne3pg3_fhistc4_gw_drag_cam4_oro_snapshot_derecho_gnu_after_c20250826.nc'
+
+! tolerances for testing
+ncdata_check_err = .true.
+min_difference = 2e-15
+
+! cam4 vertical levels (FHIST_C4 snapshots)
+pver = 26
+
+prescribed_aero_datapath = "/glade/campaign/cesm/cesmdata/inputdata/atm/cam/chem/trop_mozart_aero/aero"
+prescribed_aero_file = "aero_1.9x2.5_L26_1850-2005_c091112.nc"
+prescribed_aero_filelist = "aero_1.9x2.5_L26_list_c070514.txt"
+prescribed_aero_model = "bulk"
+prescribed_aero_specifier = 'sulf:SO4', 'bcar1:CB1', 'bcar2:CB2', 'ocar1:OC1', 'ocar2:OC2', 'sslt1:SSLT01', 'sslt2:SSLT02', 'sslt3:SSLT03', 'sslt4:SSLT04', 'dust1:DST01', 'dust2:DST02', 'dust3:DST03', 'dust4:DST04'
+prescribed_aero_type = "INTERP_MISSING_MONTHS"
+prescribed_aero_cycle_yr = 0
+prescribed_aero_fixed_tod = 0
+prescribed_aero_fixed_ymd = 0
+
+aerodep_flx_datapath           = '/glade/campaign/cesm/cesmdata/inputdata/atm/cam/chem/trop_mozart_aero/aero'
+aerodep_flx_file               = 'aerosoldep_monthly_1849-2006_1.9x2.5_c090803.nc'
+aerodep_flx_specifier          = 'BCDEPWET', 'BCPHODRY', 'BCPHIDRY', 'OCDEPWET', 'OCPHODRY', 'OCPHIDRY', 'DSTX01DD', 'DSTX02DD', 'DSTX03DD',
+     'DSTX04DD', 'DSTX01WD', 'DSTX02WD', 'DSTX03WD', 'DSTX04WD'
+aerodep_flx_type               = 'INTERP_MISSING_MONTHS'
+aerodep_flx_cycle_yr = 0
+
+prescribed_ozone_datapath = "/glade/campaign/cesm/cesmdata/inputdata/atm/cam/ozone"
+prescribed_ozone_file = "ozone_1.9x2.5_L26_1850-2005_c091112.nc"
+prescribed_ozone_filelist = "UNSET"
+prescribed_ozone_name = "O3"
+prescribed_ozone_type = "INTERP_MISSING_MONTHS"
+prescribed_ozone_fixed_tod = 0
+prescribed_ozone_fixed_ymd = 0
+prescribed_ozone_cycle_yr = 0
+
+hist_output_frequency;h1: 1*nsteps
+hist_max_frames;h1: 1
+hist_add_inst_fields;h1:ozone
+hist_add_inst_fields;h1:sulf_D,bcar1_D,bcar2_D,ocar1_D,ocar2_D,sslt1_D,sslt2_D,sslt3_D,sslt4_D,dust1_D,dust2_D,dust3_D,dust4_D
+hist_precision;h1: REAL64

src/core_utils/string_core_utils.F90

@@ -9,6 +9,9 @@ module string_core_utils
     public :: split                      ! Parse a string into tokens, one at a time
     public :: stringify                  ! Convert one or more values of any intrinsic data types to a character string for pretty printing
     public :: tokenize                   ! Parse a string into tokens
+    public :: increment_string           ! Increment a string whose ending characters are digits.
+    public :: last_non_digit             ! Get position of last non-digit in the input string.
+    public :: get_last_significant_char  ! Get position of last significant (non-blank, non-null) character in string.
 
     interface tokenize
         module procedure tokenize_into_first_last
@@ -287,4 +290,112 @@ pure subroutine tokenize_into_tokens_separator(string, set, tokens, separator)
         end if
     end subroutine tokenize_into_tokens_separator
 
+    ! Increment a string whose ending characters are digits.
+    ! The incremented integer must be in the range [0 - (10**n)-1]
+    ! where n is the number of trailing digits.
+    ! Return values:
+    !
+    !  0 success
+    ! -1 error: no trailing digits in string
+    ! -2 error: incremented integer is out of range
+    integer function increment_string(s, inc)
+        integer,          intent(in)    :: inc ! value to increment string (may be negative)
+        character(len=*), intent(inout) :: s   ! string with trailing digits
+
+        integer :: &
+          i, &        ! index
+          lstr, &     ! number of significant characters in string
+          lnd, &      ! position of last non-digit
+          ndigit, &   ! number of trailing digits
+          ival, &     ! integer value of trailing digits
+          pow, &      ! power of ten
+          digit       ! integer value of a single digit
+
+        lstr   = get_last_significant_char(s)
+        lnd    = last_non_digit(s)
+        ndigit = lstr - lnd
+
+        if(ndigit == 0) then
+            increment_string = -1
+            return
+        end if
+
+        ! Calculate integer corresponding to trailing digits.
+        ival = 0
+        pow  = 0
+        do i = lstr,lnd+1,-1
+            digit = ICHAR(s(i:i)) - ICHAR('0')
+            ival  = ival + digit * 10**pow
+            pow   = pow + 1
+        end do
+
+        ! Increment the integer
+        ival = ival + inc
+        if( ival < 0 .or. ival > 10**ndigit-1 ) then
+            increment_string = -2
+            return
+        end if
+
+        ! Overwrite trailing digits
+        pow = ndigit
+        do i = lnd+1,lstr
+            digit  = MOD( ival,10**pow ) / 10**(pow-1)
+            s(i:i) = CHAR( ICHAR('0') + digit )
+            pow    = pow - 1
+        end do
+
+        increment_string = 0
+
+    end function increment_string
+
+    ! Get position of last non-digit in the input string.
+    ! Return values:
+    !     > 0  => position of last non-digit
+    !     = 0  => token is all digits (or empty)
+    integer pure function last_non_digit(s)
+        character(len=*), intent(in) :: s
+        integer :: n, nn, digit
+
+        n = get_last_significant_char(s)
+        if(n == 0) then     ! empty string
+            last_non_digit = 0
+            return
+        end if
+
+        do nn = n,1,-1
+            digit = ICHAR(s(nn:nn)) - ICHAR('0')
+            if( digit < 0 .or. digit > 9 ) then
+                last_non_digit = nn
+            return
+            end if
+        end do
+
+        last_non_digit = 0    ! all characters are digits
+
+    end function last_non_digit
+
+    ! Get position of last significant character in string.
+    !   Here significant means non-blank or non-null.
+    !   Return values:
+    !       > 0  => position of last significant character
+    !       = 0  => no significant characters in string
+    integer pure function get_last_significant_char(cs)
+        character(len=*), intent(in) :: cs       !  Input character string
+        integer :: l, n
+
+        l = LEN(cs)
+        if( l == 0 ) then
+            get_last_significant_char = 0
+            return
+        end if
+
+        do n = l,1,-1
+            if( cs(n:n) /= ' ' .and. cs(n:n) /= CHAR(0) ) then
+                exit
+            end if
+        end do
+        get_last_significant_char = n
+
+    end function get_last_significant_char
+
 end module string_core_utils

src/data/registry.xml

@@ -1627,6 +1627,86 @@
       <ic_file_input_names>pbuf_clubbtop</ic_file_input_names>
     </variable>
 
+    <!-- Test for tracer_data / aerosols / BAM -->
+    <variable local_name="sulf"
+              standard_name="sulf"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>sulf pbuf_sulf cnst_sulf </ic_file_input_names>
+    </variable>
+    <variable local_name="bcar1"
+              standard_name="bcar1"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>bcar1 pbuf_bcar1 cnst_bcar1</ic_file_input_names>
+    </variable>
+    <variable local_name="bcar2"
+              standard_name="bcar2"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>bcar2 pbuf_bcar2 cnst_bcar2</ic_file_input_names>
+    </variable>
+    <variable local_name="ocar1"
+              standard_name="ocar1"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>ocar1 pbuf_ocar1 cnst_ocar1</ic_file_input_names>
+    </variable>
+    <variable local_name="ocar2"
+              standard_name="ocar2"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>ocar2 pbuf_ocar2 cnst_ocar2</ic_file_input_names>
+    </variable>
+    <variable local_name="sslt1"
+              standard_name="sslt1"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>sslt1 pbuf_sslt1 cnst_sslt1</ic_file_input_names>
+    </variable>
+    <variable local_name="sslt2"
+              standard_name="sslt2"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>sslt2 pbuf_sslt2 cnst_sslt2</ic_file_input_names>
+    </variable>
+    <variable local_name="sslt3"
+              standard_name="sslt3"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>sslt3 pbuf_sslt3 cnst_sslt3</ic_file_input_names>
+    </variable>
+    <variable local_name="sslt4"
+              standard_name="sslt4"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>sslt4 pbuf_sslt4 cnst_sslt4</ic_file_input_names>
+    </variable>
+    <variable local_name="dust1"
+              standard_name="dust1"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>dust1 pbuf_dust1 cnst_dust1</ic_file_input_names>
+    </variable>
+    <variable local_name="dust2"
+              standard_name="dust2"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>dust2 pbuf_dust2 cnst_dust2</ic_file_input_names>
+    </variable>
+    <variable local_name="dust3"
+              standard_name="dust3"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>dust3 pbuf_dust3 cnst_dust3</ic_file_input_names>
+    </variable>
+    <variable local_name="dust4"
+              standard_name="dust4"
+              units="kg kg-1" type="real" constituent="true">
+      <dimensions>horizontal_dimension vertical_layer_dimension</dimensions>
+      <ic_file_input_names>dust4 pbuf_dust4 cnst_dust4</ic_file_input_names>
+    </variable>
+
     <!-- Zhang McFarlane (ZM) Variables -->
     <variable local_name="ql"
               standard_name="in_cloud_water_vapor_mixing_ratio_wrt_moist_air_and_condensed_water_due_to_deep_convection"