modn_isban.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 modn_isba_n
!##################
!
!!****  *MODN_ISBA_n* - declaration of namelist NAM_ISBA_n
!!
!!    PURPOSE
!!    -------
!       The purpose of this module is to specify  the namelist NAM_ISBA_n
!     which concern the surface configuration of one nested  model.
!
!!
!!**  IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!       
!!    AUTHOR
!!    ------
!!      V. Masson    *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    01/2004                    
!!      Modified    08/2009 by B. Decharme : LSURF_BUDGETC for all tiles
!!      Modified by A.L. Gibelin, 04/2009: add carbon spinup
!!
!-------------------------------------------------------------------------------
!
!*       0.   DECLARATIONS
!             ------------
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
 CHARACTER(LEN=4)  :: cc1dry
 CHARACTER(LEN=4)  :: cscond
 CHARACTER(LEN=3)  :: csoilfrz
 CHARACTER(LEN=4)  :: cdifsfcond
 CHARACTER(LEN=3)  :: csnowres
 CHARACTER(LEN=3)  :: ccpsurf
 CHARACTER(LEN=4)  :: crunoff
 CHARACTER(LEN=3)  :: cksat
LOGICAL           :: lsoc
 CHARACTER(LEN=3)  :: crain
 CHARACTER(LEN=3)  :: chort         
REAL  :: xtstep
REAL  :: xout_tstep
REAL  :: xcgmax
REAL  :: xcdrag
REAL  :: xspinmaxs
REAL  :: xspinmaxw
REAL  :: xco2_start
REAL  :: xco2_end
INTEGER  :: nnbyearspins
INTEGER  :: nnbyearspinw
LOGICAL  :: lpgd
LOGICAL  :: lsurf_evap_budget
LOGICAL  :: lsurf_budget
LOGICAL  :: lrad_budget
LOGICAL  :: lsurf_budgetc
LOGICAL  :: lreset_budgetc
LOGICAL  :: lpatch_budget
LOGICAL  :: lsurf_misc_budget
LOGICAL  :: lsurf_diag_albedo
LOGICAL  :: lsurf_misc_dif
LOGICAL  :: lwater_budget
LOGICAL  :: lprosnow
LOGICAL  :: lvolumetric_snowliq
REAL     :: xdiag_tstep
REAL     :: xalbice1, xalbice2,xalbice3
REAL     :: xrhothreshold_ice
REAL     :: xz0icez0snow
REAL     :: xvaging_noglacier,xvaging_glacier
REAL     :: xpercentagepore
INTEGER  :: n2m
LOGICAL  :: l2m_min_zs
LOGICAL  :: lcoef
LOGICAL  :: lsurf_vars
LOGICAL  :: lch_bio_flux
LOGICAL  :: lch_no_flux
LOGICAL  :: lglacier
LOGICAL  :: lvegupd
LOGICAL  :: lnitro_dilu
LOGICAL  :: lspinupcarbs
LOGICAL  :: lspinupcarbw
LOGICAL  :: lcanopy_drag
LOGICAL  :: lpertsurf
LOGICAL  :: lsnowdrift
LOGICAL  :: lsnowdrift_sublim
LOGICAL  :: lsnow_abs_zenith
 CHARACTER(3) :: csnowmetamo
 CHARACTER(3) :: csnowrad
 CHARACTER(LEN=6)  :: cch_dry_dep
 CHARACTER(LEN=28) :: cchem_surf_file
!
NAMELIST/nam_isban/cc1dry,cscond,csoilfrz,cdifsfcond,csnowres,ccpsurf, &
                     xtstep,xcgmax,xcdrag,lglacier,lcanopy_drag,lvegupd,lpertsurf
NAMELIST/nam_isba_agsn/lnitro_dilu
NAMELIST/nam_sgh_isban/crunoff,cksat,lsoc,crain,chort
NAMELIST/nam_diag_isban/lpgd,lsurf_evap_budget,lsurf_misc_budget,lsurf_diag_albedo,lpatch_budget, &
                        lsurf_misc_dif, lwater_budget, lprosnow, lvolumetric_snowliq
NAMELIST/nam_diag_surfn/n2m,l2m_min_zs,lsurf_budget,lrad_budget, &
                        lsurf_budgetc,lreset_budgetc,lcoef,lsurf_vars
