New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
zdftke.F90 in NEMO/trunk/src/OCE/ZDF – NEMO

source: NEMO/trunk/src/OCE/ZDF/zdftke.F90 @ 12489

Last change on this file since 12489 was 12489, checked in by davestorkey, 4 years ago

Preparation for new timestepping scheme #2390.
Main changes:

  1. Initial euler timestep now handled in stp and not in TRA/DYN routines.
  2. Renaming of all timestep parameters. In summary, the namelist parameter is now rn_Dt and the current timestep is rDt (and rDt_ice, rDt_trc etc).
  3. Renaming of a few miscellaneous parameters, eg. atfp -> rn_atfp (namelist parameter used everywhere) and rau0 -> rho0.

This version gives bit-comparable results to the previous version of the trunk.

  • Property svn:keywords set to Id
File size: 39.3 KB
RevLine 
[1531]1MODULE zdftke
[1239]2   !!======================================================================
[1531]3   !!                       ***  MODULE  zdftke  ***
[1239]4   !! Ocean physics:  vertical mixing coefficient computed from the tke
5   !!                 turbulent closure parameterization
6   !!=====================================================================
[1492]7   !! History :  OPA  !  1991-03  (b. blanke)  Original code
8   !!            7.0  !  1991-11  (G. Madec)   bug fix
9   !!            7.1  !  1992-10  (G. Madec)   new mixing length and eav
10   !!            7.2  !  1993-03  (M. Guyon)   symetrical conditions
11   !!            7.3  !  1994-08  (G. Madec, M. Imbard)  nn_pdl flag
12   !!            7.5  !  1996-01  (G. Madec)   s-coordinates
13   !!            8.0  !  1997-07  (G. Madec)   lbc
14   !!            8.1  !  1999-01  (E. Stretta) new option for the mixing length
15   !!  NEMO      1.0  !  2002-06  (G. Madec) add tke_init routine
16   !!             -   !  2004-10  (C. Ethe )  1D configuration
17   !!            2.0  !  2006-07  (S. Masson)  distributed restart using iom
18   !!            3.0  !  2008-05  (C. Ethe,  G.Madec) : update TKE physics:
19   !!                 !           - tke penetration (wind steering)
20   !!                 !           - suface condition for tke & mixing length
21   !!                 !           - Langmuir cells
22   !!             -   !  2008-05  (J.-M. Molines, G. Madec)  2D form of avtb
23   !!             -   !  2008-06  (G. Madec)  style + DOCTOR name for namelist parameters
24   !!             -   !  2008-12  (G. Reffray) stable discretization of the production term
25   !!            3.2  !  2009-06  (G. Madec, S. Masson) TKE restart compatible with key_cpl
26   !!                 !                                + cleaning of the parameters + bugs correction
[2528]27   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
[5120]28   !!            3.6  !  2014-11  (P. Mathiot) add ice shelf capability
[9019]29   !!            4.0  !  2017-04  (G. Madec)  remove CPP ddm key & avm at t-point only
30   !!             -   !  2017-05  (G. Madec)  add top/bottom friction as boundary condition (ln_drg)
[1239]31   !!----------------------------------------------------------------------
[9019]32
[1239]33   !!----------------------------------------------------------------------
[3625]34   !!   zdf_tke       : update momentum and tracer Kz from a tke scheme
35   !!   tke_tke       : tke time stepping: update tke at now time step (en)
36   !!   tke_avn       : compute mixing length scale and deduce avm and avt
37   !!   zdf_tke_init  : initialization, namelist read, and parameters control
38   !!   tke_rst       : read/write tke restart in ocean restart file
[1239]39   !!----------------------------------------------------------------------
[2528]40   USE oce            ! ocean: dynamics and active tracers variables
41   USE phycst         ! physical constants
42   USE dom_oce        ! domain: ocean
43   USE domvvl         ! domain: variable volume layer
[1492]44   USE sbc_oce        ! surface boundary condition: ocean
[9019]45   USE zdfdrg         ! vertical physics: top/bottom drag coef.
[2528]46   USE zdfmxl         ! vertical physics: mixed layer
[9019]47   !
[1492]48   USE in_out_manager ! I/O manager
49   USE iom            ! I/O manager library
[2715]50   USE lib_mpp        ! MPP library
[9019]51   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
52   USE prtctl         ! Print control
[3625]53   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
[1239]54
55   IMPLICIT NONE
56   PRIVATE
57
[2528]58   PUBLIC   zdf_tke        ! routine called in step module
59   PUBLIC   zdf_tke_init   ! routine called in opa module
60   PUBLIC   tke_rst        ! routine called in step module
[1239]61
[4147]62   !                      !!** Namelist  namzdf_tke  **
63   LOGICAL  ::   ln_mxl0   ! mixing length scale surface value as function of wind stress or not
64   INTEGER  ::   nn_mxl    ! type of mixing length (=0/1/2/3)
65   REAL(wp) ::   rn_mxl0   ! surface  min value of mixing length (kappa*z_o=0.4*0.1 m)  [m]
66   INTEGER  ::   nn_pdl    ! Prandtl number or not (ratio avt/avm) (=0/1)
67   REAL(wp) ::   rn_ediff  ! coefficient for avt: avt=rn_ediff*mxl*sqrt(e)
68   REAL(wp) ::   rn_ediss  ! coefficient of the Kolmogoroff dissipation
69   REAL(wp) ::   rn_ebb    ! coefficient of the surface input of tke
70   REAL(wp) ::   rn_emin   ! minimum value of tke           [m2/s2]
71   REAL(wp) ::   rn_emin0  ! surface minimum value of tke   [m2/s2]
72   REAL(wp) ::   rn_bshear ! background shear (>0) currently a numerical threshold (do not change it)
[9019]73   LOGICAL  ::   ln_drg    ! top/bottom friction forcing flag
[4147]74   INTEGER  ::   nn_etau   ! type of depth penetration of surface tke (=0/1/2/3)
[9019]75   INTEGER  ::      nn_htau   ! type of tke profile of penetration (=0/1)
76   REAL(wp) ::      rn_efr    ! fraction of TKE surface value which penetrates in the ocean
[9546]77   REAL(wp) ::      rn_eice   ! =0 ON below sea-ice, =4 OFF when ice fraction > 1/4   
[4147]78   LOGICAL  ::   ln_lc     ! Langmuir cells (LC) as a source term of TKE or not
[9019]79   REAL(wp) ::      rn_lc     ! coef to compute vertical velocity of Langmuir cells
[1239]80
[4147]81   REAL(wp) ::   ri_cri    ! critic Richardson number (deduced from rn_ediff and rn_ediss values)
82   REAL(wp) ::   rmxl_min  ! minimum mixing length value (deduced from rn_ediff and rn_emin values)  [m]
[2528]83   REAL(wp) ::   rhftau_add = 1.e-3_wp     ! add offset   applied to HF part of taum  (nn_etau=3)
84   REAL(wp) ::   rhftau_scl = 1.0_wp       ! scale factor applied to HF part of taum  (nn_etau=3)
[1239]85
[9019]86   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   htau    ! depth of tke penetration (nn_htau)
87   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   dissl   ! now mixing lenght of dissipation
88   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   apdlr   ! now mixing lenght of dissipation
[1492]89
[1239]90   !! * Substitutions
[12377]91#  include "do_loop_substitute.h90"
[1239]92   !!----------------------------------------------------------------------
[9598]93   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[2528]94   !! $Id$
[10068]95   !! Software governed by the CeCILL license (see ./LICENSE)
[1239]96   !!----------------------------------------------------------------------
97CONTAINS
98
[2715]99   INTEGER FUNCTION zdf_tke_alloc()
100      !!----------------------------------------------------------------------
101      !!                ***  FUNCTION zdf_tke_alloc  ***
102      !!----------------------------------------------------------------------
[9019]103      ALLOCATE( htau(jpi,jpj) , dissl(jpi,jpj,jpk) , apdlr(jpi,jpj,jpk) ,   STAT= zdf_tke_alloc )
104      !
[10425]105      CALL mpp_sum ( 'zdftke', zdf_tke_alloc )
106      IF( zdf_tke_alloc /= 0 )   CALL ctl_stop( 'STOP', 'zdf_tke_alloc: failed to allocate arrays' )
[2715]107      !
108   END FUNCTION zdf_tke_alloc
109
110
[12377]111   SUBROUTINE zdf_tke( kt, Kbb, Kmm, p_sh2, p_avm, p_avt )
[1239]112      !!----------------------------------------------------------------------
[1531]113      !!                   ***  ROUTINE zdf_tke  ***
[1239]114      !!
115      !! ** Purpose :   Compute the vertical eddy viscosity and diffusivity
[1492]116      !!              coefficients using a turbulent closure scheme (TKE).
[1239]117      !!
[1492]118      !! ** Method  :   The time evolution of the turbulent kinetic energy (tke)
119      !!              is computed from a prognostic equation :
120      !!         d(en)/dt = avm (d(u)/dz)**2             ! shear production
121      !!                  + d( avm d(en)/dz )/dz         ! diffusion of tke
122      !!                  + avt N^2                      ! stratif. destruc.
123      !!                  - rn_ediss / emxl en**(2/3)    ! Kolmogoroff dissipation
[1239]124      !!      with the boundary conditions:
[1695]125      !!         surface: en = max( rn_emin0, rn_ebb * taum )
[1239]126      !!         bottom : en = rn_emin
[1492]127      !!      The associated critical Richardson number is: ri_cri = 2/(2+rn_ediss/rn_ediff)
128      !!
129      !!        The now Turbulent kinetic energy is computed using the following
130      !!      time stepping: implicit for vertical diffusion term, linearized semi
131      !!      implicit for kolmogoroff dissipation term, and explicit forward for
132      !!      both buoyancy and shear production terms. Therefore a tridiagonal
133      !!      linear system is solved. Note that buoyancy and shear terms are
134      !!      discretized in a energy conserving form (Bruchard 2002).
135      !!
136      !!        The dissipative and mixing length scale are computed from en and
137      !!      the stratification (see tke_avn)
138      !!
139      !!        The now vertical eddy vicosity and diffusivity coefficients are
140      !!      given by:
141      !!              avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
142      !!              avt = max( avmb, pdl * avm                 ) 
[1239]143      !!              eav = max( avmb, avm )
[1492]144      !!      where pdl, the inverse of the Prandtl number is 1 if nn_pdl=0 and
145      !!      given by an empirical funtion of the localRichardson number if nn_pdl=1
[1239]146      !!
147      !! ** Action  :   compute en (now turbulent kinetic energy)
[9019]148      !!                update avt, avm (before vertical eddy coef.)
[1239]149      !!
150      !! References : Gaspar et al., JGR, 1990,
151      !!              Blanke and Delecluse, JPO, 1991
152      !!              Mellor and Blumberg, JPO 2004
153      !!              Axell, JGR, 2002
[1492]154      !!              Bruchard OM 2002
[1239]155      !!----------------------------------------------------------------------
[9019]156      INTEGER                   , INTENT(in   ) ::   kt             ! ocean time step
[12377]157      INTEGER                   , INTENT(in   ) ::   Kbb, Kmm       ! ocean time level indices
[9019]158      REAL(wp), DIMENSION(:,:,:), INTENT(in   ) ::   p_sh2          ! shear production term
159      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   p_avm, p_avt   !  momentum and tracer Kz (w-points)
[1492]160      !!----------------------------------------------------------------------
[1481]161      !
[12377]162      CALL tke_tke( Kbb, Kmm, p_sh2, p_avm, p_avt )   ! now tke (en)
[5656]163      !
[12377]164      CALL tke_avn( Kbb, Kmm,        p_avm, p_avt )   ! now avt, avm, dissl
[3632]165      !
[5656]166  END SUBROUTINE zdf_tke
[1239]167
[1492]168
[12377]169   SUBROUTINE tke_tke( Kbb, Kmm, p_sh2, p_avm, p_avt )
[1239]170      !!----------------------------------------------------------------------
[1492]171      !!                   ***  ROUTINE tke_tke  ***
172      !!
173      !! ** Purpose :   Compute the now Turbulente Kinetic Energy (TKE)
174      !!
175      !! ** Method  : - TKE surface boundary condition
[2528]176      !!              - source term due to Langmuir cells (Axell JGR 2002) (ln_lc=T)
[9019]177      !!              - source term due to shear (= Kz dz[Ub] * dz[Un] )
[1492]178      !!              - Now TKE : resolution of the TKE equation by inverting
179      !!                a tridiagonal linear system by a "methode de chasse"
180      !!              - increase TKE due to surface and internal wave breaking
[9019]181      !!             NB: when sea-ice is present, both LC parameterization
182      !!                 and TKE penetration are turned off when the ice fraction
183      !!                 is smaller than 0.25
[1492]184      !!
185      !! ** Action  : - en : now turbulent kinetic energy)
[1239]186      !! ---------------------------------------------------------------------
[9019]187      USE zdf_oce , ONLY : en   ! ocean vertical physics
188      !!
[12377]189      INTEGER                    , INTENT(in   ) ::   Kbb, Kmm       ! ocean time level indices
[9019]190      REAL(wp), DIMENSION(:,:,:) , INTENT(in   ) ::   p_sh2          ! shear production term
191      REAL(wp), DIMENSION(:,:,:) , INTENT(in   ) ::   p_avm, p_avt   ! vertical eddy viscosity & diffusivity (w-points)
192      !
193      INTEGER ::   ji, jj, jk              ! dummy loop arguments
194      REAL(wp) ::   zetop, zebot, zmsku, zmskv ! local scalars
195      REAL(wp) ::   zrhoa  = 1.22              ! Air density kg/m3
196      REAL(wp) ::   zcdrag = 1.5e-3            ! drag coefficient
197      REAL(wp) ::   zbbrau, zri                ! local scalars
198      REAL(wp) ::   zfact1, zfact2, zfact3     !   -         -
199      REAL(wp) ::   ztx2  , zty2  , zcof       !   -         -
200      REAL(wp) ::   ztau  , zdif               !   -         -
201      REAL(wp) ::   zus   , zwlc  , zind       !   -         -
202      REAL(wp) ::   zzd_up, zzd_lw             !   -         -
203      INTEGER , DIMENSION(jpi,jpj)     ::   imlc
[10425]204      REAL(wp), DIMENSION(jpi,jpj)     ::   zhlc, zfr_i
[9019]205      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zpelc, zdiag, zd_up, zd_lw
[1239]206      !!--------------------------------------------------------------------
[1492]207      !
[12489]208      zbbrau = rn_ebb / rho0       ! Local constant initialisation
209      zfact1 = -.5_wp * rn_Dt 
210      zfact2 = 1.5_wp * rn_Dt * rn_ediss
[2528]211      zfact3 = 0.5_wp       * rn_ediss
[1492]212      !
213      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]214      !                     !  Surface/top/bottom boundary condition on tke
[1492]215      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]216     
[12377]217      DO_2D_00_00
218         en(ji,jj,1) = MAX( rn_emin0, zbbrau * taum(ji,jj) ) * tmask(ji,jj,1)
219      END_2D
[5120]220      IF ( ln_isfcav ) THEN
[12377]221         DO_2D_00_00
222            en(ji,jj,mikt(ji,jj)) = rn_emin * tmask(ji,jj,1)
223         END_2D
[9019]224      ENDIF
225      !
[1492]226      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
227      !                     !  Bottom boundary condition on tke
228      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1719]229      !
[12489]230      !   en(bot)   = (ebb0/rho0)*0.5*sqrt(u_botfr^2+v_botfr^2) (min value rn_emin)
[9019]231      ! where ebb0 does not includes surface wave enhancement (i.e. ebb0=3.75)
232      ! Note that stress averaged is done using an wet-only calculation of u and v at t-point like in zdfsh2
[1492]233      !
[9019]234      IF( ln_drg ) THEN       !== friction used as top/bottom boundary condition on TKE
235         !
[12377]236         DO_2D_00_00
237            zmsku = ( 2. - umask(ji-1,jj,mbkt(ji,jj)) * umask(ji,jj,mbkt(ji,jj)) )
238            zmskv = ( 2. - vmask(ji,jj-1,mbkt(ji,jj)) * vmask(ji,jj,mbkt(ji,jj)) )
[12489]239            !                       ! where 0.001875 = (rn_ebb0/rho0) * 0.5 = 3.75*0.5/1000. (CAUTION CdU<0)
[12377]240            zebot = - 0.001875_wp * rCdU_bot(ji,jj) * SQRT(  ( zmsku*( uu(ji,jj,mbkt(ji,jj),Kbb)+uu(ji-1,jj,mbkt(ji,jj),Kbb) ) )**2  &
241               &                                           + ( zmskv*( vv(ji,jj,mbkt(ji,jj),Kbb)+vv(ji,jj-1,mbkt(ji,jj),Kbb) ) )**2  )
242            en(ji,jj,mbkt(ji,jj)+1) = MAX( zebot, rn_emin ) * ssmask(ji,jj)
243         END_2D
[9019]244         IF( ln_isfcav ) THEN       ! top friction
[12377]245            DO_2D_00_00
246               zmsku = ( 2. - umask(ji-1,jj,mikt(ji,jj)) * umask(ji,jj,mikt(ji,jj)) )
247               zmskv = ( 2. - vmask(ji,jj-1,mikt(ji,jj)) * vmask(ji,jj,mikt(ji,jj)) )
[12489]248               !                             ! where 0.001875 = (rn_ebb0/rho0) * 0.5 = 3.75*0.5/1000.  (CAUTION CdU<0)
[12377]249               zetop = - 0.001875_wp * rCdU_top(ji,jj) * SQRT(  ( zmsku*( uu(ji,jj,mikt(ji,jj),Kbb)+uu(ji-1,jj,mikt(ji,jj),Kbb) ) )**2  &
250                  &                                           + ( zmskv*( vv(ji,jj,mikt(ji,jj),Kbb)+vv(ji,jj-1,mikt(ji,jj),Kbb) ) )**2  )
251               en(ji,jj,mikt(ji,jj)) = MAX( zetop, rn_emin ) * (1._wp - tmask(ji,jj,1))   ! masked at ocean surface
252            END_2D
[9019]253         ENDIF
254         !
255      ENDIF
256      !
[1492]257      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]258      IF( ln_lc ) THEN      !  Langmuir circulation source term added to tke   !   (Axell JGR 2002)
[1492]259         !                  !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1239]260         !
[1492]261         !                        !* total energy produce by LC : cumulative sum over jk
[12377]262         zpelc(:,:,1) =  MAX( rn2b(:,:,1), 0._wp ) * gdepw(:,:,1,Kmm) * e3w(:,:,1,Kmm)
[1239]263         DO jk = 2, jpk
[12377]264            zpelc(:,:,jk)  = zpelc(:,:,jk-1) + MAX( rn2b(:,:,jk), 0._wp ) * gdepw(:,:,jk,Kmm) * e3w(:,:,jk,Kmm)
[1239]265         END DO
[1492]266         !                        !* finite Langmuir Circulation depth
[1705]267         zcof = 0.5 * 0.016 * 0.016 / ( zrhoa * zcdrag )
[7753]268         imlc(:,:) = mbkt(:,:) + 1       ! Initialization to the number of w ocean point (=2 over land)
[12377]269         DO_3DS_11_11( jpkm1, 2, -1 )
270            zus  = zcof * taum(ji,jj)
271            IF( zpelc(ji,jj,jk) > zus )   imlc(ji,jj) = jk
272         END_3D
[1492]273         !                               ! finite LC depth
[12377]274         DO_2D_11_11
275            zhlc(ji,jj) = gdepw(ji,jj,imlc(ji,jj),Kmm)
276         END_2D
[1705]277         zcof = 0.016 / SQRT( zrhoa * zcdrag )
[12377]278         DO_2D_00_00
279            zus  = zcof * SQRT( taum(ji,jj) )           ! Stokes drift
280            zfr_i(ji,jj) = ( 1._wp - 4._wp * fr_i(ji,jj) ) * zus * zus * zus * tmask(ji,jj,1) ! zus > 0. ok
281            IF (zfr_i(ji,jj) < 0. ) zfr_i(ji,jj) = 0.
282         END_2D
283         DO_3D_00_00( 2, jpkm1 )
284            IF ( zfr_i(ji,jj) /= 0. ) THEN               
285               ! vertical velocity due to LC   
286               IF ( gdepw(ji,jj,jk,Kmm) - zhlc(ji,jj) < 0 .AND. wmask(ji,jj,jk) /= 0. ) THEN
287                  !                                           ! vertical velocity due to LC
288                  zwlc = rn_lc * SIN( rpi * gdepw(ji,jj,jk,Kmm) / zhlc(ji,jj) )   ! warning: optimization: zus^3 is in zfr_i
289                  !                                           ! TKE Langmuir circulation source term
[12489]290                  en(ji,jj,jk) = en(ji,jj,jk) + rn_Dt * zfr_i(ji,jj) * ( zwlc * zwlc * zwlc ) / zhlc(ji,jj)
[12377]291               ENDIF
292            ENDIF
293         END_3D
[1239]294         !
295      ENDIF
[1492]296      !
297      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
298      !                     !  Now Turbulent kinetic energy (output in en)
299      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
300      !                     ! Resolution of a tridiagonal linear system by a "methode de chasse"
301      !                     ! computation from level 2 to jpkm1  (e(1) already computed and e(jpk)=0 ).
302      !                     ! zdiag : diagonal zd_up : upper diagonal zd_lw : lower diagonal
303      !
[9019]304      IF( nn_pdl == 1 ) THEN      !* Prandtl number = F( Ri )
[12377]305         DO_3D_00_00( 2, jpkm1 )
306            !                             ! local Richardson number
307            zri = MAX( rn2b(ji,jj,jk), 0._wp ) * p_avm(ji,jj,jk) / ( p_sh2(ji,jj,jk) + rn_bshear )
308            !                             ! inverse of Prandtl number
309            apdlr(ji,jj,jk) = MAX(  0.1_wp,  ri_cri / MAX( ri_cri , zri )  )
310         END_3D
[5656]311      ENDIF
[5836]312      !         
[12377]313      DO_3D_00_00( 2, jpkm1 )
314         zcof   = zfact1 * tmask(ji,jj,jk)
315         !                                   ! A minimum of 2.e-5 m2/s is imposed on TKE vertical
316         !                                   ! eddy coefficient (ensure numerical stability)
317         zzd_up = zcof * MAX(  p_avm(ji,jj,jk+1) + p_avm(ji,jj,jk  ) , 2.e-5_wp  )   &  ! upper diagonal
318            &          /    (  e3t(ji,jj,jk  ,Kmm) * e3w(ji,jj,jk  ,Kmm)  )
319         zzd_lw = zcof * MAX(  p_avm(ji,jj,jk  ) + p_avm(ji,jj,jk-1) , 2.e-5_wp  )   &  ! lower diagonal
320            &          /    (  e3t(ji,jj,jk-1,Kmm) * e3w(ji,jj,jk  ,Kmm)  )
321         !
322         zd_up(ji,jj,jk) = zzd_up            ! Matrix (zdiag, zd_up, zd_lw)
323         zd_lw(ji,jj,jk) = zzd_lw
324         zdiag(ji,jj,jk) = 1._wp - zzd_lw - zzd_up + zfact2 * dissl(ji,jj,jk) * wmask(ji,jj,jk)
325         !
326         !                                   ! right hand side in en
[12489]327         en(ji,jj,jk) = en(ji,jj,jk) + rn_Dt * (  p_sh2(ji,jj,jk)                        &   ! shear
[12377]328            &                                 - p_avt(ji,jj,jk) * rn2(ji,jj,jk)          &   ! stratification
329            &                                 + zfact3 * dissl(ji,jj,jk) * en(ji,jj,jk)  &   ! dissipation
330            &                                ) * wmask(ji,jj,jk)
331      END_3D
[5120]332      !                          !* Matrix inversion from level 2 (tke prescribed at level 1)
[12377]333      DO_3D_00_00( 3, jpkm1 )
334         zdiag(ji,jj,jk) = zdiag(ji,jj,jk) - zd_lw(ji,jj,jk) * zd_up(ji,jj,jk-1) / zdiag(ji,jj,jk-1)
335      END_3D
336      DO_2D_00_00
337         zd_lw(ji,jj,2) = en(ji,jj,2) - zd_lw(ji,jj,2) * en(ji,jj,1)    ! Surface boudary conditions on tke
338      END_2D
339      DO_3D_00_00( 3, jpkm1 )
340         zd_lw(ji,jj,jk) = en(ji,jj,jk) - zd_lw(ji,jj,jk) / zdiag(ji,jj,jk-1) *zd_lw(ji,jj,jk-1)
341      END_3D
342      DO_2D_00_00
343         en(ji,jj,jpkm1) = zd_lw(ji,jj,jpkm1) / zdiag(ji,jj,jpkm1)
344      END_2D
345      DO_3DS_00_00( jpk-2, 2, -1 )
346         en(ji,jj,jk) = ( zd_lw(ji,jj,jk) - zd_up(ji,jj,jk) * en(ji,jj,jk+1) ) / zdiag(ji,jj,jk)
347      END_3D
348      DO_3D_00_00( 2, jpkm1 )
349         en(ji,jj,jk) = MAX( en(ji,jj,jk), rn_emin ) * wmask(ji,jj,jk)
350      END_3D
[9019]351      !
[1492]352      !                            !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
353      !                            !  TKE due to surface and internal wave breaking
354      !                            !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[6140]355!!gm BUG : in the exp  remove the depth of ssh !!!
[12377]356!!gm       i.e. use gde3w in argument (gdepw(:,:,:,Kmm))
[6140]357     
358     
[2528]359      IF( nn_etau == 1 ) THEN           !* penetration below the mixed layer (rn_efr fraction)
[12377]360         DO_3D_00_00( 2, jpkm1 )
361            en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -gdepw(ji,jj,jk,Kmm) / htau(ji,jj) )   &
362               &                                 * MAX(0.,1._wp - rn_eice *fr_i(ji,jj) )  * wmask(ji,jj,jk) * tmask(ji,jj,1)
363         END_3D
[2528]364      ELSEIF( nn_etau == 2 ) THEN       !* act only at the base of the mixed layer (jk=nmln)  (rn_efr fraction)
[12377]365         DO_2D_00_00
366            jk = nmln(ji,jj)
367            en(ji,jj,jk) = en(ji,jj,jk) + rn_efr * en(ji,jj,1) * EXP( -gdepw(ji,jj,jk,Kmm) / htau(ji,jj) )   &
368               &                                 * MAX(0.,1._wp - rn_eice *fr_i(ji,jj) )  * wmask(ji,jj,jk) * tmask(ji,jj,1)
369         END_2D
[2528]370      ELSEIF( nn_etau == 3 ) THEN       !* penetration belox the mixed layer (HF variability)
[12377]371         DO_3D_00_00( 2, jpkm1 )
372            ztx2 = utau(ji-1,jj  ) + utau(ji,jj)
373            zty2 = vtau(ji  ,jj-1) + vtau(ji,jj)
374            ztau = 0.5_wp * SQRT( ztx2 * ztx2 + zty2 * zty2 ) * tmask(ji,jj,1)    ! module of the mean stress
375            zdif = taum(ji,jj) - ztau                            ! mean of modulus - modulus of the mean
376            zdif = rhftau_scl * MAX( 0._wp, zdif + rhftau_add )  ! apply some modifications...
377            en(ji,jj,jk) = en(ji,jj,jk) + zbbrau * zdif * EXP( -gdepw(ji,jj,jk,Kmm) / htau(ji,jj) )   &
378               &                        * MAX(0.,1._wp - rn_eice *fr_i(ji,jj) ) * wmask(ji,jj,jk) * tmask(ji,jj,1)
379         END_3D
[1239]380      ENDIF
[1492]381      !
[1239]382   END SUBROUTINE tke_tke
383
[1492]384
[12377]385   SUBROUTINE tke_avn( Kbb, Kmm, p_avm, p_avt )
[1239]386      !!----------------------------------------------------------------------
[1492]387      !!                   ***  ROUTINE tke_avn  ***
[1239]388      !!
[1492]389      !! ** Purpose :   Compute the vertical eddy viscosity and diffusivity
390      !!
391      !! ** Method  :   At this stage, en, the now TKE, is known (computed in
392      !!              the tke_tke routine). First, the now mixing lenth is
393      !!      computed from en and the strafification (N^2), then the mixings
394      !!      coefficients are computed.
395      !!              - Mixing length : a first evaluation of the mixing lengh
396      !!      scales is:
397      !!                      mxl = sqrt(2*en) / N 
398      !!      where N is the brunt-vaisala frequency, with a minimum value set
[2528]399      !!      to rmxl_min (rn_mxl0) in the interior (surface) ocean.
[1492]400      !!        The mixing and dissipative length scale are bound as follow :
401      !!         nn_mxl=0 : mxl bounded by the distance to surface and bottom.
402      !!                        zmxld = zmxlm = mxl
403      !!         nn_mxl=1 : mxl bounded by the e3w and zmxld = zmxlm = mxl
404      !!         nn_mxl=2 : mxl bounded such that the vertical derivative of mxl is
405      !!                    less than 1 (|d/dz(mxl)|<1) and zmxld = zmxlm = mxl
406      !!         nn_mxl=3 : mxl is bounded from the surface to the bottom usings
407      !!                    |d/dz(xml)|<1 to obtain lup, and from the bottom to
408      !!                    the surface to obtain ldown. the resulting length
409      !!                    scales are:
410      !!                        zmxld = sqrt( lup * ldown )
411      !!                        zmxlm = min ( lup , ldown )
412      !!              - Vertical eddy viscosity and diffusivity:
413      !!                      avm = max( avtb, rn_ediff * zmxlm * en^1/2 )
414      !!                      avt = max( avmb, pdlr * avm ) 
415      !!      with pdlr=1 if nn_pdl=0, pdlr=1/pdl=F(Ri) otherwise.
416      !!
[9019]417      !! ** Action  : - avt, avm : now vertical eddy diffusivity and viscosity (w-point)
[1239]418      !!----------------------------------------------------------------------
[9019]419      USE zdf_oce , ONLY : en, avtb, avmb, avtb_2d   ! ocean vertical physics
420      !!
[12377]421      INTEGER                   , INTENT(in   ) ::   Kbb, Kmm       ! ocean time level indices
[9019]422      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   p_avm, p_avt   ! vertical eddy viscosity & diffusivity (w-points)
423      !
[2715]424      INTEGER  ::   ji, jj, jk   ! dummy loop indices
[9019]425      REAL(wp) ::   zrn2, zraug, zcoef, zav   ! local scalars
426      REAL(wp) ::   zdku,   zdkv, zsqen       !   -      -
427      REAL(wp) ::   zemxl, zemlm, zemlp       !   -      -
428      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zmxlm, zmxld   ! 3D workspace
[1239]429      !!--------------------------------------------------------------------
[3294]430      !
[1492]431      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
432      !                     !  Mixing length
433      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
434      !
435      !                     !* Buoyancy length scale: l=sqrt(2*e/n**2)
436      !
[5120]437      ! initialisation of interior minimum value (avoid a 2d loop with mikt)
[7753]438      zmxlm(:,:,:)  = rmxl_min   
439      zmxld(:,:,:)  = rmxl_min
[5120]440      !
[12489]441      IF( ln_mxl0 ) THEN            ! surface mixing length = F(stress) : l=vkarmn*2.e5*taum/(rho0*g)
442         zraug = vkarmn * 2.e5_wp / ( rho0 * grav )
[12377]443         DO_2D_00_00
444            zmxlm(ji,jj,1) = MAX( rn_mxl0, zraug * taum(ji,jj) * tmask(ji,jj,1) )
445         END_2D
[4990]446      ELSE
[7753]447         zmxlm(:,:,1) = rn_mxl0
[1239]448      ENDIF
449      !
[12377]450      DO_3D_00_00( 2, jpkm1 )
451         zrn2 = MAX( rn2(ji,jj,jk), rsmall )
452         zmxlm(ji,jj,jk) = MAX(  rmxl_min,  SQRT( 2._wp * en(ji,jj,jk) / zrn2 )  )
453      END_3D
[1492]454      !
455      !                     !* Physical limits for the mixing length
456      !
[7753]457      zmxld(:,:, 1 ) = zmxlm(:,:,1)   ! surface set to the minimum value
458      zmxld(:,:,jpk) = rmxl_min       ! last level  set to the minimum value
[1492]459      !
[1239]460      SELECT CASE ( nn_mxl )
461      !
[5836]462 !!gm Not sure of that coding for ISF....
[12377]463      ! where wmask = 0 set zmxlm == e3w(:,:,:,Kmm)
[1239]464      CASE ( 0 )           ! bounded by the distance to surface and bottom
[12377]465         DO_3D_00_00( 2, jpkm1 )
466            zemxl = MIN( gdepw(ji,jj,jk,Kmm) - gdepw(ji,jj,mikt(ji,jj),Kmm), zmxlm(ji,jj,jk),   &
467            &            gdepw(ji,jj,mbkt(ji,jj)+1,Kmm) - gdepw(ji,jj,jk,Kmm) )
468            ! wmask prevent zmxlm = 0 if jk = mikt(ji,jj)
469            zmxlm(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN( zmxlm(ji,jj,jk) , e3w(ji,jj,jk,Kmm) ) * (1 - wmask(ji,jj,jk))
470            zmxld(ji,jj,jk) = zemxl * wmask(ji,jj,jk) + MIN( zmxlm(ji,jj,jk) , e3w(ji,jj,jk,Kmm) ) * (1 - wmask(ji,jj,jk))
471         END_3D
[1239]472         !
473      CASE ( 1 )           ! bounded by the vertical scale factor
[12377]474         DO_3D_00_00( 2, jpkm1 )
475            zemxl = MIN( e3w(ji,jj,jk,Kmm), zmxlm(ji,jj,jk) )
476            zmxlm(ji,jj,jk) = zemxl
477            zmxld(ji,jj,jk) = zemxl
478         END_3D
[1239]479         !
480      CASE ( 2 )           ! |dk[xml]| bounded by e3t :
[12377]481         DO_3D_00_00( 2, jpkm1 )
482            zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk-1) + e3t(ji,jj,jk-1,Kmm), zmxlm(ji,jj,jk) )
483         END_3D
484         DO_3DS_00_00( jpkm1, 2, -1 )
485            zemxl = MIN( zmxlm(ji,jj,jk+1) + e3t(ji,jj,jk+1,Kmm), zmxlm(ji,jj,jk) )
486            zmxlm(ji,jj,jk) = zemxl
487            zmxld(ji,jj,jk) = zemxl
488         END_3D
[1239]489         !
490      CASE ( 3 )           ! lup and ldown, |dk[xml]| bounded by e3t :
[12377]491         DO_3D_00_00( 2, jpkm1 )
492            zmxld(ji,jj,jk) = MIN( zmxld(ji,jj,jk-1) + e3t(ji,jj,jk-1,Kmm), zmxlm(ji,jj,jk) )
493         END_3D
494         DO_3DS_00_00( jpkm1, 2, -1 )
495            zmxlm(ji,jj,jk) = MIN( zmxlm(ji,jj,jk+1) + e3t(ji,jj,jk+1,Kmm), zmxlm(ji,jj,jk) )
496         END_3D
497         DO_3D_00_00( 2, jpkm1 )
498            zemlm = MIN ( zmxld(ji,jj,jk),  zmxlm(ji,jj,jk) )
499            zemlp = SQRT( zmxld(ji,jj,jk) * zmxlm(ji,jj,jk) )
500            zmxlm(ji,jj,jk) = zemlm
501            zmxld(ji,jj,jk) = zemlp
502         END_3D
[1239]503         !
504      END SELECT
[1492]505      !
506      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[9019]507      !                     !  Vertical eddy viscosity and diffusivity  (avm and avt)
[1492]508      !                     !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12377]509      DO_3D_00_00( 1, jpkm1 )
510         zsqen = SQRT( en(ji,jj,jk) )
511         zav   = rn_ediff * zmxlm(ji,jj,jk) * zsqen
512         p_avm(ji,jj,jk) = MAX( zav,                  avmb(jk) ) * wmask(ji,jj,jk)
513         p_avt(ji,jj,jk) = MAX( zav, avtb_2d(ji,jj) * avtb(jk) ) * wmask(ji,jj,jk)
514         dissl(ji,jj,jk) = zsqen / zmxld(ji,jj,jk)
515      END_3D
[1492]516      !
517      !
518      IF( nn_pdl == 1 ) THEN      !* Prandtl number case: update avt
[12377]519         DO_3D_00_00( 2, jpkm1 )
520            p_avt(ji,jj,jk)   = MAX( apdlr(ji,jj,jk) * p_avt(ji,jj,jk), avtb_2d(ji,jj) * avtb(jk) ) * tmask(ji,jj,jk)
521         END_3D
[1239]522      ENDIF
[9019]523      !
[12377]524      IF(sn_cfctl%l_prtctl) THEN
[9440]525         CALL prt_ctl( tab3d_1=en   , clinfo1=' tke  - e: ', tab3d_2=p_avt, clinfo2=' t: ', kdim=jpk)
526         CALL prt_ctl( tab3d_1=p_avm, clinfo1=' tke  - m: ', kdim=jpk )
[1239]527      ENDIF
528      !
[1492]529   END SUBROUTINE tke_avn
[1239]530
[1492]531
[12377]532   SUBROUTINE zdf_tke_init( Kmm )
[1239]533      !!----------------------------------------------------------------------
[2528]534      !!                  ***  ROUTINE zdf_tke_init  ***
[1239]535      !!                     
536      !! ** Purpose :   Initialization of the vertical eddy diffivity and
[1492]537      !!              viscosity when using a tke turbulent closure scheme
[1239]538      !!
[1601]539      !! ** Method  :   Read the namzdf_tke namelist and check the parameters
[1492]540      !!              called at the first timestep (nit000)
[1239]541      !!
[1601]542      !! ** input   :   Namlist namzdf_tke
[1239]543      !!
544      !! ** Action  :   Increase by 1 the nstop flag is setting problem encounter
545      !!----------------------------------------------------------------------
[9019]546      USE zdf_oce , ONLY : ln_zdfiwm   ! Internal Wave Mixing flag
547      !!
[12377]548      INTEGER, INTENT(in) ::   Kmm          ! time level index
549      INTEGER             ::   ji, jj, jk   ! dummy loop indices
550      INTEGER             ::   ios
[1239]551      !!
[9019]552      NAMELIST/namzdf_tke/ rn_ediff, rn_ediss , rn_ebb , rn_emin  ,          &
553         &                 rn_emin0, rn_bshear, nn_mxl , ln_mxl0  ,          &
554         &                 rn_mxl0 , nn_pdl   , ln_drg , ln_lc    , rn_lc,   &
[9558]555         &                 nn_etau , nn_htau  , rn_efr , rn_eice 
[1239]556      !!----------------------------------------------------------------------
[2715]557      !
[4147]558      READ  ( numnam_ref, namzdf_tke, IOSTAT = ios, ERR = 901)
[11536]559901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_tke in reference namelist' )
[4147]560
561      READ  ( numnam_cfg, namzdf_tke, IOSTAT = ios, ERR = 902 )
[11536]562902   IF( ios >  0 ) CALL ctl_nam ( ios , 'namzdf_tke in configuration namelist' )
[4624]563      IF(lwm) WRITE ( numond, namzdf_tke )
[2715]564      !
[2528]565      ri_cri   = 2._wp    / ( 2._wp + rn_ediss / rn_ediff )   ! resulting critical Richardson number
[2715]566      !
[1492]567      IF(lwp) THEN                    !* Control print
[1239]568         WRITE(numout,*)
[2528]569         WRITE(numout,*) 'zdf_tke_init : tke turbulent closure scheme - initialisation'
570         WRITE(numout,*) '~~~~~~~~~~~~'
[1601]571         WRITE(numout,*) '   Namelist namzdf_tke : set tke mixing parameters'
[1705]572         WRITE(numout,*) '      coef. to compute avt                        rn_ediff  = ', rn_ediff
573         WRITE(numout,*) '      Kolmogoroff dissipation coef.               rn_ediss  = ', rn_ediss
574         WRITE(numout,*) '      tke surface input coef.                     rn_ebb    = ', rn_ebb
575         WRITE(numout,*) '      minimum value of tke                        rn_emin   = ', rn_emin
576         WRITE(numout,*) '      surface minimum value of tke                rn_emin0  = ', rn_emin0
[9019]577         WRITE(numout,*) '      prandl number flag                          nn_pdl    = ', nn_pdl
[1705]578         WRITE(numout,*) '      background shear (>0)                       rn_bshear = ', rn_bshear
579         WRITE(numout,*) '      mixing length type                          nn_mxl    = ', nn_mxl
[9019]580         WRITE(numout,*) '         surface mixing length = F(stress) or not    ln_mxl0   = ', ln_mxl0
581         WRITE(numout,*) '         surface  mixing length minimum value        rn_mxl0   = ', rn_mxl0
582         WRITE(numout,*) '      top/bottom friction forcing flag            ln_drg    = ', ln_drg
583         WRITE(numout,*) '      Langmuir cells parametrization              ln_lc     = ', ln_lc
584         WRITE(numout,*) '         coef to compute vertical velocity of LC     rn_lc  = ', rn_lc
[1705]585         WRITE(numout,*) '      test param. to add tke induced by wind      nn_etau   = ', nn_etau
[9019]586         WRITE(numout,*) '          type of tke penetration profile            nn_htau   = ', nn_htau
587         WRITE(numout,*) '          fraction of TKE that penetrates            rn_efr    = ', rn_efr
[9546]588         WRITE(numout,*) '          below sea-ice:  =0 ON                      rn_eice   = ', rn_eice
589         WRITE(numout,*) '          =4 OFF when ice fraction > 1/4   '
[9019]590         IF( ln_drg ) THEN
[9169]591            WRITE(numout,*)
[9019]592            WRITE(numout,*) '   Namelist namdrg_top/_bot:   used values:'
593            WRITE(numout,*) '      top    ocean cavity roughness (m)          rn_z0(_top)= ', r_z0_top
594            WRITE(numout,*) '      Bottom seafloor     roughness (m)          rn_z0(_bot)= ', r_z0_bot
595         ENDIF
596         WRITE(numout,*)
[9190]597         WRITE(numout,*) '   ==>>>   critical Richardson nb with your parameters  ri_cri = ', ri_cri
[9019]598         WRITE(numout,*)
[1239]599      ENDIF
[2715]600      !
[9019]601      IF( ln_zdfiwm ) THEN          ! Internal wave-driven mixing
602         rn_emin  = 1.e-10_wp             ! specific values of rn_emin & rmxl_min are used
603         rmxl_min = 1.e-03_wp             ! associated avt minimum = molecular salt diffusivity (10^-9 m2/s)
[9190]604         IF(lwp) WRITE(numout,*) '   ==>>>   Internal wave-driven mixing case:   force   rn_emin = 1.e-10 and rmxl_min = 1.e-3'
[9019]605      ELSE                          ! standard case : associated avt minimum = molecular viscosity (10^-6 m2/s)
606         rmxl_min = 1.e-6_wp / ( rn_ediff * SQRT( rn_emin ) )    ! resulting minimum length to recover molecular viscosity
[9190]607         IF(lwp) WRITE(numout,*) '   ==>>>   minimum mixing length with your parameters rmxl_min = ', rmxl_min
[9019]608      ENDIF
609      !
[2715]610      !                              ! allocate tke arrays
611      IF( zdf_tke_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'zdf_tke_init : unable to allocate arrays' )
612      !
[1492]613      !                               !* Check of some namelist values
[4990]614      IF( nn_mxl  < 0   .OR.  nn_mxl  > 3 )   CALL ctl_stop( 'bad flag: nn_mxl is  0, 1 or 2 ' )
615      IF( nn_pdl  < 0   .OR.  nn_pdl  > 1 )   CALL ctl_stop( 'bad flag: nn_pdl is  0 or 1    ' )
616      IF( nn_htau < 0   .OR.  nn_htau > 1 )   CALL ctl_stop( 'bad flag: nn_htau is 0, 1 or 2 ' )
[5407]617      IF( nn_etau == 3 .AND. .NOT. ln_cpl )   CALL ctl_stop( 'nn_etau == 3 : HF taum only known in coupled mode' )
[9019]618      !
[2528]619      IF( ln_mxl0 ) THEN
[9169]620         IF(lwp) WRITE(numout,*)
[9190]621         IF(lwp) WRITE(numout,*) '   ==>>>   use a surface mixing length = F(stress) :   set rn_mxl0 = rmxl_min'
[2528]622         rn_mxl0 = rmxl_min
623      ENDIF
624     
[12377]625      IF( nn_etau == 2  )   CALL zdf_mxl( nit000, Kmm )      ! Initialization of nmln
[1239]626
[1492]627      !                               !* depth of penetration of surface tke
628      IF( nn_etau /= 0 ) THEN     
[1601]629         SELECT CASE( nn_htau )             ! Choice of the depth of penetration
[2528]630         CASE( 0 )                                 ! constant depth penetration (here 10 meters)
[7753]631            htau(:,:) = 10._wp
[2528]632         CASE( 1 )                                 ! F(latitude) : 0.5m to 30m poleward of 40 degrees
[7753]633            htau(:,:) = MAX(  0.5_wp, MIN( 30._wp, 45._wp* ABS( SIN( rpi/180._wp * gphit(:,:) ) ) )   )           
[1492]634         END SELECT
635      ENDIF
[9019]636      !                                !* read or initialize all required files
637      CALL tke_rst( nit000, 'READ' )      ! (en, avt_k, avm_k, dissl)
[1239]638      !
[9367]639      IF( lwxios ) THEN
640         CALL iom_set_rstw_var_active('en')
641         CALL iom_set_rstw_var_active('avt_k')
642         CALL iom_set_rstw_var_active('avm_k')
643         CALL iom_set_rstw_var_active('dissl')
644      ENDIF
[2528]645   END SUBROUTINE zdf_tke_init
[1239]646
647
[1531]648   SUBROUTINE tke_rst( kt, cdrw )
[9019]649      !!---------------------------------------------------------------------
650      !!                   ***  ROUTINE tke_rst  ***
651      !!                     
652      !! ** Purpose :   Read or write TKE file (en) in restart file
653      !!
654      !! ** Method  :   use of IOM library
655      !!                if the restart does not contain TKE, en is either
656      !!                set to rn_emin or recomputed
657      !!----------------------------------------------------------------------
658      USE zdf_oce , ONLY : en, avt_k, avm_k   ! ocean vertical physics
659      !!
660      INTEGER         , INTENT(in) ::   kt     ! ocean time-step
661      CHARACTER(len=*), INTENT(in) ::   cdrw   ! "READ"/"WRITE" flag
662      !
663      INTEGER ::   jit, jk              ! dummy loop indices
664      INTEGER ::   id1, id2, id3, id4   ! local integers
665      !!----------------------------------------------------------------------
666      !
667      IF( TRIM(cdrw) == 'READ' ) THEN        ! Read/initialise
668         !                                   ! ---------------
669         IF( ln_rstart ) THEN                   !* Read the restart file
670            id1 = iom_varid( numror, 'en'   , ldstop = .FALSE. )
671            id2 = iom_varid( numror, 'avt_k', ldstop = .FALSE. )
672            id3 = iom_varid( numror, 'avm_k', ldstop = .FALSE. )
673            id4 = iom_varid( numror, 'dissl', ldstop = .FALSE. )
674            !
675            IF( MIN( id1, id2, id3, id4 ) > 0 ) THEN      ! fields exist
[9367]676               CALL iom_get( numror, jpdom_autoglo, 'en'   , en   , ldxios = lrxios )
677               CALL iom_get( numror, jpdom_autoglo, 'avt_k', avt_k, ldxios = lrxios )
678               CALL iom_get( numror, jpdom_autoglo, 'avm_k', avm_k, ldxios = lrxios )
679               CALL iom_get( numror, jpdom_autoglo, 'dissl', dissl, ldxios = lrxios )
[9019]680            ELSE                                          ! start TKE from rest
[9169]681               IF(lwp) WRITE(numout,*)
[9190]682               IF(lwp) WRITE(numout,*) '   ==>>>   previous run without TKE scheme, set en to background values'
[9019]683               en   (:,:,:) = rn_emin * wmask(:,:,:)
684               dissl(:,:,:) = 1.e-12_wp
685               ! avt_k, avm_k already set to the background value in zdf_phy_init
686            ENDIF
687         ELSE                                   !* Start from rest
[9169]688            IF(lwp) WRITE(numout,*)
[9190]689            IF(lwp) WRITE(numout,*) '   ==>>>   start from rest: set en to the background value'
[9019]690            en   (:,:,:) = rn_emin * wmask(:,:,:)
691            dissl(:,:,:) = 1.e-12_wp
692            ! avt_k, avm_k already set to the background value in zdf_phy_init
693         ENDIF
694         !
695      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN   ! Create restart file
696         !                                   ! -------------------
[9169]697         IF(lwp) WRITE(numout,*) '---- tke_rst ----'
[9367]698         IF( lwxios ) CALL iom_swap(      cwxios_context          ) 
699         CALL iom_rstput( kt, nitrst, numrow, 'en'   , en   , ldxios = lwxios )
700         CALL iom_rstput( kt, nitrst, numrow, 'avt_k', avt_k, ldxios = lwxios )
701         CALL iom_rstput( kt, nitrst, numrow, 'avm_k', avm_k, ldxios = lwxios )
702         CALL iom_rstput( kt, nitrst, numrow, 'dissl', dissl, ldxios = lwxios )
703         IF( lwxios ) CALL iom_swap(      cxios_context          )
[9019]704         !
705      ENDIF
706      !
[1531]707   END SUBROUTINE tke_rst
[1239]708
709   !!======================================================================
[1531]710END MODULE zdftke
Note: See TracBrowser for help on using the repository browser.