write_diag_seb_tebn.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 write_diag_seb_teb_n (DTCO, HSELECT, U, CHT, DGO, D, DUT, HPROGRAM)
!     #################################
!
!!****  *WRITE_DIAG_SEB_TEB_n* - writes TEB diagnostics
!!
!!    PURPOSE
!!    -------
!!
!!
!!**  METHOD
!!    ------
!!          
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      V. Masson   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    01/2004
!!      Modified    01/2006 : TEB flux parameterization.
!!       V. Masson  10/2013 : Adds heat/cold stress ranges diagnostics
!!      B. Decharme 02/2016 : NBLOCK instead of LCOUNTW for compilation in AAA
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
!
USE modd_data_cover_n, ONLY : data_cover_t
USE modd_diag_n, ONLY : diag_options_t, diag_t
USE modd_surf_atm_n, ONLY : surf_atm_t
USE modd_ch_teb_n, ONLY : ch_teb_t
USE modd_diag_utci_teb_n, ONLY : diag_utci_teb_t
!
USE modd_xios, ONLY : lallow_add_dim, yswband_dim_name
!
USE modd_surf_par,  ONLY : xundef
USE modd_utci
!
#ifdef SFX_ARO
USE modd_io_surf_aro,   ONLY : nblock
#endif
!
#ifdef SFX_OL
USE modd_io_surf_ol, ONLY : ldef
#endif
!
USE modi_init_io_surf_n
USE modi_write_surf
USE modi_end_io_surf_n
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
!
TYPE(data_cover_t), INTENT(INOUT) :: DTCO
 CHARACTER(LEN=*), DIMENSION(:), INTENT(IN) :: HSELECT
TYPE(surf_atm_t), INTENT(INOUT) :: U
TYPE(ch_teb_t), INTENT(INOUT) :: CHT
TYPE(diag_options_t), INTENT(INOUT) :: DGO
TYPE(diag_t), INTENT(INOUT) :: D
TYPE(diag_utci_teb_t), INTENT(INOUT) :: DUT
!
 CHARACTER(LEN=6),  INTENT(IN)  :: HPROGRAM ! program calling
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER           :: IRESP          ! IRESP  : return-code if a problem appears
 CHARACTER(LEN=12) :: YRECFM         ! Name of the article to be read
 CHARACTER(LEN=100):: YCOMMENT       ! Comment string
 CHARACTER(LEN=2)  :: YNUM
!
LOGICAL           :: GRESET
INTEGER           :: JSV, JSW
INTEGER           :: JSTRESS         ! loop on heat stress ranges
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!-------------------------------------------------------------------------------
!
!         Initialisation for IO
!
IF (lhook) CALL dr_hook('WRITE_DIAG_SEB_TEB_N',0,zhook_handle)
!
greset=.true.
#ifdef SFX_ARO
greset=(nblock>0)
#endif
#ifdef SFX_OL
IF (ldef) greset = .false.
#endif
!
 CALL init_io_surf_n(dtco, u,   hprogram,'TOWN  ','TEB   ','WRITE','TEB_DIAGNOSTICS.OUT.nc')
!
!
!
!*       2.     Richardson number :
!               -----------------
!
IF (dgo%N2M>=1) THEN

  yrecfm='RI_TEB'
  ycomment='X_Y_'//yrecfm
  CALL write_surf(hselect,hprogram,yrecfm,d%XRI(:),iresp,hcomment=ycomment)
  !
