modd_teb_optionn.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.
!     ################
      MODULE modd_teb_option_n
!     ################
!
!!****  *MODD_TEB_n - declaration of surface parameters for urban surface
!!
!!    PURPOSE
!!    -------
!     Declaration of surface parameters
!
!!
!!**  IMPLICIT ARGUMENTS
!!    ------------------
!!      None 
!!
!!    REFERENCE
!!    ---------
!!
!!    AUTHOR
!!    ------
!!      V. Masson   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original       01/2004
!!      A. Lemonsu      07/2012         Key for urban hydrology
!!      V. Masson       06/2013         splits module
!
!*       0.   DECLARATIONS
!             ------------
!
USE modd_type_date_surf
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE


TYPE teb_options_t
! TEB scheme option
!
  LOGICAL                        :: lcanopy      ! T: SBL scheme within the canopy
                                                 ! F: no atmospheric layers below forcing level      
  LOGICAL                        :: lgarden      ! T: Urban green areas (call ISBA from TEB)
                                                 ! F: No urban green areas
  CHARACTER(LEN=4)               :: croad_dir    ! TEB option for road directions
                                                 ! 'UNIF' : no specific direction
                                                 ! 'ORIE' : many road ORIEntations
                                                 ! ( one per TEB patch)
  CHARACTER(LEN=4)               :: cwall_opt    ! TEB option for walls
                                                 ! 'UNIF' : uniform walls
                                                 ! 'TWO ' : two separated walls
  CHARACTER(LEN=3)               :: cbld_atype   ! Type of averaging for walls
                                                 ! 'ARI'  : Characteristics are
                                                 !          linearly averaged
                                                 ! 'MAJ ' : Majoritary building in
                                                 !          grid mesh is chosen
  CHARACTER(LEN=6)               :: cz0h         ! TEB option for z0h roof & road
                                                 ! 'MASC95' : Mascart et al 1995
                                                 ! 'BRUT82' : Brustaert     1982
                                                 ! 'KAND07' : Kanda         2007
  CHARACTER(LEN=5)               :: cch_bem      ! BEM option for roof/wall outside convective coefficient
                                                 ! 'DOE-2' : DOE-2 model from
                                                 ! EnergyPlus Engineering reference, p65
  CHARACTER(LEN=3)               :: cbem         ! TEB option for the building energy model
                                                 ! 'DEF':  DEFault version force-restore model from Masson et al. 2002
                                                 ! 'BEM':  Building Energy Model Bueno et al. 2011

  CHARACTER(LEN=3)               :: ctree        ! TEB option for the high vegetation
                                                 ! 'DEF':  DEFault version without radiative, dynamic effects or turbulent fluxes
                                                 ! 'RAD':  only RADiative effects 
                                                 ! 'DYN':  radiative and DYNamic effects 
                                                 ! 'FLX':  radiative, dynamic effects, and turbulent fluxes 
  LOGICAL                        :: lgreenroof   ! T: green roofs (call ISBA from TEB)
  LOGICAL                        :: lhydro       ! T: urban subsoil and hydrology processes
  LOGICAL                        :: lsolar_panel ! T: solar panels on roofs
! 
! type of initialization of vegetation: from cover types (ecoclimap) or parameters prescribed
!
  LOGICAL                        :: lecoclimap   ! T: parameters computed from ecoclimap
!                                                ! F: they are read in the file
!
! General surface: 
!
  REAL, POINTER, DIMENSION(:)   :: xzs           ! orography                        (m)
  REAL, POINTER, DIMENSION(:,:) :: xcover        ! fraction of each ecosystem       (-)
  LOGICAL, POINTER, DIMENSION(:):: lcover        ! GCOVER(i)=T --> ith cover field is not 0.
  INTEGER                       :: nteb_patch    ! number of TEB patches
  REAL, POINTER, DIMENSION(:,:) :: xteb_patch    ! fraction of each TEB patch
!
! Number of layers
!
  INTEGER                       :: nroof_layer   ! number of layers in roofs
  INTEGER                       :: nroad_layer   ! number of layers in roads
  INTEGER                       :: nwall_layer   ! number of layers in walls
!
! Date:
!
  type(date_time)              :: ttime         ! current date and time
!
! Time-step:
!
  REAL                          :: xtstep        ! time step for TEB
!
  REAL                          :: xout_tstep    ! TEB output writing time step
!
END TYPE teb_options_t



CONTAINS
!----------------------------------------------------------------------------

!




SUBROUTINE teb_options_init(YTEB_OPTIONS)
TYPE(teb_options_t), INTENT(INOUT) :: YTEB_OPTIONS
REAL(KIND=JPRB) :: ZHOOK_HANDLE
IF (lhook) CALL dr_hook("MODD_TEB_N:TEB_OPTIONS_INIT",0,zhook_handle)
  NULLIFY(yteb_options%XZS)
  NULLIFY(yteb_options%XCOVER)
  NULLIFY(yteb_options%LCOVER)
  NULLIFY(yteb_options%XTEB_PATCH)
yteb_options%LCANOPY=.false.
yteb_options%LGARDEN=.false.
yteb_options%CROAD_DIR=' '
yteb_options%CWALL_OPT=' '
yteb_options%CBLD_ATYPE=' '
yteb_options%CZ0H=' '
yteb_options%CCH_BEM=' '
yteb_options%CBEM=' '
yteb_options%CTREE=' '
yteb_options%LGREENROOF=.false.
yteb_options%LHYDRO=.false.
yteb_options%LSOLAR_PANEL=.false.
yteb_options%LECOCLIMAP=.false.
yteb_options%NTEB_PATCH=0
yteb_options%NROOF_LAYER=0
yteb_options%NROAD_LAYER=0
yteb_options%NWALL_LAYER=0
yteb_options%XTSTEP=0.
yteb_options%XOUT_TSTEP=0.
IF (lhook) CALL dr_hook("MODD_TEB_N:TEB_OPTIONS_INIT",1,zhook_handle)
END SUBROUTINE teb_options_init


!----------------------------------------------------------------------------
END MODULE modd_teb_option_n