HyMAP Version 3 - Initial implementation

ldt/params/HYMAP/read_HYMAP_levee_height.F90

@@ -0,0 +1,67 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 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: read_HYMAP_levee_height
+! \label{read_HYMAP_levee_height}
+!
+! !REVISION HISTORY:
+!  25 Jul 2005: Sujay Kumar; Initial Specification
+!  20 Feb 2006: Sujay Kumar; Modified to support nesting
+!
+! !INTERFACE:
+subroutine read_HYMAP_levee_height(n, array)
+
+! !USES:
+  use ESMF
+  use HYMAP_parmsMod
+  use LDT_coreMod,      only : LDT_rc
+  use LDT_fileIOMod,    only : readLISdata
+  use LDT_logMod,       only : LDT_logunit, LDT_getNextUnitNumber, &
+          LDT_releaseUnitNumber, LDT_endrun
+
+  implicit none
+
+! !ARGUMENTS:
+  integer,          intent(in) :: n
+  real,          intent(inout) :: array(LDT_rc%lnc(n),LDT_rc%lnr(n),1)
+
+  integer :: ftn
+  integer :: c,r
+  logical :: file_exists
+
+  ftn = LDT_getNextUnitNumber()
+
+  inquire(file=trim(HYMAP_struc(n)%leveeheightfile), exist=file_exists)
+  if(.not.file_exists) then
+     write(LDT_logunit,*) '[ERR] HYMAP levee height map, ',&
+          trim(HYMAP_struc(n)%leveeheightfile),', not found.'
+     write(LDT_logunit,*) 'Program stopping ...'
+     call LDT_endrun
+  endif
+
+  open(ftn, file=trim(HYMAP_struc(n)%leveeheightfile), access='direct',&
+       status='old', form="unformatted", convert="big_endian", recl=4)
+
+  call readLISdata(n, ftn, HYMAP_struc(n)%hymap_proj, &
+       HYMAP_struc(n)%hymap_gridtransform, &
+       HYMAP_struc(n)%hymapparms_gridDesc(:), 1, array)  ! 1 = 2D layer
+
+  do r=1,LDT_rc%lnr(n)
+     do c=1,LDT_rc%lnc(n)
+        if(array(c,r,1).lt.0) then
+           array(c,r,1) = LDT_rc%udef
+        endif
+     enddo
+  enddo
+
+  call LDT_releaseUnitNumber(ftn)
+
+end subroutine read_HYMAP_levee_height

ldt/params/HYMAP/read_HYMAP_node_lat.F90

@@ -0,0 +1,59 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 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: read_HYMAP_node_lat
+! \label{read_HYMAP_node_lat}
+!
+! !REVISION HISTORY:
+!  25 Jul 2005: Sujay Kumar; Initial Specification
+!  20 Feb 2006: Sujay Kumar; Modified to support nesting
+!
+! !INTERFACE:
+subroutine read_HYMAP_node_lat(n, array)
+
+! !USES:
+  use ESMF
+  use HYMAP_parmsMod
+  use LDT_coreMod,      only : LDT_rc
+  use LDT_fileIOMod,    only : readLISdata
+  use LDT_logMod,       only : LDT_logunit, LDT_getNextUnitNumber, &
+          LDT_releaseUnitNumber, LDT_endrun
+
+  implicit none
+
+! !ARGUMENTS:
+
+  integer,          intent(in) :: n
+  real,          intent(inout) :: array(LDT_rc%lnc(n),LDT_rc%lnr(n),1)
+
+  integer :: ftn
+  logical :: file_exists
+
+  ftn = LDT_getNextUnitNumber()
+
+  inquire(file=trim(HYMAP_struc(n)%nodelatfile), exist=file_exists)
+  if(.not.file_exists) then
+     write(LDT_logunit,*) '[ERR] HYMAP node latitude map, ',&
+           trim(HYMAP_struc(n)%nodelatfile),', not found.'
+     write(LDT_logunit,*) 'Program stopping ...'
+     call LDT_endrun
+  endif
+
+  open(ftn, file=trim(HYMAP_struc(n)%nodelatfile), access='direct',&
+       status='old', form="unformatted", convert="big_endian", recl=4)
+
+  call readLISdata(n, ftn, HYMAP_struc(n)%hymap_proj, &
+       HYMAP_struc(n)%hymap_gridtransform, &
+       HYMAP_struc(n)%hymapparms_gridDesc(:), 1, array)  ! 1 = 2D layer
+
+  call LDT_releaseUnitNumber(ftn)
+
+end subroutine read_HYMAP_node_lat

