writesurf_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 writesurf_ocean_n (HSELECT, O, OR, HPROGRAM)
!     ########################################
!
!!****  *WRITE_OCEAN_n* - writes OCEAN fields
!!
!!    PURPOSE
!!    -------
!!
!!**  METHOD
!!    ------
!!
!!    EXTERNAL
!!    --------
!!
!!
!!    IMPLICIT ARGUMENTS
!!    ------------------
!!
!!    REFERENCE
!!    ---------
!!
!!
!!    AUTHOR
!!    ------
!!      C. Lebeaupin Brossier   *Meteo France*
!!
!!    MODIFICATIONS
!!    -------------
!!      Original    03/2007
!!      Modified    07/2012, P. Le Moigne : CMO1D phasing
!!      11/2014 (David BARBARY) : Write oceanic level
!-------------------------------------------------------------------------------
!
!*       0.    DECLARATIONS
!              ------------
!
!
USE modd_ocean_n, ONLY : ocean_t
USE modd_ocean_rel_n, ONLY : ocean_rel_t
!
USE modd_ocean_grid
!
USE modi_write_surf
!
!
USE yomhook   ,ONLY : lhook,   dr_hook
USE parkind1  ,ONLY : jprb
!
IMPLICIT NONE
!
!*       0.1   Declarations of arguments
!              -------------------------
!
 CHARACTER(LEN=*), DIMENSION(:), INTENT(IN) :: HSELECT
!
TYPE(ocean_t), INTENT(INOUT) :: O
TYPE(ocean_rel_t), INTENT(INOUT) :: OR
!
 CHARACTER(LEN=6),  INTENT(IN)  :: HPROGRAM ! program calling

!
!*       0.2   Declarations of local variables
!              -------------------------------
!
INTEGER           :: IRESP          ! IRESP  : return-code if a problem appears
 CHARACTER(LEN=12) :: YRECFM         ! Name of the article to be read
 CHARACTER(LEN=4 ) :: YLVL
 CHARACTER(LEN=100):: YCOMMENT       ! Comment string
 CHARACTER(LEN=14) :: YFORM          ! Writing format
!
INTEGER :: JLEVEL ! loop counter on oceanic levels
!
REAL, DIMENSION(SIZE(O%XSEAT,1)) :: ZWORK ! 1D array to write data in file
REAL(KIND=JPRB) :: ZHOOK_HANDLE
!
!-------------------------------------------------------------------------------
IF (lhook) CALL dr_hook('WRITESURF_OCEAN_N',0,zhook_handle)
!
!* flag to define if OCEAN is used
!
yrecfm='SEA_OCEAN'
ycomment='flag to use OCEAN model'
 CALL write_surf(hselect, hprogram,yrecfm,o%LMERCATOR,iresp,hcomment=ycomment)
!
IF (.NOT. o%LMERCATOR .AND. lhook) CALL dr_hook('WRITESURF_OCEAN_N',1,zhook_handle)
IF (.NOT. o%LMERCATOR) RETURN
!
! Write Oceanic Level
yrecfm='SEA_NBLEVEL'
ycomment='Number of OCEAN levels'
 CALL write_surf(hselect, hprogram,yrecfm,nockmax,iresp,hcomment=ycomment)

DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='LEVL_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A21,I1.1,A4)'
  IF (jlevel >= 10)  yform='(A21,I2.2,A4)'
  WRITE(ycomment,fmt=yform) 'Depth of OCEAN level ',jlevel,' (m)'
  CALL write_surf(hselect, hprogram,yrecfm,xzhoc(jlevel),iresp,hcomment=ycomment)
END DO
!
! Relaxation time  
yrecfm='TAU_REL_OC'
ycomment='Relaxation time of ocean model (s)'
 CALL write_surf(hselect, hprogram,yrecfm,or%XTAU_REL,iresp,hcomment=ycomment)
!
yrecfm='LREL_CUR_OC'
ycomment='FLAG FOR RELAXATION ON CURRENT'
 CALL write_surf(hselect, hprogram,yrecfm,or%LREL_CUR,iresp,hcomment=ycomment)
!
yrecfm='LREL_TS_OC'
ycomment='FLAG FOR RELAXATION ON T,S'
 CALL write_surf(hselect, hprogram,yrecfm,or%LREL_TS,iresp,hcomment=ycomment)
!
yrecfm='LFLX_NULL_OC'
ycomment='FLAG FOR ZERO FLUX '
 CALL write_surf(hselect, hprogram,yrecfm,or%LFLUX_NULL,iresp,hcomment=ycomment)

