modd_isba_optionsn.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_isba_options_n
!##################
!
!!****  *MODD_ISBA - declaration of packed surface parameters for ISBA scheme
!!
!!    PURPOSE
!!    -------
!
!!
!!**  IMPLICIT ARGUMENTS
!!    ------------------
!!      None 
!!
!!    REFERENCE
!!    ---------
!!
!!    AUTHOR
!!    ------
!!      A. Boone   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original       20/09/02
!!      A.L. Gibelin    04/2009 : BIOMASS and RESP_BIOMASS arrays 
!!      A.L. Gibelin    04/2009 : TAU_WOOD for NCB option 
!!      A.L. Gibelin    05/2009 : Add carbon spinup
!!      A.L. Gibelin    06/2009 : Soil carbon variables for CNT option
!!      A.L. Gibelin    07/2009 : Suppress RDK and transform GPP as a diagnostic
!!      A.L. Gibelin    07/2009 : Suppress PPST and PPSTF as outputs
!!      P. Samuelsson   02/2012 : MEB
!!
!-------------------------------------------------------------------------------
!
!*       0.   DECLARATIONS
!             ------------
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
TYPE ISba_options_t
!
! *  General PGD options
!
LOGICAL :: lecoclimap         ! T: parameters computed from ecoclimap
!                             ! F: they are read in the file
!
LOGICAL :: lpar               ! T: parameters computed from ecoclimap
!                             ! F: they are read in the file
!
INTEGER :: npatch             ! maximum number of sub-tiles (patches)
!                             ! used at any grid point within a 
!                             ! natural surface fraction
INTEGER :: nground_layer      ! number of ground layers
!
 CHARACTER(LEN=3) :: cisba    ! type of ISBA version:
!                             ! '2-L' (default)
!                             ! '3-L'
!                             ! 'DIF'
 CHARACTER(LEN=4) :: cpedotf  ! NOTE: Only used when HISBA = DIF
!                             ! 'CH78' = Clapp and Hornberger 1978 for BC (Default)
!                             ! 'CO84' = Cosby et al. 1988 for BC
 CHARACTER(LEN=3) :: cphoto   ! type of photosynthesis
!                             ! 'NON'
!                             ! 'AST'
!                             ! 'NIT'
!                             ! 'NCB'
!
REAL, POINTER, DIMENSION(:)  :: xsoilgrid   ! Soil layer grid as reference for DIF
!
LOGICAL :: ltr_ml             ! new radiative transfert
!
REAL :: xrm_patch             ! threshold to remove little fractions of patches 
!
LOGICAL :: lsocp              ! Soil organic carbon profile data
LOGICAL :: lcti               ! Topographic index data
LOGICAL :: lperm              ! Permafrost distribution data
LOGICAL :: lnof  
!
! Type of vegetation (simplification of vegetation charaterization)
!
 CHARACTER(LEN=4)             :: ctype_hveg   ! type of high vegetation
 CHARACTER(LEN=4)             :: ctype_lveg   ! type of low vegetation
 CHARACTER(LEN=4)             :: ctype_nveg   ! type of bare soil (no vegetation)
 CHARACTER(LEN=5)             :: ctyp_cov     ! type of green roof
!
! * AGS and Carbon PGD options
!
INTEGER :: nnbiomass    ! number of biomass pools
INTEGER :: nnlitter     ! number of litter pools
INTEGER :: nnlittlevs   ! number of litter levels
INTEGER :: nnsoilcarb   ! number of soil carbon pools  
!
! * PGD MEB OPTIONS
!
LOGICAL, POINTER, DIMENSION(:) :: lmeb_patch  ! Vector with T/F values
                                              ! True = treat patch with multi-energy balance 
                                              ! False = treat patch with classical ISBA 
LOGICAL                        :: lforc_measure ! True = Forcing data from observations
!                                               ! False = Forcing data from atmospheric model (default)
LOGICAL                        :: lmeb_litter ! Activate Litter
LOGICAL                        :: lmeb_gndres ! Activate Ground Resistance
!
! * General PREP options
!
LOGICAL :: lcanopy ! T: SBL scheme within the canopy
!                  ! F: no atmospheric layers below forcing level
!
! * Carbon PREP options
 CHARACTER(LEN=3) :: crespsl  ! Soil respiration
!                             ! 'DEF' = Default: Norman (1992)
!                             ! 'PRM' = New Parameterization
!                             ! 'CNT' = CENTURY model (Gibelin 2007)
!
!
! * General MODEL options
!
 CHARACTER(LEN=4) :: cc1dry   ! C1 formulation for dry soils
!                             ! 'DEF ' = DEFault: Giard-Bazile formulation
!                             ! 'GB93' = Giordani 1993, Braud 1993 
!                             ! discontinuous at WILT
 CHARACTER(LEN=4) :: cscond   ! Thermal conductivity
