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.
ldfslp.F90 in NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/LDF – NEMO

source: NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/LDF/ldfslp.F90 @ 11949

Last change on this file since 11949 was 11949, checked in by acc, 4 years ago

Merge in changes from 2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps. This just creates a fresh copy of this branch to use as the merge base. See ticket #2341

  • Property svn:keywords set to Id
File size: 49.3 KB
Line 
1MODULE ldfslp
2   !!======================================================================
3   !!                       ***  MODULE  ldfslp  ***
4   !! Ocean physics: slopes of neutral surfaces
5   !!======================================================================
6   !! History :  OPA  ! 1994-12  (G. Madec, M. Imbard)  Original code
7   !!            8.0  ! 1997-06  (G. Madec)  optimization, lbc
8   !!            8.1  ! 1999-10  (A. Jouzeau)  NEW profile in the mixed layer
9   !!   NEMO     1.0  ! 2002-10  (G. Madec)  Free form, F90
10   !!             -   ! 2005-10  (A. Beckmann)  correction for s-coordinates
11   !!            3.3  ! 2010-10  (G. Nurser, C. Harris, G. Madec)  add Griffies operator
12   !!             -   ! 2010-11  (F. Dupond, G. Madec)  bug correction in slopes just below the ML
13   !!            3.7  ! 2013-12  (F. Lemarie, G. Madec)  add limiter on triad slopes
14   !!----------------------------------------------------------------------
15
16   !!----------------------------------------------------------------------
17   !!   ldf_slp       : calculates the slopes of neutral surface   (Madec operator)
18   !!   ldf_slp_triad : calculates the triads of isoneutral slopes (Griffies operator)
19   !!   ldf_slp_mxl   : calculates the slopes at the base of the mixed layer (Madec operator)
20   !!   ldf_slp_init  : initialization of the slopes computation
21   !!----------------------------------------------------------------------
22   USE oce            ! ocean dynamics and tracers
23   USE dom_oce        ! ocean space and time domain
24!   USE ldfdyn         ! lateral diffusion: eddy viscosity coef.
25   USE phycst         ! physical constants
26   USE zdfmxl         ! mixed layer depth
27   USE eosbn2         ! equation of states
28   !
29   USE in_out_manager ! I/O manager
30   USE prtctl         ! Print control
31   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
32   USE lib_mpp        ! distribued memory computing library
33   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
34   USE timing         ! Timing
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC   ldf_slp         ! routine called by step.F90
40   PUBLIC   ldf_slp_triad   ! routine called by step.F90
41   PUBLIC   ldf_slp_init    ! routine called by nemogcm.F90
42
43   LOGICAL , PUBLIC ::   l_ldfslp = .FALSE.     !: slopes flag
44
45   LOGICAL , PUBLIC ::   ln_traldf_iso   = .TRUE.       !: iso-neutral direction                           (nam_traldf namelist)
46   LOGICAL , PUBLIC ::   ln_traldf_triad = .FALSE.      !: griffies triad scheme                           (nam_traldf namelist)
47   LOGICAL , PUBLIC ::   ln_dynldf_iso                  !: iso-neutral direction                           (nam_dynldf namelist)
48
49   LOGICAL , PUBLIC ::   ln_triad_iso    = .FALSE.      !: pure horizontal mixing in ML                    (nam_traldf namelist)
50   LOGICAL , PUBLIC ::   ln_botmix_triad = .FALSE.      !: mixing on bottom                                (nam_traldf namelist)
51   REAL(wp), PUBLIC ::   rn_sw_triad     = 1._wp        !: =1 switching triads ; =0 all four triads used   (nam_traldf namelist)
52   REAL(wp), PUBLIC ::   rn_slpmax       = 0.01_wp      !: slope limit                                     (nam_traldf namelist)
53
54   LOGICAL , PUBLIC ::   l_grad_zps = .FALSE.           !: special treatment for Horz Tgradients w partial steps (triad operator)
55   
56   !                                                     !! Classic operator (Madec)
57   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)     ::   uslp, wslpi          !: i_slope at U- and W-points
58   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)     ::   vslp, wslpj          !: j-slope at V- and W-points
59   !                                                     !! triad operator (Griffies)
60   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)     ::   wslp2                !: wslp**2 from Griffies quarter cells
61   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:) ::   triadi_g, triadj_g   !: skew flux  slopes relative to geopotentials
62   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:) ::   triadi  , triadj     !: isoneutral slopes relative to model-coordinate
63   !                                                     !! both operators
64   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)     ::   ah_wslp2             !: ah * slope^2 at w-point
65   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)     ::   akz                  !: stabilizing vertical diffusivity
66   
67   !                                                     !! Madec operator
68   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   omlmask           ! mask of the surface mixed layer at T-pt
69   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   uslpml, wslpiml   ! i_slope at U- and W-points just below the mixed layer
70   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   vslpml, wslpjml   ! j_slope at V- and W-points just below the mixed layer
71
72   REAL(wp) ::   repsln = 1.e-25_wp       ! tiny value used as minium of di(rho), dj(rho) and dk(rho)
73
74   !! * Substitutions
75#  include "vectopt_loop_substitute.h90"
76   !!----------------------------------------------------------------------
77   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
78   !! $Id$
79   !! Software governed by the CeCILL license (see ./LICENSE)
80   !!----------------------------------------------------------------------
81CONTAINS
82
83   SUBROUTINE ldf_slp( kt, prd, pn2, Kbb, Kmm )
84      !!----------------------------------------------------------------------
85      !!                 ***  ROUTINE ldf_slp  ***
86      !!
87      !! ** Purpose :   Compute the slopes of neutral surface (slope of isopycnal
88      !!              surfaces referenced locally) (ln_traldf_iso=T).
89      !!
90      !! ** Method  :   The slope in the i-direction is computed at U- and
91      !!      W-points (uslp, wslpi) and the slope in the j-direction is
92      !!      computed at V- and W-points (vslp, wslpj).
93      !!      They are bounded by 1/100 over the whole ocean, and within the
94      !!      surface layer they are bounded by the distance to the surface
95      !!      ( slope<= depth/l  where l is the length scale of horizontal
96      !!      diffusion (here, aht=2000m2/s ==> l=20km with a typical velocity
97      !!      of 10cm/s)
98      !!        A horizontal shapiro filter is applied to the slopes
99      !!        ln_sco=T, s-coordinate, add to the previously computed slopes
100      !!      the slope of the model level surface.
101      !!        macro-tasked on horizontal slab (jk-loop)  (2, jpk-1)
102      !!      [slopes already set to zero at level 1, and to zero or the ocean
103      !!      bottom slope (ln_sco=T) at level jpk in inildf]
104      !!
105      !! ** Action : - uslp, wslpi, and vslp, wslpj, the i- and  j-slopes
106      !!               of now neutral surfaces at u-, w- and v- w-points, resp.
107      !!----------------------------------------------------------------------
108      INTEGER , INTENT(in)                   ::   kt    ! ocean time-step index
109      INTEGER , INTENT(in)                   ::   Kbb, Kmm   ! ocean time level indices
110      REAL(wp), INTENT(in), DIMENSION(:,:,:) ::   prd   ! in situ density
111      REAL(wp), INTENT(in), DIMENSION(:,:,:) ::   pn2   ! Brunt-Vaisala frequency (locally ref.)
112      !!
113      INTEGER  ::   ji , jj , jk    ! dummy loop indices
114      INTEGER  ::   ii0, ii1        ! temporary integer
115      INTEGER  ::   ij0, ij1        ! temporary integer
116      REAL(wp) ::   zeps, zm1_g, zm1_2g, z1_16, zcofw, z1_slpmax ! local scalars
117      REAL(wp) ::   zci, zfi, zau, zbu, zai, zbi   !   -      -
118      REAL(wp) ::   zcj, zfj, zav, zbv, zaj, zbj   !   -      -
119      REAL(wp) ::   zck, zfk,      zbw             !   -      -
120      REAL(wp) ::   zdepu, zdepv                   !   -      -
121      REAL(wp), DIMENSION(jpi,jpj)     ::  zslpml_hmlpu, zslpml_hmlpv
122      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zgru, zwz, zdzr
123      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zgrv, zww
124      !!----------------------------------------------------------------------
125      !
126      IF( ln_timing )   CALL timing_start('ldf_slp')
127      !
128      zeps   =  1.e-20_wp        !==   Local constant initialization   ==!
129      z1_16  =  1.0_wp / 16._wp
130      zm1_g  = -1.0_wp / grav
131      zm1_2g = -0.5_wp / grav
132      z1_slpmax = 1._wp / rn_slpmax
133      !
134      zww(:,:,:) = 0._wp
135      zwz(:,:,:) = 0._wp
136      !
137      DO jk = 1, jpk             !==   i- & j-gradient of density   ==!
138         DO jj = 1, jpjm1
139            DO ji = 1, fs_jpim1   ! vector opt.
140               zgru(ji,jj,jk) = umask(ji,jj,jk) * ( prd(ji+1,jj  ,jk) - prd(ji,jj,jk) )
141               zgrv(ji,jj,jk) = vmask(ji,jj,jk) * ( prd(ji  ,jj+1,jk) - prd(ji,jj,jk) )
142            END DO
143         END DO
144      END DO
145      IF( ln_zps ) THEN                           ! partial steps correction at the bottom ocean level
146         DO jj = 1, jpjm1
147            DO ji = 1, jpim1
148               zgru(ji,jj,mbku(ji,jj)) = gru(ji,jj)
149               zgrv(ji,jj,mbkv(ji,jj)) = grv(ji,jj)
150            END DO
151         END DO
152      ENDIF
153      IF( ln_zps .AND. ln_isfcav ) THEN           ! partial steps correction at the bottom ocean level
154         DO jj = 1, jpjm1
155            DO ji = 1, jpim1
156               IF( miku(ji,jj) > 1 )   zgru(ji,jj,miku(ji,jj)) = grui(ji,jj) 
157               IF( mikv(ji,jj) > 1 )   zgrv(ji,jj,mikv(ji,jj)) = grvi(ji,jj)
158            END DO
159         END DO
160      ENDIF
161      !
162      zdzr(:,:,1) = 0._wp        !==   Local vertical density gradient at T-point   == !   (evaluated from N^2)
163      DO jk = 2, jpkm1
164         !                                ! zdzr = d/dz(prd)= - ( prd ) / grav * mk(pn2) -- at t point
165         !                                !   trick: tmask(ik  )  = 0   =>   all pn2   = 0   =>   zdzr = 0
166         !                                !    else  tmask(ik+1)  = 0   =>   pn2(ik+1) = 0   =>   zdzr divides by 1
167         !                                !          umask(ik+1) /= 0   =>   all pn2  /= 0   =>   zdzr divides by 2
168         !                                ! NB: 1/(tmask+1) = (1-.5*tmask)  substitute a / by a *  ==> faster
169         zdzr(:,:,jk) = zm1_g * ( prd(:,:,jk) + 1._wp )              &
170            &                 * ( pn2(:,:,jk) + pn2(:,:,jk+1) ) * ( 1._wp - 0.5_wp * tmask(:,:,jk+1) )
171      END DO
172      !
173      !                          !==   Slopes just below the mixed layer   ==!
174      CALL ldf_slp_mxl( prd, pn2, zgru, zgrv, zdzr, Kmm )        ! output: uslpml, vslpml, wslpiml, wslpjml
175
176
177      ! I.  slopes at u and v point      | uslp = d/di( prd ) / d/dz( prd )
178      ! ===========================      | vslp = d/dj( prd ) / d/dz( prd )
179      !
180      IF ( ln_isfcav ) THEN
181         DO jj = 2, jpjm1
182            DO ji = fs_2, fs_jpim1   ! vector opt.
183               zslpml_hmlpu(ji,jj) = uslpml(ji,jj) / ( MAX(hmlpt  (ji,jj), hmlpt  (ji+1,jj  ), 5._wp) &
184                  &                                  - MAX(risfdep(ji,jj), risfdep(ji+1,jj  )       ) ) 
185               zslpml_hmlpv(ji,jj) = vslpml(ji,jj) / ( MAX(hmlpt  (ji,jj), hmlpt  (ji  ,jj+1), 5._wp) &
186                  &                                  - MAX(risfdep(ji,jj), risfdep(ji  ,jj+1)       ) )
187            END DO
188         END DO
189      ELSE
190         DO jj = 2, jpjm1
191            DO ji = fs_2, fs_jpim1   ! vector opt.
192               zslpml_hmlpu(ji,jj) = uslpml(ji,jj) / MAX(hmlpt(ji,jj), hmlpt(ji+1,jj  ), 5._wp)
193               zslpml_hmlpv(ji,jj) = vslpml(ji,jj) / MAX(hmlpt(ji,jj), hmlpt(ji  ,jj+1), 5._wp)
194            END DO
195         END DO
196      END IF
197
198      DO jk = 2, jpkm1                            !* Slopes at u and v points
199         DO jj = 2, jpjm1
200            DO ji = fs_2, fs_jpim1   ! vector opt.
201               !                                      ! horizontal and vertical density gradient at u- and v-points
202               zau = zgru(ji,jj,jk) * r1_e1u(ji,jj)
203               zav = zgrv(ji,jj,jk) * r1_e2v(ji,jj)
204               zbu = 0.5_wp * ( zdzr(ji,jj,jk) + zdzr(ji+1,jj  ,jk) )
205               zbv = 0.5_wp * ( zdzr(ji,jj,jk) + zdzr(ji  ,jj+1,jk) )
206               !                                      ! bound the slopes: abs(zw.)<= 1/100 and zb..<0
207               !                                      ! + kxz max= ah slope max =< e1 e3 /(pi**2 2 dt)
208               zbu = MIN(  zbu, - z1_slpmax * ABS( zau ) , -7.e+3_wp/e3u(ji,jj,jk,Kmm)* ABS( zau )  )
209               zbv = MIN(  zbv, - z1_slpmax * ABS( zav ) , -7.e+3_wp/e3v(ji,jj,jk,Kmm)* ABS( zav )  )
210               !                                      ! uslp and vslp output in zwz and zww, resp.
211               zfi = MAX( omlmask(ji,jj,jk), omlmask(ji+1,jj,jk) )
212               zfj = MAX( omlmask(ji,jj,jk), omlmask(ji,jj+1,jk) )
213               ! thickness of water column between surface and level k at u/v point
214               zdepu = 0.5_wp * ( ( gdept (ji,jj,jk,Kmm) + gdept (ji+1,jj,jk,Kmm) )                            &
215                                - 2 * MAX( risfdep(ji,jj), risfdep(ji+1,jj) ) - e3u(ji,jj,miku(ji,jj),Kmm)   )
216               zdepv = 0.5_wp * ( ( gdept (ji,jj,jk,Kmm) + gdept (ji,jj+1,jk,Kmm) )                            &
217                                - 2 * MAX( risfdep(ji,jj), risfdep(ji,jj+1) ) - e3v(ji,jj,mikv(ji,jj),Kmm)   )
218               !
219               zwz(ji,jj,jk) = ( ( 1._wp - zfi) * zau / ( zbu - zeps )                                     &
220                  &                      + zfi  * zdepu * zslpml_hmlpu(ji,jj) ) * umask(ji,jj,jk)
221               zww(ji,jj,jk) = ( ( 1._wp - zfj) * zav / ( zbv - zeps )                                     &
222                  &                      + zfj  * zdepv * zslpml_hmlpv(ji,jj) ) * vmask(ji,jj,jk)
223!!gm  modif to suppress omlmask.... (as in Griffies case)
224!               !                                         ! jk must be >= ML level for zf=1. otherwise  zf=0.
225!               zfi = REAL( 1 - 1/(1 + jk / MAX( nmln(ji+1,jj), nmln(ji,jj) ) ), wp )
226!               zfj = REAL( 1 - 1/(1 + jk / MAX( nmln(ji,jj+1), nmln(ji,jj) ) ), wp )
227!               zci = 0.5 * ( gdept(ji+1,jj,jk,Kmm)+gdept(ji,jj,jk,Kmm) ) / MAX( hmlpt(ji,jj), hmlpt(ji+1,jj), 10. ) )
228!               zcj = 0.5 * ( gdept(ji,jj+1,jk,Kmm)+gdept(ji,jj,jk,Kmm) ) / MAX( hmlpt(ji,jj), hmlpt(ji,jj+1), 10. ) )
229!               zwz(ji,jj,jk) = ( zfi * zai / ( zbi - zeps ) + ( 1._wp - zfi ) * wslpiml(ji,jj) * zci ) * tmask(ji,jj,jk)
230!               zww(ji,jj,jk) = ( zfj * zaj / ( zbj - zeps ) + ( 1._wp - zfj ) * wslpjml(ji,jj) * zcj ) * tmask(ji,jj,jk)
231!!gm end modif
232            END DO
233         END DO
234      END DO
235      CALL lbc_lnk_multi( 'ldfslp', zwz, 'U', -1.,  zww, 'V', -1. )      ! lateral boundary conditions
236      !
237      !                                            !* horizontal Shapiro filter
238      DO jk = 2, jpkm1
239         DO jj = 2, jpjm1, MAX(1, jpj-3)                        ! rows jj=2 and =jpjm1 only
240            DO ji = 2, jpim1
241               uslp(ji,jj,jk) = z1_16 * (        zwz(ji-1,jj-1,jk) + zwz(ji+1,jj-1,jk)      &
242                  &                       +      zwz(ji-1,jj+1,jk) + zwz(ji+1,jj+1,jk)      &
243                  &                       + 2.*( zwz(ji  ,jj-1,jk) + zwz(ji-1,jj  ,jk)      &
244                  &                       +      zwz(ji+1,jj  ,jk) + zwz(ji  ,jj+1,jk) )    &
245                  &                       + 4.*  zwz(ji  ,jj  ,jk)                       )
246               vslp(ji,jj,jk) = z1_16 * (        zww(ji-1,jj-1,jk) + zww(ji+1,jj-1,jk)      &
247                  &                       +      zww(ji-1,jj+1,jk) + zww(ji+1,jj+1,jk)      &
248                  &                       + 2.*( zww(ji  ,jj-1,jk) + zww(ji-1,jj  ,jk)      &
249                  &                       +      zww(ji+1,jj  ,jk) + zww(ji  ,jj+1,jk) )    &
250                  &                       + 4.*  zww(ji,jj    ,jk)                       )
251            END DO
252         END DO
253         DO jj = 3, jpj-2                               ! other rows
254            DO ji = fs_2, fs_jpim1   ! vector opt.
255               uslp(ji,jj,jk) = z1_16 * (        zwz(ji-1,jj-1,jk) + zwz(ji+1,jj-1,jk)      &
256                  &                       +      zwz(ji-1,jj+1,jk) + zwz(ji+1,jj+1,jk)      &
257                  &                       + 2.*( zwz(ji  ,jj-1,jk) + zwz(ji-1,jj  ,jk)      &
258                  &                       +      zwz(ji+1,jj  ,jk) + zwz(ji  ,jj+1,jk) )    &
259                  &                       + 4.*  zwz(ji  ,jj  ,jk)                       )
260               vslp(ji,jj,jk) = z1_16 * (        zww(ji-1,jj-1,jk) + zww(ji+1,jj-1,jk)      &
261                  &                       +      zww(ji-1,jj+1,jk) + zww(ji+1,jj+1,jk)      &
262                  &                       + 2.*( zww(ji  ,jj-1,jk) + zww(ji-1,jj  ,jk)      &
263                  &                       +      zww(ji+1,jj  ,jk) + zww(ji  ,jj+1,jk) )    &
264                  &                       + 4.*  zww(ji,jj    ,jk)                       )
265            END DO
266         END DO
267         !                                        !* decrease along coastal boundaries
268         DO jj = 2, jpjm1
269            DO ji = fs_2, fs_jpim1   ! vector opt.
270               uslp(ji,jj,jk) = uslp(ji,jj,jk) * ( umask(ji,jj+1,jk) + umask(ji,jj-1,jk  ) ) * 0.5_wp   &
271                  &                            * ( umask(ji,jj  ,jk) + umask(ji,jj  ,jk+1) ) * 0.5_wp
272               vslp(ji,jj,jk) = vslp(ji,jj,jk) * ( vmask(ji+1,jj,jk) + vmask(ji-1,jj,jk  ) ) * 0.5_wp   &
273                  &                            * ( vmask(ji  ,jj,jk) + vmask(ji  ,jj,jk+1) ) * 0.5_wp
274            END DO
275         END DO
276      END DO
277
278
279      ! II.  slopes at w point           | wslpi = mij( d/di( prd ) / d/dz( prd )
280      ! ===========================      | wslpj = mij( d/dj( prd ) / d/dz( prd )
281      !
282      DO jk = 2, jpkm1
283         DO jj = 2, jpjm1
284            DO ji = fs_2, fs_jpim1   ! vector opt.
285               !                                  !* Local vertical density gradient evaluated from N^2
286               zbw = zm1_2g * pn2 (ji,jj,jk) * ( prd (ji,jj,jk) + prd (ji,jj,jk-1) + 2. )
287               !                                  !* Slopes at w point
288               !                                        ! i- & j-gradient of density at w-points
289               zci = MAX(  umask(ji-1,jj,jk  ) + umask(ji,jj,jk  )           &
290                  &      + umask(ji-1,jj,jk-1) + umask(ji,jj,jk-1) , zeps  ) * e1t(ji,jj)
291               zcj = MAX(  vmask(ji,jj-1,jk  ) + vmask(ji,jj,jk-1)           &
292                  &      + vmask(ji,jj-1,jk-1) + vmask(ji,jj,jk  ) , zeps  ) * e2t(ji,jj)
293               zai =    (  zgru (ji-1,jj,jk  ) + zgru (ji,jj,jk-1)           &
294                  &      + zgru (ji-1,jj,jk-1) + zgru (ji,jj,jk  )   ) / zci * wmask (ji,jj,jk)
295               zaj =    (  zgrv (ji,jj-1,jk  ) + zgrv (ji,jj,jk-1)           &
296                  &      + zgrv (ji,jj-1,jk-1) + zgrv (ji,jj,jk  )   ) / zcj * wmask (ji,jj,jk)
297               !                                        ! bound the slopes: abs(zw.)<= 1/100 and zb..<0.
298               !                                        ! + kxz max= ah slope max =< e1 e3 /(pi**2 2 dt)
299               zbi = MIN( zbw ,- 100._wp* ABS( zai ) , -7.e+3_wp/e3w(ji,jj,jk,Kmm)* ABS( zai )  )
300               zbj = MIN( zbw , -100._wp* ABS( zaj ) , -7.e+3_wp/e3w(ji,jj,jk,Kmm)* ABS( zaj )  )
301               !                                        ! wslpi and wslpj with ML flattening (output in zwz and zww, resp.)
302               zfk = MAX( omlmask(ji,jj,jk), omlmask(ji,jj,jk-1) )   ! zfk=1 in the ML otherwise zfk=0
303               zck = ( gdepw(ji,jj,jk,Kmm) - gdepw(ji,jj,mikt(ji,jj),Kmm) ) / MAX( hmlp(ji,jj) - gdepw(ji,jj,mikt(ji,jj),Kmm), 10._wp )
304               zwz(ji,jj,jk) = (  zai / ( zbi - zeps ) * ( 1._wp - zfk ) + zck * wslpiml(ji,jj) * zfk  ) * wmask(ji,jj,jk)
305               zww(ji,jj,jk) = (  zaj / ( zbj - zeps ) * ( 1._wp - zfk ) + zck * wslpjml(ji,jj) * zfk  ) * wmask(ji,jj,jk)
306
307!!gm  modif to suppress omlmask....  (as in Griffies operator)
308!               !                                         ! jk must be >= ML level for zfk=1. otherwise  zfk=0.
309!               zfk = REAL( 1 - 1/(1 + jk / nmln(ji+1,jj)), wp )
310!               zck = gdepw(ji,jj,jk)    / MAX( hmlp(ji,jj), 10. )
311!               zwz(ji,jj,jk) = ( zfk * zai / ( zbi - zeps ) + ( 1._wp - zfk ) * wslpiml(ji,jj) * zck ) * tmask(ji,jj,jk)
312!               zww(ji,jj,jk) = ( zfk * zaj / ( zbj - zeps ) + ( 1._wp - zfk ) * wslpjml(ji,jj) * zck ) * tmask(ji,jj,jk)
313!!gm end modif
314            END DO
315         END DO
316      END DO
317      CALL lbc_lnk_multi( 'ldfslp', zwz, 'T', -1.,  zww, 'T', -1. )      ! lateral boundary conditions
318      !
319      !                                           !* horizontal Shapiro filter
320      DO jk = 2, jpkm1
321         DO jj = 2, jpjm1, MAX(1, jpj-3)                        ! rows jj=2 and =jpjm1 only
322            DO ji = 2, jpim1
323               zcofw = wmask(ji,jj,jk) * z1_16
324               wslpi(ji,jj,jk) = (         zwz(ji-1,jj-1,jk) + zwz(ji+1,jj-1,jk)     &
325                    &               +      zwz(ji-1,jj+1,jk) + zwz(ji+1,jj+1,jk)     &
326                    &               + 2.*( zwz(ji  ,jj-1,jk) + zwz(ji-1,jj  ,jk)     &
327                    &               +      zwz(ji+1,jj  ,jk) + zwz(ji  ,jj+1,jk) )   &
328                    &               + 4.*  zwz(ji  ,jj  ,jk)                         ) * zcofw
329
330               wslpj(ji,jj,jk) = (         zww(ji-1,jj-1,jk) + zww(ji+1,jj-1,jk)     &
331                    &               +      zww(ji-1,jj+1,jk) + zww(ji+1,jj+1,jk)     &
332                    &               + 2.*( zww(ji  ,jj-1,jk) + zww(ji-1,jj  ,jk)     &
333                    &               +      zww(ji+1,jj  ,jk) + zww(ji  ,jj+1,jk) )   &
334                    &               + 4.*  zww(ji  ,jj  ,jk)                         ) * zcofw
335            END DO
336         END DO
337         DO jj = 3, jpj-2                               ! other rows
338            DO ji = fs_2, fs_jpim1   ! vector opt.
339               zcofw = wmask(ji,jj,jk) * z1_16
340               wslpi(ji,jj,jk) = (         zwz(ji-1,jj-1,jk) + zwz(ji+1,jj-1,jk)     &
341                    &               +      zwz(ji-1,jj+1,jk) + zwz(ji+1,jj+1,jk)     &
342                    &               + 2.*( zwz(ji  ,jj-1,jk) + zwz(ji-1,jj  ,jk)     &
343                    &               +      zwz(ji+1,jj  ,jk) + zwz(ji  ,jj+1,jk) )   &
344                    &               + 4.*  zwz(ji  ,jj  ,jk)                         ) * zcofw
345
346               wslpj(ji,jj,jk) = (         zww(ji-1,jj-1,jk) + zww(ji+1,jj-1,jk)     &
347                    &               +      zww(ji-1,jj+1,jk) + zww(ji+1,jj+1,jk)     &
348                    &               + 2.*( zww(ji  ,jj-1,jk) + zww(ji-1,jj  ,jk)     &
349                    &               +      zww(ji+1,jj  ,jk) + zww(ji  ,jj+1,jk) )   &
350                    &               + 4.*  zww(ji  ,jj  ,jk)                         ) * zcofw
351            END DO
352         END DO
353         !                                        !* decrease in vicinity of topography
354         DO jj = 2, jpjm1
355            DO ji = fs_2, fs_jpim1   ! vector opt.
356               zck =   ( umask(ji,jj,jk) + umask(ji-1,jj,jk) )   &
357                  &  * ( vmask(ji,jj,jk) + vmask(ji,jj-1,jk) ) * 0.25
358               wslpi(ji,jj,jk) = wslpi(ji,jj,jk) * zck
359               wslpj(ji,jj,jk) = wslpj(ji,jj,jk) * zck
360            END DO
361         END DO
362      END DO
363
364      ! IV. Lateral boundary conditions
365      ! ===============================
366      CALL lbc_lnk_multi( 'ldfslp', uslp , 'U', -1. , vslp , 'V', -1. , wslpi, 'W', -1., wslpj, 'W', -1. )
367
368      IF(ln_ctl) THEN
369         CALL prt_ctl(tab3d_1=uslp , clinfo1=' slp  - u : ', tab3d_2=vslp,  clinfo2=' v : ', kdim=jpk)
370         CALL prt_ctl(tab3d_1=wslpi, clinfo1=' slp  - wi: ', tab3d_2=wslpj, clinfo2=' wj: ', kdim=jpk)
371      ENDIF
372      !
373      IF( ln_timing )   CALL timing_stop('ldf_slp')
374      !
375   END SUBROUTINE ldf_slp
376
377
378   SUBROUTINE ldf_slp_triad ( kt, Kbb, Kmm )
379      !!----------------------------------------------------------------------
380      !!                 ***  ROUTINE ldf_slp_triad  ***
381      !!
382      !! ** Purpose :   Compute the squared slopes of neutral surfaces (slope
383      !!      of iso-pycnal surfaces referenced locally) (ln_traldf_triad=T)
384      !!      at W-points using the Griffies quarter-cells.
385      !!
386      !! ** Method  :   calculates alpha and beta at T-points
387      !!
388      !! ** Action : - triadi_g, triadj_g   T-pts i- and j-slope triads relative to geopot. (used for eiv)
389      !!             - triadi , triadj    T-pts i- and j-slope triads relative to model-coordinate
390      !!             - wslp2              squared slope of neutral surfaces at w-points.
391      !!----------------------------------------------------------------------
392      INTEGER, INTENT( in ) ::   kt             ! ocean time-step index
393      INTEGER , INTENT(in)  ::   Kbb, Kmm       ! ocean time level indices
394      !!
395      INTEGER  ::   ji, jj, jk, jl, ip, jp, kp  ! dummy loop indices
396      INTEGER  ::   iku, ikv                    ! local integer
397      REAL(wp) ::   zfacti, zfactj              ! local scalars
398      REAL(wp) ::   znot_thru_surface           ! local scalars
399      REAL(wp) ::   zdit, zdis, zdkt, zbu, zbti, zisw
400      REAL(wp) ::   zdjt, zdjs, zdks, zbv, zbtj, zjsw
401      REAL(wp) ::   zdxrho_raw, zti_coord, zti_raw, zti_lim, zti_g_raw, zti_g_lim
402      REAL(wp) ::   zdyrho_raw, ztj_coord, ztj_raw, ztj_lim, ztj_g_raw, ztj_g_lim
403      REAL(wp) ::   zdzrho_raw
404      REAL(wp) ::   zbeta0, ze3_e1, ze3_e2
405      REAL(wp), DIMENSION(jpi,jpj)     ::   z1_mlbw
406      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zalbet
407      REAL(wp), DIMENSION(jpi,jpj,jpk,0:1) ::   zdxrho , zdyrho, zdzrho     ! Horizontal and vertical density gradients
408      REAL(wp), DIMENSION(jpi,jpj,0:1,0:1) ::   zti_mlb, ztj_mlb            ! for Griffies operator only
409      !!----------------------------------------------------------------------
410      !
411      IF( ln_timing )   CALL timing_start('ldf_slp_triad')
412      !
413      !--------------------------------!
414      !  Some preliminary calculation  !
415      !--------------------------------!
416      !
417      DO jl = 0, 1                            !==  unmasked before density i- j-, k-gradients  ==!
418         !
419         ip = jl   ;   jp = jl                ! guaranteed nonzero gradients ( absolute value larger than repsln)
420         DO jk = 1, jpkm1                     ! done each pair of triad
421            DO jj = 1, jpjm1                  ! NB: not masked ==>  a minimum value is set
422               DO ji = 1, fs_jpim1            ! vector opt.
423                  zdit = ( ts(ji+1,jj,jk,jp_tem,Kbb) - ts(ji,jj,jk,jp_tem,Kbb) )    ! i-gradient of T & S at u-point
424                  zdis = ( ts(ji+1,jj,jk,jp_sal,Kbb) - ts(ji,jj,jk,jp_sal,Kbb) )
425                  zdjt = ( ts(ji,jj+1,jk,jp_tem,Kbb) - ts(ji,jj,jk,jp_tem,Kbb) )    ! j-gradient of T & S at v-point
426                  zdjs = ( ts(ji,jj+1,jk,jp_sal,Kbb) - ts(ji,jj,jk,jp_sal,Kbb) )
427                  zdxrho_raw = ( - rab_b(ji+ip,jj   ,jk,jp_tem) * zdit + rab_b(ji+ip,jj   ,jk,jp_sal) * zdis ) * r1_e1u(ji,jj)
428                  zdyrho_raw = ( - rab_b(ji   ,jj+jp,jk,jp_tem) * zdjt + rab_b(ji   ,jj+jp,jk,jp_sal) * zdjs ) * r1_e2v(ji,jj)
429                  zdxrho(ji+ip,jj   ,jk,1-ip) = SIGN(  MAX( repsln, ABS( zdxrho_raw ) ), zdxrho_raw  )   ! keep the sign
430                  zdyrho(ji   ,jj+jp,jk,1-jp) = SIGN(  MAX( repsln, ABS( zdyrho_raw ) ), zdyrho_raw  )
431               END DO
432            END DO
433         END DO
434         !
435         IF( ln_zps .AND. l_grad_zps ) THEN     ! partial steps: correction of i- & j-grad on bottom
436            DO jj = 1, jpjm1
437               DO ji = 1, jpim1
438                  iku  = mbku(ji,jj)          ;   ikv  = mbkv(ji,jj)             ! last ocean level (u- & v-points)
439                  zdit = gtsu(ji,jj,jp_tem)   ;   zdjt = gtsv(ji,jj,jp_tem)      ! i- & j-gradient of Temperature
440                  zdis = gtsu(ji,jj,jp_sal)   ;   zdjs = gtsv(ji,jj,jp_sal)      ! i- & j-gradient of Salinity
441                  zdxrho_raw = ( - rab_b(ji+ip,jj   ,iku,jp_tem) * zdit + rab_b(ji+ip,jj   ,iku,jp_sal) * zdis ) * r1_e1u(ji,jj)
442                  zdyrho_raw = ( - rab_b(ji   ,jj+jp,ikv,jp_tem) * zdjt + rab_b(ji   ,jj+jp,ikv,jp_sal) * zdjs ) * r1_e2v(ji,jj)
443                  zdxrho(ji+ip,jj   ,iku,1-ip) = SIGN( MAX( repsln, ABS( zdxrho_raw ) ), zdxrho_raw )   ! keep the sign
444                  zdyrho(ji   ,jj+jp,ikv,1-jp) = SIGN( MAX( repsln, ABS( zdyrho_raw ) ), zdyrho_raw )
445               END DO
446            END DO
447         ENDIF
448         !
449      END DO
450
451      DO kp = 0, 1                            !==  unmasked before density i- j-, k-gradients  ==!
452         DO jk = 1, jpkm1                     ! done each pair of triad
453            DO jj = 1, jpj                    ! NB: not masked ==>  a minimum value is set
454               DO ji = 1, jpi                 ! vector opt.
455                  IF( jk+kp > 1 ) THEN        ! k-gradient of T & S a jk+kp
456                     zdkt = ( ts(ji,jj,jk+kp-1,jp_tem,Kbb) - ts(ji,jj,jk+kp,jp_tem,Kbb) )
457                     zdks = ( ts(ji,jj,jk+kp-1,jp_sal,Kbb) - ts(ji,jj,jk+kp,jp_sal,Kbb) )
458                  ELSE
459                     zdkt = 0._wp                                             ! 1st level gradient set to zero
460                     zdks = 0._wp
461                  ENDIF
462                  zdzrho_raw = ( - rab_b(ji,jj,jk+kp,jp_tem) * zdkt & 
463                             &   + rab_b(ji,jj,jk+kp,jp_sal) * zdks &
464                             & ) / e3w(ji,jj,jk+kp,Kmm) 
465                  zdzrho(ji,jj,jk,kp) = - MIN( - repsln , zdzrho_raw )    ! force zdzrho >= repsln
466                 END DO
467            END DO
468         END DO
469      END DO
470      !
471      DO jj = 1, jpj                          !==  Reciprocal depth of the w-point below ML base  ==!
472         DO ji = 1, jpi
473            jk = MIN( nmln(ji,jj), mbkt(ji,jj) ) + 1     ! MIN in case ML depth is the ocean depth
474            z1_mlbw(ji,jj) = 1._wp / gdepw(ji,jj,jk,Kmm)
475         END DO
476      END DO
477      !
478      !                                       !==  intialisations to zero  ==!
479      !
480      wslp2  (:,:,:)     = 0._wp              ! wslp2 will be cumulated 3D field set to zero
481      triadi_g(:,:,1,:,:) = 0._wp   ;   triadi_g(:,:,jpk,:,:) = 0._wp   ! set surface and bottom slope to zero
482      triadj_g(:,:,1,:,:) = 0._wp   ;   triadj_g(:,:,jpk,:,:) = 0._wp
483      !!gm _iso set to zero missing
484      triadi  (:,:,1,:,:) = 0._wp   ;   triadj  (:,:,jpk,:,:) = 0._wp   ! set surface and bottom slope to zero
485      triadj  (:,:,1,:,:) = 0._wp   ;   triadj  (:,:,jpk,:,:) = 0._wp
486
487      !-------------------------------------!
488      !  Triads just below the Mixed Layer  !
489      !-------------------------------------!
490      !
491      DO jl = 0, 1                            ! calculate slope of the 4 triads immediately ONE level below mixed-layer base
492         DO kp = 0, 1                         ! with only the slope-max limit   and   MASKED
493            DO jj = 1, jpjm1
494               DO ji = 1, fs_jpim1
495                  ip = jl   ;   jp = jl
496                  !
497                  jk = nmln(ji+ip,jj) + 1
498                  IF( jk > mbkt(ji+ip,jj) ) THEN   ! ML reaches bottom
499                     zti_mlb(ji+ip,jj   ,1-ip,kp) = 0.0_wp
500                  ELSE                             
501                     ! Add s-coordinate slope at t-points (do this by *subtracting* gradient of depth)
502                     zti_g_raw = (  zdxrho(ji+ip,jj,jk-kp,1-ip) / zdzrho(ji+ip,jj,jk-kp,kp)      &
503                        &          - ( gdept(ji+1,jj,jk-kp,Kmm) - gdept(ji,jj,jk-kp,Kmm) ) * r1_e1u(ji,jj)  ) * umask(ji,jj,jk)
504                     ze3_e1    =  e3w(ji+ip,jj,jk-kp,Kmm) * r1_e1u(ji,jj) 
505                     zti_mlb(ji+ip,jj   ,1-ip,kp) = SIGN( MIN( rn_slpmax, 5.0_wp * ze3_e1  , ABS( zti_g_raw ) ), zti_g_raw )
506                  ENDIF
507                  !
508                  jk = nmln(ji,jj+jp) + 1
509                  IF( jk >  mbkt(ji,jj+jp) ) THEN  !ML reaches bottom
510                     ztj_mlb(ji   ,jj+jp,1-jp,kp) = 0.0_wp
511                  ELSE
512                     ztj_g_raw = (  zdyrho(ji,jj+jp,jk-kp,1-jp) / zdzrho(ji,jj+jp,jk-kp,kp)      &
513                        &      - ( gdept(ji,jj+1,jk-kp,Kmm) - gdept(ji,jj,jk-kp,Kmm) ) / e2v(ji,jj)  ) * vmask(ji,jj,jk)
514                     ze3_e2    =  e3w(ji,jj+jp,jk-kp,Kmm) / e2v(ji,jj)
515                     ztj_mlb(ji   ,jj+jp,1-jp,kp) = SIGN( MIN( rn_slpmax, 5.0_wp * ze3_e2  , ABS( ztj_g_raw ) ), ztj_g_raw )
516                  ENDIF
517               END DO
518            END DO
519         END DO
520      END DO
521
522      !-------------------------------------!
523      !  Triads with surface limits         !
524      !-------------------------------------!
525      !
526      DO kp = 0, 1                            ! k-index of triads
527         DO jl = 0, 1
528            ip = jl   ;   jp = jl             ! i- and j-indices of triads (i-k and j-k planes)
529            DO jk = 1, jpkm1
530               ! Must mask contribution to slope from dz/dx at constant s for triads jk=1,kp=0 that poke up though ocean surface
531               znot_thru_surface = REAL( 1-1/(jk+kp), wp )  !jk+kp=1,=0.; otherwise=1.0
532               DO jj = 1, jpjm1
533                  DO ji = 1, fs_jpim1         ! vector opt.
534                     !
535                     ! Calculate slope relative to geopotentials used for GM skew fluxes
536                     ! Add s-coordinate slope at t-points (do this by *subtracting* gradient of depth)
537                     ! Limit by slope *relative to geopotentials* by rn_slpmax, and mask by psi-point
538                     ! masked by umask taken at the level of dz(rho)
539                     !
540                     ! raw slopes: unmasked unbounded slopes (relative to geopotential (zti_g) and model surface (zti)
541                     !
542                     zti_raw   = zdxrho(ji+ip,jj   ,jk,1-ip) / zdzrho(ji+ip,jj   ,jk,kp)                   ! unmasked
543                     ztj_raw   = zdyrho(ji   ,jj+jp,jk,1-jp) / zdzrho(ji   ,jj+jp,jk,kp)
544                     !
545                     ! Must mask contribution to slope for triad jk=1,kp=0 that poke up though ocean surface
546                     zti_coord = znot_thru_surface * ( gdept(ji+1,jj  ,jk,Kmm) - gdept(ji,jj,jk,Kmm) ) * r1_e1u(ji,jj)
547                     ztj_coord = znot_thru_surface * ( gdept(ji  ,jj+1,jk,Kmm) - gdept(ji,jj,jk,Kmm) ) * r1_e2v(ji,jj)     ! unmasked
548                     zti_g_raw = zti_raw - zti_coord      ! ref to geopot surfaces
549                     ztj_g_raw = ztj_raw - ztj_coord
550                     ! additional limit required in bilaplacian case
551                     ze3_e1    = e3w(ji+ip,jj   ,jk+kp,Kmm) * r1_e1u(ji,jj)
552                     ze3_e2    = e3w(ji   ,jj+jp,jk+kp,Kmm) * r1_e2v(ji,jj)
553                     ! NB: hard coded factor 5 (can be a namelist parameter...)
554                     zti_g_lim = SIGN( MIN( rn_slpmax, 5.0_wp * ze3_e1, ABS( zti_g_raw ) ), zti_g_raw )
555                     ztj_g_lim = SIGN( MIN( rn_slpmax, 5.0_wp * ze3_e2, ABS( ztj_g_raw ) ), ztj_g_raw )
556                     !
557                     ! Below  ML use limited zti_g as is & mask
558                     ! Inside ML replace by linearly reducing sx_mlb towards surface & mask
559                     !
560                     zfacti = REAL( 1 - 1/(1 + (jk+kp-1)/nmln(ji+ip,jj)), wp )  ! k index of uppermost point(s) of triad is jk+kp-1
561                     zfactj = REAL( 1 - 1/(1 + (jk+kp-1)/nmln(ji,jj+jp)), wp )  ! must be .ge. nmln(ji,jj) for zfact=1
562                     !                                                          !                   otherwise  zfact=0
563                     zti_g_lim =          ( zfacti   * zti_g_lim                       &
564                        &      + ( 1._wp - zfacti ) * zti_mlb(ji+ip,jj,1-ip,kp)   &
565                        &                           * gdepw(ji+ip,jj,jk+kp,Kmm) * z1_mlbw(ji+ip,jj) ) * umask(ji,jj,jk+kp)
566                     ztj_g_lim =          ( zfactj   * ztj_g_lim                       &
567                        &      + ( 1._wp - zfactj ) * ztj_mlb(ji,jj+jp,1-jp,kp)   &
568                        &                           * gdepw(ji,jj+jp,jk+kp,Kmm) * z1_mlbw(ji,jj+jp) ) * vmask(ji,jj,jk+kp)
569                     !
570                     triadi_g(ji+ip,jj   ,jk,1-ip,kp) = zti_g_lim
571                     triadj_g(ji   ,jj+jp,jk,1-jp,kp) = ztj_g_lim
572                     !
573                     ! Get coefficients of isoneutral diffusion tensor
574                     ! 1. Utilise gradients *relative* to s-coordinate, so add t-point slopes (*subtract* depth gradients)
575                     ! 2. We require that isoneutral diffusion  gives no vertical buoyancy flux
576                     !     i.e. 33 term = (real slope* 31, 13 terms)
577                     ! To do this, retain limited sx**2  in vertical flux, but divide by real slope for 13/31 terms
578                     ! Equivalent to tapering A_iso = sx_limited**2/(real slope)**2
579                     !
580                     zti_lim  = ( zti_g_lim + zti_coord ) * umask(ji,jj,jk+kp)    ! remove coordinate slope => relative to coordinate surfaces
581                     ztj_lim  = ( ztj_g_lim + ztj_coord ) * vmask(ji,jj,jk+kp)
582                     !
583                     IF( ln_triad_iso ) THEN
584                        zti_raw = zti_lim*zti_lim / zti_raw
585                        ztj_raw = ztj_lim*ztj_lim / ztj_raw
586                        zti_raw = SIGN( MIN( ABS(zti_lim), ABS( zti_raw ) ), zti_raw )
587                        ztj_raw = SIGN( MIN( ABS(ztj_lim), ABS( ztj_raw ) ), ztj_raw )
588                        zti_lim = zfacti * zti_lim + ( 1._wp - zfacti ) * zti_raw
589                        ztj_lim = zfactj * ztj_lim + ( 1._wp - zfactj ) * ztj_raw
590                     ENDIF
591                     !                                      ! switching triad scheme
592                     zisw = (1._wp - rn_sw_triad ) + rn_sw_triad    &
593                        &            * 2._wp * ABS( 0.5_wp - kp - ( 0.5_wp - ip ) * SIGN( 1._wp , zdxrho(ji+ip,jj,jk,1-ip) )  )
594                     zjsw = (1._wp - rn_sw_triad ) + rn_sw_triad    &
595                        &            * 2._wp * ABS( 0.5_wp - kp - ( 0.5_wp - jp ) * SIGN( 1._wp , zdyrho(ji,jj+jp,jk,1-jp) )  )
596                     !
597                     triadi(ji+ip,jj   ,jk,1-ip,kp) = zti_lim * zisw
598                     triadj(ji   ,jj+jp,jk,1-jp,kp) = ztj_lim * zjsw
599                     !
600                     zbu  = e1e2u(ji   ,jj   ) * e3u(ji   ,jj   ,jk   ,Kmm)
601                     zbv  = e1e2v(ji   ,jj   ) * e3v(ji   ,jj   ,jk   ,Kmm)
602                     zbti = e1e2t(ji+ip,jj   ) * e3w(ji+ip,jj   ,jk+kp,Kmm)
603                     zbtj = e1e2t(ji   ,jj+jp) * e3w(ji   ,jj+jp,jk+kp,Kmm)
604                     !
605                     wslp2(ji+ip,jj,jk+kp) = wslp2(ji+ip,jj,jk+kp) + 0.25_wp * zbu / zbti * zti_g_lim*zti_g_lim      ! masked
606                     wslp2(ji,jj+jp,jk+kp) = wslp2(ji,jj+jp,jk+kp) + 0.25_wp * zbv / zbtj * ztj_g_lim*ztj_g_lim
607                  END DO
608               END DO
609            END DO
610         END DO
611      END DO
612      !
613      wslp2(:,:,1) = 0._wp                ! force the surface wslp to zero
614
615      CALL lbc_lnk( 'ldfslp', wslp2, 'W', 1. )      ! lateral boundary confition on wslp2 only   ==>>> gm : necessary ? to be checked
616      !
617      IF( ln_timing )   CALL timing_stop('ldf_slp_triad')
618      !
619   END SUBROUTINE ldf_slp_triad
620
621
622   SUBROUTINE ldf_slp_mxl( prd, pn2, p_gru, p_grv, p_dzr, Kmm )
623      !!----------------------------------------------------------------------
624      !!                  ***  ROUTINE ldf_slp_mxl  ***
625      !!
626      !! ** Purpose :   Compute the slopes of iso-neutral surface just below
627      !!              the mixed layer.
628      !!
629      !! ** Method  :   The slope in the i-direction is computed at u- & w-points
630      !!              (uslpml, wslpiml) and the slope in the j-direction is computed
631      !!              at v- and w-points (vslpml, wslpjml) with the same bounds as
632      !!              in ldf_slp.
633      !!
634      !! ** Action  :   uslpml, wslpiml :  i- &  j-slopes of neutral surfaces
635      !!                vslpml, wslpjml    just below the mixed layer
636      !!                omlmask         :  mixed layer mask
637      !!----------------------------------------------------------------------
638      REAL(wp), DIMENSION(:,:,:), INTENT(in) ::   prd            ! in situ density
639      REAL(wp), DIMENSION(:,:,:), INTENT(in) ::   pn2            ! Brunt-Vaisala frequency (locally ref.)
640      REAL(wp), DIMENSION(:,:,:), INTENT(in) ::   p_gru, p_grv   ! i- & j-gradient of density (u- & v-pts)
641      REAL(wp), DIMENSION(:,:,:), INTENT(in) ::   p_dzr          ! z-gradient of density      (T-point)
642      INTEGER , INTENT(in)                   ::   Kmm            ! ocean time level indices
643      !!
644      INTEGER  ::   ji , jj , jk                   ! dummy loop indices
645      INTEGER  ::   iku, ikv, ik, ikm1             ! local integers
646      REAL(wp) ::   zeps, zm1_g, zm1_2g, z1_slpmax ! local scalars
647      REAL(wp) ::   zci, zfi, zau, zbu, zai, zbi   !   -      -
648      REAL(wp) ::   zcj, zfj, zav, zbv, zaj, zbj   !   -      -
649      REAL(wp) ::   zck, zfk,      zbw             !   -      -
650      !!----------------------------------------------------------------------
651      !
652      zeps   =  1.e-20_wp        !==   Local constant initialization   ==!
653      zm1_g  = -1.0_wp / grav
654      zm1_2g = -0.5_wp / grav
655      z1_slpmax = 1._wp / rn_slpmax
656      !
657      uslpml (1,:) = 0._wp      ;      uslpml (jpi,:) = 0._wp
658      vslpml (1,:) = 0._wp      ;      vslpml (jpi,:) = 0._wp
659      wslpiml(1,:) = 0._wp      ;      wslpiml(jpi,:) = 0._wp
660      wslpjml(1,:) = 0._wp      ;      wslpjml(jpi,:) = 0._wp
661      !
662      !                                            !==   surface mixed layer mask   !
663      DO jk = 1, jpk                               ! =1 inside the mixed layer, =0 otherwise
664         DO jj = 1, jpj
665            DO ji = 1, jpi
666               ik = nmln(ji,jj) - 1
667               IF( jk <= ik ) THEN   ;   omlmask(ji,jj,jk) = 1._wp
668               ELSE                  ;   omlmask(ji,jj,jk) = 0._wp
669               ENDIF
670            END DO
671         END DO
672      END DO
673
674
675      ! Slopes of isopycnal surfaces just before bottom of mixed layer
676      ! --------------------------------------------------------------
677      ! The slope are computed as in the 3D case.
678      ! A key point here is the definition of the mixed layer at u- and v-points.
679      ! It is assumed to be the maximum of the two neighbouring T-point mixed layer depth.
680      ! Otherwise, a n2 value inside the mixed layer can be involved in the computation
681      ! of the slope, resulting in a too steep diagnosed slope and thus a spurious eddy
682      ! induce velocity field near the base of the mixed layer.
683      !-----------------------------------------------------------------------
684      !
685      DO jj = 2, jpjm1
686         DO ji = 2, jpim1
687            !                        !==   Slope at u- & v-points just below the Mixed Layer   ==!
688            !
689            !                        !- vertical density gradient for u- and v-slopes (from dzr at T-point)
690            iku = MIN(  MAX( 1, nmln(ji,jj) , nmln(ji+1,jj) ) , jpkm1  )   ! ML (MAX of T-pts, bound by jpkm1)
691            ikv = MIN(  MAX( 1, nmln(ji,jj) , nmln(ji,jj+1) ) , jpkm1  )   !
692            zbu = 0.5_wp * ( p_dzr(ji,jj,iku) + p_dzr(ji+1,jj  ,iku) )
693            zbv = 0.5_wp * ( p_dzr(ji,jj,ikv) + p_dzr(ji  ,jj+1,ikv) )
694            !                        !- horizontal density gradient at u- & v-points
695            zau = p_gru(ji,jj,iku) * r1_e1u(ji,jj)
696            zav = p_grv(ji,jj,ikv) * r1_e2v(ji,jj)
697            !                        !- bound the slopes: abs(zw.)<= 1/100 and zb..<0
698            !                           kxz max= ah slope max =< e1 e3 /(pi**2 2 dt)
699            zbu = MIN(  zbu , - z1_slpmax * ABS( zau ) , -7.e+3_wp/e3u(ji,jj,iku,Kmm)* ABS( zau )  )
700            zbv = MIN(  zbv , - z1_slpmax * ABS( zav ) , -7.e+3_wp/e3v(ji,jj,ikv,Kmm)* ABS( zav )  )
701            !                        !- Slope at u- & v-points (uslpml, vslpml)
702            uslpml(ji,jj) = zau / ( zbu - zeps ) * umask(ji,jj,iku)
703            vslpml(ji,jj) = zav / ( zbv - zeps ) * vmask(ji,jj,ikv)
704            !
705            !                        !==   i- & j-slopes at w-points just below the Mixed Layer   ==!
706            !
707            ik   = MIN( nmln(ji,jj) + 1, jpk )
708            ikm1 = MAX( 1, ik-1 )
709            !                        !- vertical density gradient for w-slope (from N^2)
710            zbw = zm1_2g * pn2 (ji,jj,ik) * ( prd (ji,jj,ik) + prd (ji,jj,ikm1) + 2. )
711            !                        !- horizontal density i- & j-gradient at w-points
712            zci = MAX(   umask(ji-1,jj,ik  ) + umask(ji,jj,ik  )           &
713               &       + umask(ji-1,jj,ikm1) + umask(ji,jj,ikm1) , zeps  ) * e1t(ji,jj)
714            zcj = MAX(   vmask(ji,jj-1,ik  ) + vmask(ji,jj,ik  )           &
715               &       + vmask(ji,jj-1,ikm1) + vmask(ji,jj,ikm1) , zeps  ) * e2t(ji,jj)
716            zai =    (   p_gru(ji-1,jj,ik  ) + p_gru(ji,jj,ik)             &
717               &       + p_gru(ji-1,jj,ikm1) + p_gru(ji,jj,ikm1  )  ) / zci  * tmask(ji,jj,ik)
718            zaj =    (   p_grv(ji,jj-1,ik  ) + p_grv(ji,jj,ik  )           &
719               &       + p_grv(ji,jj-1,ikm1) + p_grv(ji,jj,ikm1)  ) / zcj  * tmask(ji,jj,ik)
720            !                        !- bound the slopes: abs(zw.)<= 1/100 and zb..<0.
721            !                           kxz max= ah slope max =< e1 e3 /(pi**2 2 dt)
722            zbi = MIN(  zbw , -100._wp* ABS( zai ) , -7.e+3_wp/e3w(ji,jj,ik,Kmm)* ABS( zai )  )
723            zbj = MIN(  zbw , -100._wp* ABS( zaj ) , -7.e+3_wp/e3w(ji,jj,ik,Kmm)* ABS( zaj )  )
724            !                        !- i- & j-slope at w-points (wslpiml, wslpjml)
725            wslpiml(ji,jj) = zai / ( zbi - zeps ) * tmask (ji,jj,ik)
726            wslpjml(ji,jj) = zaj / ( zbj - zeps ) * tmask (ji,jj,ik)
727         END DO
728      END DO
729      !!gm this lbc_lnk should be useless....
730      CALL lbc_lnk_multi( 'ldfslp', uslpml , 'U', -1. , vslpml , 'V', -1. , wslpiml, 'W', -1. , wslpjml, 'W', -1. ) 
731      !
732   END SUBROUTINE ldf_slp_mxl
733
734
735   SUBROUTINE ldf_slp_init
736      !!----------------------------------------------------------------------
737      !!                  ***  ROUTINE ldf_slp_init  ***
738      !!
739      !! ** Purpose :   Initialization for the isopycnal slopes computation
740      !!
741      !! ** Method  :   
742      !!----------------------------------------------------------------------
743      INTEGER ::   ji, jj, jk   ! dummy loop indices
744      INTEGER ::   ierr         ! local integer
745      !!----------------------------------------------------------------------
746      !
747      IF(lwp) THEN
748         WRITE(numout,*)
749         WRITE(numout,*) 'ldf_slp_init : direction of lateral mixing'
750         WRITE(numout,*) '~~~~~~~~~~~~'
751      ENDIF
752      !
753      ALLOCATE( ah_wslp2(jpi,jpj,jpk) , akz(jpi,jpj,jpk) , STAT=ierr )
754      IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'ldf_slp_init : unable to allocate ah_slp2 or akz' )
755      !
756      IF( ln_traldf_triad ) THEN        ! Griffies operator : triad of slopes
757         IF(lwp) WRITE(numout,*) '   ==>>>   triad) operator (Griffies)'
758         ALLOCATE( triadi_g(jpi,jpj,jpk,0:1,0:1) , triadj_g(jpi,jpj,jpk,0:1,0:1) ,     &
759            &      triadi  (jpi,jpj,jpk,0:1,0:1) , triadj  (jpi,jpj,jpk,0:1,0:1) ,     &
760            &      wslp2   (jpi,jpj,jpk)                                         , STAT=ierr )
761         IF( ierr > 0      )   CALL ctl_stop( 'STOP', 'ldf_slp_init : unable to allocate Griffies operator slope' )
762         IF( ln_dynldf_iso )   CALL ctl_stop( 'ldf_slp_init: Griffies operator on momentum not supported' )
763         !
764      ELSE                             ! Madec operator : slopes at u-, v-, and w-points
765         IF(lwp) WRITE(numout,*) '   ==>>>   iso operator (Madec)'
766         ALLOCATE( omlmask(jpi,jpj,jpk) ,                                                                        &
767            &      uslp(jpi,jpj,jpk) , uslpml(jpi,jpj) , wslpi(jpi,jpj,jpk) , wslpiml(jpi,jpj) ,     &
768            &      vslp(jpi,jpj,jpk) , vslpml(jpi,jpj) , wslpj(jpi,jpj,jpk) , wslpjml(jpi,jpj) , STAT=ierr )
769         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'ldf_slp_init : unable to allocate Madec operator slope ' )
770
771         ! Direction of lateral diffusion (tracers and/or momentum)
772         ! ------------------------------
773         uslp (:,:,:) = 0._wp   ;   uslpml (:,:) = 0._wp      ! set the slope to zero (even in s-coordinates)
774         vslp (:,:,:) = 0._wp   ;   vslpml (:,:) = 0._wp
775         wslpi(:,:,:) = 0._wp   ;   wslpiml(:,:) = 0._wp
776         wslpj(:,:,:) = 0._wp   ;   wslpjml(:,:) = 0._wp
777
778         !!gm I no longer understand this.....
779!!gm         IF( (ln_traldf_hor .OR. ln_dynldf_hor) .AND. .NOT. (.NOT.ln_linssh .AND. ln_rstart) ) THEN
780!            IF(lwp)   WRITE(numout,*) '          Horizontal mixing in s-coordinate: slope = slope of s-surfaces'
781!
782!            ! geopotential diffusion in s-coordinates on tracers and/or momentum
783!            ! The slopes of s-surfaces are computed once (no call to ldfslp in step)
784!            ! The slopes for momentum diffusion are i- or j- averaged of those on tracers
785!
786!            ! set the slope of diffusion to the slope of s-surfaces
787!            !      ( c a u t i o n : minus sign as dep has positive value )
788!            DO jk = 1, jpk
789!               DO jj = 2, jpjm1
790!                  DO ji = fs_2, fs_jpim1   ! vector opt.
791!                     uslp (ji,jj,jk) = - ( gdept(ji+1,jj,jk,Kmm) - gdept(ji ,jj ,jk,Kmm) ) * r1_e1u(ji,jj) * umask(ji,jj,jk)
792!                     vslp (ji,jj,jk) = - ( gdept(ji,jj+1,jk,Kmm) - gdept(ji ,jj ,jk,Kmm) ) * r1_e2v(ji,jj) * vmask(ji,jj,jk)
793!                     wslpi(ji,jj,jk) = - ( gdepw(ji+1,jj,jk,Kmm) - gdepw(ji-1,jj,jk,Kmm) ) * r1_e1t(ji,jj) * wmask(ji,jj,jk) * 0.5
794!                     wslpj(ji,jj,jk) = - ( gdepw(ji,jj+1,jk,Kmm) - gdepw(ji,jj-1,jk,Kmm) ) * r1_e2t(ji,jj) * wmask(ji,jj,jk) * 0.5
795!                  END DO
796!               END DO
797!            END DO
798!            CALL lbc_lnk_multi( 'ldfslp', uslp , 'U', -1. ; CALL lbc_lnk( 'ldfslp', vslp , 'V', -1.,  wslpi, 'W', -1.,  wslpj, 'W', -1. )
799!!gm         ENDIF
800      ENDIF
801      !
802   END SUBROUTINE ldf_slp_init
803
804   !!======================================================================
805END MODULE ldfslp
Note: See TracBrowser for help on using the repository browser.