init_outfn_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.
!     #########
       SUBROUTINE init_outfn_isba_n (IM, UG, U, HSELECT, OSNOWDIMNC, HPROGRAM, KLUOUT)
!     ###############################
!
!
!!****  *INIT_OUTFN_ISBA_n* -  create output files and defines variables
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      F. Habets   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    07-03
!!      modified    11-03,by P. Le Moigne   *Meteo France*
!!      modified    05-04,by P. Le Moigne : surf_atm diagnostics moved at the
!!                                           right place
!!      modified    10-04,by P. Le Moigne : add new diagnostics
!!      modified    10-04,by P. Le Moigne : add Halstead coefficient
!!      modified     2008,by B. Decharme  : limit the number of diag
!!                                           Add floodplains diag
!!      modified    04-09,by A.L. Gibelin : Add respiration diagnostics
!!      modified    05-09,by A.L. Gibelin : Add carbon spinup
!!      modified    07-09,by A.L. Gibelin : Add carbon prognostic variables
!!  
!!      modified    09-12,by B. Decharme  : delete LPROVAR_TO_DIAG for prognostic variables
!!                                           delete NWG_LAYER
!!                                           Erroneous description in diag comments
!!      modified    06-13,by B. Decharme  : good dimension for Tg,Wg,et Wgi
!!                                           bug : TSN_VEG if Snowlayer = 1 ; 
!!                                           bug : TSRAD_P and not TTSRAD_P
!!                                           add diag (Qsb,Subl) and Snow noted SN
!!      modified    10-14,by P. Samuelsson: Added MEB output
!!      modified    09-15  by M. Lafaysse  : new Crocus-MEPRA outputs
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
USE modd_type_date_surf
!
USE modd_surfex_n, ONLY : isba_model_t
!
USE modd_surf_atm_grid_n,ONLY : surf_atm_grid_t
USE modd_surf_atm_n,ONLY : surf_atm_t
!
USE modd_ol_fileid,       ONLY : xnetcdf_fileid_out, xnetcdf_filename_out
!
USE modd_assim,          ONLY : lassim, cassim, cassim_isba
!
USE modd_write_surf_atm, ONLY : lsplit_patch
!
USE modn_io_offline,      ONLY : xtstep_output
!
USE modi_get_dim_full_n
USE modi_get_isba_conf_n
USE modi_ol_define_dim
USE modi_get_date_ol
USE modi_create_file
USE modi_def_var_netcdf
USE modi_ol_write_coord
USE modi_ol_write_proj
!
USE yomhook ,ONLY : lhook,  dr_hook
USE parkind1,ONLY : jprb
!
USE netcdf
!
IMPLICIT NONE
!
TYPE(isba_model_t), INTENT(IN) :: IM
!
TYPE(surf_atm_grid_t),INTENT(INOUT) :: UG
TYPE(surf_atm_t),INTENT(INOUT) :: U
!
 CHARACTER(LEN=*),DIMENSION(:),INTENT(IN) :: HSELECT
LOGICAL, INTENT(IN) :: OSNOWDIMNC
!
 CHARACTER(LEN=6),INTENT(IN) :: HPROGRAM
INTEGER,         INTENT(IN) :: KLUOUT
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
 CHARACTER(LEN=100),DIMENSION(:),POINTER :: YNAME_DIM
 CHARACTER(LEN=100),DIMENSION(1)  :: YATT_TITLE,YATT
 CHARACTER(LEN=40),DIMENSION(1)   :: YDATE
 CHARACTER(LEN=13),DIMENSION(1)   :: YUNIT1,YUNIT2
 CHARACTER(LEN=100)               :: YCOMMENT  
 CHARACTER(LEN=50)                :: YFILE
 CHARACTER(LEN=12)                :: YRECFM
 CHARACTER(LEN=3)                 :: YPAS,YPAT
 CHARACTER(LEN=6)                 :: YLVL
 CHARACTER(LEN=3)                 :: YISBA
 CHARACTER(LEN=1)                 :: YNDAYS 
 CHARACTER(LEN=2)                 :: YLVLV
 CHARACTER(LEN=3) :: YSNOW_SCHEME
! 
TYPE(date_time) :: TPTIME
REAL,DIMENSION(:),POINTER     :: ZX,ZY
REAL,DIMENSION(:), POINTER    :: ZLAT,ZLON
!
INTEGER :: ISNOW_LAYER
INTEGER,DIMENSION(:),POINTER :: IDIMS, IDDIMALL
INTEGER                      :: INI, INPATCH, INLVLD, INLVLS, INBIOMASS,&
                                INLITTER, INLITTLEVS, INSOILCARB
INTEGER                      :: IDIM1, INDIMS, INDIMSALL, INJDIMS
INTEGER                      :: IFILE_ID, IDIMID, JSV
INTEGER                      :: IL,JRET, INSNLAYER, JFILE
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------

! 1. Compute output lenght dimension
!-----------------------------------

IF (lhook) CALL dr_hook('INIT_OUTFN_ISBA_N',0,zhook_handle)
!
tptime = im%S%TTIME
ysnow_scheme = im%NPE%AL(1)%TSNOW%SCHEME
isnow_layer  = im%NPE%AL(1)%TSNOW%NLAYER
!
 CALL get_dim_full_n(u%NDIM_FULL,ini)
 CALL get_isba_conf_n(im%O,isnow_layer,yisba,inpatch,inlvld,inlvls,inbiomass,&
                       inlitter,inlittlevs,insoilcarb)  
!
insnlayer = 1
IF ( osnowdimnc ) insnlayer = isnow_layer
IF (lsplit_patch) THEN
  CALL ol_define_dim(ug, u%NSIZE_FULL, hprogram, kluout, ini, idim1, yunit1, yunit2,&
                     zx, zy, idims, iddimall, yname_dim, knsnlayer=insnlayer,plat=zlat,plon=zlon)
