Merge pull request #3753 from GEOS-ESM/feature/bmauer/fixes-#3752

mathomp4 · web-flow · commit 71a5425d59b7 · 2025-05-30T13:24:08.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Deprecated
 
+## [2.56.1] - 2025-05-30
+
+### Fixed
+
+- Fixed issue so that if ExtData cannot find a file and fail on missing is false, just set collection to /dev/null
+
 ## [2.56.0] - 2025-05-23
 
 ### Fixed
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,7 +8,7 @@ endif ()
 
 project (
   MAPL
-  VERSION 2.56.0
+  VERSION 2.56.1
   LANGUAGES Fortran CXX C)  # Note - CXX is required for ESMF
 
 # Set the possible values of build type for cmake-gui
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/AGCM1.rc b/Tests/ExtData_Testing_Framework/test_cases/case38/AGCM1.rc
@@ -0,0 +1,26 @@
+NX: 1
+NY: 1
+
+Root.GRID_TYPE: LatLon
+Root.GRIDNAME: DC90x45-PC
+Root.LM: 3
+Root.IM_WORLD: 90
+Root.JM_WORLD: 45
+Root.POLE: 'PC'
+Root.DATELINE: 'DC'
+
+RUN_MODE: CompareImports
+
+IMPORT_STATE::
+VAR2D , time , days , xy , c
+::
+
+EXPORT_STATE::
+VAR2D , time , days , xy , c
+::
+
+FILL_DEF::
+VAR2D 1.0e15
+::
+
+REF_TIME: 20040701 000000
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/CAP.rc b/Tests/ExtData_Testing_Framework/test_cases/case38/CAP.rc
@@ -0,0 +1,3 @@
+CASES::
+CAP1.rc
+::
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/CAP1.rc b/Tests/ExtData_Testing_Framework/test_cases/case38/CAP1.rc
@@ -0,0 +1,25 @@
+ROOT_NAME: Root
+ROOT_CF: AGCM1.rc
+HIST_CF: HISTORY1.rc
+
+BEG_DATE:     20040101 210000
+
+JOB_SGMT:     00001200 000000
+HEARTBEAT_DT:   3600
+
+#RUN_EXTDATA: .false.
+RUN_TIMES::
+20040115 210000
+20040215 210000
+20040315 210000
+20040415 210000
+20040515 210000
+20040615 210000
+20040715 210000
+20040815 210000
+20040915 210000
+20041015 210000
+20041115 210000
+20041215 210000
+::
+
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/ExtData.rc b/Tests/ExtData_Testing_Framework/test_cases/case38/ExtData.rc
@@ -0,0 +1,13 @@
+#CASE_SENSITIVE_VARIABLE_NAMES: .false.
+Ext_AllowExtrap: .false.
+Prefetch: .true.
+#DEBUG_LEVEL: 20
+
+PrimaryExports%%
+VAR2D NA  N N 0   none     none VAR2D case1.%y4.nc4
+VAR3D NA  N N 0   none     none VAR3D case1.%y4.nc4
+%%
+
+
+DerivedExports%%
+%%
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/HISTORY1.rc b/Tests/ExtData_Testing_Framework/test_cases/case38/HISTORY1.rc
@@ -0,0 +1,5 @@
+GRID_LABELS:
+::
+
+COLLECTIONS:
+::
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/README b/Tests/ExtData_Testing_Framework/test_cases/case38/README
@@ -0,0 +1 @@
+Test case with no files and using exact and fail on missing
diff --git a/Tests/ExtData_Testing_Framework/test_cases/case38/extdata.yaml b/Tests/ExtData_Testing_Framework/test_cases/case38/extdata.yaml
@@ -0,0 +1,4 @@
+Collections:
+   fstream1: {template: case1.%y4.nc4}
+Exports:
+   VAR2D: {variable: VAR2D, collection: fstream1, fail_on_missing_file: false, sample: {exact: true}}
diff --git a/Tests/ExtData_Testing_Framework/test_cases/extdata_2g_cases.txt b/Tests/ExtData_Testing_Framework/test_cases/extdata_2g_cases.txt
@@ -35,3 +35,4 @@ case34
 case35
 case36
 case37
