init_trip_diag.F90

Go to the documentation of this file.

!     #########
      SUBROUTINE init_trip_diag (TPDG, TPG, &
                                  KLISTING,HFILE,KLON,KLAT,HTITLE,HTIMEUNIT,OTIME)
!     #######################################################################
!
!!****  *INIT_TRIP_DIAG*  
!!
!!    PURPOSE
!!    -------
!
!     Define the name and unit of each trip output variable.
!     
!!    REFERENCE
!!    ---------
!!      
!!    AUTHOR
!!    ------
!!      B. Decharme
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    27/05/08 
!-------------------------------------------------------------------------------
!
!*       0.     DECLARATIONS
!               ------------
!
!
!
USE modd_trip_diag, ONLY : trip_diag_t
USE modd_trip_grid, ONLY : trip_grid_t
!
USE mode_trip_netcdf
!
USE modn_trip_run,   ONLY : ldiag_misc
USE modn_trip,       ONLY : cgroundw, cvit, lflood
!
USE modd_trip_oasis, ONLY : lcpl_land
!
USE modd_trip_par, ONLY : xundef, 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_diag_t), INTENT(INOUT) :: TPDG
TYPE(trip_grid_t), INTENT(INOUT) :: TPG
!
 CHARACTER(LEN=*), INTENT(IN) :: HFILE, HTITLE, HTIMEUNIT
!
INTEGER, INTENT(IN)          :: KLISTING, KLON, KLAT
!
LOGICAL, INTENT(IN)          :: OTIME
!
!*      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
!
REAL, DIMENSION(:), ALLOCATABLE ::  ZLON
REAL, DIMENSION(:), ALLOCATABLE ::  ZLAT
!
INTEGER :: INDIAG, INCID, INUM
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
!
! * Number of output variable
!
IF (lhook) CALL dr_hook('INIT_TRIP_DIAG',0,zhook_handle)
inum   = 0
indiag = 2
IF(ldiag_misc) indiag = indiag + 1
IF(lcpl_land.AND.ldiag_misc) indiag = indiag + 2
IF(cvit=='VAR')     indiag = indiag + 2
IF(cgroundw/='DEF') indiag = indiag + 2
IF(cgroundw=='DIF')THEN 
  indiag = indiag + 3
  IF(ldiag_misc)indiag = indiag + 2
ENDIF
IF(lflood)THEN
  indiag = indiag + 3
  IF(ldiag_misc) indiag = indiag + 8
ENDIF
!
! * Allocate netcdf file attributs
!
ALLOCATE(yvname(indiag))
ALLOCATE(yvlname(indiag))
ALLOCATE(yunit(indiag))
!
ALLOCATE(zlon(klon))
ALLOCATE(zlat(klat))
!
! * Initialyse netcdf file attributs
!
inum = inum + 1
yvname(inum) = 'SURF_STO                  '
yvlname(inum) = 'River storage             '
yunit(inum) = 'kg m-2                    '
!
inum = inum + 1
yvname(inum) = 'QDIS                      '
yvlname(inum) = 'Discharge                 '
yunit(inum) = 'm3 s-1                    '
!
IF(ldiag_misc)THEN
! 
  inum = inum + 1
  yvname(inum) = 'QSIN                      '
  yvlname(inum) = 'Inflow to the river       '
  yunit(inum) = 'm3 s-1                    '
! 
ENDIF
!
IF(lcpl_land.AND.ldiag_misc)THEN
! 
  inum = inum + 1
  yvname(inum) = 'RUNOFF                    '
  yvlname(inum) = 'Input surface runoff (can be used to force TRIP offline)'
  yunit(inum) = 'mm of water               '
! 
  inum = inum + 1
  yvname(inum) = 'DRAIN                     '
  yvlname(inum) = 'Input drainage or recharge (can be used to force TRIP offline)'
  yunit(inum) = 'mm of water               '  
! 
ENDIF
!
IF(cgroundw/='DEF')THEN
!        
  inum = inum + 1
  yvname(inum) = 'QGF'
  yvlname(inum) = 'Groundwater-river exchange'
  yunit(inum) = 'm3 s-1                    '