END IF
!
!*       3.     Energy fluxes :
!               -------------
!
IF (dgo%LSURF_BUDGET) THEN

  yrecfm='RN_TEB'
  ycomment='X_Y_'//yrecfm//' (W/m2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XRN(:),iresp,hcomment=ycomment)
  !
  yrecfm='H_TEB'
  ycomment='X_Y_'//yrecfm//' (W/m2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XH(:),iresp,hcomment=ycomment)
  !
  yrecfm='LE_TEB'
  ycomment='X_Y_'//yrecfm//' (W/m2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XLE(:),iresp,hcomment=ycomment)
  !
  yrecfm='GFLUX_TEB'
  ycomment='X_Y_'//yrecfm//' (W/m2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XGFLUX(:),iresp,hcomment=ycomment)
  !
  IF (dgo%LRAD_BUDGET) THEN
    !        
    yrecfm='SWD_TEB'
    ycomment='X_Y_'//yrecfm//' (W/m2)'
    CALL write_surf(hselect,hprogram,yrecfm,d%XSWD(:),iresp,hcomment=ycomment)
    !
    yrecfm='SWU_TEB'
    ycomment='X_Y_'//yrecfm//' (W/m2)'
    CALL write_surf(hselect,hprogram,yrecfm,d%XSWU(:),iresp,hcomment=ycomment)
    !
    yrecfm='LWD_TEB'
    ycomment='X_Y_'//yrecfm//' (W/m2)'
    CALL write_surf(hselect,hprogram,yrecfm,d%XLWD(:),iresp,hcomment=ycomment)
    !
    yrecfm='LWU_TEB'
    ycomment='X_Y_'//yrecfm//' (W/m2)'
    CALL write_surf(hselect,hprogram,yrecfm,d%XLWU(:),iresp,hcomment=ycomment)
    !
    IF (lallow_add_dim)  THEN
      !
      yrecfm='SWD_TEB'
      ycomment='X_Y_'//yrecfm//' (W/m2)'
      CALL write_surf(hselect,&
           hprogram,yrecfm,d%XSWBD(:,:),iresp,hcomment=ycomment, hnam_dim=yswband_dim_name)
      !
      yrecfm='SWU_TEB'
      ycomment='X_Y_'//yrecfm//' (W/m2)'
      CALL write_surf(hselect,&
           hprogram,yrecfm,d%XSWBD(:,:),iresp,hcomment=ycomment, hnam_dim=yswband_dim_name)  
      !
    ELSE
      !    
      DO jsw=1, SIZE(d%XSWBD,2)
        ynum=achar(48+jsw)
        !
        yrecfm='SWD_TEB_'//ynum
        ycomment='X_Y_'//yrecfm//' (W/m2)'
        CALL write_surf(hselect,hprogram,yrecfm,d%XSWBD(:,jsw),iresp,hcomment=ycomment)
        !
        yrecfm='SWU_TEB_'//ynum
        ycomment='X_Y_'//yrecfm//' (W/m2)'
        CALL write_surf(hselect,hprogram,yrecfm,d%XSWBU(:,jsw),iresp,hcomment=ycomment)
        !
      ENDDO
      !
    ENDIF
    !
  ENDIF
  !
  yrecfm='FMU_TEB'
  ycomment='X_Y_'//yrecfm//' (kg/ms2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XFMU(:),iresp,hcomment=ycomment)
  !
  yrecfm='FMV_TEB'
  ycomment='X_Y_'//yrecfm//' (kg/ms2)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XFMV(:),iresp,hcomment=ycomment)
  !
END IF
!
!
!
!*       4.     Transfer coefficients
!               ---------------------
!
IF (dgo%LCOEF) THEN

  yrecfm='CD_TEB'
  ycomment='X_Y_'//yrecfm
  CALL write_surf(hselect,hprogram,yrecfm,d%XCD(:),iresp,hcomment=ycomment)
  !
  yrecfm='CH_TEB'
  ycomment='X_Y_'//yrecfm
  CALL write_surf(hselect,hprogram,yrecfm,d%XCH(:),iresp,hcomment=ycomment)
  !
  yrecfm='CE_TEB'
  ycomment='X_Y_'//yrecfm
  CALL write_surf(hselect,hprogram,yrecfm,d%XCE(:),iresp,hcomment=ycomment)
  !
  yrecfm='Z0_TEB'
  ycomment='X_Y_'//yrecfm//' (M)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XZ0(:),iresp,hcomment=ycomment)
  !
  yrecfm='Z0H_TEB'
  ycomment='X_Y_'//yrecfm//' (M)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XZ0H(:),iresp,hcomment=ycomment)
  !
ENDIF
!
!
!*       5.     Surface humidity
!               ----------------
!
IF (dgo%LSURF_VARS) THEN

  yrecfm='QS_TEB'
  ycomment='X_Y_'//yrecfm//' (KG/KG)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XQS(:),iresp,hcomment=ycomment)
  !
ENDIF