yrecfm='LFLX_CORR_OC'
ycomment='FLAG FOR FLUX CORRECTION '
 CALL write_surf(hselect, hprogram,yrecfm,or%LFLX_CORR,iresp,hcomment=ycomment)

yrecfm='CORR_FLX_OC'
ycomment='FLUX CORRECTION COEFF (W/M2/K)'
 CALL write_surf(hselect, hprogram,yrecfm,or%XQCORR,iresp,hcomment=ycomment)
!
yrecfm='LDIAPYC_OC'
ycomment='FLAG FOR DIAPYCNAL MIXING '
 CALL write_surf(hselect, hprogram,yrecfm,or%LDIAPYCNAL,iresp,hcomment=ycomment)
!
!-------------------------------------------------------------------------------
!
!*       3.     Prognostic fields:
!               -----------------
!
! tendance surface liee au flux non solaire
!
  jlevel=1
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='DTFNSOL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
!RJ: extended ascii should be avoided in I/O
  WRITE(ycomment,fmt=yform) 'X_Y_DTFNSOL',jlevel,' (°C)'
  zwork=o%XDTFNSOL(:)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
!
!* oceanic temperature
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='TEMP_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
!RJ: extended ascii should be avoided in I/O
  WRITE(ycomment,fmt=yform) 'X_Y_TEMP_OC',jlevel,' (°C)'
  zwork=o%XSEAT(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO
!
! Budget terms lie au flux solaire
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='DTFSOL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
!RJ: extended ascii should be avoided in I/O
  WRITE(ycomment,fmt=yform) 'X_Y_DTFSOL',jlevel,' (°C/s)'
  zwork=o%XDTFSOL(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO

!
!* relaxation profile for oceanic temperature
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='T_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
!RJ: extended ascii should be avoided in I/O
  WRITE(ycomment,fmt=yform) 'X_Y_T_OC_REL',jlevel,' (°C)'
  zwork=or%XSEAT_REL(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO
!
!* oceanic salinity
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='SALT_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_SALT_OC',jlevel,'(psu)'
  zwork=o%XSEAS(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO
!
!* oceanic salinity profile of relxation
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='S_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_S_OC_REL',jlevel,'(psu)'
  zwork=or%XSEAS_REL(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO
!
!* oceanic zonal current
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='U_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_U_OC_REL',jlevel,' M/S'
  zwork=or%XSEAU_REL(:,jlevel)
  CALL write_surf(hselect, hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='UCUR_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_UCUR_OC',jlevel,' (m/s)'
  zwork=o%XSEAU(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO
!
!* oceanic meridian current
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='V_OC_REL'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_V_OC_REL',jlevel,' M/S'
  zwork=or%XSEAV_REL(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel  
  yrecfm='VCUR_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_VCUR_OC',jlevel,'(m/s)'
  zwork=o%XSEAV(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)
END DO
!
!* oceanic turbulent kinetic energy
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='TKE_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_TKE_OC',jlevel,' (J)'
  zwork=o%XSEAE(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO
!
!* oceanic mixing coefficient
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='KMEL_OC'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_KMEL_OC',jlevel,' (m2/s2)'
  zwork=o%XKMEL(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO

!
!-------------------------------------------------------------------------------
!
!*       4.     Semi-prognostic fields:
!               ----------------------
!* bathymetry indice
!
DO jlevel=nockmin+1,nockmax
  WRITE(ylvl,'(I4)') jlevel
  yrecfm='SEAINDBATH'//adjustl(ylvl(:len_trim(ylvl)))
  yform='(A11,I1.1,A5)'
  IF (jlevel >= 10)  yform='(A11,I2.2,A5)'
  WRITE(ycomment,fmt=yform) 'X_Y_SEAINDBATH',jlevel,' (J)'
  zwork=o%XSEABATH(:,jlevel)
  CALL write_surf(hselect,hprogram,yrecfm,zwork,iresp,hcomment=ycomment)  
END DO
!
!-------------------------------------------------------------------------------
!Sea Surface Salinity
!
yrecfm='SSS_OC'
ycomment='SSS_OC'
 CALL write_surf(hselect,hprogram,yrecfm,o%XSEAS(:,nockmin),iresp,hcomment=ycomment)
!-------------------------------------------------------------------------------
!Sea Surface Salinity
!
yrecfm='SEA_HMO'
ycomment='X_Y_'
 CALL write_surf(hselect,hprogram,yrecfm,o%XSEAHMO(:),iresp,hcomment=ycomment)
!-------------------------------------------------------------------------------
IF (lhook) CALL dr_hook('WRITESURF_OCEAN_N',1,zhook_handle)
!
END SUBROUTINE writesurf_ocean_n