NAMELIST/nam_ch_controln/cchem_surf_file
NAMELIST/nam_ch_isban/lch_bio_flux,cch_dry_dep,lch_no_flux
NAMELIST/nam_spinup_carbn/lspinupcarbs,lspinupcarbw,xspinmaxs,xspinmaxw,nnbyearspins,&
        nnbyearspinw, xco2_start, xco2_end
NAMELIST/nam_isba_snown/lsnowdrift,lsnowdrift_sublim, lsnow_abs_zenith, csnowmetamo, csnowrad
!
CONTAINS
!
SUBROUTINE init_nam_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBAN',0,zhook_handle)
  cc1dry = io%CC1DRY
  cscond = io%CSCOND
  csoilfrz = io%CSOILFRZ
  cdifsfcond = io%CDIFSFCOND
  csnowres = io%CSNOWRES
  ccpsurf = io%CCPSURF
  xtstep = io%XTSTEP
  xout_tstep = io%XOUT_TSTEP
  xcgmax = io%XCGMAX
  xcdrag = io%XCDRAG
  lglacier = io%LGLACIER
  lvegupd = io%LVEGUPD  
  lcanopy_drag = io%LCANOPY_DRAG
  lpertsurf = io%LPERTSURF
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBAN',1,zhook_handle)
END SUBROUTINE init_nam_isban