!                             ! 'DEF ' = DEFault: NP89 implicit method
!                             ! 'PL98' = Peters-Lidard et al. 1998 used
!                             ! for explicit computation of CG
 CHARACTER(LEN=3) :: csoilfrz ! soil freezing-physics option
!                             ! 'DEF' = Default (Boone et al. 2000; 
!                             !        Giard and Bazile 2000)
!                             ! 'LWT' = Phase changes as above,
!                             !         but relation between unfrozen 
!                             !         water and temperature considered
 CHARACTER(LEN=4) :: cdifsfcond ! Mulch effects
!                               ! 'MLCH' = include the insulating effect of
!                               ! leaf litter/mulch on the surf. thermal cond.
!                               ! 'DEF ' = no mulch effect
!                               NOTE: Only used when YISBA = DIF
 CHARACTER(LEN=3) :: csnowres   ! Turbulent exchanges over snow
!                               ! 'DEF' = Default: Louis (ISBA)
!                               ! 'RIL' = Maximum Richardson number limit
!                               !         for stable conditions ISBA-SNOW3L
!                               !         turbulent exchange option
 CHARACTER(LEN=4) :: calbedo    ! albedo type
!                               ! 'DRY ' 
!                               ! 'EVOL' 
!                               ! 'WET ' 
!                               ! 'USER' 
!                            NOTE that when using the YISBA='DIF' multi-layer soil option,
!                            the 'LWT' method is used. It is only an option
!                            when using the force-restore soil method ('2-L' or '3-L')
 CHARACTER(LEN=3) :: ccpsurf    ! specific heat at surface
!                               ! 'DRY' = default value (dry Cp)
!                               ! 'HUM' = Cp as a fct of specific humidity  
!
REAL :: xout_tstep              ! ISBA output writing time step
REAL :: xtstep                  ! ISBA time step
REAL :: xcgmax                  ! maximum soil heat capacity
REAL :: xcdrag                  ! drag coefficient in canopy
!
LOGICAL :: lglacier             ! True = Over permanent snow and ice, 
!                                 initialise WGI=WSAT,
!                                 Hsnow>=10m and allow 0.8<SNOALB<0.85
                                ! False = No specific treatment
LOGICAL :: lcanopy_drag         ! T: drag activated in SBL scheme within the canopy
!                               ! F: no drag activated in SBL atmospheric layers
LOGICAL :: lvegupd              ! True = update vegetation parameters every decade
LOGICAL :: lpertsurf            ! True  = apply random perturbations for ensemble prediction
                                ! False = no random perturbation (default)
!
!
! * SGH model options
!
! - Adjustable physical parameters
!
INTEGER :: nlayer_hort
INTEGER :: nlayer_dun
!
! - Sub-grid hydrology and vertical hydrology
!                                                     
 CHARACTER(LEN=4) :: crunoff ! surface runoff formulation
!                            ! 'WSAT'
!                            ! 'DT92'
!                            ! 'SGH ' Topmodel
!                                                     
 CHARACTER(LEN=3) :: cksat   ! ksat
!                            ! 'DEF' = default value 
!                            ! 'SGH' = profil exponentiel
!                                           
LOGICAL :: lsoc              ! soil organic carbon effect
!                            ! False = default value 
!                            ! True  = soil SOC profil
!
 CHARACTER(LEN=3) :: crain   ! Rainfall spatial distribution
                             ! 'DEF' = No rainfall spatial distribution
                             ! 'SGH' = Rainfall exponential spatial distribution
                             ! 
!
 CHARACTER(LEN=3) :: chort   ! Horton runoff
                             ! 'DEF' = no Horton runoff
                             ! 'SGH' = Horton runoff
!
! * AGS and carbon options
!
LOGICAL :: lnitro_dilu          ! nitrogen dilution fct of CO2 (Calvet et al. 2008)
                                ! False = keep vegetation parameters constant in time
!
LOGICAL  :: lspinupcarbs  ! T: do the soil carb spinup, F: no
LOGICAL  :: lspinupcarbw  ! T: do the wood carb spinup, F: no  
REAL :: xspinmaxs         ! max number of times CARBON_SOIL subroutine is
                          ! called for each timestep in simulation during
                          ! acceleration procedure number                             
REAL :: xspinmaxw         ! max number of times the wood is accelerated  
REAL :: xco2_start        ! Pre-industrial CO2 concentration
REAL :: xco2_end          ! Begin-transient CO2 concentration
INTEGER :: nnbyearspins   ! nbr years needed to reaches soil equilibrium 
INTEGER :: nnbyearspinw   ! nbr years needed to reaches wood equilibrium
INTEGER :: nnbyearsold    ! nbr years executed at curent time step
INTEGER :: nspins         ! number of times the soil is accelerated
INTEGER :: nspinw         ! number of times the wood is accelerated
!
LOGICAL :: lagri_to_grass ! During soil carbon spinup with ISBA-CC, 
                          ! grass parameters are attributed to all agricultural PFT
