add a test to test the multi-file capability in data_override (#1745)

Author: uramirez8707

test_fms/data_override/Makefile.am

@@ -71,11 +71,13 @@ TESTS_ENVIRONMENT= test_input_path="@TEST_INPUT_PATH@" \
 # Run the test program.
 
 TESTS = test_data_override2.sh test_data_override_init.sh test_data_override2_mono.sh test_data_override2_ongrid.sh \
-        test_data_override2_scalar.sh test_data_override_weights.sh test_data_override_ensembles.sh
+        test_data_override2_scalar.sh test_data_override_weights.sh test_data_override_ensembles.sh \
+        test_multi_file.sh
 
 # Include these files with the distribution.
 EXTRA_DIST = test_data_override2.sh test_data_override_init.sh test_data_override2_mono.sh test_data_override2_ongrid.sh \
-             test_data_override2_scalar.sh test_data_override_weights.sh test_data_override_ensembles.sh
+             test_data_override2_scalar.sh test_data_override_weights.sh test_data_override_ensembles.sh \
+             test_multi_file.sh
 
 # Clean up
 CLEANFILES = input.nml *.nc* *.out diag_table data_table data_table.yaml INPUT/* *.dpi *.spi *.dyn *.spl *-files/*

test_fms/data_override/include/test_data_override_ongrid.inc

@@ -222,3 +222,38 @@ subroutine ENSEMBLE_TEST_
 
   deallocate(runoff)
 end subroutine ENSEMBLE_TEST_
+
+subroutine MULTI_FILE_TESTS_
+  integer, parameter                       :: lkind = DO_TEST_KIND_ !< Real precision of the test
+  real(lkind)                              :: expected_result       !< Expected result from data_override
+  type(time_type)                          :: Time                  !< Time
+  real(lkind), allocatable, dimension(:,:) :: runoff                !< Data to be written
+  logical :: sucessful !< .True. if the data_override was sucessful
+
+  allocate(runoff(is:ie,js:je))
+
+  !< Run it when time=3, this is going to use the previous file and the current file
+  Time = set_date(1,1,4,0,0,0)
+  runoff = 999._lkind
+  call data_override('OCN','runoff',runoff, Time, override=sucessful)
+  if (.not. sucessful) call mpp_error(FATAL, "The data was not overridden correctly")
+  expected_result = 3._lkind
+  call COMPARE_DATA_ (Domain, runoff, expected_result)
+
+  !< Run it when time=4, this is going to use the current file
+  Time = set_date(1,1,5,0,0,0)
+  runoff = 999._lkind
+  call data_override('OCN','runoff',runoff, Time, override=sucessful)
+  if (.not. sucessful) call mpp_error(FATAL, "The data was not overridden correctly")
+  expected_result = 4._lkind
+  call COMPARE_DATA_ (Domain, runoff, expected_result)
+
+  !< Run it when time=5, this is going to use the current file and the next file
+  Time = set_date(1,1,6,0,0,0)
+  runoff = 999._lkind
+  call data_override('OCN','runoff',runoff, Time, override=sucessful)
+  if (.not. sucessful) call mpp_error(FATAL, "The data was not overridden correctly")
+  expected_result = 5._lkind
+  call COMPARE_DATA_ (Domain, runoff, expected_result)
+
+end subroutine MULTI_FILE_TESTS_

test_fms/data_override/include/test_data_override_ongrid_r4.fh

@@ -24,6 +24,7 @@
 #undef WEIGHT_FILE_TEST_
 #undef SCALAR_TEST_
 #undef ENSEMBLE_TEST_
+#undef MULTI_FILE_TESTS_
 
 #define DO_TEST_KIND_              r4_kind
 #define COMPARE_DATA_              compare_data_r4
@@ -32,5 +33,6 @@
 #define WEIGHT_FILE_TEST_          weight_file_test_r4
 #define SCALAR_TEST_               scalar_test_r4
 #define ENSEMBLE_TEST_             ensemble_test_r4
+#define MULTI_FILE_TESTS_          multi_file_r4
 
 #include "test_data_override_ongrid.inc"

test_fms/data_override/include/test_data_override_ongrid_r8.fh

@@ -24,6 +24,7 @@
 #undef WEIGHT_FILE_TEST_
 #undef SCALAR_TEST_
 #undef ENSEMBLE_TEST_
+#undef MULTI_FILE_TESTS_
 
 #define DO_TEST_KIND_              r8_kind
 #define COMPARE_DATA_              compare_data_r8
@@ -32,5 +33,6 @@
 #define WEIGHT_FILE_TEST_          weight_file_test_r8
 #define SCALAR_TEST_               scalar_test_r8
 #define ENSEMBLE_TEST_             ensemble_test_r8
+#define MULTI_FILE_TESTS_          multi_file_r8
 
 #include "test_data_override_ongrid.inc"

test_fms/data_override/test_data_override_ongrid.F90

@@ -55,6 +55,7 @@ program test_data_override_ongrid
 integer, parameter                         :: weight_file = 4
 integer, parameter                         :: ensemble_case = 5
 integer, parameter                         :: ensemble_same_yaml = 6
+integer, parameter                         :: multi_file = 7
 integer                                    :: test_case = ongrid
 logical                                    :: init_with_mode = .false.
 integer                                    :: npes
@@ -112,6 +113,8 @@ program test_data_override_ongrid
     call generate_weight_input_file ()
   case (ensemble_case, ensemble_same_yaml)
     call generate_ensemble_input_file()
+  case (multi_file)
+    call generate_multi_file_input_file()
   end select
 
   call mpp_sync()
@@ -150,6 +153,9 @@ program test_data_override_ongrid
     call ensemble_test_r4
     call ensemble_test_r8
     call mpp_set_current_pelist(pelist)
+  case (multi_file)
+    call multi_file_r4
+    call multi_file_r8
   end select
 endif
 
@@ -288,6 +294,63 @@ subroutine create_ongrid_data_file(is_ensemble)
   deallocate(runoff_in)
 end subroutine create_ongrid_data_file
 
+subroutine create_multi_file_data_file
+  type(FmsNetcdfFile_t) :: fileobj
+  character(len=10) :: dimnames(3)
+  real(r4_kind), allocatable, dimension(:,:,:) :: runoff_in
+  real(r4_kind), allocatable, dimension(:)     :: time_data
+  integer :: i
+
+  integer, parameter :: ntimes = 9
+  integer, parameter :: nfiles = 3
+  integer :: starting
+  integer :: ending
+
+  allocate(runoff_in(nlon, nlat, ntimes))
+  allocate(time_data(ntimes))
+
+  time_data = (/1_r4_kind, 2_r4_kind, 3_r4_kind, &
+                4_r4_kind, 5_r4_kind, 6_r4_kind, &
+                7_r4_kind, 7_r4_kind, 9_r4_kind /)
+
+  do i = 1, ntimes
+    runoff_in(:,:,i) = real(i, r4_kind)
+  enddo
+
+  dimnames(1) = 'i'
+  dimnames(2) = 'j'
+  dimnames(3) = 'time'
+
+  do i = 1, nfiles
+    if (open_file(fileobj, "INPUT/hadisst_ice.data_yr"//string(i-1)//".nc", "overwrite")) then
+      call register_axis(fileobj, "i", nlon)
+      call register_axis(fileobj, "j", nlat)
+      call register_axis(fileobj, "time", unlimited)
+
+      call register_field(fileobj, "i", "float", (/"i"/))
+      call register_variable_attribute(fileobj, "i", "cartesian_axis", "x", str_len=1)
+
+      call register_field(fileobj, "j", "float", (/"j"/))
+      call register_variable_attribute(fileobj, "j", "cartesian_axis", "y", str_len=1)
+
+      call register_field(fileobj, "time", "float", (/"time"/))
+      call register_variable_attribute(fileobj, "time", "cartesian_axis", "T", str_len=1)
+      call register_variable_attribute(fileobj, "time", "calendar", "noleap", str_len=6)
+      call register_variable_attribute(fileobj, "time", "units", "days since 0001-01-01 00:00:00", str_len=30)
+
+      call register_field(fileobj, "runoff", "float", dimnames)
+
+      starting = 2 * (i - 1) + 1
+      ending = starting + 1
+
+      call write_data(fileobj, "runoff", runoff_in(:,:, starting:ending))
+      call write_data(fileobj, "time", time_data(starting:ending))
+      call close_file(fileobj)
+    endif
+  enddo
+
+end subroutine create_multi_file_data_file
+
 subroutine generate_ongrid_input_file
   !< Create some files needed by data_override!
   if (mpp_pe() .eq. mpp_root_pe()) then
@@ -299,6 +362,17 @@ subroutine generate_ongrid_input_file
   call mpp_sync()
 end subroutine generate_ongrid_input_file
 
+subroutine generate_multi_file_input_file
+  if (mpp_pe() .eq. mpp_root_pe()) then
+    call create_grid_spec_file()
+    call create_ocean_mosaic_file()
+    call create_ocean_hgrid_file()
+    call create_multi_file_data_file()
+  endif
+
+  call mpp_sync()
+end subroutine generate_multi_file_input_file
+
 !> @brief Creates an input netcdf data file to use for the ongrid data_override test case
 !! with either an increasing or decreasing lat, lon grid
 subroutine create_bilinear_data_file(increasing_grid)

test_fms/data_override/test_multi_file.sh

@@ -0,0 +1,76 @@
+#!/bin/sh
+
+#***********************************************************************
+#*                   GNU Lesser General Public License
+#*
+#* This file is part of the GFDL Flexible Modeling System (FMS).
+#*
+#* FMS is free software: you can redistribute it and/or modify it under
+#* the terms of the GNU Lesser General Public License as published by
+#* the Free Software Foundation, either version 3 of the License, or (at
+#* your option) any later version.
+#*
+#* FMS is distributed in the hope that it will be useful, but WITHOUT
+#* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+#* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+#* for more details.
+#*
+#* You should have received a copy of the GNU Lesser General Public
+#* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
+#***********************************************************************
+#
+# Copyright (c) 2019-2021 Ed Hartnett, Uriel Ramirez, Seth Underwood
+
+# Set common test settings.
+. ../test-lib.sh
+
+output_dir
+rm -rf data_table data_table.yaml input.nml input_base.nml
+
+if [ -z $parser_skip ]; then
+
+cat <<_EOF > input_base.nml
+&data_override_nml
+use_data_table_yaml=.True.
+/
+&test_data_override_ongrid_nml
+  test_case = 7
+  nlon = 5
+  nlat = 6
+  layout = 1, 2
+  write_only = .False.
+/
+_EOF
+
+cat <<_EOF > data_table.yaml
+data_table:
+ - grid_name           : OCN
+   fieldname_in_model  : runoff
+   override_file:
+   - file_name         : INPUT/hadisst_ice.data_yr1.nc
+     fieldname_in_file : runoff
+     interp_method     : none
+     multi_file:
+     - next_file_name: INPUT/hadisst_ice.data_yr2.nc
+       prev_file_name: INPUT/hadisst_ice.data_yr0.nc
+   factor              : 1
+_EOF
+
+[ ! -d "INPUT" ] && mkdir -p "INPUT"
+rm -rf INPUT/*
+
+sed 's/write_only = .False./write_only = .True./g' input_base.nml > input.nml
+test_expect_success "Creating input files" '
+  mpirun -n 2 ../test_data_override_ongrid
+'
+
+cp input_base.nml input.nml
+test_expect_success "data_override multi_file" '
+  mpirun -n 2 ../test_data_override_ongrid
+'
+
+rm -rf INPUT *.nc # remove any leftover files to reduce size
+
+fi
+
+test_done