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/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfgls.F90 @ 3432

Last change on this file since 3432 was 3432, checked in by trackstand2, 12 years ago

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