!
! * Snow model options
!                                           
LOGICAL :: lsnowdrift, lsnowdrift_sublim ! Logicals for snowdrift and sublimation

LOGICAL :: lsnow_abs_zenith  ! if True modify solar absorption as a function of solar zenithal angle
                             ! (physically wrong but better results in polar regions when CSNOWRAD=B92)
! Scheme of snow metamorphism (Crocus)
 CHARACTER(3) :: csnowmetamo ! B92 (historical version, Brun et al 92), C13, T07, F06 (see Carmagnola et al 2014)
!
! radiative transfer scheme in snow (Crocus)
 CHARACTER(3) :: csnowrad    ! B92 (historical version, Brun et al 92), TAR, TA1, TA2 (see Libois et al 2013)
!
! * Other options
!
LOGICAL :: lflood       ! Activation of the flooding scheme
LOGICAL :: lwtd         ! Activation of Water table depth coupling
LOGICAL :: lcpl_rrm     ! Activation of the coupling
!
LOGICAL :: ltemp_arp      ! True  = time-varying force-restore soil temperature (as in ARPEGE)
                          ! False = No time-varying force-restore soil temperature (Default
INTEGER :: ntemplayer_arp ! Number of force-restore soil temperature layer, including Ts (Default = 4)
                          ! Only used if LTEMP_ARP=True
REAL, POINTER, DIMENSION(:) ::  xsodelx       ! Pulsation for each layer (Only used if LTEMP_ARP=True)
!
END TYPE isba_options_t
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
CONTAINS

SUBROUTINE isba_options_init(IO)
TYPE(isba_options_t), INTENT(INOUT) :: IO
REAL(KIND=JPRB) :: ZHOOK_HANDLE
IF (lhook) CALL dr_hook("MODD_ISBA_OPTIONS_N:ISBA_OPTIONS_INIT",0,zhook_handle)
!
NULLIFY(io%XSOILGRID)
NULLIFY(io%LMEB_PATCH)
!  
io%CTYPE_HVEG='    '
io%CTYPE_LVEG='    '
io%CTYPE_NVEG='    '
io%CTYP_COV='     '
io%LPAR=.false.
io%LECOCLIMAP=.false.
io%NPATCH=0
io%NGROUND_LAYER=0
io%CISBA=' '
io%CPEDOTF=' '
io%CPHOTO=' '
io%LTR_ML=.false.
io%XRM_PATCH=0.0
io%LSOCP=.false.
io%LCTI=.false.
io%LPERM=.false.
io%LNOF=.false.
io%NNBIOMASS=0
io%NNLITTER=0
io%NNLITTLEVS=0
io%NNSOILCARB=0
io%LFORC_MEASURE=.false.
io%LMEB_LITTER=.false.
io%LMEB_GNDRES=.false.
!
io%LCANOPY=.false.
io%CRESPSL=' '
!
io%CC1DRY=' '
io%CSCOND=' '
io%CSOILFRZ=' '
io%CDIFSFCOND=' '
io%CSNOWRES=' '
io%CALBEDO=' '
io%CCPSURF=' '
io%XOUT_TSTEP=0.
io%XTSTEP=0.
io%XCGMAX=0.
io%XCDRAG=0.
io%LGLACIER=.false.
io%LCANOPY_DRAG=.false.
io%LVEGUPD=.false.
io%LPERTSURF=.false.
io%NLAYER_HORT=0
io%NLAYER_DUN=0
io%CRUNOFF=' '
io%CKSAT=' '
io%CRAIN=' '
io%CHORT=' '
io%LSOC=.false.
io%LNITRO_DILU=.false.
io%LSPINUPCARBS=.false.
io%LSPINUPCARBW=.false.
io%XSPINMAXS=0.
io%XSPINMAXW=0.
io%XCO2_START=0.
io%XCO2_END=0.
io%NNBYEARSPINS=0
io%NNBYEARSPINW=0
io%NNBYEARSOLD=0
io%NSPINS=1
io%NSPINW=1
io%LAGRI_TO_GRASS=.false.
io%LSNOWDRIFT=.true.
io%LSNOWDRIFT_SUBLIM=.false.
io%LSNOW_ABS_ZENITH=.false.
io%CSNOWMETAMO='B92'
io%CSNOWRAD='B92'
io%LFLOOD=.false.
io%LWTD=.false.
io%LCPL_RRM=.false.
io%LTEMP_ARP=.false.
io%NTEMPLAYER_ARP=0
!
IF (lhook) CALL dr_hook("MODD_ISBA_OPTIONS_N:ISBA_OPTIONS_INIT",1,zhook_handle)
END SUBROUTINE isba_options_init

END MODULE modd_isba_options_n