ldt/params/HYMAP/read_HYMAP_node_lon.F90

@@ -0,0 +1,58 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 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: read_HYMAP_node_lon
+! \label{read_HYMAP_node_lon}
+!
+! !REVISION HISTORY:
+!  25 Jul 2005: Sujay Kumar; Initial Specification
+!  20 Feb 2006: Sujay Kumar; Modified to support nesting
+!
+! !INTERFACE:
+subroutine read_HYMAP_node_lon(n, array)
+
+! !USES:
+  use ESMF
+  use HYMAP_parmsMod
+  use LDT_coreMod,      only : LDT_rc
+  use LDT_fileIOMod,    only : readLISdata
+  use LDT_logMod,       only : LDT_logunit, LDT_getNextUnitNumber, &
+          LDT_releaseUnitNumber, LDT_endrun
+
+  implicit none
+
+! !ARGUMENTS:
+  integer,          intent(in) :: n
+  real,          intent(inout) :: array(LDT_rc%lnc(n),LDT_rc%lnr(n),1)
+
+  integer :: ftn
+  logical :: file_exists
+
+  ftn = LDT_getNextUnitNumber()
+
+  inquire(file=trim(HYMAP_struc(n)%nodelonfile), exist=file_exists)
+  if(.not.file_exists) then
+     write(LDT_logunit,*) '[ERR] HYMAP node longitude map, ', &
+           trim(HYMAP_struc(n)%nodelonfile),', not found.'
+     write(LDT_logunit,*) 'Program stopping ...'
+     call LDT_endrun
+  endif
+
+  open(ftn, file=trim(HYMAP_struc(n)%nodelonfile), access='direct', &
+       status='old', form="unformatted", convert="big_endian", recl=4)
+
+  call readLISdata(n, ftn, HYMAP_struc(n)%hymap_proj, &
+       HYMAP_struc(n)%hymap_gridtransform, &
+       HYMAP_struc(n)%hymapparms_gridDesc(:), 1, array)  ! 1 = 2D layer
+
+  call LDT_releaseUnitNumber(ftn)
+
+end subroutine read_HYMAP_node_lon

ldt/params/HYMAP/read_HYMAP_urban_drain_outlet.F90

@@ -0,0 +1,70 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 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: read_HYMAP_urban_drain_outlet
+! \label{read_HYMAP_urban_drain_outlet}
+!
+! !REVISION HISTORY:
+!  25 Jul 2005: Sujay Kumar; Initial Specification
+!  20 Feb 2006: Sujay Kumar; Modified to support nesting
+!
+! !INTERFACE:
+subroutine read_HYMAP_urban_drain_outlet(n, array)
+
+! !USES:
+  use ESMF
+  use HYMAP_parmsMod
+  use LDT_coreMod,      only : LDT_rc
+  use LDT_fileIOMod,    only : readLISdata
+  use LDT_logMod,       only : LDT_logunit, LDT_getNextUnitNumber, &
+          LDT_releaseUnitNumber, LDT_endrun
+
+  implicit none
+
+! !ARGUMENTS:
+
+  integer,          intent(in) :: n
+  real,          intent(inout) :: array(LDT_rc%lnc(n),LDT_rc%lnr(n),1)
+
+  integer :: ftn
+  integer :: c,r
+  logical :: file_exists
+
+  ftn = LDT_getNextUnitNumber()
+
+  inquire(file=trim(HYMAP_struc(n)%urbandrainoutletfile), &
+       exist=file_exists)
+  if (.not.file_exists) then
+     write(LDT_logunit,*) '[ERR] HYMAP urban drainage outlet map, ',&
+           trim(HYMAP_struc(n)%urbandrainoutletfile),', not found.'
+     write(LDT_logunit,*) '[ERR] Program stopping ...'
+     call LDT_endrun
+  endif
+
+  open(ftn, file=trim(HYMAP_struc(n)%urbandrainoutletfile), &
+       access='direct', &
+       status='old', form="unformatted", convert="big_endian", recl=4)
+
+  call readLISdata(n, ftn, HYMAP_struc(n)%hymap_proj, &
+       HYMAP_struc(n)%hymap_gridtransform, &
+       HYMAP_struc(n)%hymapparms_gridDesc(:), 1, array)  ! 1 = 2D layer
+
+  do r=1,LDT_rc%lnr(n)
+     do c=1,LDT_rc%lnc(n)
+        if(array(c,r,1).lt.0) then
+           array(c,r,1) = LDT_rc%udef
+        endif
+     enddo
+  enddo
+
+  call LDT_releaseUnitNumber(ftn)
+
+end subroutine read_HYMAP_urban_drain_outlet

