read_oceann.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 read_ocean_n (DTCO, O, OR, U, HPROGRAM)
!     #########################################
!
!!****  *READ_OCEAN_n* - read oceanic variables
!!
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      C. Lebeaupin Brossier   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    04/2007 
!!      Modofied    07/2012, P. Le Moigne : CMO1D phasing
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
!
!
!
USE modd_data_cover_n, ONLY : data_cover_t
USE modd_ocean_n, ONLY : ocean_t
USE modd_ocean_rel_n, ONLY : ocean_rel_t
USE modd_surf_atm_n, ONLY : surf_atm_t
!
USE modd_surf_par, ONLY : xundef
USE modd_ocean_grid, ONLY : nockmin,nockmax,xzhoc
!
!
USE modi_read_surf
USE modi_ocean_mercatorvergrid
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
USE modi_get_type_dim_n
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
!
TYPE(data_cover_t), INTENT(INOUT) :: DTCO
TYPE(ocean_t), INTENT(INOUT) :: O
TYPE(ocean_rel_t), INTENT(INOUT) :: OR
TYPE(surf_atm_t), INTENT(INOUT) :: U
!
 CHARACTER(LEN=6),  INTENT(IN)  :: HPROGRAM ! calling program
!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER           :: ILU          ! 1D physical dimension
!
INTEGER           :: IRESP          ! Error code after redding
!
 CHARACTER(LEN=4)  :: YLVL
!
 CHARACTER(LEN=12) :: YRECFM         ! Name of the article to be read
 CHARACTER(LEN=14) :: YFORM          ! Writing format
REAL, DIMENSION(:),ALLOCATABLE  :: ZWORK      ! 1D array to write data in file
!
INTEGER :: JLEVEL ! loop counter on oceanic levels
INTEGER :: J      ! loop counter on sea grid points
!
INTEGER           :: IVERSION       ! surface version
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
IF (lhook) CALL dr_hook('READ_OCEAN_N',0,zhook_handle)
o%NOCTCOUNT=0
!
yrecfm='VERSION'
 CALL read_surf(hprogram,yrecfm,iversion,iresp)
!
!* flag to use or not Ocean model
!
IF (iversion<=3) THEN
   o%LMERCATOR=.false.
ELSE
   yrecfm='SEA_OCEAN'
   CALL read_surf(hprogram,yrecfm,o%LMERCATOR,iresp)
ENDIF
!
IF (.NOT. o%LMERCATOR) THEN
  ALLOCATE(o%XSEAT(0,0))
  ALLOCATE(o%XSEAS(0,0))  
  ALLOCATE(o%XSEAU(0,0))
  ALLOCATE(o%XSEAV(0,0))  
  ALLOCATE(or%XSEAT_REL(0,0))
  ALLOCATE(or%XSEAS_REL(0,0))
  ALLOCATE(or%XSEAU_REL(0,0))
  ALLOCATE(or%XSEAV_REL(0,0))
  !
  ALLOCATE(o%XSEAE(0,0))
  ALLOCATE(o%XSEABATH(0,0))
  ALLOCATE(o%XSEAHMO(0))
  ALLOCATE(o%XLE        (0,0))
  ALLOCATE(o%XLK        (0,0))
  ALLOCATE(o%XKMEL      (0,0))
  ALLOCATE(o%XKMELM     (0,0))
  ALLOCATE(o%XSEATEND   (0))
  ALLOCATE(o%XDTFSOL(0,0))
  ALLOCATE(o%XDTFNSOL(0))
  IF (lhook) CALL dr_hook('READ_OCEAN_N',1,zhook_handle)
  RETURN
ENDIF
!
!-------------------------------------------------------------------------------
!
nockmin = 0
yrecfm='SEA_NBLEVEL'
 CALL read_surf(hprogram,yrecfm,nockmax,iresp)
!
ALLOCATE(xzhoc(nockmin:nockmax))
xzhoc(nockmin) = 0.
! Read vertical grid
DO jlevel = nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='LEVL_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,xzhoc(jlevel),iresp)
END DO
!
 CALL ocean_mercatorvergrid
!
! Relaxation time and logical
yrecfm='TAU_REL_OC'
 CALL read_surf(hprogram,yrecfm,or%XTAU_REL,iresp)
!
yrecfm='LREL_CUR_OC'
 CALL read_surf(hprogram,yrecfm,or%LREL_CUR,iresp)

yrecfm='LREL_TS_OC'
 CALL read_surf(hprogram,yrecfm,or%LREL_TS,iresp)
yrecfm='LFLX_NULL_OC'
 CALL read_surf(hprogram,yrecfm,or%LFLUX_NULL,iresp)
yrecfm='LFLX_CORR_OC'
 CALL read_surf(hprogram,yrecfm,or%LFLX_CORR,iresp)
yrecfm='CORR_FLX_OC'
 CALL read_surf(hprogram,yrecfm,or%XQCORR,iresp)
yrecfm='LDIAPYC_OC'
 CALL read_surf(hprogram,yrecfm,or%LDIAPYCNAL,iresp)
!
!* 1D physical dimension
!
yrecfm='SIZE_SEA'
 CALL get_type_dim_n(dtco, u, 'SEA   ',ilu)
