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.
zdfgls.F90 in branches/UKMO/dev_r5518_obs_oper_update/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/UKMO/dev_r5518_obs_oper_update/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfgls.F90 @ 9188

Last change on this file since 9188 was 9188, checked in by kingr, 6 years ago

Small change to zdftke/zdfgls to avoid merge conflicts with AMM15 branch.
File size: 57.8 KB
Line 
1MODULE zdfgls
2   !!======================================================================
3   !!                       ***  MODULE  zdfgls  ***
4   !! Ocean physics:  vertical mixing coefficient computed from the gls
5   !!                 turbulent closure parameterization
6   !!======================================================================
7   !! History :   3.0  !  2009-09  (G. Reffray)  Original code
8   !!             3.3  !  2010-10  (C. Bricaud)  Add in the reference
9   !!----------------------------------------------------------------------
10#if defined key_zdfgls   ||   defined key_esopa
11   !!----------------------------------------------------------------------
12   !!   'key_zdfgls'                 Generic Length Scale vertical physics
13   !!----------------------------------------------------------------------
14   !!   zdf_gls       : update momentum and tracer Kz from a gls scheme
15   !!   zdf_gls_init  : initialization, namelist read, and parameters control
16   !!   gls_rst       : read/write gls restart in ocean restart file
17   !!----------------------------------------------------------------------
18   USE oce            ! ocean dynamics and active tracers
19   USE dom_oce        ! ocean space and time domain
20   USE domvvl         ! ocean space and time domain : variable volume layer
21   USE zdf_oce        ! ocean vertical physics
22   USE zdfbfr         ! bottom friction (only for rn_bfrz0)
23   USE sbc_oce        ! surface boundary condition: ocean
24   USE phycst         ! physical constants
25   USE zdfmxl         ! mixed layer
26   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
27   USE lib_mpp        ! MPP manager
28   USE wrk_nemo       ! work arrays
29   USE prtctl         ! Print control
30   USE in_out_manager ! I/O manager
31   USE iom            ! I/O manager library
32   USE timing         ! Timing
33   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
34
35   IMPLICIT NONE
36   PRIVATE
37
38   PUBLIC   zdf_gls        ! routine called in step module
39   PUBLIC   zdf_gls_init   ! routine called in opa module
40   PUBLIC   gls_rst        ! routine called in step module
41
42   LOGICAL , PUBLIC, PARAMETER ::   lk_zdfgls = .TRUE.   !: TKE vertical mixing flag
43   !
44   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   mxln    !: now mixing length
45   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   zwall   !: wall function
46   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   ustars2 !: Squared surface velocity scale at T-points
47   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   ustarb2 !: Squared bottom  velocity scale at T-points
48
49   !                              !! ** Namelist  namzdf_gls  **
50   LOGICAL  ::   ln_length_lim     ! use limit on the dissipation rate under stable stratification (Galperin et al. 1988)
51   LOGICAL  ::   ln_sigpsi         ! Activate Burchard (2003) modification for k-eps closure & wave breaking mixing
52   INTEGER  ::   nn_bc_surf        ! surface boundary condition (=0/1)
53   INTEGER  ::   nn_bc_bot         ! bottom boundary condition (=0/1)
54   INTEGER  ::   nn_z0_met         ! Method for surface roughness computation
55   INTEGER  ::   nn_stab_func      ! stability functions G88, KC or Canuto (=0/1/2)
56   INTEGER  ::   nn_clos           ! closure 0/1/2/3 MY82/k-eps/k-w/gen
57   REAL(wp) ::   rn_clim_galp      ! Holt 2008 value for k-eps: 0.267
58   REAL(wp) ::   rn_epsmin         ! minimum value of dissipation (m2/s3)
59   REAL(wp) ::   rn_emin           ! minimum value of TKE (m2/s2)
60   REAL(wp) ::   rn_charn          ! Charnock constant for surface breaking waves mixing : 1400. (standard) or 2.e5 (Stacey value)
61   REAL(wp) ::   rn_crban          ! Craig and Banner constant for surface breaking waves mixing
62   REAL(wp) ::   rn_hsro           ! Minimum surface roughness
63   REAL(wp) ::   rn_frac_hs        ! Fraction of wave height as surface roughness (if nn_z0_met > 1)
64
65   REAL(wp) ::   rcm_sf        =  0.73_wp     ! Shear free turbulence parameters
66   REAL(wp) ::   ra_sf         = -2.0_wp      ! Must be negative -2 < ra_sf < -1
67   REAL(wp) ::   rl_sf         =  0.2_wp      ! 0 <rl_sf<vkarmn   
68   REAL(wp) ::   rghmin        = -0.28_wp
69   REAL(wp) ::   rgh0          =  0.0329_wp
70   REAL(wp) ::   rghcri        =  0.03_wp
71   REAL(wp) ::   ra1           =  0.92_wp
72   REAL(wp) ::   ra2           =  0.74_wp
73   REAL(wp) ::   rb1           = 16.60_wp
74   REAL(wp) ::   rb2           = 10.10_wp         
75   REAL(wp) ::   re2           =  1.33_wp         
76   REAL(wp) ::   rl1           =  0.107_wp
77   REAL(wp) ::   rl2           =  0.0032_wp
78   REAL(wp) ::   rl3           =  0.0864_wp
79   REAL(wp) ::   rl4           =  0.12_wp
80   REAL(wp) ::   rl5           = 11.9_wp
81   REAL(wp) ::   rl6           =  0.4_wp
82   REAL(wp) ::   rl7           =  0.0_wp
83   REAL(wp) ::   rl8           =  0.48_wp
84   REAL(wp) ::   rm1           =  0.127_wp
85   REAL(wp) ::   rm2           =  0.00336_wp
86   REAL(wp) ::   rm3           =  0.0906_wp
87   REAL(wp) ::   rm4           =  0.101_wp
88   REAL(wp) ::   rm5           = 11.2_wp
89   REAL(wp) ::   rm6           =  0.4_wp
90   REAL(wp) ::   rm7           =  0.0_wp
91   REAL(wp) ::   rm8           =  0.318_wp
92   REAL(wp) ::   rtrans        =  0.1_wp
93   REAL(wp) ::   rc02, rc02r, rc03, rc04                          ! coefficients deduced from above parameters
94   REAL(wp) ::   rsbc_tke1, rsbc_tke2, rfact_tke                  !     -           -           -        -
95   REAL(wp) ::   rsbc_psi1, rsbc_psi2, rfact_psi                  !     -           -           -        -
96   REAL(wp) ::   rsbc_zs1, rsbc_zs2                               !     -           -           -        -
97   REAL(wp) ::   rc0, rc2, rc3, rf6, rcff, rc_diff                !     -           -           -        -
98   REAL(wp) ::   rs0, rs1, rs2, rs4, rs5, rs6                     !     -           -           -        -
99   REAL(wp) ::   rd0, rd1, rd2, rd3, rd4, rd5                     !     -           -           -        -
100   REAL(wp) ::   rsc_tke, rsc_psi, rpsi1, rpsi2, rpsi3, rsc_psi0  !     -           -           -        -
101   REAL(wp) ::   rpsi3m, rpsi3p, rpp, rmm, rnn                    !     -           -           -        -
102
103   !! * Substitutions
104#  include "domzgr_substitute.h90"
105#  include "vectopt_loop_substitute.h90"
106   !!----------------------------------------------------------------------
107   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
108   !! $Id$
109   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
110   !!----------------------------------------------------------------------
111CONTAINS
112
113   INTEGER FUNCTION zdf_gls_alloc()
114      !!----------------------------------------------------------------------
115      !!                ***  FUNCTION zdf_gls_alloc  ***
116      !!----------------------------------------------------------------------
117      ALLOCATE( mxln(jpi,jpj,jpk), zwall(jpi,jpj,jpk) ,     &
118         &      ustars2(jpi,jpj) , ustarb2(jpi,jpj)   , STAT= zdf_gls_alloc )
119         !
120      IF( lk_mpp             )   CALL mpp_sum ( zdf_gls_alloc )
121      IF( zdf_gls_alloc /= 0 )   CALL ctl_warn('zdf_gls_alloc: failed to allocate arrays')
122   END FUNCTION zdf_gls_alloc
123
124
125   SUBROUTINE zdf_gls( kt )
126      !!----------------------------------------------------------------------
127      !!                   ***  ROUTINE zdf_gls  ***
128      !!
129      !! ** Purpose :   Compute the vertical eddy viscosity and diffusivity
130      !!              coefficients using the GLS turbulent closure scheme.
131      !!----------------------------------------------------------------------
132      INTEGER, INTENT(in) ::   kt ! ocean time step
133      INTEGER  ::   ji, jj, jk, ibot, ibotm1, dir  ! dummy loop arguments
134      REAL(wp) ::   zesh2, zsigpsi, zcoef, zex1, zex2   ! local scalars
135      REAL(wp) ::   ztx2, zty2, zup, zdown, zcof        !   -      -
136      REAL(wp) ::   zratio, zrn2, zflxb, sh             !   -      -
137      REAL(wp) ::   prod, buoy, diss, zdiss, sm         !   -      -
138      REAL(wp) ::   gh, gm, shr, dif, zsqen, zav        !   -      -
139      REAL(wp), POINTER, DIMENSION(:,:  ) ::   zdep
140      REAL(wp), POINTER, DIMENSION(:,:  ) ::   zkar
141      REAL(wp), POINTER, DIMENSION(:,:  ) ::   zflxs       ! Turbulence fluxed induced by internal waves
142      REAL(wp), POINTER, DIMENSION(:,:  ) ::   zhsro       ! Surface roughness (surface waves)
143      REAL(wp), POINTER, DIMENSION(:,:,:) ::   eb          ! tke at time before
144      REAL(wp), POINTER, DIMENSION(:,:,:) ::   mxlb        ! mixing length at time before
145      REAL(wp), POINTER, DIMENSION(:,:,:) ::   shear       ! vertical shear
146      REAL(wp), POINTER, DIMENSION(:,:,:) ::   eps         ! dissipation rate
147      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zwall_psi   ! Wall function use in the wb case (ln_sigpsi)
148      REAL(wp), POINTER, DIMENSION(:,:,:) ::   psi         ! psi at time now
149      REAL(wp), POINTER, DIMENSION(:,:,:) ::   z_elem_a    ! element of the first  matrix diagonal
150      REAL(wp), POINTER, DIMENSION(:,:,:) ::   z_elem_b    ! element of the second matrix diagonal
151      REAL(wp), POINTER, DIMENSION(:,:,:) ::   z_elem_c    ! element of the third  matrix diagonal
152      !!--------------------------------------------------------------------
153      !
154      IF( nn_timing == 1 )  CALL timing_start('zdf_gls')
155      !
156      CALL wrk_alloc( jpi,jpj, zdep, zkar, zflxs, zhsro )
157      CALL wrk_alloc( jpi,jpj,jpk, eb, mxlb, shear, eps, zwall_psi, z_elem_a, z_elem_b, z_elem_c, psi  )
158     
159      ! Preliminary computing
160
161      ustars2 = 0._wp   ;   ustarb2 = 0._wp   ;   psi  = 0._wp   ;   zwall_psi = 0._wp
162
163      IF( kt /= nit000 ) THEN   ! restore before value to compute tke
164         avt (:,:,:) = avt_k (:,:,:)
165         avm (:,:,:) = avm_k (:,:,:)
166         avmu(:,:,:) = avmu_k(:,:,:)
167         avmv(:,:,:) = avmv_k(:,:,:) 
168      ENDIF
169
170      ! Compute surface and bottom friction at T-points
171!CDIR NOVERRCHK         
172      DO jj = 2, jpjm1         
173!CDIR NOVERRCHK         
174         DO ji = fs_2, fs_jpim1   ! vector opt.         
175            !
176            ! surface friction
177            ustars2(ji,jj) = r1_rau0 * taum(ji,jj) * tmask(ji,jj,1)
178            !   
179            ! bottom friction (explicit before friction)       
180            ! Note that we chose here not to bound the friction as in dynbfr)   
181            ztx2 = (  bfrua(ji,jj)  * ub(ji,jj,mbku(ji,jj)) + bfrua(ji-1,jj) * ub(ji-1,jj,mbku(ji-1,jj))  )   &         
182               & * ( 1._wp - 0.5_wp * umask(ji,jj,1) * umask(ji-1,jj,1)  )     
183            zty2 = (  bfrva(ji,jj)  * vb(ji,jj,mbkv(ji,jj)) + bfrva(ji,jj-1) * vb(ji,jj-1,mbkv(ji,jj-1))  )   &         
184               & * ( 1._wp - 0.5_wp * vmask(ji,jj,1) * vmask(ji,jj-1,1)  )     
185            ustarb2(ji,jj) = SQRT( ztx2 * ztx2 + zty2 * zty2 ) * tmask(ji,jj,1)         
186         END DO         
187      END DO   
188
189      ! Set surface roughness length
190      SELECT CASE ( nn_z0_met )
191      !
192      CASE ( 0 )             ! Constant roughness         
193         zhsro(:,:) = rn_hsro
194      CASE ( 1 )             ! Standard Charnock formula
195         zhsro(:,:) = MAX(rsbc_zs1 * ustars2(:,:), rn_hsro)
196      CASE ( 2 )             ! Roughness formulae according to Rascle et al., Ocean Modelling (2008)
197         zdep(:,:)  = 30.*TANH(2.*0.3/(28.*SQRT(MAX(ustars2(:,:),rsmall))))             ! Wave age (eq. 10)
198         zhsro(:,:) = MAX(rsbc_zs2 * ustars2(:,:) * zdep(:,:)**1.5, rn_hsro) ! zhsro = rn_frac_hs * Hsw (eq. 11)
199      !
200      END SELECT
201
202      ! Compute shear and dissipation rate
203      DO jk = 2, jpkm1
204         DO jj = 2, jpjm1
205            DO ji = fs_2, fs_jpim1   ! vector opt.
206               avmu(ji,jj,jk) = avmu(ji,jj,jk) * ( un(ji,jj,jk-1) - un(ji,jj,jk) )   &
207                  &                            * ( ub(ji,jj,jk-1) - ub(ji,jj,jk) )   &
208                  &                            / (  fse3uw_n(ji,jj,jk)               &
209                  &                            *    fse3uw_b(ji,jj,jk) )
210               avmv(ji,jj,jk) = avmv(ji,jj,jk) * ( vn(ji,jj,jk-1) - vn(ji,jj,jk) )   &
211                  &                            * ( vb(ji,jj,jk-1) - vb(ji,jj,jk) )   &
212                  &                            / (  fse3vw_n(ji,jj,jk)               &
213                  &                            *    fse3vw_b(ji,jj,jk) )
214               eps(ji,jj,jk)  = rc03 * en(ji,jj,jk) * SQRT(en(ji,jj,jk)) / mxln(ji,jj,jk)
215            END DO
216         END DO
217      END DO
218      !
219      ! Lateral boundary conditions (avmu,avmv) (sign unchanged)
220      CALL lbc_lnk( avmu, 'U', 1. )   ;   CALL lbc_lnk( avmv, 'V', 1. )
221
222      ! Save tke at before time step
223      eb  (:,:,:) = en  (:,:,:)
224      mxlb(:,:,:) = mxln(:,:,:)
225
226      IF( nn_clos == 0 ) THEN    ! Mellor-Yamada
227         DO jk = 2, jpkm1
228            DO jj = 2, jpjm1 
229               DO ji = fs_2, fs_jpim1   ! vector opt.
230                  zup   = mxln(ji,jj,jk) * fsdepw(ji,jj,mbkt(ji,jj)+1)
231                  zdown = vkarmn * fsdepw(ji,jj,jk) * ( -fsdepw(ji,jj,jk) + fsdepw(ji,jj,mbkt(ji,jj)+1) )
232                  zcoef = ( zup / MAX( zdown, rsmall ) )
233                  zwall (ji,jj,jk) = ( 1._wp + re2 * zcoef*zcoef ) * tmask(ji,jj,jk)
234               END DO
235            END DO
236         END DO
237      ENDIF
238
239      !!---------------------------------!!
240      !!   Equation to prognostic k      !!
241      !!---------------------------------!!
242      !
243      ! Now Turbulent kinetic energy (output in en)
244      ! -------------------------------
245      ! Resolution of a tridiagonal linear system by a "methode de chasse"
246      ! computation from level 2 to jpkm1  (e(1) computed after and e(jpk)=0 ).
247      ! The surface boundary condition are set after
248      ! The bottom boundary condition are also set after. In standard e(bottom)=0.
249      ! z_elem_b : diagonal z_elem_c : upper diagonal z_elem_a : lower diagonal
250      ! Warning : after this step, en : right hand side of the matrix
251
252      DO jk = 2, jpkm1
253         DO jj = 2, jpjm1
254            DO ji = fs_2, fs_jpim1   ! vector opt.
255               !
256               ! shear prod. at w-point weightened by mask
257               shear(ji,jj,jk) =  ( avmu(ji-1,jj,jk) + avmu(ji,jj,jk) ) / MAX( 1.e0 , umask(ji-1,jj,jk) + umask(ji,jj,jk) )   &
258                  &             + ( avmv(ji,jj-1,jk) + avmv(ji,jj,jk) ) / MAX( 1.e0 , vmask(ji,jj-1,jk) + vmask(ji,jj,jk) )
259               !
260               ! stratif. destruction
261               buoy = - avt(ji,jj,jk) * rn2(ji,jj,jk)
262               !
263               ! shear prod. - stratif. destruction
264               diss = eps(ji,jj,jk)
265               !
266               dir = 0.5_wp + SIGN( 0.5_wp, shear(ji,jj,jk) + buoy )   ! dir =1(=0) if shear(ji,jj,jk)+buoy >0(<0)
267               !
268               zesh2 = dir*(shear(ji,jj,jk)+buoy)+(1._wp-dir)*shear(ji,jj,jk)          ! production term
269               zdiss = dir*(diss/en(ji,jj,jk))   +(1._wp-dir)*(diss-buoy)/en(ji,jj,jk) ! dissipation term
270               !
271               ! Compute a wall function from 1. to rsc_psi*zwall/rsc_psi0
272               ! Note that as long that Dirichlet boundary conditions are NOT set at the first and last levels (GOTM style)
273               ! there is no need to set a boundary condition for zwall_psi at the top and bottom boundaries.
274               ! Otherwise, this should be rsc_psi/rsc_psi0
275               IF( ln_sigpsi ) THEN
276                  zsigpsi = MIN( 1._wp, zesh2 / eps(ji,jj,jk) )     ! 0. <= zsigpsi <= 1.
277                  zwall_psi(ji,jj,jk) = rsc_psi /   & 
278                     &     (  zsigpsi * rsc_psi + (1._wp-zsigpsi) * rsc_psi0 / MAX( zwall(ji,jj,jk), 1._wp )  )
279               ELSE
280                  zwall_psi(ji,jj,jk) = 1._wp
281               ENDIF
282               !
283               ! building the matrix
284               zcof = rfact_tke * tmask(ji,jj,jk)
285               !
286               ! lower diagonal
287               z_elem_a(ji,jj,jk) = zcof * ( avm  (ji,jj,jk  ) + avm  (ji,jj,jk-1) )   &
288                  &                      / ( fse3t(ji,jj,jk-1) * fse3w(ji,jj,jk  ) )
289               !
290               ! upper diagonal
291               z_elem_c(ji,jj,jk) = zcof * ( avm  (ji,jj,jk+1) + avm  (ji,jj,jk  ) )   &
292                  &                      / ( fse3t(ji,jj,jk  ) * fse3w(ji,jj,jk) )
293               !
294               ! diagonal
295               z_elem_b(ji,jj,jk) = 1._wp - z_elem_a(ji,jj,jk) - z_elem_c(ji,jj,jk)  &
296                  &                       + rdt * zdiss * tmask(ji,jj,jk) 
297               !
298               ! right hand side in en
299               en(ji,jj,jk) = en(ji,jj,jk) + rdt * zesh2 * tmask(ji,jj,jk)
300            END DO
301         END DO
302      END DO
303      !
304      z_elem_b(:,:,jpk) = 1._wp
305      !
306      ! Set surface condition on zwall_psi (1 at the bottom)
307      zwall_psi(:,:,1) = zwall_psi(:,:,2)
308      zwall_psi(:,:,jpk) = 1.
309      !
310      ! Surface boundary condition on tke
311      ! ---------------------------------
312      !
313      SELECT CASE ( nn_bc_surf )
314      !
315      CASE ( 0 )             ! Dirichlet case
316      ! First level
317      en(:,:,1) = rc02r * ustars2(:,:) * (1._wp + rsbc_tke1)**(2._wp/3._wp)
318      en(:,:,1) = MAX(en(:,:,1), rn_emin) 
319      z_elem_a(:,:,1) = en(:,:,1)
320      z_elem_c(:,:,1) = 0._wp
321      z_elem_b(:,:,1) = 1._wp
322      !
323      ! One level below
324      en(:,:,2) = rc02r * ustars2(:,:) * (1._wp + rsbc_tke1 * ((zhsro(:,:)+fsdepw(:,:,2))/zhsro(:,:) )**(1.5_wp*ra_sf))**(2._wp/3._wp)
325      en(:,:,2) = MAX(en(:,:,2), rn_emin )
326      z_elem_a(:,:,2) = 0._wp 
327      z_elem_c(:,:,2) = 0._wp
328      z_elem_b(:,:,2) = 1._wp
329      !
330      !
331      CASE ( 1 )             ! Neumann boundary condition on d(e)/dz
332      !
333      ! Dirichlet conditions at k=1
334      en(:,:,1)       = rc02r * ustars2(:,:) * (1._wp + rsbc_tke1)**(2._wp/3._wp)
335      en(:,:,1)       = MAX(en(:,:,1), rn_emin)     
336      z_elem_a(:,:,1) = en(:,:,1)
337      z_elem_c(:,:,1) = 0._wp
338      z_elem_b(:,:,1) = 1._wp
339      !
340      ! at k=2, set de/dz=Fw
341      !cbr
342      z_elem_b(:,:,2) = z_elem_b(:,:,2) +  z_elem_a(:,:,2) ! Remove z_elem_a from z_elem_b
343      z_elem_a(:,:,2) = 0._wp
344      zkar(:,:)       = (rl_sf + (vkarmn-rl_sf)*(1.-exp(-rtrans*fsdept(:,:,1)/zhsro(:,:)) ))
345      zflxs(:,:)      = rsbc_tke2 * ustars2(:,:)**1.5_wp * zkar(:,:) * ((zhsro(:,:)+fsdept(:,:,1))/zhsro(:,:) )**(1.5_wp*ra_sf)
346
347      en(:,:,2) = en(:,:,2) + zflxs(:,:)/fse3w(:,:,2)
348      !
349      !
350      END SELECT
351
352      ! Bottom boundary condition on tke
353      ! --------------------------------
354      !
355      SELECT CASE ( nn_bc_bot )
356      !
357      CASE ( 0 )             ! Dirichlet
358         !                      ! en(ibot) = u*^2 / Co2 and mxln(ibot) = rn_lmin
359         !                      ! Balance between the production and the dissipation terms
360!CDIR NOVERRCHK
361         DO jj = 2, jpjm1
362!CDIR NOVERRCHK
363            DO ji = fs_2, fs_jpim1   ! vector opt.
364               ibot   = mbkt(ji,jj) + 1      ! k   bottom level of w-point
365               ibotm1 = mbkt(ji,jj)          ! k-1 bottom level of w-point but >=1
366               !
367               ! Bottom level Dirichlet condition:
368               z_elem_a(ji,jj,ibot  ) = 0._wp
369               z_elem_c(ji,jj,ibot  ) = 0._wp
370               z_elem_b(ji,jj,ibot  ) = 1._wp
371               en(ji,jj,ibot  ) = MAX( rc02r * ustarb2(ji,jj), rn_emin )
372               !
373               ! Just above last level, Dirichlet condition again
374               z_elem_a(ji,jj,ibotm1) = 0._wp
375               z_elem_c(ji,jj,ibotm1) = 0._wp
376               z_elem_b(ji,jj,ibotm1) = 1._wp
377               en(ji,jj,ibotm1) = MAX( rc02r * ustarb2(ji,jj), rn_emin ) 
378            END DO
379         END DO
380         !
381      CASE ( 1 )             ! Neumman boundary condition
382         !                     
383!CDIR NOVERRCHK
384         DO jj = 2, jpjm1
385!CDIR NOVERRCHK
386            DO ji = fs_2, fs_jpim1   ! vector opt.
387               ibot   = mbkt(ji,jj) + 1      ! k   bottom level of w-point
388               ibotm1 = mbkt(ji,jj)          ! k-1 bottom level of w-point but >=1
389               !
390               ! Bottom level Dirichlet condition:
391               z_elem_a(ji,jj,ibot) = 0._wp
392               z_elem_c(ji,jj,ibot) = 0._wp
393               z_elem_b(ji,jj,ibot) = 1._wp
394               en(ji,jj,ibot) = MAX( rc02r * ustarb2(ji,jj), rn_emin )
395               !
396               ! Just above last level: Neumann condition
397               z_elem_b(ji,jj,ibotm1) = z_elem_b(ji,jj,ibotm1) + z_elem_c(ji,jj,ibotm1)   ! Remove z_elem_c from z_elem_b
398               z_elem_c(ji,jj,ibotm1) = 0._wp
399            END DO
400         END DO
401         !
402      END SELECT
403
404      ! Matrix inversion (en prescribed at surface and the bottom)
405      ! ----------------------------------------------------------
406      !
407      DO jk = 2, jpkm1                             ! First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1
408         DO jj = 2, jpjm1
409            DO ji = fs_2, fs_jpim1    ! vector opt.
410               z_elem_b(ji,jj,jk) = z_elem_b(ji,jj,jk) - z_elem_a(ji,jj,jk) * z_elem_c(ji,jj,jk-1) / z_elem_b(ji,jj,jk-1)
411            END DO
412         END DO
413      END DO
414      DO jk = 2, jpk                               ! Second recurrence : Lk = RHSk - Lk / Dk-1 * Lk-1
415         DO jj = 2, jpjm1
416            DO ji = fs_2, fs_jpim1    ! vector opt.
417               z_elem_a(ji,jj,jk) = en(ji,jj,jk) - z_elem_a(ji,jj,jk) / z_elem_b(ji,jj,jk-1) * z_elem_a(ji,jj,jk-1)
418            END DO
419         END DO
420      END DO
421      DO jk = jpk-1, 2, -1                         ! thrid recurrence : Ek = ( Lk - Uk * Ek+1 ) / Dk
422         DO jj = 2, jpjm1
423            DO ji = fs_2, fs_jpim1    ! vector opt.
424               en(ji,jj,jk) = ( z_elem_a(ji,jj,jk) - z_elem_c(ji,jj,jk) * en(ji,jj,jk+1) ) / z_elem_b(ji,jj,jk)
425            END DO
426         END DO
427      END DO
428      !                                            ! set the minimum value of tke
429      en(:,:,:) = MAX( en(:,:,:), rn_emin )
430
431      !!----------------------------------------!!
432      !!   Solve prognostic equation for psi    !!
433      !!----------------------------------------!!
434
435      ! Set psi to previous time step value
436      !
437      SELECT CASE ( nn_clos )
438      !
439      CASE( 0 )               ! k-kl  (Mellor-Yamada)
440         DO jk = 2, jpkm1
441            DO jj = 2, jpjm1
442               DO ji = fs_2, fs_jpim1   ! vector opt.
443                  psi(ji,jj,jk)  = eb(ji,jj,jk) * mxlb(ji,jj,jk)
444               END DO
445            END DO
446         END DO
447         !
448      CASE( 1 )               ! k-eps
449         DO jk = 2, jpkm1
450            DO jj = 2, jpjm1
451               DO ji = fs_2, fs_jpim1   ! vector opt.
452                  psi(ji,jj,jk)  = eps(ji,jj,jk)
453               END DO
454            END DO
455         END DO
456         !
457      CASE( 2 )               ! k-w
458         DO jk = 2, jpkm1
459            DO jj = 2, jpjm1
460               DO ji = fs_2, fs_jpim1   ! vector opt.
461                  psi(ji,jj,jk)  = SQRT( eb(ji,jj,jk) ) / ( rc0 * mxlb(ji,jj,jk) )
462               END DO
463            END DO
464         END DO
465         !
466      CASE( 3 )               ! generic
467         DO jk = 2, jpkm1
468            DO jj = 2, jpjm1
469               DO ji = fs_2, fs_jpim1   ! vector opt.
470                  psi(ji,jj,jk)  = rc02 * eb(ji,jj,jk) * mxlb(ji,jj,jk)**rnn 
471               END DO
472            END DO
473         END DO
474         !
475      END SELECT
476      !
477      ! Now gls (output in psi)
478      ! -------------------------------
479      ! Resolution of a tridiagonal linear system by a "methode de chasse"
480      ! computation from level 2 to jpkm1  (e(1) already computed and e(jpk)=0 ).
481      ! z_elem_b : diagonal z_elem_c : upper diagonal z_elem_a : lower diagonal
482      ! Warning : after this step, en : right hand side of the matrix
483
484      DO jk = 2, jpkm1
485         DO jj = 2, jpjm1
486            DO ji = fs_2, fs_jpim1   ! vector opt.
487               !
488               ! psi / k
489               zratio = psi(ji,jj,jk) / eb(ji,jj,jk) 
490               !
491               ! psi3+ : stable : B=-KhN²<0 => N²>0 if rn2>0 dir = 1 (stable) otherwise dir = 0 (unstable)
492               dir = 0.5_wp + SIGN( 0.5_wp, rn2(ji,jj,jk) )
493               !
494               rpsi3 = dir * rpsi3m + ( 1._wp - dir ) * rpsi3p
495               !
496               ! shear prod. - stratif. destruction
497               prod = rpsi1 * zratio * shear(ji,jj,jk)
498               !
499               ! stratif. destruction
500               buoy = rpsi3 * zratio * (- avt(ji,jj,jk) * rn2(ji,jj,jk) )
501               !
502               ! shear prod. - stratif. destruction
503               diss = rpsi2 * zratio * zwall(ji,jj,jk) * eps(ji,jj,jk)
504               !
505               dir = 0.5_wp + SIGN( 0.5_wp, prod + buoy )   ! dir =1(=0) if shear(ji,jj,jk)+buoy >0(<0)
506               !
507               zesh2 = dir * ( prod + buoy )          + (1._wp - dir ) * prod                        ! production term
508               zdiss = dir * ( diss / psi(ji,jj,jk) ) + (1._wp - dir ) * (diss-buoy) / psi(ji,jj,jk) ! dissipation term
509               !                                                       
510               ! building the matrix
511               zcof = rfact_psi * zwall_psi(ji,jj,jk) * tmask(ji,jj,jk)
512               ! lower diagonal
513               z_elem_a(ji,jj,jk) = zcof * ( avm  (ji,jj,jk  ) + avm  (ji,jj,jk-1) )   &
514                  &                      / ( fse3t(ji,jj,jk-1) * fse3w(ji,jj,jk  ) )
515               ! upper diagonal
516               z_elem_c(ji,jj,jk) = zcof * ( avm  (ji,jj,jk+1) + avm  (ji,jj,jk  ) )   &
517                  &                      / ( fse3t(ji,jj,jk  ) * fse3w(ji,jj,jk) )
518               ! diagonal
519               z_elem_b(ji,jj,jk) = 1._wp - z_elem_a(ji,jj,jk) - z_elem_c(ji,jj,jk)  &
520                  &                       + rdt * zdiss * tmask(ji,jj,jk)
521               !
522               ! right hand side in psi
523               psi(ji,jj,jk) = psi(ji,jj,jk) + rdt * zesh2 * tmask(ji,jj,jk)
524            END DO
525         END DO
526      END DO
527      !
528      z_elem_b(:,:,jpk) = 1._wp
529
530      ! Surface boundary condition on psi
531      ! ---------------------------------
532      !
533      SELECT CASE ( nn_bc_surf )
534      !
535      CASE ( 0 )             ! Dirichlet boundary conditions
536      !
537      ! Surface value
538      zdep(:,:)       = zhsro(:,:) * rl_sf ! Cosmetic
539      psi (:,:,1)     = rc0**rpp * en(:,:,1)**rmm * zdep(:,:)**rnn * tmask(:,:,1)
540      z_elem_a(:,:,1) = psi(:,:,1)
541      z_elem_c(:,:,1) = 0._wp
542      z_elem_b(:,:,1) = 1._wp
543      !
544      ! One level below
545      zkar(:,:)       = (rl_sf + (vkarmn-rl_sf)*(1._wp-exp(-rtrans*fsdepw(:,:,2)/zhsro(:,:) )))
546      zdep(:,:)       = (zhsro(:,:) + fsdepw(:,:,2)) * zkar(:,:)
547      psi (:,:,2)     = rc0**rpp * en(:,:,2)**rmm * zdep(:,:)**rnn * tmask(:,:,1)
548      z_elem_a(:,:,2) = 0._wp
549      z_elem_c(:,:,2) = 0._wp
550      z_elem_b(:,:,2) = 1._wp
551      !
552      !
553      CASE ( 1 )             ! Neumann boundary condition on d(psi)/dz
554      !
555      ! Surface value: Dirichlet
556      zdep(:,:)       = zhsro(:,:) * rl_sf
557      psi (:,:,1)     = rc0**rpp * en(:,:,1)**rmm * zdep(:,:)**rnn * tmask(:,:,1)
558      z_elem_a(:,:,1) = psi(:,:,1)
559      z_elem_c(:,:,1) = 0._wp
560      z_elem_b(:,:,1) = 1._wp
561      !
562      ! Neumann condition at k=2
563      z_elem_b(:,:,2) = z_elem_b(:,:,2) +  z_elem_a(:,:,2) ! Remove z_elem_a from z_elem_b
564      z_elem_a(:,:,2) = 0._wp
565      !
566      ! Set psi vertical flux at the surface:
567      zkar(:,:) = rl_sf + (vkarmn-rl_sf)*(1._wp-exp(-rtrans*fsdept(:,:,1)/zhsro(:,:) )) ! Lengh scale slope
568      zdep(:,:) = ((zhsro(:,:) + fsdept(:,:,1)) / zhsro(:,:))**(rmm*ra_sf)
569      zflxs(:,:) = (rnn + rsbc_tke1 * (rnn + rmm*ra_sf) * zdep(:,:))*(1._wp + rsbc_tke1*zdep(:,:))**(2._wp*rmm/3._wp-1_wp)
570      zdep(:,:) =  rsbc_psi1 * (zwall_psi(:,:,1)*avm(:,:,1)+zwall_psi(:,:,2)*avm(:,:,2)) * &
571             & ustars2(:,:)**rmm * zkar(:,:)**rnn * (zhsro(:,:) + fsdept(:,:,1))**(rnn-1.)
572      zflxs(:,:) = zdep(:,:) * zflxs(:,:)
573      psi(:,:,2) = psi(:,:,2) + zflxs(:,:) / fse3w(:,:,2)
574
575      !   
576      !
577      END SELECT
578
579      ! Bottom boundary condition on psi
580      ! --------------------------------
581      !
582      SELECT CASE ( nn_bc_bot )
583      !
584      !
585      CASE ( 0 )             ! Dirichlet
586         !                      ! en(ibot) = u*^2 / Co2 and mxln(ibot) = vkarmn * rn_bfrz0
587         !                      ! Balance between the production and the dissipation terms
588!CDIR NOVERRCHK
589         DO jj = 2, jpjm1
590!CDIR NOVERRCHK
591            DO ji = fs_2, fs_jpim1   ! vector opt.
592               ibot   = mbkt(ji,jj) + 1      ! k   bottom level of w-point
593               ibotm1 = mbkt(ji,jj)          ! k-1 bottom level of w-point but >=1
594               zdep(ji,jj) = vkarmn * rn_bfrz0
595               psi (ji,jj,ibot) = rc0**rpp * en(ji,jj,ibot)**rmm * zdep(ji,jj)**rnn
596               z_elem_a(ji,jj,ibot) = 0._wp
597               z_elem_c(ji,jj,ibot) = 0._wp
598               z_elem_b(ji,jj,ibot) = 1._wp
599               !
600               ! Just above last level, Dirichlet condition again (GOTM like)
601               zdep(ji,jj) = vkarmn * ( rn_bfrz0 + fse3t(ji,jj,ibotm1) )
602               psi (ji,jj,ibotm1) = rc0**rpp * en(ji,jj,ibot  )**rmm * zdep(ji,jj)**rnn
603               z_elem_a(ji,jj,ibotm1) = 0._wp
604               z_elem_c(ji,jj,ibotm1) = 0._wp
605               z_elem_b(ji,jj,ibotm1) = 1._wp
606            END DO
607         END DO
608         !
609      CASE ( 1 )             ! Neumman boundary condition
610         !                     
611!CDIR NOVERRCHK
612         DO jj = 2, jpjm1
613!CDIR NOVERRCHK
614            DO ji = fs_2, fs_jpim1   ! vector opt.
615               ibot   = mbkt(ji,jj) + 1      ! k   bottom level of w-point
616               ibotm1 = mbkt(ji,jj)          ! k-1 bottom level of w-point but >=1
617               !
618               ! Bottom level Dirichlet condition:
619               zdep(ji,jj) = vkarmn * rn_bfrz0
620               psi (ji,jj,ibot) = rc0**rpp * en(ji,jj,ibot)**rmm * zdep(ji,jj)**rnn
621               !
622               z_elem_a(ji,jj,ibot) = 0._wp
623               z_elem_c(ji,jj,ibot) = 0._wp
624               z_elem_b(ji,jj,ibot) = 1._wp
625               !
626               ! Just above last level: Neumann condition with flux injection
627               z_elem_b(ji,jj,ibotm1) = z_elem_b(ji,jj,ibotm1) + z_elem_c(ji,jj,ibotm1) ! Remove z_elem_c from z_elem_b
628               z_elem_c(ji,jj,ibotm1) = 0.
629               !
630               ! Set psi vertical flux at the bottom:
631               zdep(ji,jj) = rn_bfrz0 + 0.5_wp*fse3t(ji,jj,ibotm1)
632               zflxb = rsbc_psi2 * ( avm(ji,jj,ibot) + avm(ji,jj,ibotm1) )   &
633                  &  * (0.5_wp*(en(ji,jj,ibot)+en(ji,jj,ibotm1)))**rmm * zdep(ji,jj)**(rnn-1._wp)
634               psi(ji,jj,ibotm1) = psi(ji,jj,ibotm1) + zflxb / fse3w(ji,jj,ibotm1)
635            END DO
636         END DO
637         !
638      END SELECT
639
640      ! Matrix inversion
641      ! ----------------
642      !
643      DO jk = 2, jpkm1                             ! First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1
644         DO jj = 2, jpjm1
645            DO ji = fs_2, fs_jpim1    ! vector opt.
646               z_elem_b(ji,jj,jk) = z_elem_b(ji,jj,jk) - z_elem_a(ji,jj,jk) * z_elem_c(ji,jj,jk-1) / z_elem_b(ji,jj,jk-1)
647            END DO
648         END DO
649      END DO
650      DO jk = 2, jpk                               ! Second recurrence : Lk = RHSk - Lk / Dk-1 * Lk-1
651         DO jj = 2, jpjm1
652            DO ji = fs_2, fs_jpim1    ! vector opt.
653               z_elem_a(ji,jj,jk) = psi(ji,jj,jk) - z_elem_a(ji,jj,jk) / z_elem_b(ji,jj,jk-1) * z_elem_a(ji,jj,jk-1)
654            END DO
655         END DO
656      END DO
657      DO jk = jpk-1, 2, -1                         ! Third recurrence : Ek = ( Lk - Uk * Ek+1 ) / Dk
658         DO jj = 2, jpjm1
659            DO ji = fs_2, fs_jpim1    ! vector opt.
660               psi(ji,jj,jk) = ( z_elem_a(ji,jj,jk) - z_elem_c(ji,jj,jk) * psi(ji,jj,jk+1) ) / z_elem_b(ji,jj,jk)
661            END DO
662         END DO
663      END DO
664
665      ! Set dissipation
666      !----------------
667
668      SELECT CASE ( nn_clos )
669      !
670      CASE( 0 )               ! k-kl  (Mellor-Yamada)
671         DO jk = 1, jpkm1
672            DO jj = 2, jpjm1
673               DO ji = fs_2, fs_jpim1   ! vector opt.
674                  eps(ji,jj,jk) = rc03 * en(ji,jj,jk) * en(ji,jj,jk) * SQRT( en(ji,jj,jk) ) / MAX( psi(ji,jj,jk), rn_epsmin)
675               END DO
676            END DO
677         END DO
678         !
679      CASE( 1 )               ! k-eps
680         DO jk = 1, jpkm1
681            DO jj = 2, jpjm1
682               DO ji = fs_2, fs_jpim1   ! vector opt.
683                  eps(ji,jj,jk) = psi(ji,jj,jk)
684               END DO
685            END DO
686         END DO
687         !
688      CASE( 2 )               ! k-w
689         DO jk = 1, jpkm1
690            DO jj = 2, jpjm1
691               DO ji = fs_2, fs_jpim1   ! vector opt.
692                  eps(ji,jj,jk) = rc04 * en(ji,jj,jk) * psi(ji,jj,jk) 
693               END DO
694            END DO
695         END DO
696         !
697      CASE( 3 )               ! generic
698         zcoef = rc0**( 3._wp  + rpp/rnn )
699         zex1  =      ( 1.5_wp + rmm/rnn )
700         zex2  = -1._wp / rnn
701         DO jk = 1, jpkm1
702            DO jj = 2, jpjm1
703               DO ji = fs_2, fs_jpim1   ! vector opt.
704                  eps(ji,jj,jk) = zcoef * en(ji,jj,jk)**zex1 * psi(ji,jj,jk)**zex2
705               END DO
706            END DO
707         END DO
708         !
709      END SELECT
710
711      ! Limit dissipation rate under stable stratification
712      ! --------------------------------------------------
713      DO jk = 1, jpkm1 ! Note that this set boundary conditions on mxln at the same time
714         DO jj = 2, jpjm1
715            DO ji = fs_2, fs_jpim1    ! vector opt.
716               ! limitation
717               eps(ji,jj,jk)  = MAX( eps(ji,jj,jk), rn_epsmin )
718               mxln(ji,jj,jk)  = rc03 * en(ji,jj,jk) * SQRT( en(ji,jj,jk) ) / eps(ji,jj,jk)
719               ! Galperin criterium (NOTE : Not required if the proper value of C3 in stable cases is calculated)
720               zrn2 = MAX( rn2(ji,jj,jk), rsmall )
721               IF (ln_length_lim) mxln(ji,jj,jk) = MIN(  rn_clim_galp * SQRT( 2._wp * en(ji,jj,jk) / zrn2 ), mxln(ji,jj,jk) )
722            END DO
723         END DO
724      END DO 
725
726      !
727      ! Stability function and vertical viscosity and diffusivity
728      ! ---------------------------------------------------------
729      !
730      SELECT CASE ( nn_stab_func )
731      !
732      CASE ( 0 , 1 )             ! Galperin or Kantha-Clayson stability functions
733         DO jk = 2, jpkm1
734            DO jj = 2, jpjm1
735               DO ji = fs_2, fs_jpim1   ! vector opt.
736                  ! zcof =  l²/q²
737                  zcof = mxlb(ji,jj,jk) * mxlb(ji,jj,jk) / ( 2._wp*eb(ji,jj,jk) )
738                  ! Gh = -N²l²/q²
739                  gh = - rn2(ji,jj,jk) * zcof
740                  gh = MIN( gh, rgh0   )
741                  gh = MAX( gh, rghmin )
742                  ! Stability functions from Kantha and Clayson (if C2=C3=0 => Galperin)
743                  sh = ra2*( 1._wp-6._wp*ra1/rb1 ) / ( 1.-3.*ra2*gh*(6.*ra1+rb2*( 1._wp-rc3 ) ) )
744                  sm = ( rb1**(-1._wp/3._wp) + ( 18._wp*ra1*ra1 + 9._wp*ra1*ra2*(1._wp-rc2) )*sh*gh ) / (1._wp-9._wp*ra1*ra2*gh)
745                  !
746                  ! Store stability function in avmu and avmv
747                  avmu(ji,jj,jk) = rc_diff * sh * tmask(ji,jj,jk)
748                  avmv(ji,jj,jk) = rc_diff * sm * tmask(ji,jj,jk)
749               END DO
750            END DO
751         END DO
752         !
753      CASE ( 2, 3 )               ! Canuto stability functions
754         DO jk = 2, jpkm1
755            DO jj = 2, jpjm1
756               DO ji = fs_2, fs_jpim1   ! vector opt.
757                  ! zcof =  l²/q²
758                  zcof = mxlb(ji,jj,jk)*mxlb(ji,jj,jk) / ( 2._wp * eb(ji,jj,jk) )
759                  ! Gh = -N²l²/q²
760                  gh = - rn2(ji,jj,jk) * zcof
761                  gh = MIN( gh, rgh0   )
762                  gh = MAX( gh, rghmin )
763                  gh = gh * rf6
764                  ! Gm =  M²l²/q² Shear number
765                  shr = shear(ji,jj,jk) / MAX( avm(ji,jj,jk), rsmall )
766                  gm = MAX( shr * zcof , 1.e-10 )
767                  gm = gm * rf6
768                  gm = MIN ( (rd0 - rd1*gh + rd3*gh*gh) / (rd2-rd4*gh) , gm )
769                  ! Stability functions from Canuto
770                  rcff = rd0 - rd1*gh +rd2*gm + rd3*gh*gh - rd4*gh*gm + rd5*gm*gm
771                  sm = (rs0 - rs1*gh + rs2*gm) / rcff
772                  sh = (rs4 - rs5*gh + rs6*gm) / rcff
773                  !
774                  ! Store stability function in avmu and avmv
775                  avmu(ji,jj,jk) = rc_diff * sh * tmask(ji,jj,jk)
776                  avmv(ji,jj,jk) = rc_diff * sm * tmask(ji,jj,jk)
777               END DO
778            END DO
779         END DO
780         !
781      END SELECT
782
783      ! Boundary conditions on stability functions for momentum (Neumann):
784      ! Lines below are useless if GOTM style Dirichlet conditions are used
785
786      avmv(:,:,1) = avmv(:,:,2)
787
788      DO jj = 2, jpjm1
789         DO ji = fs_2, fs_jpim1   ! vector opt.
790            avmv(ji,jj,mbkt(ji,jj)+1) = avmv(ji,jj,mbkt(ji,jj))
791         END DO
792      END DO
793
794      ! Compute diffusivities/viscosities
795      ! The computation below could be restrained to jk=2 to jpkm1 if GOTM style Dirichlet conditions are used
796      DO jk = 1, jpk
797         DO jj = 2, jpjm1
798            DO ji = fs_2, fs_jpim1   ! vector opt.
799               zsqen         = SQRT( 2._wp * en(ji,jj,jk) ) * mxln(ji,jj,jk)
800               zav           = zsqen * avmu(ji,jj,jk)
801               avt(ji,jj,jk) = MAX( zav, avtb(jk) )*tmask(ji,jj,jk) ! apply mask for zdfmxl routine
802               zav           = zsqen * avmv(ji,jj,jk)
803               avm(ji,jj,jk) = MAX( zav, avmb(jk) ) ! Note that avm is not masked at the surface and the bottom
804            END DO
805         END DO
806      END DO
807      !
808      ! Lateral boundary conditions (sign unchanged)
809      avt(:,:,1)  = 0._wp
810      CALL lbc_lnk( avm, 'W', 1. )   ;   CALL lbc_lnk( avt, 'W', 1. )
811
812      DO jk = 2, jpkm1            !* vertical eddy viscosity at u- and v-points
813         DO jj = 2, jpjm1
814            DO ji = fs_2, fs_jpim1   ! vector opt.
815               avmu(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk) + avm(ji+1,jj  ,jk) ) * umask(ji,jj,jk)
816               avmv(ji,jj,jk) = 0.5 * ( avm(ji,jj,jk) + avm(ji  ,jj+1,jk) ) * vmask(ji,jj,jk)
817            END DO
818         END DO
819      END DO
820      avmu(:,:,1) = 0._wp             ;   avmv(:,:,1) = 0._wp                 ! set surface to zero
821      CALL lbc_lnk( avmu, 'U', 1. )   ;   CALL lbc_lnk( avmv, 'V', 1. )       ! Lateral boundary conditions
822
823      IF(ln_ctl) THEN
824         CALL prt_ctl( tab3d_1=en  , clinfo1=' gls  - e: ', tab3d_2=avt, clinfo2=' t: ', ovlap=1, kdim=jpk)
825         CALL prt_ctl( tab3d_1=avmu, clinfo1=' gls  - u: ', mask1=umask,                   &
826            &          tab3d_2=avmv, clinfo2=       ' v: ', mask2=vmask, ovlap=1, kdim=jpk )
827      ENDIF
828      !
829      avt_k (:,:,:) = avt (:,:,:)
830      avm_k (:,:,:) = avm (:,:,:)
831      avmu_k(:,:,:) = avmu(:,:,:)
832      avmv_k(:,:,:) = avmv(:,:,:)
833      !
834      CALL wrk_dealloc( jpi,jpj, zdep, zkar, zflxs, zhsro )
835      CALL wrk_dealloc( jpi,jpj,jpk, eb, mxlb, shear, eps, zwall_psi, z_elem_a, z_elem_b, z_elem_c, psi )
836      !
837      IF( nn_timing == 1 )  CALL timing_stop('zdf_gls')
838      !
839      !
840   END SUBROUTINE zdf_gls
841
842
843   SUBROUTINE zdf_gls_init
844      !!----------------------------------------------------------------------
845      !!                  ***  ROUTINE zdf_gls_init  ***
846      !!                     
847      !! ** Purpose :   Initialization of the vertical eddy diffivity and
848      !!      viscosity when using a gls turbulent closure scheme
849      !!
850      !! ** Method  :   Read the namzdf_gls namelist and check the parameters
851      !!      called at the first timestep (nit000)
852      !!
853      !! ** input   :   Namlist namzdf_gls
854      !!
855      !! ** Action  :   Increase by 1 the nstop flag is setting problem encounter
856      !!
857      !!----------------------------------------------------------------------
858      USE dynzdf_exp
859      USE trazdf_exp
860      !
861      INTEGER ::   jk    ! dummy loop indices
862      INTEGER ::   ios   ! Local integer output status for namelist read
863      REAL(wp)::   zcr   ! local scalar
864      !!
865      NAMELIST/namzdf_gls/rn_emin, rn_epsmin, ln_length_lim, &
866         &            rn_clim_galp, ln_sigpsi, rn_hsro,      &
867         &            rn_crban, rn_charn, rn_frac_hs,        &
868         &            nn_bc_surf, nn_bc_bot, nn_z0_met,      &
869         &            nn_stab_func, nn_clos
870      !!----------------------------------------------------------
871      !
872      IF( nn_timing == 1 )  CALL timing_start('zdf_gls_init')
873      !
874      REWIND( numnam_ref )              ! Namelist namzdf_gls in reference namelist : Vertical eddy diffivity and viscosity using gls turbulent closure scheme
875      READ  ( numnam_ref, namzdf_gls, IOSTAT = ios, ERR = 901)
876901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_gls in reference namelist', lwp )
877
878      REWIND( numnam_cfg )              ! Namelist namzdf_gls in configuration namelist : Vertical eddy diffivity and viscosity using gls turbulent closure scheme
879      READ  ( numnam_cfg, namzdf_gls, IOSTAT = ios, ERR = 902 )
880902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf_gls in configuration namelist', lwp )
881      IF(lwm) WRITE ( numond, namzdf_gls )
882
883      IF(lwp) THEN                     !* Control print
884         WRITE(numout,*)
885         WRITE(numout,*) 'zdf_gls_init : gls turbulent closure scheme'
886         WRITE(numout,*) '~~~~~~~~~~~~'
887         WRITE(numout,*) '   Namelist namzdf_gls : set gls mixing parameters'
888         WRITE(numout,*) '      minimum value of en                           rn_emin        = ', rn_emin
889         WRITE(numout,*) '      minimum value of eps                          rn_epsmin      = ', rn_epsmin
890         WRITE(numout,*) '      Limit dissipation rate under stable stratif.  ln_length_lim  = ', ln_length_lim
891         WRITE(numout,*) '      Galperin limit (Standard: 0.53, Holt: 0.26)   rn_clim_galp   = ', rn_clim_galp
892         WRITE(numout,*) '      TKE Surface boundary condition                nn_bc_surf     = ', nn_bc_surf
893         WRITE(numout,*) '      TKE Bottom boundary condition                 nn_bc_bot      = ', nn_bc_bot
894         WRITE(numout,*) '      Modify psi Schmidt number (wb case)           ln_sigpsi      = ', ln_sigpsi
895         WRITE(numout,*) '      Craig and Banner coefficient                  rn_crban       = ', rn_crban
896         WRITE(numout,*) '      Charnock coefficient                          rn_charn       = ', rn_charn
897         WRITE(numout,*) '      Surface roughness formula                     nn_z0_met      = ', nn_z0_met
898         WRITE(numout,*) '      Wave height frac. (used if nn_z0_met=2)       rn_frac_hs     = ', rn_frac_hs
899         WRITE(numout,*) '      Stability functions                           nn_stab_func   = ', nn_stab_func
900         WRITE(numout,*) '      Type of closure                               nn_clos        = ', nn_clos
901         WRITE(numout,*) '      Surface roughness (m)                         rn_hsro        = ', rn_hsro
902         WRITE(numout,*) '      Bottom roughness (m) (nambfr namelist)        rn_bfrz0       = ', rn_bfrz0
903      ENDIF
904
905      !                                !* allocate gls arrays
906      IF( zdf_gls_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'zdf_gls_init : unable to allocate arrays' )
907
908      !                                !* Check of some namelist values
909      IF( nn_bc_surf < 0 .OR. nn_bc_surf > 1 ) CALL ctl_stop( 'bad flag: nn_bc_surf is 0 or 1' )
910      IF( nn_bc_surf < 0 .OR. nn_bc_surf > 1 ) CALL ctl_stop( 'bad flag: nn_bc_surf is 0 or 1' )
911      IF( nn_z0_met < 0 .OR. nn_z0_met > 2 ) CALL ctl_stop( 'bad flag: nn_z0_met is 0, 1 or 2' )
912      IF( nn_stab_func  < 0 .OR. nn_stab_func  > 3 ) CALL ctl_stop( 'bad flag: nn_stab_func is 0, 1, 2 and 3' )
913      IF( nn_clos       < 0 .OR. nn_clos       > 3 ) CALL ctl_stop( 'bad flag: nn_clos is 0, 1, 2 or 3' )
914
915      SELECT CASE ( nn_clos )          !* set the parameters for the chosen closure
916      !
917      CASE( 0 )                              ! k-kl  (Mellor-Yamada)
918         !
919         IF(lwp) WRITE(numout,*) 'The choosen closure is k-kl closed to the classical Mellor-Yamada'
920         rpp     = 0._wp
921         rmm     = 1._wp
922         rnn     = 1._wp
923         rsc_tke = 1.96_wp
924         rsc_psi = 1.96_wp
925         rpsi1   = 0.9_wp
926         rpsi3p  = 1._wp
927         rpsi2   = 0.5_wp
928         !
929         SELECT CASE ( nn_stab_func )
930         CASE( 0, 1 )   ;   rpsi3m = 2.53_wp       ! G88 or KC stability functions
931         CASE( 2 )      ;   rpsi3m = 2.62_wp       ! Canuto A stability functions
932         CASE( 3 )      ;   rpsi3m = 2.38          ! Canuto B stability functions (caution : constant not identified)
933         END SELECT
934         !
935      CASE( 1 )                              ! k-eps
936         !
937         IF(lwp) WRITE(numout,*) 'The choosen closure is k-eps'
938         rpp     =  3._wp
939         rmm     =  1.5_wp
940         rnn     = -1._wp
941         rsc_tke =  1._wp
942         rsc_psi =  1.2_wp  ! Schmidt number for psi
943         rpsi1   =  1.44_wp
944         rpsi3p  =  1._wp
945         rpsi2   =  1.92_wp
946         !
947         SELECT CASE ( nn_stab_func )
948         CASE( 0, 1 )   ;   rpsi3m = -0.52_wp      ! G88 or KC stability functions
949         CASE( 2 )      ;   rpsi3m = -0.629_wp     ! Canuto A stability functions
950         CASE( 3 )      ;   rpsi3m = -0.566        ! Canuto B stability functions
951         END SELECT
952         !
953      CASE( 2 )                              ! k-omega
954         !
955         IF(lwp) WRITE(numout,*) 'The choosen closure is k-omega'
956         rpp     = -1._wp
957         rmm     =  0.5_wp
958         rnn     = -1._wp
959         rsc_tke =  2._wp
960         rsc_psi =  2._wp
961         rpsi1   =  0.555_wp
962         rpsi3p  =  1._wp
963         rpsi2   =  0.833_wp
964         !
965         SELECT CASE ( nn_stab_func )
966         CASE( 0, 1 )   ;   rpsi3m = -0.58_wp       ! G88 or KC stability functions
967         CASE( 2 )      ;   rpsi3m = -0.64_wp       ! Canuto A stability functions
968         CASE( 3 )      ;   rpsi3m = -0.64_wp       ! Canuto B stability functions caution : constant not identified)
969         END SELECT
970         !
971      CASE( 3 )                              ! generic
972         !
973         IF(lwp) WRITE(numout,*) 'The choosen closure is generic'
974         rpp     = 2._wp
975         rmm     = 1._wp
976         rnn     = -0.67_wp
977         rsc_tke = 0.8_wp
978         rsc_psi = 1.07_wp
979         rpsi1   = 1._wp
980         rpsi3p  = 1._wp
981         rpsi2   = 1.22_wp
982         !
983         SELECT CASE ( nn_stab_func )
984         CASE( 0, 1 )   ;   rpsi3m = 0.1_wp         ! G88 or KC stability functions
985         CASE( 2 )      ;   rpsi3m = 0.05_wp        ! Canuto A stability functions
986         CASE( 3 )      ;   rpsi3m = 0.05_wp        ! Canuto B stability functions caution : constant not identified)
987         END SELECT
988         !
989      END SELECT
990
991      !
992      SELECT CASE ( nn_stab_func )     !* set the parameters of the stability functions
993      !
994      CASE ( 0 )                             ! Galperin stability functions
995         !
996         IF(lwp) WRITE(numout,*) 'Stability functions from Galperin'
997         rc2     =  0._wp
998         rc3     =  0._wp
999         rc_diff =  1._wp
1000         rc0     =  0.5544_wp
1001         rcm_sf  =  0.9884_wp
1002         rghmin  = -0.28_wp
1003         rgh0    =  0.0233_wp
1004         rghcri  =  0.02_wp
1005         !
1006      CASE ( 1 )                             ! Kantha-Clayson stability functions
1007         !
1008         IF(lwp) WRITE(numout,*) 'Stability functions from Kantha-Clayson'
1009         rc2     =  0.7_wp
1010         rc3     =  0.2_wp
1011         rc_diff =  1._wp
1012         rc0     =  0.5544_wp
1013         rcm_sf  =  0.9884_wp
1014         rghmin  = -0.28_wp
1015         rgh0    =  0.0233_wp
1016         rghcri  =  0.02_wp
1017         !
1018      CASE ( 2 )                             ! Canuto A stability functions
1019         !
1020         IF(lwp) WRITE(numout,*) 'Stability functions from Canuto A'
1021         rs0 = 1.5_wp * rl1 * rl5*rl5
1022         rs1 = -rl4*(rl6+rl7) + 2._wp*rl4*rl5*(rl1-(1._wp/3._wp)*rl2-rl3) + 1.5_wp*rl1*rl5*rl8
1023         rs2 = -(3._wp/8._wp) * rl1*(rl6*rl6-rl7*rl7)
1024         rs4 = 2._wp * rl5
1025         rs5 = 2._wp * rl4
1026         rs6 = (2._wp/3._wp) * rl5 * ( 3._wp*rl3*rl3 - rl2*rl2 ) - 0.5_wp * rl5*rl1 * (3._wp*rl3-rl2)   &
1027            &                                                    + 0.75_wp * rl1 * ( rl6 - rl7 )
1028         rd0 = 3._wp * rl5*rl5
1029         rd1 = rl5 * ( 7._wp*rl4 + 3._wp*rl8 )
1030         rd2 = rl5*rl5 * ( 3._wp*rl3*rl3 - rl2*rl2 ) - 0.75_wp*(rl6*rl6 - rl7*rl7 )
1031         rd3 = rl4 * ( 4._wp*rl4 + 3._wp*rl8)
1032         rd4 = rl4 * ( rl2 * rl6 - 3._wp*rl3*rl7 - rl5*(rl2*rl2 - rl3*rl3 ) ) + rl5*rl8 * ( 3._wp*rl3*rl3 - rl2*rl2 )
1033         rd5 = 0.25_wp * ( rl2*rl2 - 3._wp *rl3*rl3 ) * ( rl6*rl6 - rl7*rl7 )
1034         rc0 = 0.5268_wp
1035         rf6 = 8._wp / (rc0**6._wp)
1036         rc_diff = SQRT(2._wp) / (rc0**3._wp)
1037         rcm_sf  =  0.7310_wp
1038         rghmin  = -0.28_wp
1039         rgh0    =  0.0329_wp
1040         rghcri  =  0.03_wp
1041         !
1042      CASE ( 3 )                             ! Canuto B stability functions
1043         !
1044         IF(lwp) WRITE(numout,*) 'Stability functions from Canuto B'
1045         rs0 = 1.5_wp * rm1 * rm5*rm5
1046         rs1 = -rm4 * (rm6+rm7) + 2._wp * rm4*rm5*(rm1-(1._wp/3._wp)*rm2-rm3) + 1.5_wp * rm1*rm5*rm8
1047         rs2 = -(3._wp/8._wp) * rm1 * (rm6*rm6-rm7*rm7 )
1048         rs4 = 2._wp * rm5
1049         rs5 = 2._wp * rm4
1050         rs6 = (2._wp/3._wp) * rm5 * (3._wp*rm3*rm3-rm2*rm2) - 0.5_wp * rm5*rm1*(3._wp*rm3-rm2) + 0.75_wp * rm1*(rm6-rm7)
1051         rd0 = 3._wp * rm5*rm5
1052         rd1 = rm5 * (7._wp*rm4 + 3._wp*rm8)
1053         rd2 = rm5*rm5 * (3._wp*rm3*rm3 - rm2*rm2) - 0.75_wp * (rm6*rm6 - rm7*rm7)
1054         rd3 = rm4 * ( 4._wp*rm4 + 3._wp*rm8 )
1055         rd4 = rm4 * ( rm2*rm6 -3._wp*rm3*rm7 - rm5*(rm2*rm2 - rm3*rm3) ) + rm5 * rm8 * ( 3._wp*rm3*rm3 - rm2*rm2 )
1056         rd5 = 0.25_wp * ( rm2*rm2 - 3._wp*rm3*rm3 ) * ( rm6*rm6 - rm7*rm7 )
1057         rc0 = 0.5268_wp            !!       rc0 = 0.5540_wp (Warner ...) to verify !
1058         rf6 = 8._wp / ( rc0**6._wp )
1059         rc_diff = SQRT(2._wp)/(rc0**3.)
1060         rcm_sf  =  0.7470_wp
1061         rghmin  = -0.28_wp
1062         rgh0    =  0.0444_wp
1063         rghcri  =  0.0414_wp
1064         !
1065      END SELECT
1066   
1067      !                                !* Set Schmidt number for psi diffusion in the wave breaking case
1068      !                                     ! See Eq. (13) of Carniel et al, OM, 30, 225-239, 2009
1069      !                                     !  or Eq. (17) of Burchard, JPO, 31, 3133-3145, 2001
1070      IF( ln_sigpsi ) THEN
1071         ra_sf = -1.5 ! Set kinetic energy slope, then deduce rsc_psi and rl_sf
1072         ! Verification: retrieve Burchard (2001) results by uncomenting the line below:
1073         ! Note that the results depend on the value of rn_cm_sf which is constant (=rc0) in his work
1074         ! ra_sf = -SQRT(2./3.*rc0**3./rn_cm_sf*rn_sc_tke)/vkarmn
1075         rsc_psi0 = rsc_tke/(24.*rpsi2)*(-1.+(4.*rnn + ra_sf*(1.+4.*rmm))**2./(ra_sf**2.))
1076      ELSE
1077         rsc_psi0 = rsc_psi
1078      ENDIF
1079 
1080      !                                !* Shear free turbulence parameters
1081      !
1082      ra_sf  = -4._wp*rnn*SQRT(rsc_tke) / ( (1._wp+4._wp*rmm)*SQRT(rsc_tke) &
1083               &                              - SQRT(rsc_tke + 24._wp*rsc_psi0*rpsi2 ) )
1084
1085      IF ( rn_crban==0._wp ) THEN
1086         rl_sf = vkarmn
1087      ELSE
1088         rl_sf = rc0 * SQRT(rc0/rcm_sf) * SQRT( ( (1._wp + 4._wp*rmm + 8._wp*rmm**2_wp)*rsc_tke          &
1089                 &                                       + 12._wp * rsc_psi0*rpsi2 - (1._wp + 4._wp*rmm) &
1090                 &                                                *SQRT(rsc_tke*(rsc_tke                 &
1091                 &                                                   + 24._wp*rsc_psi0*rpsi2)) )         &
1092                 &                                         /(12._wp*rnn**2.)                             &
1093                 &                                       )
1094      ENDIF
1095
1096      !
1097      IF(lwp) THEN                     !* Control print
1098         WRITE(numout,*)
1099         WRITE(numout,*) 'Limit values'
1100         WRITE(numout,*) '~~~~~~~~~~~~'
1101         WRITE(numout,*) 'Parameter  m = ',rmm
1102         WRITE(numout,*) 'Parameter  n = ',rnn
1103         WRITE(numout,*) 'Parameter  p = ',rpp
1104         WRITE(numout,*) 'rpsi1   = ',rpsi1
1105         WRITE(numout,*) 'rpsi2   = ',rpsi2
1106         WRITE(numout,*) 'rpsi3m  = ',rpsi3m
1107         WRITE(numout,*) 'rpsi3p  = ',rpsi3p
1108         WRITE(numout,*) 'rsc_tke = ',rsc_tke
1109         WRITE(numout,*) 'rsc_psi = ',rsc_psi
1110         WRITE(numout,*) 'rsc_psi0 = ',rsc_psi0
1111         WRITE(numout,*) 'rc0     = ',rc0
1112         WRITE(numout,*)
1113         WRITE(numout,*) 'Shear free turbulence parameters:'
1114         WRITE(numout,*) 'rcm_sf  = ',rcm_sf
1115         WRITE(numout,*) 'ra_sf   = ',ra_sf
1116         WRITE(numout,*) 'rl_sf   = ',rl_sf
1117         WRITE(numout,*)
1118      ENDIF
1119
1120      !                                !* Constants initialization
1121      rc02  = rc0  * rc0   ;   rc02r = 1. / rc02
1122      rc03  = rc02 * rc0
1123      rc04  = rc03 * rc0
1124      rsbc_tke1 = -3._wp/2._wp*rn_crban*ra_sf*rl_sf                      ! Dirichlet + Wave breaking
1125      rsbc_tke2 = rdt * rn_crban / rl_sf                                 ! Neumann + Wave breaking
1126      zcr = MAX(rsmall, rsbc_tke1**(1./(-ra_sf*3._wp/2._wp))-1._wp )
1127      rtrans = 0.2_wp / zcr                                              ! Ad. inverse transition length between log and wave layer
1128      rsbc_zs1  = rn_charn/grav                                          ! Charnock formula for surface roughness
1129      rsbc_zs2  = rn_frac_hs / 0.85_wp / grav * 665._wp                  ! Rascle formula for surface roughness
1130      rsbc_psi1 = -0.5_wp * rdt * rc0**(rpp-2._wp*rmm) / rsc_psi
1131      rsbc_psi2 = -0.5_wp * rdt * rc0**rpp * rnn * vkarmn**rnn / rsc_psi ! Neumann + NO Wave breaking
1132
1133      rfact_tke = -0.5_wp / rsc_tke * rdt                                ! Cst used for the Diffusion term of tke
1134      rfact_psi = -0.5_wp / rsc_psi * rdt                                ! Cst used for the Diffusion term of tke
1135
1136      !                                !* Wall proximity function
1137      zwall (:,:,:) = 1._wp * tmask(:,:,:)
1138
1139      !                                !* set vertical eddy coef. to the background value
1140      DO jk = 1, jpk
1141         avt (:,:,jk) = avtb(jk) * tmask(:,:,jk)
1142         avm (:,:,jk) = avmb(jk) * tmask(:,:,jk)
1143         avmu(:,:,jk) = avmb(jk) * umask(:,:,jk)
1144         avmv(:,:,jk) = avmb(jk) * vmask(:,:,jk)
1145      END DO
1146      !                             
1147      CALL gls_rst( nit000, 'READ' )   !* read or initialize all required files
1148      !
1149      IF( nn_timing == 1 )  CALL timing_stop('zdf_gls_init')
1150      !
1151   END SUBROUTINE zdf_gls_init
1152
1153
1154   SUBROUTINE gls_rst( kt, cdrw )
1155      !!---------------------------------------------------------------------
1156      !!                   ***  ROUTINE ts_rst  ***
1157      !!                     
1158      !! ** Purpose :   Read or write TKE file (en) in restart file
1159      !!
1160      !! ** Method  :   use of IOM library
1161      !!                if the restart does not contain TKE, en is either
1162      !!                set to rn_emin or recomputed (nn_igls/=0)
1163      !!----------------------------------------------------------------------
1164      INTEGER         , INTENT(in) ::   kt         ! ocean time-step
1165      CHARACTER(len=*), INTENT(in) ::   cdrw       ! "READ"/"WRITE" flag
1166      !
1167      INTEGER ::   jit, jk   ! dummy loop indices
1168      INTEGER ::   id1, id2, id3, id4, id5, id6
1169      INTEGER ::   ji, jj, ikbu, ikbv
1170      REAL(wp)::   cbx, cby
1171      !!----------------------------------------------------------------------
1172      !
1173      IF( TRIM(cdrw) == 'READ' ) THEN        ! Read/initialise
1174         !                                   ! ---------------
1175         IF( ln_rstart ) THEN                   !* Read the restart file
1176            id1 = iom_varid( numror, 'en'   , ldstop = .FALSE. )
1177            id2 = iom_varid( numror, 'avt'  , ldstop = .FALSE. )
1178            id3 = iom_varid( numror, 'avm'  , ldstop = .FALSE. )
1179            id4 = iom_varid( numror, 'avmu' , ldstop = .FALSE. )
1180            id5 = iom_varid( numror, 'avmv' , ldstop = .FALSE. )
1181            id6 = iom_varid( numror, 'mxln' , ldstop = .FALSE. )
1182            !
1183            IF( MIN( id1, id2, id3, id4, id5, id6 ) > 0 ) THEN        ! all required arrays exist
1184               CALL iom_get( numror, jpdom_autoglo, 'en'    , en     )
1185               CALL iom_get( numror, jpdom_autoglo, 'avt'   , avt    )
1186               CALL iom_get( numror, jpdom_autoglo, 'avm'   , avm    )
1187               CALL iom_get( numror, jpdom_autoglo, 'avmu'  , avmu   )
1188               CALL iom_get( numror, jpdom_autoglo, 'avmv'  , avmv   )
1189               CALL iom_get( numror, jpdom_autoglo, 'mxln'  , mxln   )
1190            ELSE                       
1191               IF(lwp) WRITE(numout,*) ' ===>>>> : previous run without gls scheme, en and mxln computed by iterative loop'
1192               en  (:,:,:) = rn_emin
1193               mxln(:,:,:) = 0.05       
1194               avt_k (:,:,:) = avt (:,:,:)
1195               avm_k (:,:,:) = avm (:,:,:)
1196               avmu_k(:,:,:) = avmu(:,:,:)
1197               avmv_k(:,:,:) = avmv(:,:,:)
1198               DO jit = nit000 + 1, nit000 + 10   ;   CALL zdf_gls( jit )   ;   END DO
1199            ENDIF
1200         ELSE                                   !* Start from rest
1201            IF(lwp) WRITE(numout,*) ' ===>>>> : Initialisation of en and mxln by background values'
1202            en  (:,:,:) = rn_emin
1203            mxln(:,:,:) = 0.05       
1204         ENDIF
1205         !
1206      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN   ! Create restart file
1207         !                                   ! -------------------
1208         IF(lwp) WRITE(numout,*) '---- gls-rst ----'
1209         CALL iom_rstput( kt, nitrst, numrow, 'en'   , en     ) 
1210         CALL iom_rstput( kt, nitrst, numrow, 'avt'  , avt_k  )
1211         CALL iom_rstput( kt, nitrst, numrow, 'avm'  , avm_k  )
1212         CALL iom_rstput( kt, nitrst, numrow, 'avmu' , avmu_k ) 
1213         CALL iom_rstput( kt, nitrst, numrow, 'avmv' , avmv_k )
1214         CALL iom_rstput( kt, nitrst, numrow, 'mxln' , mxln   )
1215         !
1216      ENDIF
1217      !
1218   END SUBROUTINE gls_rst
1219
1220#else
1221   !!----------------------------------------------------------------------
1222   !!   Dummy module :                                        NO TKE scheme
1223   !!----------------------------------------------------------------------
1224   LOGICAL, PUBLIC, PARAMETER ::   lk_zdfgls = .FALSE.   !: TKE flag
1225CONTAINS
1226   SUBROUTINE zdf_gls_init           ! Empty routine
1227      WRITE(*,*) 'zdf_gls_init: You should not have seen this print! error?'
1228   END SUBROUTINE zdf_gls_init
1229   SUBROUTINE zdf_gls( kt )          ! Empty routine
1230      WRITE(*,*) 'zdf_gls: You should not have seen this print! error?', kt
1231   END SUBROUTINE zdf_gls
1232   SUBROUTINE gls_rst( kt, cdrw )          ! Empty routine
1233      INTEGER         , INTENT(in) ::   kt         ! ocean time-step
1234      CHARACTER(len=*), INTENT(in) ::   cdrw       ! "READ"/"WRITE" flag
1235      WRITE(*,*) 'gls_rst: You should not have seen this print! error?', kt, cdrw
1236   END SUBROUTINE gls_rst
1237#endif
1238
1239   !!======================================================================
1240END MODULE zdfgls
1241
Note: See TracBrowser for help on using the repository browser.