Fix improper handling of date timestamps and lat/lon bounds for mask files

[msulprizio]

Name and Institution (Required)

Name: Melissa Sulprizio
Institution: Harvard

Describe the update

As reported in #307, mask with temporal variability were only read once per simulation. This was caused by a bug in hco_config_mod.F90 where the year and month values for mask fields were overwritten by the lat/lon bounds of the mask file and later set to -999. To fix this, new fields Lats and Lons have been added to the FileData type in hco_types_mod.F90. The lat and lon bounds are now directly stored in those 2D arrays without modifying the year and month values. The lat and lon values will now also be printed to the log file for mask files.

With this fix, the SEASONAL_RES_MASK container in the GEOS-Chem CH4 simulation now properly lists the year and month ranges instead of -999 values. Previously, the log file listed:

 New container set to ReadList:
Container SEASONAL_RES_MASK
    -->Data type       :            3
    -->Container ID    :            7
    -->Target ID       :            7
    -->File data home?           -999
    -->Source file     : $ROOT/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
    -->ncRead?            T
    -->Shared data file?  F
    -->Source parameter: Mask
    -->Year range      :         -999        -999
    -->Month range     :         -999        -999
    -->Day range       :            1           1
    -->Hour range      :            0           0
    -->SpaceDim        :            2
    -->Array dimension :            0           0
    -->Array sum       :    0.00000000
    -->Array min & max :    0.00000000       0.00000000
    -->Time dimension  :            0
    -->Delta t[h]      :            0
    -->Local time?        F
    -->OrigUnit        : 1
    -->Concentration?     F
    -->Coverage        :            1
    -->Scal ID         :         1500
    -->Operator        :            1

With this fix:

 New container set to ReadList:
Container SEASONAL_RES_MASK
    -->Data type       :            3
    -->Container ID    :            6
    -->Target ID       :            6
    -->File data home?           -999
    -->Source file     : $ROOT/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
    -->ncRead?            T
    -->Shared data file?  F
    -->Source parameter: Mask
    -->Year range      :         2022        2022
    -->Month range     :            1          12
    -->Day range       :            1           1
    -->Hour range      :            0           0
    -->SpaceDim        :            2
    -->Array dimension :            0           0
    -->Array sum       :    0.00000000
    -->Array min & max :    0.00000000       0.00000000
    -->Time dimension  :            0
    -->Delta t[h]      :            0
    -->Local time?        F
    -->OrigUnit        : 1
    -->Concentration?     F
    -->Coverage        :            1
    -->Lon range       :         -180         180
    -->Lat range       :          -90          90
    -->Scal ID         :         1500
    -->Operator        :            1

I have confirmed that the reservoir mask file in these simulations is now read and updated monthly. From the log file:

 Processing container: SEASONAL_RES_MASK
 Parsing source file and replacing tokens
 Opening file: /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Opening /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Entering GET_TIMEIDX (HCOIO_UTIL_MOD.F90) ( 6)
 Number of time slices found:           12
 Time slice range :    202201010000.00000        202212010000.00000
          preferred datetime:  202201010000.
              selected tidx1:              1
...
 Processing container: SEASONAL_RES_MASK
 Parsing source file and replacing tokens
 Opening file: /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Opening /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Entering GET_TIMEIDX (HCOIO_UTIL_MOD.F90) ( 6)
 Number of time slices found:           12
 Time slice range :    202201010000.00000        202212010000.00000
          preferred datetime:  202202010000.
              selected tidx1:              2
...
 Processing container: SEASONAL_RES_MASK
 Parsing source file and replacing tokens
 Opening file: /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Opening /n/holylfs06/LABS/jacob_lab/Shared/GEOS-CHEM/gcgrid/gcdata/ExtData/HEMCO/CH4/v2024-01/ResME/reservoir_mask.01x01.nc
HEMCO: Entering GET_TIMEIDX (HCOIO_UTIL_MOD.F90) ( 6)
 Number of time slices found:           12
 Time slice range :    202201010000.00000        202212010000.00000
          preferred datetime:  202203010000.
              selected tidx1:              3
etc.

Expected changes

This is a zero-difference update with respect to full-chemistry benchmark simulations. It will impact CH4 GEOS-Chem simulations which do include mask files with temporal variability.

Related Github Issue

• Closes ResME reservoir mask only is read once instead of monthly #307

[yantosca]

Thanks @msulprizio! Looks good to merge!