Revert "Deprecate gx1 CORE forcing option (CICE-Consortium#643)"

This reverts commit 9f72e87.
phil-blain · Nov 24, 2021 · d6dac9e · d6dac9e
1 parent 0127e1e
commit d6dac9e
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 11 deletions.
diff --git a/cicecore/cicedynB/general/ice_forcing.F90 b/cicecore/cicedynB/general/ice_forcing.F90
@@ -118,7 +118,7 @@ module ice_forcing
          atm_data_format, & ! 'bin'=binary or 'nc'=netcdf
          ocn_data_format, & ! 'bin'=binary or 'nc'=netcdf
          atm_data_type, & ! 'default', 'monthly', 'ncar', 
-                          ! 'hadgem' or 'oned' or
+                          ! 'LYq' or 'hadgem' or 'oned' or
                           ! 'JRA55_gx1' or 'JRA55_gx3' or 'JRA55_tx1'
          bgc_data_type, & ! 'default', 'clim'
          ocn_data_type, & ! 'default', 'clim', 'ncar', 'oned',
@@ -290,10 +290,8 @@ subroutine init_forcing_atmo
       ! default forcing values from init_flux_atm
       if (trim(atm_data_type) == 'ncar') then
          call NCAR_files(fyear)
-#ifdef UNDEPRECATE_LYq
       elseif (trim(atm_data_type) == 'LYq') then
          call LY_files(fyear)
-#endif
       elseif (trim(atm_data_type) == 'JRA55_gx1') then
          call JRA55_gx1_files(fyear)
       elseif (trim(atm_data_type) == 'JRA55_gx3') then
@@ -608,10 +606,8 @@ subroutine get_forcing_atmo
 
       if (trim(atm_data_type) == 'ncar') then
          call ncar_data
-#ifdef UNDEPRECATE_LYq
       elseif (trim(atm_data_type) == 'LYq') then
          call LY_data
-#endif
       elseif (trim(atm_data_type) == 'JRA55_gx1') then
          call JRA55_data
       elseif (trim(atm_data_type) == 'JRA55_gx3') then
@@ -1625,7 +1621,6 @@ subroutine prepare_forcing (nx_block, ny_block, &
          enddo
          enddo
 
-#ifdef UNDEPRECATE_LYq
       elseif (trim(atm_data_type) == 'LYq') then
 
          ! precip is in mm/s
@@ -1641,7 +1636,7 @@ subroutine prepare_forcing (nx_block, ny_block, &
                                           hm(i,j),   flw(i,j))
          enddo
          enddo
-#endif
+
       elseif (trim(atm_data_type) == 'oned') then  ! rectangular grid 
 
          ! precip is in kg/m^2/s
@@ -2094,7 +2089,6 @@ subroutine ncar_data
 
       end subroutine ncar_data
 
-#ifdef UNDEPRECATE_LYq
 !=======================================================================
 ! Large and Yeager forcing (AOMIP style)
 !=======================================================================
@@ -2151,7 +2145,7 @@ subroutine LY_files (yr)
       endif                     ! master_task
 
       end subroutine LY_files
-#endif
+
 !=======================================================================
 
       subroutine JRA55_gx1_files(yr)
@@ -2215,7 +2209,6 @@ subroutine JRA55_gx3_files(yr)
       endif
       end subroutine JRA55_gx3_files
 
-#ifdef UNDEPRECATE_LYq
 !=======================================================================
 !
 ! read Large and Yeager atmospheric data
@@ -2439,7 +2432,7 @@ subroutine LY_data
         endif                   ! debug_forcing
 
       end subroutine LY_data
-#endif
+
 !=======================================================================
 
       subroutine JRA55_data

diff --git a/configuration/scripts/options/set_nml.gx1coreii b/configuration/scripts/options/set_nml.gx1coreii
@@ -0,0 +1,10 @@
+year_init      = 1997
+use_leap_years = .false.
+use_restart_time = .true.
+ice_ic          = 'ICE_MACHINE_INPUTDATA/CICE_data/ic/gx1/iced_gx1_v5.nc'
+fyear_init      = 2005
+ycycle          = 1
+atm_data_format = 'bin'
+atm_data_type   = 'LYq'
+atm_data_dir    = 'ICE_MACHINE_INPUTDATA/CICE_data/forcing/gx1/COREII'
+precip_units    = 'mm_per_sec'
diff --git a/configuration/scripts/tests/base_suite.ts b/configuration/scripts/tests/base_suite.ts
@@ -70,6 +70,7 @@ smoke          gx3     8x2        diag24,run5day,zsal,debug
 restart        gx3     8x2        zsal
 restart        gx3     8x2        gx3ncarbulk,debug
 restart        gx3     4x4        gx3ncarbulk,diag1
+restart        gx1    24x1        gx1coreii,short
 smoke          gx3     4x1        calcdragio
 restart        gx3     4x2        atmbndyconstant
 restart        gx3     4x2        atmbndymixed
diff --git a/doc/source/developer_guide/dg_forcing.rst b/doc/source/developer_guide/dg_forcing.rst
@@ -150,6 +150,21 @@ Users are encouraged to switch to the JRA55 (see :ref:`JRA55forcing`) dataset.
 atmosphere forcing dataset may be deprecated in the future.
 
 
+.. _LYqforcing:
+
+LYq Atmosphere Forcing
+-------------------------
+
+The LYq (:cite:`Hunke07`) forcing was used in earlier standalone 
+runs on the gx1 grid, and the
+Consortium continues to do some very limited testing with this forcing dataset.
+This dataset is largely based on the CORE II data.
+Monthly average data for cldf and fsnow is read while 6-hourly data for Qa, Tair, 
+uatm, and vatm are read with other fields derived or set by default.
+Users are encouraged to switch to the JRA55 (see :ref:`JRA55forcing`) dataset. This
+atmosphere forcing dataset may be deprecated in the future.
+
+
 .. _defaultforcing:
 
 Default Atmosphere Forcing

diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst
@@ -542,6 +542,7 @@ forcing_nml
    "", "``JRA55_gx1``", "JRA55 forcing data for gx1 grid :cite:`Tsujino18`", ""
    "", "``JRA55_gx3``", "JRA55 forcing data for gx3 grid :cite:`Tsujino18`", ""
    "", "``JRA55_tx1``", "JRA55 forcing data for tx1 grid :cite:`Tsujino18`", ""
+   "", "``LYq``", "COREII Large-Yeager (AOMIP) forcing data :cite:`Large09`", ""
    "", "``monthly``", "monthly forcing data", ""
    "", "``ncar``", "NCAR bulk forcing data", ""
    "", "``oned``", "column forcing data", ""