!
  inum = inum + 1
  yvname(inum) = 'GROUND_STO                '
  IF(cgroundw=='CST')THEN
    yvlname(inum) = 'Groundwater storage     '
  ELSEIF(cgroundw=='DIF')THEN
    yvlname(inum) = 'Groundwater mass equivalent'
  ENDIF
  yunit(inum) = 'kg m-2                    '
!
ENDIF
!
IF(cgroundw=='DIF')THEN
!
  inum = inum + 1
  yvname(inum) = 'HGROUND                   '
  yvlname(inum) = 'Groundwater height        '
  yunit(inum) = 'm                         '
!
  inum = inum + 1
  yvname(inum) = 'FWTD                      '
  yvlname(inum) = 'grid-cell fraction of wtd '
  yunit(inum) = '-                         '
!
  inum = inum + 1
  yvname(inum) = 'WTD                       '
  yvlname(inum) = 'Wat Tab Depth for coupling'
  yunit(inum) = 'm                         '
!
  IF(ldiag_misc)THEN
!
    inum = inum + 1
    yvname(inum) = 'QGCELL                    ' 
    yvlname(inum) = 'Grid-cell fluxes budget   '
    yunit(inum) = 'm3 s-1                    '
!
    inum = inum + 1
    yvname(inum)= 'HGHRIV                     '
    yvlname(inum)= 'Hground - Hriver           '
    yunit(inum)= 'm                          '
!
  ENDIF
!
ENDIF
!
IF(cvit=='VAR')THEN
!
  inum = inum + 1
  yvname(inum) = 'VEL                       '
  yvlname(inum) = 'Stream flow velocity      '
  yunit(inum) = 'm s-1                     '
!
  inum = inum + 1
  yvname(inum) = 'HSTREAM                   '
  yvlname(inum) = 'Stream river height       '
  yunit(inum) = 'm                         '
!
ENDIF
!
IF(lflood)THEN
!        
  inum = inum + 1
  yvname(inum) = 'FLOOD_STO                 '
  yvlname(inum) = 'Floodplain storage        '
  yunit(inum) = 'kg m-2                    '
!
  inum = inum + 1
  yvname(inum) = 'FFLOOD                    '
  yvlname(inum) = 'TRIP flooded fraction     '
  yunit(inum) = '-                         '
!
  inum = inum + 1
  yvname(inum) = 'HFLOOD                    '
  yvlname(inum) = 'Flood depth               '
  yunit(inum) = 'm                         '
!
  IF(ldiag_misc)THEN
!
    inum = inum + 1
    yvname(inum)= 'FSOURCE                      '
    yvlname(inum)= 'Floodplains source (Pf-Ef-If) (can be used to force TRIP offline)'
    yunit(inum)= 'mm of water                  '
!
    inum = inum + 1
    yvname(inum)= 'VFIN                      '
    yvlname(inum)= 'River to flood velocity   '
    yunit(inum)= 'm s-1                     '
!
    inum = inum + 1
    yvname(inum)= 'QRF                       '
    yvlname(inum)= 'River flow to floodplain  '
    yunit(inum)= 'm3 s-1                    '
!
    inum = inum + 1
    yvname(inum)= 'VFOUT                     '
    yvlname(inum)= 'Flood to river velocity   '
    yunit(inum)= 'm s-1                     '
!
    inum = inum + 1
    yvname(inum)= 'QFR                       '
    yvlname(inum)= 'Flood flow to river       '
    yunit(inum)= 'm3 s-1                    '
!
    inum = inum + 1
    yvname(inum)= 'HSF                         '
    yvlname(inum)= 'River-Flood depth comparison'
    yunit(inum)= 'm                           '
!
    inum = inum + 1
    yvname(inum)= 'WF                          '
    yvlname(inum)= 'Flood width during dt       '
    yunit(inum)= 'm                           '
!
    inum = inum + 1
    yvname(inum)= 'LF                          '
    yvlname(inum)= 'Flood lenght during dt      '
    yunit(inum)= 'm                           '
!
  ENDIF
!
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)
!
 CALL nccreate(klisting,yfile,ytitle,ytimeunit,yvname,yvlname,yunit,zlon,zlat,xundef,lncprint,incid,otime)
!
 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_TRIP_DIAG',1,zhook_handle)
!
!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
END SUBROUTINE init_trip_diag