!
!*       5.     parameters at 2 and 10 meters :
!               -----------------------------
!
IF (dgo%N2M>=1) THEN

  yrecfm='T2M_TEB'
  ycomment='X_Y_'//yrecfm//' (K)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XT2M(:),iresp,hcomment=ycomment)
  !
  yrecfm='T2MMIN_TEB'
  ycomment='X_Y_'//yrecfm//' (K)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XT2M_MIN(:),iresp,hcomment=ycomment)
  IF(greset)d%XT2M_MIN(:)=xundef
  !
  yrecfm='T2MMAX_TEB'
  ycomment='X_Y_'//yrecfm//' (K)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XT2M_MAX(:),iresp,hcomment=ycomment)
  IF(greset)d%XT2M_MAX(:)=-xundef
  !
  yrecfm='Q2M_TEB'
  ycomment='X_Y_'//yrecfm//' (KG/KG)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XQ2M(:),iresp,hcomment=ycomment)
  !
  yrecfm='HU2M_TEB'
  ycomment='X_Y_'//yrecfm//' (KG/KG)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XHU2M(:),iresp,hcomment=ycomment)
  !
  yrecfm='HU2MMIN_TEB'
  ycomment='X_Y_'//yrecfm//' (-)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XHU2M_MIN(:),iresp,hcomment=ycomment)
  IF(greset)d%XHU2M_MIN(:)=xundef
  !
  yrecfm='HU2MMAX_TEB'
  ycomment='X_Y_'//yrecfm//' (-)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XHU2M_MAX(:),iresp,hcomment=ycomment)
  IF(greset)d%XHU2M_MAX(:)=-xundef
  !
  yrecfm='ZON10M_TEB'
  ycomment='X_Y_'//yrecfm//' (M/S)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XZON10M(:),iresp,hcomment=ycomment)
  !
  yrecfm='MER10M_TEB'
  ycomment='X_Y_'//yrecfm//' (M/S)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XMER10M(:),iresp,hcomment=ycomment)
  !
  yrecfm='W10M_TEB'
  ycomment='X_Y_'//yrecfm//' (M/S)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XWIND10M(:),iresp,hcomment=ycomment)
  !
  yrecfm='W10MMAX_TEB'
  ycomment='X_Y_'//yrecfm//' (M/S)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XWIND10M_MAX(:),iresp,hcomment=ycomment)
  IF(greset)d%XWIND10M_MAX(:)=0.0
  !
  yrecfm='SFCO2_TEB'
  ycomment='X_Y_'//yrecfm//' (M.kgCO2.S-1.kgAIR-1)'
  CALL write_surf(hselect,hprogram,yrecfm,d%XSFCO2(:),iresp,hcomment=ycomment)
  !
END IF
!
IF (dut%LUTCI .AND. dgo%N2M >0) THEN
  yrecfm='UTCI_IN'
!RJ: extended ascii should be avoided in I/O
  ycomment='UTCI for person indoor'//' (°C)'
  CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCI_IN(:),iresp,hcomment=ycomment)
  !
  yrecfm='UTCI_OUTSUN'
!RJ: extended ascii should be avoided in I/O
  ycomment='UTCI for person at sun'//' (°C)'
  CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCI_OUTSUN(:),iresp,hcomment=ycomment)
  !
  yrecfm='UTCI_OUTSHAD'
!RJ: extended ascii should be avoided in I/O
  ycomment='UTCI for person in shade'//' (°C)'
  CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCI_OUTSHADE(:),iresp,hcomment=ycomment)
  !
  yrecfm='TRAD_SUN'
  ycomment='Mean radiant temperature seen by person at sun'//' (K)'
  CALL write_surf(hselect,hprogram,yrecfm,dut%XTRAD_SUN(:),iresp,hcomment=ycomment)
  !
  yrecfm='TRAD_SHADE'
  ycomment='Mean radiant temperature seen by person in shade'//' (K)'
  CALL write_surf(hselect,hprogram,yrecfm,dut%XTRAD_SHADE(:),iresp,hcomment=ycomment)
  !
  DO jstress=1,nutci_stress
    yrecfm='UTCIC_IN_'//cutci_stress_names(jstress)
    ycomment='Cumulated time spent in '//cutci_stress_names(jstress)//' stress range for person indoor'//' (s)'
    CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCIC_IN(:,jstress),iresp,hcomment=ycomment)
  END DO
  !
  DO jstress=1,nutci_stress
    yrecfm='UTCIC_SU_'//cutci_stress_names(jstress)
    ycomment='Cumulated time spent in '//cutci_stress_names(jstress)//' stress range for person at sun'//' (s)'
    CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCIC_OUTSUN(:,jstress),iresp,hcomment=ycomment)
  END DO
  !
  DO jstress=1,nutci_stress
    yrecfm='UTCIC_SH_'//cutci_stress_names(jstress)
    ycomment='Cumulated time spent in '//cutci_stress_names(jstress)//' stress range for person in shade'//' (s)'
    CALL write_surf(hselect,hprogram,yrecfm,dut%XUTCIC_OUTSHADE(:,jstress),iresp,hcomment=ycomment)
  END DO
END IF
!
!
!*       6.     chemical diagnostics:
!               --------------------
!
IF (cht%SVT%NBEQ>0 .AND. cht%CCH_DRY_DEP=="WES89 ") THEN
  DO jsv = 1,SIZE(cht%CCH_NAMES,1)
    yrecfm='DVTN'//trim(cht%CCH_NAMES(jsv))
    WRITE(ycomment,'(A13,I3.3)')'(m/s) DV_TWN_',jsv
    CALL write_surf(hselect,hprogram,yrecfm,cht%XDEP(:,jsv),iresp,hcomment=ycomment)
  END DO
ENDIF
!-------------------------------------------------------------------------------
!
!         End of IO
!
 CALL end_io_surf_n(hprogram)
IF (lhook) CALL dr_hook('WRITE_DIAG_SEB_TEB_N',1,zhook_handle)
!
!
END SUBROUTINE write_diag_seb_teb_n