ldt/params/HYMAP/read_land_grid_area.F90

@@ -0,0 +1,80 @@
+!-----------------------BEGIN NOTICE -- DO NOT EDIT-----------------------
+! NASA Goddard Space Flight Center
+! Land Information System Framework (LISF)
+! Version 7.5
+!
+! Copyright (c) 2024 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: read_land_grid_area
+! \label{read_land_grid_area}
+!
+! !REVISION HISTORY:
+!  25 Jul 2005: Sujay Kumar; Initial Specification
+!  20 Feb 2006: Sujay Kumar; Modified to support nesting
+!
+! !INTERFACE:
+subroutine read_land_grid_area(n, array)
+
+! !USES:
+  use ESMF
+  use HYMAP_parmsMod
+  use LDT_coreMod,      only : LDT_rc
+  use LDT_fileIOMod,    only : readLISdata
+  use LDT_logMod,       only : LDT_logunit, LDT_getNextUnitNumber, &
+          LDT_releaseUnitNumber, LDT_endrun
+
+  implicit none
+
+! !ARGUMENTS:
+  integer,          intent(in) :: n
+  real,          intent(inout) :: array(LDT_rc%lnc(n),LDT_rc%lnr(n),1)
+
+! !DESCRIPTION:
+!  This subroutine retrieves the bottom temperature climatology for the
+!  specified month and returns the values in the latlon projection
+!
+!  The arguments are:
+!  \begin{description}
+!  \item[n]
+!   index of the nest
+!  \item[mo]
+!   time index (month or quarter)
+!  \item[array]
+!   output field with the retrieved greenness fraction
+!  \end{description}
+!
+!EOP
+  integer :: ftn
+  integer :: c,r
+  logical :: file_exists
+
+  ftn = LDT_getNextUnitNumber()
+
+  inquire(file=trim(HYMAP_struc(n)%landgridareafile), exist=file_exists)
+  if(.not.file_exists) then
+     write(LDT_logunit,*) '[ERR] Land grid area map, ',&
+           trim(HYMAP_struc(n)%landgridareafile),', not found.'
+     write(LDT_logunit,*) '[ERR] Program stopping ...'
+     call LDT_endrun
+  endif
+
+  open(ftn, file=trim(HYMAP_struc(n)%landgridareafile), access='direct',&
+       status='old', form="unformatted", convert="big_endian", recl=4)
+
+  call readLISdata(n, ftn, HYMAP_struc(n)%hymap_proj, &
+       HYMAP_struc(n)%hymap_gridtransform, &
+       HYMAP_struc(n)%hymapparms_gridDesc(:), 1, array)  ! 1 = 2D layer
+  do r=1,LDT_rc%lnr(n)
+     do c=1,LDT_rc%lnc(n)
+        if(array(c,r,1).lt.0) then
+           array(c,r,1) = LDT_rc%udef
+        endif
+     enddo
+  enddo
+  call LDT_releaseUnitNumber(ftn)
+
+end subroutine read_land_grid_area