init_param_trip.F90

Go to the documentation of this file.

!     #########
      SUBROUTINE init_param_trip (TPG, &
                                   KLISTING,HFILE,KLON,KLAT,HTITLE,HTIMEUNIT)
!     #######################################################################
!
!!****  *INIT_PARAM_TRIP*  
!!
!!    PURPOSE
!!    -------
!
!     Define the name and unit of each trip parameter.
!     
!!    REFERENCE
!!    ---------
!!      
!!    AUTHOR
!!    ------
!!      B. Decharme
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    27/05/08 
!-------------------------------------------------------------------------------
!
!*       0.     DECLARATIONS
!               ------------
!
!
!
USE modd_trip_grid, ONLY : trip_grid_t
!
USE mode_trip_netcdf
!
USE modn_trip,     ONLY : cgroundw, cvit, lflood
USE modd_trip_par, ONLY : xundef, ndimtab, lncprint
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
USE netcdf
!
USE modi_get_lonlat_trip
!
IMPLICIT NONE
!
!
!*      0.1    declarations of arguments
!
!
!
TYPE(trip_grid_t), INTENT(INOUT) :: TPG
!
 CHARACTER(LEN=*), INTENT(IN) :: HFILE, HTITLE, HTIMEUNIT
!
INTEGER, INTENT(IN)          :: KLISTING, KLON, KLAT
!
!*      0.2    declarations of output variables
!
 CHARACTER(LEN=NF90_MAX_NAME), DIMENSION(:), ALLOCATABLE :: YVNAME  !Name of each output variable
 CHARACTER(LEN=NF90_MAX_NAME), DIMENSION(:), ALLOCATABLE :: YVLNAME !Long name of each output variables
 CHARACTER(LEN=NF90_MAX_NAME), DIMENSION(:), ALLOCATABLE :: YUNIT   !Unit of each output variable
!
 CHARACTER(LEN=NF90_MAX_NAME) :: YFILE,YTITLE,YTIMEUNIT