!
!*       2.     Prognostic fields:
!               -----------------
!
ALLOCATE(zwork(ilu))
!* oceanic temperature
!
ALLOCATE(o%XSEAT(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='TEMP_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEAT(:,jlevel)=zwork(:)
END DO
o%XSEAT(:,nockmin)=o%XSEAT(:,nockmin+1)
!
!* relaxation profile for oceanic temperature
!
ALLOCATE(or%XSEAT_REL(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='T_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  or%XSEAT_REL(:,jlevel)=zwork(:)
END DO
or%XSEAT_REL(:,nockmin)=or%XSEAT_REL(:,nockmin+1)
!
!* oceanic salinity
!
ALLOCATE(o%XSEAS(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='SALT_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEAS(:,jlevel)=zwork(:)
END DO
o%XSEAS(:,nockmin)=o%XSEAS(:,nockmin+1)
!
!* oceanic salinity profile of relaxation
!
ALLOCATE(or%XSEAS_REL(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='S_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  or%XSEAS_REL(:,jlevel)=zwork(:)
END DO
or%XSEAS_REL(:,nockmin)=or%XSEAS_REL(:,nockmin+1)
!
!* oceanic current
!
ALLOCATE(or%XSEAU_REL(ilu,nockmin:nockmax))
ALLOCATE(or%XSEAV_REL(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='U_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  or%XSEAU_REL(:,jlevel)=zwork(:)
END DO
or%XSEAU_REL(:,nockmin)=or%XSEAU_REL(:,nockmin+1)
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='V_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  or%XSEAV_REL(:,jlevel)=zwork(:)
END DO
or%XSEAV_REL(:,nockmin)=or%XSEAV_REL(:,nockmin+1)
!
ALLOCATE(o%XSEAU(ilu,nockmin:nockmax))
ALLOCATE(o%XSEAV(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='UCUR_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEAU(:,jlevel)=zwork(:)
END DO
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='VCUR_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEAV(:,jlevel)=zwork(:)
END DO
o%XSEAU(:,nockmin)=o%XSEAU(:,nockmin+1)
o%XSEAV(:,nockmin)=o%XSEAV(:,nockmin+1)
!
!* oceanic turbulent kinetic energy
!
ALLOCATE(o%XSEAE(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='TKE_OC'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEAE(:,jlevel)=zwork(:)
END DO
o%XSEAE(:,nockmin)=o%XSEAE(:,nockmin+1)
!
!
!-------------------------------------------------------------------------------
!
!*       4.     Semi-prognostic fields:
!               ----------------------
!
!* bathymetry indice
!
ALLOCATE(o%XSEABATH(ilu,nockmin:nockmax))
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='SEAINDBATH'//adjustl(ylvl(:len_trim(ylvl)))
  CALL read_surf(hprogram,yrecfm,zwork(:),iresp)
  o%XSEABATH(:,jlevel)=zwork(:)
END DO
o%XSEABATH(:,nockmin)=1.
!
!-------------------------------------------------------------------------------
!Complete undefined values for the oceanic 1D model convergence
DO j=1,ilu
  DO jlevel=nockmin+2,nockmax
    IF (o%XSEABATH(j,jlevel)==0.) THEN
      o%XSEAT(j,jlevel)=o%XSEAT(j,jlevel-1)
      o%XSEAS(j,jlevel)=o%XSEAS(j,jlevel-1)
      o%XSEAU(j,jlevel)=o%XSEAU(j,jlevel-1)
      o%XSEAV(j,jlevel)=o%XSEAV(j,jlevel-1)
      o%XSEAE(j,jlevel)=o%XSEAE(j,jlevel-1)
      !
      or%XSEAT_REL(j,jlevel)=or%XSEAT_REL(j,jlevel-1)
      or%XSEAS_REL(j,jlevel)=or%XSEAS_REL(j,jlevel-1)
      or%XSEAU_REL(j,jlevel)=or%XSEAU_REL(j,jlevel-1)
      or%XSEAV_REL(j,jlevel)=or%XSEAV_REL(j,jlevel-1)      
    ENDIF
  ENDDO
ENDDO
!
DEALLOCATE(zwork)
!-------------------------------------------------------------------------------
ALLOCATE(o%XSEAHMO(ilu))
yrecfm='SEA_HMO'
 CALL read_surf(hprogram,yrecfm,o%XSEAHMO(:),iresp)
!
!-------------------------------------------------------------------------------
ALLOCATE(o%XLE        (SIZE(o%XSEAT,1),nockmin:nockmax))
ALLOCATE(o%XLK        (SIZE(o%XSEAT,1),nockmin:nockmax))
ALLOCATE(o%XKMEL      (SIZE(o%XSEAT,1),nockmin:nockmax))
ALLOCATE(o%XKMELM     (SIZE(o%XSEAT,1),nockmin:nockmax))
o%XLE(:,:)    =xundef
o%XLK(:,:)    =xundef
o%XKMEL(:,:)  =xundef
o%XKMELM(:,:) =xundef
!
ALLOCATE(o%XSEATEND   (SIZE(o%XSEAT,1)))
o%XSEATEND(:) =xundef
!
ALLOCATE(o%XDTFSOL(ilu,nockmin:nockmax))
ALLOCATE(o%XDTFNSOL(ilu))
!
o%XDTFSOL(:,:) = xundef 
o%XDTFNSOL(:) = xundef 
!
IF (lhook) CALL dr_hook('READ_OCEAN_N',1,zhook_handle)
!
!------------------------------------------------------------------------------
END SUBROUTINE read_ocean_n