modn_io_offline.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_io_offline
!     #######################
!
!!****  *MODN_IO_OFFLINE* define the variables and namelist for SURFEX
!                         offline programs (pgd, prep, offline)
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      V. Masson   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    04/2008
!!      P. Lemoigne 04/2013 Add XDELTA_OROG to fix the maximum difference allowed between
!!                          forcing and surface file orographies if LSET_FORC_ZS=.F
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
IMPLICIT NONE
!
!*    Types of files
!     --------------
!
 CHARACTER(LEN=6) :: csurf_filetype       = 'ASCII ' ! type of SURFEX surface files
!                                                   ! 'NETDF '
!                                                   ! 'FA    '
!                                                   ! 'ASCII '
!                                                   ! 'LFI   '
 CHARACTER(LEN=6) :: ctimeseries_filetype = 'NONE  ' ! type of the files contining the
!                                                   ! output diagnostic time series
!                                                   ! 'NETCDF ', 'TEXTE '
 CHARACTER(LEN=6) :: cforcing_filetype    = 'NETCDF' ! type of atmospheric FORCING files
!                                                   ! 'NETDF', 'BINARY', or 'ASCII '
!
!*    Names of files
!     --------------
!
 CHARACTER(LEN=28):: cpgdfile  ='PGD'          ! name of the PGD file
 CHARACTER(LEN=28):: cprepfile ='PREP'         ! name of the INITIAL file
 CHARACTER(LEN=28):: csurffile ='SURFOUT'      ! name of the final output CSURFEX file
 CHARACTER(LEN=28):: cnamelist ='OPTIONS.nam'  ! name of namelist file
!
!
!*    General flags defining output options
!     -------------------------------------
!
LOGICAL          :: lprint      = .false.  ! write some information on screen 
LOGICAL          :: lrestart    = .false.  ! write restart file
LOGICAL          :: lrestart_2m = .false.  ! write restart file
LOGICAL          :: linquire    = .false.  ! inquiry mode
!      
LOGICAL          :: lwrite_coord = .false. ! write lat/lon of the target grid
!
LOGICAL          :: lout_timename = .false.! change the name of output file at the end of a day
                                           ! (ex: 19860502_00h00 -> 19860501_24h00)
!
LOGICAL          :: ldiag_fa_nocompact = .false. ! fa compaction for diagnostic files
!
 LOGICAL           :: lallow_add_dim   = .false. ! allow multi-dimensional output 
                                                 ! if IO scheme can deal with- e.g. XIOS
!
!*    Variables
!     ---------
!
INTEGER          :: nscal = 0                 ! Number of scalar species
INTEGER          :: nhalo = 0
!
!*    Time steps
!     ----------
!
REAL             :: xtstep_surf   = 300.   ! time step of the surface 
REAL             :: xtstep_output = 1800.  ! time step of the output time-series
INTEGER          :: nb_read_forc  = 0      ! subdivisions of the reading of forcings
!
!*    Allow the simulation to start from a different time step than the first record of a netcdf file
!     ----------
LOGICAL          :: ldelayedstart_nc = .false.
INTEGER,DIMENSION(4) :: ndatestop=(/0,0,0,0/) ! Year month day time (sec) to stop the simulation before the end of the netcdf forcing file
!
!*    General flag for coherence between forcing file orography and surface file orography
!     ----------
!
LOGICAL          :: lset_forc_zs =.false.  ! .T. : the orography of the
!                                          !  forcing file is
!                                          !  automatically set to the same
!                                          !  value as in the surface file
!                                          ! .F. : the orography of the
!                                          !  forcing file is kept as it is
REAL             :: xdelta_orog   = 200. ! maximum difference allowed between
!                                          ! forcing and surface file
!                                          ! orographies if LSET_FORC_ZS=.F.
!
!*    General flag for coherence between forcing Qair and calculated Qsat(Tair)
!     ----------
!
LOGICAL          :: llimit_qair = .false. ! .T. : Qair always <= Qsat(Tair)
                                          ! .F. : No limitation
!
!*    General flag for using land use scheme
!     ----------
!
LOGICAL          :: lland_use = .false.
!
!*    General flag for using simple coherence between solar zenithal angle and radiation
!     ----------
!
LOGICAL          :: ladapt_sw = .false.
LOGICAL          :: linterp_sw = .false.
!
!*    General flag to modify direct solar radiation due to slopes and shadows.
!     ----------
!
LOGICAL          :: lshadows_slope = .false.
LOGICAL          :: lshadows_other = .false.
!
LOGICAL          :: lwr_vegtype = .false.
!
! * For offline driver with openMP
INTEGER         :: nproma                 ! Size of openMP packets
INTEGER         :: ni,nj                  ! Domain size
!
REAL            :: xio_frac = 1.          ! fraction of ISIZE deduced to I/O
!
 CHARACTER(LEN=4) :: yalg_mpi = "LIN "     ! type of distribution algorithm for MPI
!
!-------------------------------------------------------------------------------
!
!*       1.    NAMELISTS
!              ---------
!
NAMELIST/nam_io_offline/csurf_filetype, ctimeseries_filetype, cforcing_filetype, &
                        cpgdfile, cprepfile, csurffile, lrestart_2m,             &
                        lprint, lrestart, linquire, nscal, nhalo,                &
                        xtstep_surf, xtstep_output, ldiag_fa_nocompact,          &
                        lset_forc_zs, lwrite_coord, lout_timename, llimit_qair,  &
                        lshadows_slope,lshadows_other, lwr_vegtype,              &
                        nb_read_forc, lland_use, nproma, ni, nj, xio_frac,       &
                        yalg_mpi, xdelta_orog, ladapt_sw, linterp_sw,            &
                        lallow_add_dim, ldelayedstart_nc, ndatestop
!
!-------------------------------------------------------------------------------
END MODULE modn_io_offline