!
LOGICAL, DIMENSION(:), ALLOCATABLE ::  LZLEN
!
REAL,    DIMENSION(:), ALLOCATABLE ::  ZLON
REAL,    DIMENSION(:), ALLOCATABLE ::  ZLAT
LOGICAL, DIMENSION(:), ALLOCATABLE ::  LDOUBLE
!
INTEGER :: INPARAM, INCID, INUM
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
!
! * Number of output variable
!
IF (lhook) CALL dr_hook('INIT_PARAM_TRIP',0,zhook_handle)
!
inparam = 7
IF(cgroundw/='DEF'           )inparam = inparam + 1
IF(cvit=='VAR'               )inparam = inparam + 3
IF(cgroundw=='DIF'           )inparam = inparam + 6
IF(lflood.OR.cgroundw=='DIF')inparam = inparam + 1
IF(lflood                   )inparam = inparam + 4
!
!
! * Allocate netcdf file attributs
!
ALLOCATE(yvname(inparam))
ALLOCATE(yvlname(inparam))
ALLOCATE(yunit(inparam))
ALLOCATE(lzlen(inparam))
ALLOCATE(ldouble(inparam))
!
ALLOCATE(zlon(klon))
ALLOCATE(zlat(klat))
!
! * Initialyse netcdf file attributs
!
yvname(1) = 'FLOWDIR                    '
yvlname(1) = 'Flow direction             '
yunit(1) = '-                          '
lzlen(1) = .false.
ldouble(1) = .false.
!
yvname(2) = 'RIVSEQ                     '
yvlname(2) = 'River sequence             '
yunit(2) = '-                          '
lzlen(2) = .false.
ldouble(2) = .false.
!
yvname(3) = 'RIVLEN                     '
yvlname(3) = 'River length               '
yunit(3) = 'm                          '
lzlen(3) = .false.
ldouble(3) = .true.
!
yvname(4) = 'NUM_BAS                    '
yvlname(4) = 'Trip basin reference number'
yunit(4) = '-                          '
lzlen(4) = .false.
ldouble(4) = .false.
!
yvname(5) = 'CELL_AREA                  '
yvlname(5) = 'Trip cell area             '
yunit(5) = 'm2                         '
lzlen(5) = .false.
ldouble(5) = .true.
!
yvname(6) = 'GREEN_ANT                  '
yvlname(6) = 'Greenland/Antarctic mask   '
yunit(6) = '-                          '
lzlen(6) = .false.
ldouble(6) = .false.
!
yvname(7) = 'DR_AREA                    '
yvlname(7) = 'Trip drainage area         '
yunit(7) = 'm2                         '
lzlen(7) = .false.
ldouble(7) = .true.
!
inum = 7
!
IF(cgroundw/='DEF')THEN
!   
inum = inum + 1
!
yvname(inum) = 'TAUG                      '
yvlname(inum) = 'Groundwater transfert time (0=permafrost area)'
yunit(inum) = 'days                      '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
ENDIF
!
IF(cvit=='VAR')THEN
!
inum = inum + 1
yvname(inum) = 'N_RIV                     '
yvlname(inum) = 'Manning coefficient       '
yunit(inum) = '-                         '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'WIDTHRIV                  '
yvlname(inum) = 'Stream river width        '
yunit(inum) = 'm                         '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'SLOPERIV                  '
yvlname(inum) = 'Stream River slope        '
yunit(inum) = 'm/m                       '
lzlen(inum) = .false.
ldouble(inum) = .true.
!
ENDIF
!
IF(cgroundw=='DIF')THEN
!   
inum = inum + 1
yvname(inum) = 'WEFF                      '
yvlname(inum) = 'Effective porosity        '
yunit(inum) = '                          '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'TRANS                     '
yvlname(inum) = 'Transmissivity'
yunit(inum) = 'm2/s                      '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'NUM_AQUI                  '
yvlname(inum) = 'Numero aquifere           '
yunit(inum) = '                          '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'TOPO_RIV                  '
yvlname(inum) = 'River elevation           '
yunit(inum) = '                          '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
!
yvname(inum) = 'TABGW_F                      '
yvlname(inum) = 'Potential fraction of wt rise'
yunit(inum) = '-                            '
lzlen(inum) = .true.
ldouble(inum) = .false.
!
inum = inum + 1
!
yvname(inum) = 'TABGW_H                      '
yvlname(inum) = 'Subgrid elevation height     '
yunit(inum) = 'm                            '
lzlen(inum) = .true.
ldouble(inum) = .false.
!
ENDIF
!
IF(lflood.OR.cgroundw=='DIF')THEN
!
inum = inum + 1
yvname(inum) = 'RIVDEPTH                  '
yvlname(inum) = 'Stream River Depth (Hc)   '
yunit(inum) = 'm                         '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
ENDIF
!
IF(lflood)THEN
!
inum = inum + 1
yvname(inum) = 'NFLOOD                    '
yvlname(inum) = 'Manning coef for flood    '
yunit(inum) = '-                         '
lzlen(inum) = .false.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum) = 'TABF                      '
yvlname(inum) = 'Potential flood fraction  '
yunit(inum) = '-                         '
lzlen(inum) = .true.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum)= 'TABH                      '
yvlname(inum)= 'Topographic height        '
yunit(inum)= 'm                         '
lzlen(inum)= .true.
ldouble(inum) = .false.
!
inum = inum + 1
yvname(inum)= 'TABVF                     '
yvlname(inum)= 'Potential flood volume    '
yunit(inum)= 'kg/m2                     '
lzlen(inum)= .true.
ldouble(inum) = .false.
!
ENDIF
!
! * Create netcdf file
!
yfile     = hfile(1:len_trim(hfile))
ytitle    = htitle(1:len_trim(htitle))
ytimeunit = htimeunit(1:len_trim(htimeunit))
!
 CALL get_lonlat_trip(tpg, &
                     klon,klat,zlon,zlat)
!
IF(all(.NOT.lzlen(:)))THEN
   CALL nccreate(klisting,yfile,ytitle,ytimeunit,yvname,yvlname,yunit,   &
                   zlon,zlat,xundef,lncprint,incid,.false.,odouble=ldouble)  
ELSE
   CALL nccreate(klisting,yfile,ytitle,ytimeunit,yvname,yvlname,yunit,   &
                   zlon,zlat,xundef,lncprint,incid,.false.,ndimtab,lzlen,odouble=ldouble)  
ENDIF
!
 CALL ncclose(klisting,lncprint,yfile,incid)
!
! * Deallocate netcdf file attributs
!
DEALLOCATE(yvname  )
DEALLOCATE(yvlname )
DEALLOCATE(yunit   )
DEALLOCATE(zlon    )
DEALLOCATE(zlat    )
!
IF (lhook) CALL dr_hook('INIT_PARAM_TRIP',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
END SUBROUTINE init_param_trip