+case38
diff --git a/Tests/ExtData_Testing_Framework/test_cases/test_case_descriptions.md b/Tests/ExtData_Testing_Framework/test_cases/test_case_descriptions.md
@@ -43,3 +43,4 @@ path_to_script/run_extdatadriver_cases.py --builddir path_to_geos_install/bin --
 36. Case1 with zstandard compression and NetCDF granular_bitround quantization (only enabled if netcdf built with quantization
     support and zstandard support)
 37. Test that when time interpolation is off, missing files is allowed, that the last read value is persisted during the period of the missing file
+38. Test when there are no files available, but the collection is not /dev/null, set fail_on_missing_file false, and exact so that the pointer is set ot MAPL_UNDEF 
diff --git a/gridcomps/ExtData2G/ExtDataAbstractFileHandler.F90 b/gridcomps/ExtData2G/ExtDataAbstractFileHandler.F90
@@ -15,6 +15,7 @@ module MAPL_ExtdataAbstractFileHandler
    use MAPL_FileMetadataUtilsMod
    use MAPL_TimeStringConversion
    use MAPL_StringTemplate
+   use MAPL_CommsMod
    implicit none
    private
    public :: ExtDataAbstractFileHandler
@@ -168,10 +169,11 @@ subroutine make_metadata(this,file,metadata,rc)
 
   end subroutine make_metadata
 
-  function find_any_file(this, current_time, rc) result(filename)
+  function find_any_file(this, current_time, fail_on_missing, rc) result(filename)
      character(len=:), allocatable :: filename
      class(ExtDataAbstractFileHandler), intent(inout) :: this
      type(ESMF_Time), intent(in) :: current_time
+     logical, intent(in) :: fail_on_missing 
      integer, optional, intent(out) :: rc
 
      integer :: status, i
@@ -197,8 +199,12 @@ function find_any_file(this, current_time, rc) result(filename)
         if (file_found) exit
      enddo
 
-     _ASSERT(file_found,"Could not find any file to open to determine metadata after multiple trials")
-     filename = trial_file
+     if (fail_on_missing) then
+        _ASSERT(file_found,"Could not find any file to open to determine metadata after multiple trials")
+        filename = trial_file
+     else
+        filename = 'NONE'
+     end if
      _RETURN(_SUCCESS) 
 
    end function find_any_file
diff --git a/gridcomps/ExtData2G/ExtDataGridCompNG.F90 b/gridcomps/ExtData2G/ExtDataGridCompNG.F90
@@ -880,7 +880,12 @@ subroutine GetLevs(item, current_time, rc)
         if (trim(item%file_template) == "/dev/null") then
            _RETURN(_SUCCESS)
         end if
-        filename = item%filestream%find_any_file(current_time, _RC)
+        filename = item%filestream%find_any_file(current_time, item%fail_on_missing_file, _RC)
+        if (.not.(item%fail_on_missing_file) .and. filename == 'NONE') then
+           item%file_template = "/dev/null"
+           item%isConst = .true.
+           _RETURN(_SUCCESS)
+        end if
         collection => DataCollections%at(item%pfioCollection_id)
         metadata => collection%find(filename,_RC)
         item%file_metadata = metadata
@@ -1446,12 +1451,24 @@ subroutine set_constant_field(item,ExtDataState,rc)
 
      if (item%vartype == MAPL_FieldItem) then
         call ESMF_StateGet(ExtDataState,trim(item%name),field,_RC)
-        call FieldSet(field, item%const, _RC)
+        if (item%modelGridFields%comp1%exact) then
+           call FieldSet(field, MAPL_UNDEF, _RC)
+        else
+           call FieldSet(field, item%const, _RC)
+        end if
      else if (item%vartype == MAPL_VectorField) then
         call ESMF_StateGet(ExtDataState,trim(item%vcomp1),field,_RC)
-        call FieldSet(field, item%const, _RC)
+        if (item%modelGridFields%comp1%exact) then
+           call FieldSet(field, MAPL_UNDEF, _RC)
+        else
+           call FieldSet(field, item%const, _RC)
+        end if
         call ESMF_StateGet(ExtDataState,trim(item%vcomp2),field,_RC)
-        call FieldSet(field, item%const, _RC)
+        if (item%modelGridFields%comp2%exact) then
+           call FieldSet(field, MAPL_UNDEF, _RC)
+        else
+           call FieldSet(field, item%const, _RC)
+        end if
       end if
 
      _RETURN(_SUCCESS)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +GRID_LABELS:
 +::
++
 +COLLECTIONS:
 +::
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Test case with no files and using exact and fail on missing`