ELSE
  CALL ol_define_dim(ug, u%NSIZE_FULL, hprogram, kluout, ini, idim1, yunit1, yunit2,&
                     zx, zy, idims, iddimall, yname_dim, knpatch=inpatch, &
                     knsnlayer=insnlayer, plat=zlat, plon=zlon)
ENDIF
 CALL get_date_ol(tptime,xtstep_output,ydate(1))
!
indimsall = SIZE(iddimall)
!
IF ( osnowdimnc ) THEN
  injdims = indimsall-2
  indims  = indimsall-1
ELSE
  injdims = indimsall-1
  indims  = indimsall
ENDIF
!
! 4. Create output file for prognostic variables
!----------------------------------------------------------
!
yatt_title(1)='units'
!
yfile='ISBA_PROGNOSTIC.OUT.nc'
 CALL create_file(yfile,idims,yname_dim,ifile_id,iddimall)
jret=nf90_redef(ifile_id) 
!
 CALL ol_write_proj(hselect,ifile_id,ug)
!
DO jfile = 1,SIZE(xnetcdf_filename_out) 
  IF (trim(yfile)==trim(xnetcdf_filename_out(jfile))) THEN
    xnetcdf_fileid_out(jfile) = ifile_id
    EXIT
  ENDIF
ENDDO
!
IF (.NOT. im%ID%DM%LPROSNOW) THEN
  !
  CALL ol_write_coord(hselect,yfile,ifile_id,iddimall,yatt_title,yname_dim,&
                      yunit1,yunit2,idim1,ydate,zx,zy,zlon,zlat)
  !
  !
  ! 4. Create output file for fluxes values
  !----------------------------------------------------------
  !
  yfile='ISBA_DIAGNOSTICS.OUT.nc'
  CALL create_file(yfile,idims,yname_dim,ifile_id,iddimall)
  jret=nf90_redef(ifile_id) 
  yatt ='dimensionless'
  !
  CALL ol_write_proj(hselect,ifile_id,ug)
  !
  DO jfile = 1,SIZE(xnetcdf_filename_out) 
    IF (trim(yfile)==trim(xnetcdf_filename_out(jfile))) THEN
      xnetcdf_fileid_out(jfile) = ifile_id
      EXIT
    ENDIF
  ENDDO
  !
ENDIF
!
 CALL ol_write_coord(hselect,yfile,ifile_id,iddimall,yatt_title,yname_dim,&
                     yunit1,yunit2,idim1,ydate,zx,zy,zlon,zlat)
!
IF (im%ID%O%LSURF_BUDGETC) THEN
  !
  yfile='ISBA_DIAG_CUMUL.OUT.nc'
  CALL create_file(yfile,idims,yname_dim,ifile_id,iddimall)
  jret=nf90_redef(ifile_id)
  !
  CALL ol_write_proj(hselect,ifile_id,ug)
  !
  DO jfile = 1,SIZE(xnetcdf_filename_out) 
    IF (trim(yfile)==trim(xnetcdf_filename_out(jfile))) THEN
      xnetcdf_fileid_out(jfile) = ifile_id
      EXIT
    ENDIF
  ENDDO
  !
  CALL ol_write_coord(hselect,yfile,ifile_id,iddimall,yatt_title,&
                      yname_dim,yunit1,yunit2,idim1,ydate,zx,zy,zlon,zlat)
  !
ENDIF


! 6. Create file for vegetation parameter values
!----------------------------------------------------------

IF( lassim.OR.im%ID%O%LPGD ) THEN
  !
  yfile='ISBA_VEG_EVOLUTION.OUT.nc'
  CALL create_file(yfile,idims,yname_dim,ifile_id,iddimall)
  jret=nf90_redef(ifile_id)
  !
  CALL ol_write_proj(hselect,ifile_id,ug)
  !
  DO jfile = 1,SIZE(xnetcdf_filename_out) 
    IF (trim(yfile)==trim(xnetcdf_filename_out(jfile))) THEN
      xnetcdf_fileid_out(jfile) = ifile_id
      EXIT
    ENDIF
  ENDDO  
  !
  CALL ol_write_coord(hselect,yfile,ifile_id,iddimall,yatt_title,yname_dim,&
                      yunit1,yunit2,idim1,ydate,zx,zy,zlon,zlat)
  !  
ENDIF
!
! 7. Create file for analysis increments for EKF
!----------------------------------------------------------

IF(lassim .AND. cassim_isba=='EKF  ') THEN
  !
  yfile='ISBA_ANALYSIS.OUT.nc'
  CALL create_file(yfile,idims,yname_dim,ifile_id,iddimall)
  jret=nf90_redef(ifile_id)
  !  
  CALL ol_write_proj(hselect,ifile_id,ug)
  !
  DO jfile = 1,SIZE(xnetcdf_filename_out) 
    IF (trim(yfile)==trim(xnetcdf_filename_out(jfile))) THEN
      xnetcdf_fileid_out(jfile) = ifile_id
      EXIT
    ENDIF
  ENDDO  
  !
  CALL ol_write_coord(hselect,yfile,ifile_id,iddimall,yatt_title,yname_dim,&
                      yunit1,yunit2,idim1,ydate,zx,zy,zlon,zlat)
ENDIF
!
IF (ASSOCIATED(zx)) DEALLOCATE(zx,zy)
DEALLOCATE(zlon,zlat)
!
IF (lhook) CALL dr_hook('INIT_OUTFN_ISBA_N',1,zhook_handle)
!
END SUBROUTINE init_outfn_isba_n