SUBROUTINE init_nam_isba_agsn (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_AGSN',0,zhook_handle)
  lnitro_dilu = io%LNITRO_DILU
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_AGSN',1,zhook_handle)
END SUBROUTINE init_nam_isba_agsn

SUBROUTINE init_nam_sgh_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_SGH_ISBAN',0,zhook_handle)
  crunoff = io%CRUNOFF
  cksat=io%CKSAT
  lsoc=io%LSOC
  crain=io%CRAIN
  chort=io%CHORT
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_SGH_ISBAN',1,zhook_handle)
END SUBROUTINE init_nam_sgh_isban

SUBROUTINE update_nam_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_ISBAN',0,zhook_handle)
  io%CC1DRY = cc1dry
  io%CSCOND = cscond
  io%CSOILFRZ = csoilfrz
  io%CDIFSFCOND = cdifsfcond
  io%CSNOWRES = csnowres
  io%CCPSURF = ccpsurf
  io%XTSTEP = xtstep
  io%XOUT_TSTEP = xout_tstep
  io%XCGMAX = xcgmax
  io%XCDRAG = xcdrag
  io%LGLACIER = lglacier
  io%LVEGUPD = lvegupd  
  io%LCANOPY_DRAG = lcanopy_drag
  io%LPERTSURF = lpertsurf
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_ISBAN',1,zhook_handle)
END SUBROUTINE update_nam_isban

SUBROUTINE update_nam_isba_agsn (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_ISBA_AGSN',0,zhook_handle)
  io%LNITRO_DILU = lnitro_dilu
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_ISBA_AGSN',1,zhook_handle)
END SUBROUTINE update_nam_isba_agsn

SUBROUTINE update_nam_sgh_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_SGH_ISBAN',0,zhook_handle)
  io%CRUNOFF=crunoff
  io%CKSAT=cksat
  io%LSOC=lsoc
  io%CRAIN=crain
  io%CHORT=chort
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_SGH_ISBAN',1,zhook_handle)
END SUBROUTINE update_nam_sgh_isban

SUBROUTINE init_nam_diag_isban (DE, DGO, DMI)
!
  USE modd_diag_evap_isba_n, ONLY : diag_evap_isba_t
  USE modd_diag_n, ONLY : diag_options_t
  USE modd_diag_misc_isba_n, ONLY : diag_misc_isba_t
!
  IMPLICIT NONE

!
  TYPE(diag_evap_isba_t), INTENT(INOUT) :: DE
  TYPE(diag_options_t), INTENT(INOUT) :: DGO
  TYPE(diag_misc_isba_t), INTENT(INOUT) :: DMI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_DIAG_ISBAN',0,zhook_handle)
  lpgd = dgo%LPGD
  lsurf_evap_budget = de%LSURF_EVAP_BUDGET
  lwater_budget = de%LWATER_BUDGET
  lsurf_misc_budget = dmi%LSURF_MISC_BUDGET
  lsurf_diag_albedo = dmi%LSURF_DIAG_ALBEDO
  lsurf_misc_dif = dmi%LSURF_MISC_DIF
  lpatch_budget = dgo%LPATCH_BUDGET
  lprosnow = dmi%LPROSNOW
  lvolumetric_snowliq = dmi%LPROSNOW
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_DIAG_ISBAN',1,zhook_handle)
END SUBROUTINE init_nam_diag_isban

SUBROUTINE update_nam_diag_isban (DE, DGO, DMI)
!
  USE modd_diag_evap_isba_n, ONLY : diag_evap_isba_t
  USE modd_diag_n, ONLY : diag_options_t
  USE modd_diag_misc_isba_n, ONLY : diag_misc_isba_t
!
  IMPLICIT NONE

!
  TYPE(diag_evap_isba_t), INTENT(INOUT) :: DE
  TYPE(diag_options_t), INTENT(INOUT) :: DGO
  TYPE(diag_misc_isba_t), INTENT(INOUT) :: DMI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_DIAG_ISBAN',0,zhook_handle)
  dgo%LPGD = lpgd
  de%LSURF_EVAP_BUDGET = lsurf_evap_budget
  de%LWATER_BUDGET = lwater_budget
  dmi%LSURF_MISC_BUDGET = lsurf_misc_budget
  dmi%LSURF_DIAG_ALBEDO = lsurf_diag_albedo
  dmi%LSURF_MISC_DIF = lsurf_misc_dif
  dgo%LPATCH_BUDGET = lpatch_budget
  dmi%LPROSNOW = lprosnow
  dmi%LVOLUMETRIC_SNOWLIQ = lvolumetric_snowliq  
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_DIAG_ISBAN',1,zhook_handle)
END SUBROUTINE update_nam_diag_isban

SUBROUTINE init_nam_diag_surfn (DGO)
!
  USE modd_diag_evap_isba_n, ONLY : diag_evap_isba_t
  USE modd_diag_n, ONLY : diag_options_t
!
  IMPLICIT NONE

!
  TYPE(diag_options_t), INTENT(INOUT) :: DGO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_DIAG_SURFN',0,zhook_handle)
  xdiag_tstep = dgo%XDIAG_TSTEP  
  n2m = dgo%N2M
  l2m_min_zs = dgo%L2M_MIN_ZS
  lsurf_budget = dgo%LSURF_BUDGET
  lrad_budget = dgo%LRAD_BUDGET
  lsurf_budgetc = dgo%LSURF_BUDGETC
  lreset_budgetc = dgo%LRESET_BUDGETC  
  lcoef = dgo%LCOEF
  lsurf_vars = dgo%LSURF_VARS
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_DIAG_SURFN',1,zhook_handle)
END SUBROUTINE init_nam_diag_surfn

SUBROUTINE update_nam_diag_surfn (DGO)
!
  USE modd_diag_evap_isba_n, ONLY : diag_evap_isba_t
  USE modd_diag_n, ONLY : diag_options_t
!
  IMPLICIT NONE

!
  TYPE(diag_options_t), INTENT(INOUT) :: DGO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_DIAG_SURFN',0,zhook_handle)
  dgo%XDIAG_TSTEP = xdiag_tstep  
  dgo%N2M = n2m
  dgo%L2M_MIN_ZS = l2m_min_zs
  dgo%LSURF_BUDGET = lsurf_budget
  dgo%LRAD_BUDGET = lrad_budget 
  dgo%LSURF_BUDGETC = lsurf_budgetc
  dgo%LRESET_BUDGETC = lreset_budgetc  
  dgo%LCOEF = lcoef
  dgo%LSURF_VARS = lsurf_vars
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_DIAG_SURFN',1,zhook_handle)
END SUBROUTINE update_nam_diag_surfn

SUBROUTINE init_nam_ch_controln (CHI)
!
  USE modd_ch_isba_n, ONLY : ch_isba_t
!
  IMPLICIT NONE

!
  TYPE(ch_isba_t), INTENT(INOUT) :: CHI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_CH_CONTROLN',0,zhook_handle)
  cchem_surf_file = chi%CCHEM_SURF_FILE
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_CH_CONTROLN',1,zhook_handle)
END SUBROUTINE init_nam_ch_controln

SUBROUTINE update_nam_ch_controln (CHI)
!
  USE modd_ch_isba_n, ONLY : ch_isba_t
!
  IMPLICIT NONE

!
  TYPE(ch_isba_t), INTENT(INOUT) :: CHI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_CH_CONTROLN',0,zhook_handle)
  chi%CCHEM_SURF_FILE = cchem_surf_file
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_CH_CONTROLN',1,zhook_handle)
END SUBROUTINE update_nam_ch_controln

SUBROUTINE init_nam_ch_isban (CHI)
!
  USE modd_ch_isba_n, ONLY : ch_isba_t
!
  IMPLICIT NONE

!
  TYPE(ch_isba_t), INTENT(INOUT) :: CHI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_CH_ISBAN',0,zhook_handle)
  lch_bio_flux = chi%LCH_BIO_FLUX
  lch_no_flux = chi%LCH_NO_FLUX
  cch_dry_dep = chi%CCH_DRY_DEP
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_CH_ISBAN',1,zhook_handle)
END SUBROUTINE init_nam_ch_isban

SUBROUTINE update_nam_ch_isban (CHI)
!
  USE modd_ch_isba_n, ONLY : ch_isba_t
!
  IMPLICIT NONE

!
  TYPE(ch_isba_t), INTENT(INOUT) :: CHI
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_CH_ISBAN',0,zhook_handle)
  chi%LCH_BIO_FLUX = lch_bio_flux
  chi%LCH_NO_FLUX = lch_no_flux
  chi%CCH_DRY_DEP = cch_dry_dep
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_CH_ISBAN',1,zhook_handle)
END SUBROUTINE update_nam_ch_isban

SUBROUTINE init_nam_spinup_carb_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_SPINUP_CARB_ISBAN',0,zhook_handle)
  lspinupcarbs = io%LSPINUPCARBS
  lspinupcarbw = io%LSPINUPCARBW  
  xspinmaxs   = io%XSPINMAXS
  xspinmaxw   = io%XSPINMAXW  
  nnbyearspins = io%NNBYEARSPINS
  nnbyearspinw = io%NNBYEARSPINW
  xco2_start = io%XCO2_START
  xco2_end = io%XCO2_END
IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_SPINUP_CARB_ISBAN',1,zhook_handle)
END SUBROUTINE init_nam_spinup_carb_isban

SUBROUTINE update_nam_spinup_carb_isban (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_SPINUP_CARB_ISBAN',0,zhook_handle)
  io%LSPINUPCARBS = lspinupcarbs
  io%LSPINUPCARBW = lspinupcarbw  
  io%XSPINMAXS   = xspinmaxs
  io%XSPINMAXW   = xspinmaxw  
  io%NNBYEARSPINS = nnbyearspins
  io%NNBYEARSPINW = nnbyearspinw
  io%XCO2_START = xco2_start
  io%XCO2_END = xco2_end
IF (lhook) CALL dr_hook('MODN_ISBA_N:UPDATE_NAM_SPINUP_CARB_ISBAN',1,zhook_handle)
END SUBROUTINE update_nam_spinup_carb_isban

SUBROUTINE init_nam_isba_snown (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_SNOWn',0,zhook_handle)
  lsnowdrift = io%LSNOWDRIFT
  lsnowdrift_sublim =  io%LSNOWDRIFT_SUBLIM
  lsnow_abs_zenith = io%LSNOW_ABS_ZENITH
  csnowmetamo = io%CSNOWMETAMO
  csnowrad = io%CSNOWRAD  
  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_SNOWn',1,zhook_handle)

END SUBROUTINE init_nam_isba_snown

SUBROUTINE update_nam_isba_snown (IO)
!
  USE modd_isba_options_n, ONLY : isba_options_t
!
  IMPLICIT NONE

!
  TYPE(isba_options_t), INTENT(INOUT) :: IO
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_SNOWn',0,zhook_handle)
  io%LSNOWDRIFT = lsnowdrift
  io%LSNOWDRIFT_SUBLIM = lsnowdrift_sublim
  io%LSNOW_ABS_ZENITH = lsnow_abs_zenith
  io%CSNOWMETAMO = csnowmetamo
  io%CSNOWRAD=csnowrad  
  IF (lhook) CALL dr_hook('MODN_ISBA_N:INIT_NAM_ISBA_SNOWn',1,zhook_handle)

END SUBROUTINE update_nam_isba_snown

END MODULE modn_isba_n