read_nam_pgd_cover.F90

Go to the documentation of this file.

!SFX_LIC Copyright 1994-2014 CNRS, Meteo-France and Universite Paul Sabatier
!SFX_LIC This is part of the SURFEX software governed by the CeCILL-C licence
!SFX_LIC version 1. See LICENSE, CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt  
!SFX_LIC for details. version 1.
!     #########
      SUBROUTINE read_nam_pgd_cover(HPROGRAM, HCOVER, HFILETYPE, PUNIF_COVER,  &
                                    prm_cover, prm_coast, prm_lake, orm_river, &
                                    prm_sea, oorca_grid, plat_ant, oimp_cover  )  
!     ##############################################################
!
!!**** *READ_NAM_PGD_COVER* reads namelist for Cover
!!
!!    PURPOSE
!!    -------
!!
!!    METHOD
!!    ------
!!   
!
!!    EXTERNAL
!!    --------
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!    AUTHOR
!!    ------
!!
!!    B. Decharme        Meteo-France
!!
!!    MODIFICATION
!!    ------------
!!
!!    Original    02/2010
!----------------------------------------------------------------------------
!
!*    0.     DECLARATION
!            -----------
!
USE modd_data_cover_par, ONLY : jpcover
!
USE modi_get_luout
USE modi_open_namelist
USE modi_close_namelist
!
USE mode_pos_surf
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*    0.1    Declaration of arguments
!            ------------------------
!                                   
 CHARACTER(LEN=6),    INTENT(IN)    :: hprogram    ! Type of program
 CHARACTER(LEN=28),   INTENT(OUT)   :: hcover      ! file name for cover types
 CHARACTER(LEN=6),    INTENT(OUT)   :: hfiletype   ! data file type
REAL, DIMENSION(:),  INTENT(OUT)   :: punif_cover ! value of each cover (cover will be uniform on the horizontal)
REAL,                INTENT(OUT)   :: prm_cover   ! limit of coverage under which the cover is removed. Default is 1.E-6
REAL,                INTENT(OUT)   :: prm_coast   ! limit of coast coverage
REAL,                INTENT(OUT)   :: prm_lake    ! limit of inland lake coverage                                       
LOGICAL,             INTENT(OUT)   :: orm_river   ! delete river coverage                                       
REAL,                INTENT(OUT)   :: prm_sea     ! limit of sea coverage
LOGICAL,             INTENT(OUT)   :: oorca_grid  ! flag to compatibility between Surfex and Orca grid 
REAL,                INTENT(OUT)   :: plat_ant    ! Lattitude limit from Orca grid (Antartic)
LOGICAL,             INTENT(OUT)   :: oimp_cover  ! Imposed values for Cover from another PGD file
!
!
!*    0.2    Declaration of local variables
!            ------------------------------
!
INTEGER                           :: iluout    ! output listing logical unit
INTEGER                           :: ilunam    ! namelist file logical unit
LOGICAL                           :: gfound    ! flag when namelist is present
!
!*    0.3    Declaration of namelists
!            ------------------------
!
REAL, DIMENSION(JPCOVER) :: xunif_cover ! value of each cover (cover will be
!                                                   uniform on the horizontal)
!
 CHARACTER(LEN=28)        :: ycover      ! file name for cover types
 CHARACTER(LEN=6)         :: ycoverfiletype   ! data file type
REAL                     :: xrm_cover   ! limit of coverage under which the
                                        ! cover is removed. Default is 1.E-6
REAL                     :: xrm_coast   ! limit of coast coverage under which
                                        ! the coast is replaced by sea or
                                        ! inland water. Default is 1.
!
REAL                     :: xrm_lake    ! limit of inland lake coverage under which
                                        ! the water is removed. Default is 0.0
!
LOGICAL                  :: lrm_river   ! delete inland river coverage. Default is false
!                                        
REAL                     :: xrm_sea     ! limit of sea coverage under which
                                        ! the sea is removed. Default is 0.0
!
LOGICAL                  :: lorca_grid  ! flag to compatibility between Surfex and Orca grid 
                                        ! (Earth Model over Antarctic)
REAL                     :: xlat_ant    ! Lattitude limit from Orca grid (Antartic)
!
LOGICAL                  :: limp_cover  ! Imposed values for Cover from another PGD file
REAL(KIND=JPRB) :: zhook_handle
!
namelist/nam_cover/ ycover, ycoverfiletype, xunif_cover, xrm_cover, xrm_coast,     &
                    xrm_lake, lrm_river, xrm_sea, lorca_grid, xlat_ant, limp_cover  
!
!-------------------------------------------------------------------------------
!
!*    1.      Initializations of defaults
!             ---------------------------
!
IF (lhook) CALL dr_hook('READ_NAM_PGD_COVER',0,zhook_handle)
xunif_cover(:) = 0.
ycover         = '                          '
ycoverfiletype = '      '
xrm_cover      = 1.e-6
xrm_coast      = 1.0
xrm_lake       = 0.0
lrm_river      = .false.
xrm_sea        = 0.0
!
lorca_grid     = .false.
xlat_ant       = -77.0
!
limp_cover     = .false.
!
 CALL get_luout(hprogram,iluout)
!
!-------------------------------------------------------------------------------
!
!*    2.      Reading of namelist
!             -------------------
!
 CALL open_namelist(hprogram,ilunam)
!
 CALL posnam(ilunam,'NAM_COVER',gfound,iluout)
IF (gfound) READ(unit=ilunam,nml=nam_cover)
!
 CALL close_namelist(hprogram,ilunam)
!
!-------------------------------------------------------------------------------
!
hcover      = ycover      ! file name for cover types
hfiletype   = ycoverfiletype   ! data file type
punif_cover = xunif_cover ! value of each cover (cover will be uniform on the horizontal)
prm_cover   = xrm_cover   ! limit of coverage under which the cover is removed. Default is 1.E-6
prm_coast   = xrm_coast   ! limit of coast coverage
prm_lake    = xrm_lake    ! limit of inland lake coverage                                       
orm_river   = lrm_river   ! delete river coverage                                       
prm_sea     = xrm_sea     ! limit of sea coverage
oorca_grid  = lorca_grid  ! flag to compatibility between Surfex and Orca grid 
plat_ant    = xlat_ant    ! Lattitude limit from Orca grid (Antartic)
oimp_cover  = limp_cover  ! Imposed values for Cover from another PGD file
IF (lhook) CALL dr_hook('READ_NAM_PGD_COVER',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!
END SUBROUTINE read_nam_pgd_cover