Merge pull request NASA-LIS#1321 from dmocko/feature/geos-it-forcing

Add GEOS-IT as a metforcing for LIS

lis/configs/lis.config.adoc

@@ -351,6 +351,7 @@ Acceptable values for the sources are:
 |"`GLDAS`"                     | GLDAS
 |"`GFS`"                       | GFS
 |"`MERRA2`"                    | MERRA2
+|"`GEOS-IT`"                   | GEOS-IT
 |"`CMAP`"                      | CMAP
 |"`TRMM 3B42RT`"               | TRMM 3B42RT
 |"`TRMM 3B42RTV7`"             | TRMM 3B42RTV7
@@ -5580,7 +5581,6 @@ GFS domain y-dimension size:      256
 GFS number of forcing variables:  10
 ....
 
-
 [[sssec_forcings_MERRA2,MERRA2]]
 ==== MERRA2
 
@@ -5636,6 +5636,50 @@ MERRA2 use 2m wind fields:                 0
 MERRA2 use corrected total precipitation:  1
 ....
 
+[[sssec_forcings_GEOS-IT,GEOS-IT]]
+==== GEOS-IT
+
+`GEOS-IT forcing directory:` specifies the location of
+the GEOS-IT forcing files.
+
+Please note that GEOS-IT is currently in production and is
+not complete for all calendar years.  Also, it is not yet
+available outside of NASA`'s NCCS computing platforms.
+Also, the topographic or elevation correction option is
+supported through the MERRA-2 geopotential terrain height
+file.  Please also see the latest LDT notes for updates on
+how to use this option.
+
+`GEOS-IT use lowest model level forcing:` specifies whether
+to use the lowest model level forcing.
+Acceptable values are:
+
+|====
+|Value | Description
+
+|0     | Do not use the lowest model level forcing.
+|1     | Use the lowest model level forcing.
+|====
+
+`GEOS-IT use 2m wind fields:` specifies whether to use the
+2m diagnosed wind fields.  This option will only work if
+the lowest model level forcing option is turned off.
+Acceptable values are:
+
+|====
+|Value | Description
+
+|0     | Do not use the 2m diagnosed wind speed fields.
+|1     | Use the 2m diagnosed wind speed fields.
+|====
+
+.Example _lis.config_ entry
+....
+GEOS-IT forcing directory:                  ./GEOS-IT
+GEOS-IT use lowest model level forcing:     1
+GEOS-IT use 2m wind fields:                 0 
+....
+
 [[sssec_forcings_ERA5,ERA5]]
 ==== ERA5
 

lis/make/default.cfg

@@ -282,6 +282,11 @@ enabled: True
 macro: MF_MERRA2
 path: metforcing/merra2
 
+[GEOS-IT]
+enabled: True
+macro: MF_GEOS_IT
+path: metforcing/geos_it
+
 [ERA5]
 enabled: True
 macro: MF_ERA5

lis/metforcing/geos_it/0Intro_geosit.txt

@@ -0,0 +1,14 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.4
+!
+! Copyright (c) 2022 United States Government as represented by the
+! Administrator of the National Aeronautics and Space Administration.
+! All Rights Reserved.
+!-------------------------END NOTICE -- DO NOT EDIT-----------------------
+!
+!BOP
+!\section{GEOS-IT}
+!This section describes the implementation of the GEOS-IT forcing data.
+!EOP

lis/metforcing/geos_it/finalize_geosit.F90

@@ -0,0 +1,72 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.4
+!
+! Copyright (c) 2022 United States Government as represented by the
+! Administrator of the National Aeronautics and Space Administration.
+! All Rights Reserved.
+!-------------------------END NOTICE -- DO NOT EDIT-----------------------
+!BOP
+! !ROUTINE: finalize_geosit
+! \label{finalize_geosit}
+!
+! !REVISION HISTORY:
+! 18 Mar 2015: James Geiger, initial code (based on merra-land)
+! 20 Apr 2023: David Mocko,  initial code (based on merra2)
+!
+! !INTERFACE:
+      subroutine finalize_geosit(findex)
+
+! !USES:
+      use LIS_coreMod,     only   : LIS_rc
+      use geosit_forcingMod, only : geosit_struc
+!
+! !DESCRIPTION:
+!  Routine to cleanup GEOS-IT forcing related memory allocations.
+!
+!EOP
+      implicit none
+
+      integer :: findex
+      integer :: n
+
+      do n = 1,LIS_rc%nnest
+         select case( LIS_rc%met_interp(findex) )
+
+         case( "bilinear" )
+            deallocate(geosit_struc(n)%n111)
+            deallocate(geosit_struc(n)%n121)
+            deallocate(geosit_struc(n)%n211)
+            deallocate(geosit_struc(n)%n221)
+            deallocate(geosit_struc(n)%w111)
+            deallocate(geosit_struc(n)%w121)
+            deallocate(geosit_struc(n)%w211)
+            deallocate(geosit_struc(n)%w221)
+
+         case( "budget-bilinear" )
+            deallocate(geosit_struc(n)%n111)
+            deallocate(geosit_struc(n)%n121)
+            deallocate(geosit_struc(n)%n211)
+            deallocate(geosit_struc(n)%n221)
+            deallocate(geosit_struc(n)%w111)
+            deallocate(geosit_struc(n)%w121)
+            deallocate(geosit_struc(n)%w211)
+            deallocate(geosit_struc(n)%w221)
+            deallocate(geosit_struc(n)%n112)
+            deallocate(geosit_struc(n)%n122)
+            deallocate(geosit_struc(n)%n212)
+            deallocate(geosit_struc(n)%n222)
+            deallocate(geosit_struc(n)%w112)
+            deallocate(geosit_struc(n)%w122)
+            deallocate(geosit_struc(n)%w212)
+            deallocate(geosit_struc(n)%w222)
+
+         case( "neighbor" )
+            deallocate(geosit_struc(n)%n113)
+         end select
+      enddo
+      deallocate(geosit_struc)
+
+      end subroutine finalize_geosit
+