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.
dynzdf.F90 in NEMO/branches/2021/dev_r14318_RK3_stage1/src/OCE/DYN – NEMO

source: NEMO/branches/2021/dev_r14318_RK3_stage1/src/OCE/DYN/dynzdf.F90

Last change on this file was 15574, checked in by techene, 3 years ago

#2605 #2715 trunk merged into dev_r14318_RK3_stage1

  • Property svn:keywords set to Id
File size: 25.5 KB
Line 
1MODULE dynzdf
2   !!==============================================================================
3   !!                 ***  MODULE  dynzdf  ***
4   !! Ocean dynamics :  vertical component of the momentum mixing trend
5   !!==============================================================================
6   !! History :  1.0  !  2005-11  (G. Madec)  Original code
7   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
8   !!            4.0  !  2017-06  (G. Madec) remove the explicit time-stepping option + avm at t-point
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   dyn_zdf       : compute the after velocity through implicit calculation of vertical mixing
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers variables
15   USE phycst         ! physical constants
16   USE dom_oce        ! ocean space and time domain variables
17   USE sbc_oce        ! surface boundary condition: ocean
18   USE zdf_oce        ! ocean vertical physics variables
19   USE zdfdrg         ! vertical physics: top/bottom drag coef.
20   USE dynadv    ,ONLY: ln_dynadv_vec    ! dynamics: advection form
21#if defined key_loop_fusion
22   USE dynldf_iso_lf,ONLY: akzu, akzv       ! dynamics: vertical component of rotated lateral mixing
23#else
24   USE dynldf_iso,ONLY: akzu, akzv       ! dynamics: vertical component of rotated lateral mixing
25#endif
26   USE ldfdyn         ! lateral diffusion: eddy viscosity coef. and type of operator
27   USE trd_oce        ! trends: ocean variables
28   USE trddyn         ! trend manager: dynamics
29   !
30   USE in_out_manager ! I/O manager
31   USE lib_mpp        ! MPP library
32   USE prtctl         ! Print control
33   USE timing         ! Timing
34
35   IMPLICIT NONE
36   PRIVATE
37
38   PUBLIC   dyn_zdf   !  routine called by step.F90
39
40   REAL(wp) ::  r_vvl     ! non-linear free surface indicator: =0 if ln_linssh=T, =1 otherwise
41
42   !! * Substitutions
43#  include "do_loop_substitute.h90"
44#  include "domzgr_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
47   !! $Id$
48   !! Software governed by the CeCILL license (see ./LICENSE)
49   !!----------------------------------------------------------------------
50CONTAINS
51   
52   SUBROUTINE dyn_zdf( kt, Kbb, Kmm, Krhs, puu, pvv, Kaa )
53      !!----------------------------------------------------------------------
54      !!                  ***  ROUTINE dyn_zdf  ***
55      !!
56      !! ** Purpose :   compute the trend due to the vert. momentum diffusion
57      !!              together with the Leap-Frog time stepping using an
58      !!              implicit scheme.
59      !!
60      !! ** Method  :  - Leap-Frog time stepping on all trends but the vertical mixing
61      !!         u(after) =         u(before) + 2*dt *       u(rhs)                vector form or linear free surf.
62      !!         u(after) = ( e3u_b*u(before) + 2*dt * e3u_n*u(rhs) ) / e3u_after   otherwise
63      !!               - update the after velocity with the implicit vertical mixing.
64      !!      This requires to solver the following system:
65      !!         u(after) = u(after) + 1/e3u_after  dk+1[ mi(avm) / e3uw_after dk[ua] ]
66      !!      with the following surface/top/bottom boundary condition:
67      !!      surface: wind stress input (averaged over kt-1/2 & kt+1/2)
68      !!      top & bottom : top stress (iceshelf-ocean) & bottom stress (cf zdfdrg.F90)
69      !!
70      !! ** Action :   (puu(:,:,:,Kaa),pvv(:,:,:,Kaa))   after velocity
71      !!---------------------------------------------------------------------
72      INTEGER                             , INTENT( in )  ::  kt                  ! ocean time-step index
73      INTEGER                             , INTENT( in )  ::  Kbb, Kmm, Krhs, Kaa ! ocean time level indices
74      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv            ! ocean velocities and RHS of momentum equation
75      !
76      INTEGER  ::   ji, jj, jk           ! dummy loop indices
77      INTEGER  ::   iku, ikv             ! local integers
78      REAL(wp) ::   zzwi, ze3ua, zDt_2   ! local scalars
79      REAL(wp) ::   zzws, ze3va          !   -      -
80      REAL(wp) ::   z1_e3ua, z1_e3va     !   -      -
81      REAL(wp) ::   zWu , zWv            !   -      -
82      REAL(wp) ::   zWui, zWvi           !   -      -
83      REAL(wp) ::   zWus, zWvs           !   -      -
84      REAL(wp), DIMENSION(A2D(nn_hls),jpk)        ::  zwi, zwd, zws   ! 3D workspace
85      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::   ztrdu, ztrdv   !  -      -
86      !!---------------------------------------------------------------------
87      !
88      IF( ln_timing )   CALL timing_start('dyn_zdf')
89      !
90      IF( .NOT. l_istiled .OR. ntile == 1 )  THEN                       ! Do only on the first tile
91         IF( kt == nit000 ) THEN       !* initialization
92            IF(lwp) WRITE(numout,*)
93            IF(lwp) WRITE(numout,*) 'dyn_zdf_imp : vertical momentum diffusion implicit operator'
94            IF(lwp) WRITE(numout,*) '~~~~~~~~~~~ '
95            !
96            If( ln_linssh ) THEN   ;    r_vvl = 0._wp    ! non-linear free surface indicator
97            ELSE                   ;    r_vvl = 1._wp
98            ENDIF
99         ENDIF
100      ENDIF
101      !
102      zDt_2 = rDt * 0.5_wp
103      !
104      !                             !* explicit top/bottom drag case
105      IF( .NOT.ln_drgimp )   CALL zdf_drg_exp( kt, Kmm, puu(:,:,:,Kbb), pvv(:,:,:,Kbb), puu(:,:,:,Krhs), pvv(:,:,:,Krhs) )  ! add top/bottom friction trend to (puu(Kaa),pvv(Kaa))
106      !
107      !
108      IF( l_trddyn )   THEN         !* temporary save of ta and sa trends
109         ALLOCATE( ztrdu(jpi,jpj,jpk), ztrdv(jpi,jpj,jpk) ) 
110         ztrdu(:,:,:) = puu(:,:,:,Krhs)
111         ztrdv(:,:,:) = pvv(:,:,:,Krhs)
112      ENDIF
113      !
114      !              !==  RHS: Leap-Frog time stepping on all trends but the vertical mixing  ==!   (put in puu(:,:,:,Kaa),pvv(:,:,:,Kaa))
115      !
116      !                    ! time stepping except vertical diffusion
117      IF( ln_dynadv_vec .OR. ln_linssh ) THEN   ! applied on velocity
118         DO_3D( 0, 0, 0, 0, 1, jpkm1 )
119            puu(ji,jj,jk,Kaa) = ( puu(ji,jj,jk,Kbb) + rDt * puu(ji,jj,jk,Krhs) ) * umask(ji,jj,jk)
120            pvv(ji,jj,jk,Kaa) = ( pvv(ji,jj,jk,Kbb) + rDt * pvv(ji,jj,jk,Krhs) ) * vmask(ji,jj,jk)
121         END_3D
122      ELSE                                      ! applied on thickness weighted velocity
123         DO_3D( 0, 0, 0, 0, 1, jpkm1 )
124            puu(ji,jj,jk,Kaa) = (         e3u(ji,jj,jk,Kbb) * puu(ji,jj,jk,Kbb )  &
125               &                  + rDt * e3u(ji,jj,jk,Kmm) * puu(ji,jj,jk,Krhs)  ) &
126               &                        / e3u(ji,jj,jk,Kaa) * umask(ji,jj,jk)
127            pvv(ji,jj,jk,Kaa) = (         e3v(ji,jj,jk,Kbb) * pvv(ji,jj,jk,Kbb )  &
128               &                  + rDt * e3v(ji,jj,jk,Kmm) * pvv(ji,jj,jk,Krhs)  ) &
129               &                        / e3v(ji,jj,jk,Kaa) * vmask(ji,jj,jk)
130         END_3D
131      ENDIF
132      !                    ! add top/bottom friction
133      !     With split-explicit free surface, barotropic stress is treated explicitly Update velocities at the bottom.
134      !     J. Chanut: The bottom stress is computed considering after barotropic velocities, which does
135      !                not lead to the effective stress seen over the whole barotropic loop.
136      !     G. Madec : in linear free surface, e3u(:,:,:,Kaa) = e3u(:,:,:,Kmm) = e3u_0, so systematic use of e3u(:,:,:,Kaa)
137      IF( ln_drgimp .AND. ln_dynspg_ts ) THEN
138         DO_3D( 0, 0, 0, 0, 1, jpkm1 )      ! remove barotropic velocities
139            puu(ji,jj,jk,Kaa) = ( puu(ji,jj,jk,Kaa) - uu_b(ji,jj,Kaa) ) * umask(ji,jj,jk)
140            pvv(ji,jj,jk,Kaa) = ( pvv(ji,jj,jk,Kaa) - vv_b(ji,jj,Kaa) ) * vmask(ji,jj,jk)
141         END_3D
142         DO_2D( 0, 0, 0, 0 )      ! Add bottom/top stress due to barotropic component only
143            iku = mbku(ji,jj)         ! ocean bottom level at u- and v-points
144            ikv = mbkv(ji,jj)         ! (deepest ocean u- and v-points)
145            ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,iku,Kmm)    &
146               &             + r_vvl   * e3u(ji,jj,iku,Kaa)
147            ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,ikv,Kmm)    &
148               &             + r_vvl   * e3v(ji,jj,ikv,Kaa)
149            puu(ji,jj,iku,Kaa) = puu(ji,jj,iku,Kaa) + zDt_2 *( rCdU_bot(ji+1,jj)+rCdU_bot(ji,jj) ) * uu_b(ji,jj,Kaa) / ze3ua
150            pvv(ji,jj,ikv,Kaa) = pvv(ji,jj,ikv,Kaa) + zDt_2 *( rCdU_bot(ji,jj+1)+rCdU_bot(ji,jj) ) * vv_b(ji,jj,Kaa) / ze3va
151         END_2D
152         IF( ln_isfcav.OR.ln_drgice_imp ) THEN    ! Ocean cavities (ISF)
153            DO_2D( 0, 0, 0, 0 )
154               iku = miku(ji,jj)         ! top ocean level at u- and v-points
155               ikv = mikv(ji,jj)         ! (first wet ocean u- and v-points)
156               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,iku,Kmm)    &
157                  &             + r_vvl   * e3u(ji,jj,iku,Kaa)
158               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,ikv,Kmm)    &
159                  &             + r_vvl   * e3v(ji,jj,ikv,Kaa)
160               puu(ji,jj,iku,Kaa) = puu(ji,jj,iku,Kaa) + zDt_2 *( rCdU_top(ji+1,jj)+rCdU_top(ji,jj) ) * uu_b(ji,jj,Kaa) / ze3ua
161               pvv(ji,jj,ikv,Kaa) = pvv(ji,jj,ikv,Kaa) + zDt_2 *( rCdU_top(ji,jj+1)+rCdU_top(ji,jj) ) * vv_b(ji,jj,Kaa) / ze3va
162            END_2D
163         END IF
164      ENDIF
165      !
166      !              !==  Vertical diffusion on u  ==!
167      !
168      !                    !* Matrix construction
169      IF( ln_zad_Aimp ) THEN   !!
170         SELECT CASE( nldf_dyn )
171         CASE( np_lap_i )           ! rotated lateral mixing: add its vertical mixing (akzu)
172            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
173               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,jk,Kmm)    &
174                  &             + r_vvl   * e3u(ji,jj,jk,Kaa)   ! after scale factor at U-point
175               zzwi = - zDt_2 * ( avm(ji+1,jj,jk  ) + avm(ji,jj,jk  ) + akzu(ji,jj,jk  ) )   &
176                  &         / ( ze3ua * e3uw(ji,jj,jk  ,Kmm) ) * wumask(ji,jj,jk  )
177               zzws = - zDt_2 * ( avm(ji+1,jj,jk+1) + avm(ji,jj,jk+1) + akzu(ji,jj,jk+1) )   &
178                  &         / ( ze3ua * e3uw(ji,jj,jk+1,Kmm) ) * wumask(ji,jj,jk+1)
179               zWui = ( wi(ji,jj,jk  ) + wi(ji+1,jj,jk  ) ) / ze3ua
180               zWus = ( wi(ji,jj,jk+1) + wi(ji+1,jj,jk+1) ) / ze3ua
181               zwi(ji,jj,jk) = zzwi + zDt_2 * MIN( zWui, 0._wp ) 
182               zws(ji,jj,jk) = zzws - zDt_2 * MAX( zWus, 0._wp )
183               zwd(ji,jj,jk) = 1._wp - zzwi - zzws + zDt_2 * ( MAX( zWui, 0._wp ) - MIN( zWus, 0._wp ) )
184            END_3D
185         CASE DEFAULT               ! iso-level lateral mixing
186            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
187               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,jk,Kmm)    &    ! after scale factor at U-point
188                  &             + r_vvl   * e3u(ji,jj,jk,Kaa)
189               zzwi = - zDt_2 * ( avm(ji+1,jj,jk  ) + avm(ji,jj,jk  ) )   &
190                  &         / ( ze3ua * e3uw(ji,jj,jk  ,Kmm) ) * wumask(ji,jj,jk  )
191               zzws = - zDt_2 * ( avm(ji+1,jj,jk+1) + avm(ji,jj,jk+1) )   &
192                  &         / ( ze3ua * e3uw(ji,jj,jk+1,Kmm) ) * wumask(ji,jj,jk+1)
193               zWui = ( wi(ji,jj,jk  ) + wi(ji+1,jj,jk  ) ) / ze3ua
194               zWus = ( wi(ji,jj,jk+1) + wi(ji+1,jj,jk+1) ) / ze3ua
195               zwi(ji,jj,jk) = zzwi + zDt_2 * MIN( zWui, 0._wp )
196               zws(ji,jj,jk) = zzws - zDt_2 * MAX( zWus, 0._wp )
197               zwd(ji,jj,jk) = 1._wp - zzwi - zzws + zDt_2 * ( MAX( zWui, 0._wp ) - MIN( zWus, 0._wp ) )
198            END_3D
199         END SELECT
200         DO_2D( 0, 0, 0, 0 )     !* Surface boundary conditions
201            zwi(ji,jj,1) = 0._wp
202            ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,1,Kmm)    &
203               &             + r_vvl   * e3u(ji,jj,1,Kaa)
204            zzws = - zDt_2 * ( avm(ji+1,jj,2) + avm(ji  ,jj,2) )   &
205               &         / ( ze3ua * e3uw(ji,jj,2,Kmm) ) * wumask(ji,jj,2)
206            zWus = ( wi(ji  ,jj,2) +  wi(ji+1,jj,2) ) / ze3ua
207            zws(ji,jj,1 ) = zzws - zDt_2 * MAX( zWus, 0._wp )
208            zwd(ji,jj,1 ) = 1._wp - zzws - zDt_2 * ( MIN( zWus, 0._wp ) )
209         END_2D
210      ELSE
211         SELECT CASE( nldf_dyn )
212         CASE( np_lap_i )           ! rotated lateral mixing: add its vertical mixing (akzu)
213            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
214               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,jk,Kmm)    &
215                  &             + r_vvl   * e3u(ji,jj,jk,Kaa)   ! after scale factor at U-point
216               zzwi = - zDt_2 * ( avm(ji+1,jj,jk  ) + avm(ji,jj,jk  ) + akzu(ji,jj,jk  ) )   &
217                  &         / ( ze3ua * e3uw(ji,jj,jk  ,Kmm) ) * wumask(ji,jj,jk  )
218               zzws = - zDt_2 * ( avm(ji+1,jj,jk+1) + avm(ji,jj,jk+1) + akzu(ji,jj,jk+1) )   &
219                  &         / ( ze3ua * e3uw(ji,jj,jk+1,Kmm) ) * wumask(ji,jj,jk+1)
220               zwi(ji,jj,jk) = zzwi
221               zws(ji,jj,jk) = zzws
222               zwd(ji,jj,jk) = 1._wp - zzwi - zzws
223            END_3D
224         CASE DEFAULT               ! iso-level lateral mixing
225            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
226               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,jk,Kmm)    &
227                  &             + r_vvl   * e3u(ji,jj,jk,Kaa)   ! after scale factor at U-point
228               zzwi = - zDt_2 * ( avm(ji+1,jj,jk  ) + avm(ji,jj,jk  ) )    &
229                  &         / ( ze3ua * e3uw(ji,jj,jk  ,Kmm) ) * wumask(ji,jj,jk  )
230               zzws = - zDt_2 * ( avm(ji+1,jj,jk+1) + avm(ji,jj,jk+1) )    &
231                  &         / ( ze3ua * e3uw(ji,jj,jk+1,Kmm) ) * wumask(ji,jj,jk+1)
232               zwi(ji,jj,jk) = zzwi
233               zws(ji,jj,jk) = zzws
234               zwd(ji,jj,jk) = 1._wp - zzwi - zzws
235            END_3D
236         END SELECT
237         DO_2D( 0, 0, 0, 0 )     !* Surface boundary conditions
238            zwi(ji,jj,1) = 0._wp
239            zwd(ji,jj,1) = 1._wp - zws(ji,jj,1)
240         END_2D
241      ENDIF
242      !
243      !
244      !              !==  Apply semi-implicit bottom friction  ==!
245      !
246      !     Only needed for semi-implicit bottom friction setup. The explicit
247      !     bottom friction has been included in "u(v)a" which act as the R.H.S
248      !     column vector of the tri-diagonal matrix equation
249      !
250      IF ( ln_drgimp ) THEN      ! implicit bottom friction
251         DO_2D( 0, 0, 0, 0 )
252            iku = mbku(ji,jj)       ! ocean bottom level at u- and v-points
253            ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,iku,Kmm)    &
254               &             + r_vvl   * e3u(ji,jj,iku,Kaa)   ! after scale factor at T-point
255            zwd(ji,jj,iku) = zwd(ji,jj,iku) - zDt_2 *( rCdU_bot(ji+1,jj)+rCdU_bot(ji,jj) ) / ze3ua
256         END_2D
257         IF ( ln_isfcav.OR.ln_drgice_imp ) THEN   ! top friction (always implicit)
258            DO_2D( 0, 0, 0, 0 )
259               !!gm   top Cd is masked (=0 outside cavities) no need of test on mik>=2  ==>> it has been suppressed
260               iku = miku(ji,jj)       ! ocean top level at u- and v-points
261               ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,iku,Kmm)    &
262                  &             + r_vvl   * e3u(ji,jj,iku,Kaa)   ! after scale factor at T-point
263               zwd(ji,jj,iku) = zwd(ji,jj,iku) - zDt_2 *( rCdU_top(ji+1,jj)+rCdU_top(ji,jj) ) / ze3ua
264            END_2D
265         END IF
266      ENDIF
267      !
268      ! Matrix inversion starting from the first level
269      !-----------------------------------------------------------------------
270      !   solve m.x = y  where m is a tri diagonal matrix ( jpk*jpk )
271      !
272      !        ( zwd1 zws1   0    0    0  )( zwx1 ) ( zwy1 )
273      !        ( zwi2 zwd2 zws2   0    0  )( zwx2 ) ( zwy2 )
274      !        (  0   zwi3 zwd3 zws3   0  )( zwx3 )=( zwy3 )
275      !        (        ...               )( ...  ) ( ...  )
276      !        (  0    0    0   zwik zwdk )( zwxk ) ( zwyk )
277      !
278      !   m is decomposed in the product of an upper and a lower triangular matrix
279      !   The 3 diagonal terms are in 2d arrays: zwd, zws, zwi
280      !   The solution (the after velocity) is in puu(:,:,:,Kaa)
281      !-----------------------------------------------------------------------
282      !
283      DO_3D( 0, 0, 0, 0, 2, jpkm1 )   !==  First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1   (increasing k)  ==
284         zwd(ji,jj,jk) = zwd(ji,jj,jk) - zwi(ji,jj,jk) * zws(ji,jj,jk-1) / zwd(ji,jj,jk-1)
285      END_3D
286      !
287      DO_2D( 0, 0, 0, 0 )             !==  second recurrence:    SOLk = RHSk - Lk / Dk-1  Lk-1  ==!
288         ze3ua =  ( 1._wp - r_vvl ) * e3u(ji,jj,1,Kmm)    &
289            &             + r_vvl   * e3u(ji,jj,1,Kaa) 
290         puu(ji,jj,1,Kaa) = puu(ji,jj,1,Kaa) + zDt_2 * ( utau_b(ji,jj) + utau(ji,jj) )   &
291            &                                      / ( ze3ua * rho0 ) * umask(ji,jj,1) 
292      END_2D
293      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
294         puu(ji,jj,jk,Kaa) = puu(ji,jj,jk,Kaa) - zwi(ji,jj,jk) / zwd(ji,jj,jk-1) * puu(ji,jj,jk-1,Kaa)
295      END_3D
296      !
297      DO_2D( 0, 0, 0, 0 )             !==  thrid recurrence : SOLk = ( Lk - Uk * Ek+1 ) / Dk  ==!
298         puu(ji,jj,jpkm1,Kaa) = puu(ji,jj,jpkm1,Kaa) / zwd(ji,jj,jpkm1)
299      END_2D
300      DO_3DS( 0, 0, 0, 0, jpk-2, 1, -1 )
301         puu(ji,jj,jk,Kaa) = ( puu(ji,jj,jk,Kaa) - zws(ji,jj,jk) * puu(ji,jj,jk+1,Kaa) ) / zwd(ji,jj,jk)
302      END_3D
303      !
304      !              !==  Vertical diffusion on v  ==!
305      !
306      !                       !* Matrix construction
307      IF( ln_zad_Aimp ) THEN   !!
308         SELECT CASE( nldf_dyn )
309         CASE( np_lap_i )           ! rotated lateral mixing: add its vertical mixing (akzv)
310            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
311               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,jk,Kmm)    &
312                  &             + r_vvl   * e3v(ji,jj,jk,Kaa)   ! after scale factor at V-point
313               zzwi = - zDt_2 * ( avm(ji,jj+1,jk  ) + avm(ji,jj,jk  ) + akzv(ji,jj,jk  ) )   &
314                  &         / ( ze3va * e3vw(ji,jj,jk  ,Kmm) ) * wvmask(ji,jj,jk  )
315               zzws = - zDt_2 * ( avm(ji,jj+1,jk+1) + avm(ji,jj,jk+1) + akzv(ji,jj,jk+1) )   &
316                  &         / ( ze3va * e3vw(ji,jj,jk+1,Kmm) ) * wvmask(ji,jj,jk+1)
317               zWvi = ( wi(ji,jj,jk  ) + wi(ji,jj+1,jk  ) ) / ze3va
318               zWvs = ( wi(ji,jj,jk+1) + wi(ji,jj+1,jk+1) ) / ze3va
319               zwi(ji,jj,jk) = zzwi + zDt_2 * MIN( zWvi, 0._wp )
320               zws(ji,jj,jk) = zzws - zDt_2 * MAX( zWvs, 0._wp )
321               zwd(ji,jj,jk) = 1._wp - zzwi - zzws - zDt_2 * ( - MAX( zWvi, 0._wp ) + MIN( zWvs, 0._wp ) )
322            END_3D
323         CASE DEFAULT               ! iso-level lateral mixing
324            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
325               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,jk,Kmm)    &
326                  &             + r_vvl   * e3v(ji,jj,jk,Kaa)   ! after scale factor at V-point
327               zzwi = - zDt_2 * ( avm(ji,jj+1,jk  ) + avm(ji,jj,jk  ) )    &
328                  &         / ( ze3va * e3vw(ji,jj,jk  ,Kmm) ) * wvmask(ji,jj,jk  )
329               zzws = - zDt_2 * ( avm(ji,jj+1,jk+1) + avm(ji,jj,jk+1) )    &
330                  &         / ( ze3va * e3vw(ji,jj,jk+1,Kmm) ) * wvmask(ji,jj,jk+1)
331               zWvi = ( wi(ji,jj,jk  ) + wi(ji,jj+1,jk  ) ) / ze3va
332               zWvs = ( wi(ji,jj,jk+1) + wi(ji,jj+1,jk+1) ) / ze3va
333               zwi(ji,jj,jk) = zzwi  + zDt_2 * MIN( zWvi, 0._wp )
334               zws(ji,jj,jk) = zzws  - zDt_2 * MAX( zWvs, 0._wp )
335               zwd(ji,jj,jk) = 1._wp - zzwi - zzws - zDt_2 * ( - MAX( zWvi, 0._wp ) + MIN( zWvs, 0._wp ) )
336            END_3D
337         END SELECT
338         DO_2D( 0, 0, 0, 0 )   !* Surface boundary conditions
339            zwi(ji,jj,1) = 0._wp
340            ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,1,Kmm)    &
341               &             + r_vvl   * e3v(ji,jj,1,Kaa)
342            zzws = - zDt_2 * ( avm(ji,jj+1,2) + avm(ji,jj,2) )    &
343               &         / ( ze3va * e3vw(ji,jj,2,Kmm) ) * wvmask(ji,jj,2)
344            zWvs = ( wi(ji,jj  ,2) +  wi(ji,jj+1,2) ) / ze3va
345            zws(ji,jj,1 ) = zzws - zDt_2 * MAX( zWvs, 0._wp )
346            zwd(ji,jj,1 ) = 1._wp - zzws - zDt_2 * ( MIN( zWvs, 0._wp ) )
347         END_2D
348      ELSE
349         SELECT CASE( nldf_dyn )
350         CASE( np_lap_i )           ! rotated lateral mixing: add its vertical mixing (akzu)
351            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
352               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,jk,Kmm)    &
353                  &             + r_vvl   * e3v(ji,jj,jk,Kaa)   ! after scale factor at V-point
354               zzwi = - zDt_2 * ( avm(ji,jj+1,jk  ) + avm(ji,jj,jk  ) + akzv(ji,jj,jk  ) )   &
355                  &         / ( ze3va * e3vw(ji,jj,jk  ,Kmm) ) * wvmask(ji,jj,jk  )
356               zzws = - zDt_2 * ( avm(ji,jj+1,jk+1) + avm(ji,jj,jk+1) + akzv(ji,jj,jk+1) )   &
357                  &         / ( ze3va * e3vw(ji,jj,jk+1,Kmm) ) * wvmask(ji,jj,jk+1)
358               zwi(ji,jj,jk) = zzwi
359               zws(ji,jj,jk) = zzws
360               zwd(ji,jj,jk) = 1._wp - zzwi - zzws
361            END_3D
362         CASE DEFAULT               ! iso-level lateral mixing
363            DO_3D( 0, 0, 0, 0, 1, jpkm1 )
364               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,jk,Kmm)    &
365                  &             + r_vvl   * e3v(ji,jj,jk,Kaa)   ! after scale factor at V-point
366               zzwi = - zDt_2 * ( avm(ji,jj+1,jk  ) + avm(ji,jj,jk  ) )    &
367                  &         / ( ze3va * e3vw(ji,jj,jk  ,Kmm) ) * wvmask(ji,jj,jk  )
368               zzws = - zDt_2 * ( avm(ji,jj+1,jk+1) + avm(ji,jj,jk+1) )    &
369                  &         / ( ze3va * e3vw(ji,jj,jk+1,Kmm) ) * wvmask(ji,jj,jk+1)
370               zwi(ji,jj,jk) = zzwi
371               zws(ji,jj,jk) = zzws
372               zwd(ji,jj,jk) = 1._wp - zzwi - zzws
373            END_3D
374         END SELECT
375         DO_2D( 0, 0, 0, 0 )        !* Surface boundary conditions
376            zwi(ji,jj,1) = 0._wp
377            zwd(ji,jj,1) = 1._wp - zws(ji,jj,1)
378         END_2D
379      ENDIF
380      !
381      !              !==  Apply semi-implicit top/bottom friction  ==!
382      !
383      !     Only needed for semi-implicit bottom friction setup. The explicit
384      !     bottom friction has been included in "u(v)a" which act as the R.H.S
385      !     column vector of the tri-diagonal matrix equation
386      !
387      IF( ln_drgimp ) THEN
388         DO_2D( 0, 0, 0, 0 )
389            ikv = mbkv(ji,jj)       ! (deepest ocean u- and v-points)
390            ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,ikv,Kmm)    &
391               &             + r_vvl   * e3v(ji,jj,ikv,Kaa)   ! after scale factor at T-point
392            zwd(ji,jj,ikv) = zwd(ji,jj,ikv) - zDt_2*( rCdU_bot(ji,jj+1)+rCdU_bot(ji,jj) ) / ze3va           
393         END_2D
394         IF ( ln_isfcav.OR.ln_drgice_imp ) THEN
395            DO_2D( 0, 0, 0, 0 )
396               ikv = mikv(ji,jj)       ! (first wet ocean u- and v-points)
397               ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,ikv,Kmm)    &
398                  &             + r_vvl   * e3v(ji,jj,ikv,Kaa)   ! after scale factor at T-point
399               zwd(ji,jj,ikv) = zwd(ji,jj,ikv) - zDt_2*( rCdU_top(ji,jj+1)+rCdU_top(ji,jj) ) / ze3va
400            END_2D
401         ENDIF
402      ENDIF
403
404      ! Matrix inversion
405      !-----------------------------------------------------------------------
406      !   solve m.x = y  where m is a tri diagonal matrix ( jpk*jpk )
407      !
408      !        ( zwd1 zws1   0    0    0  )( zwx1 ) ( zwy1 )
409      !        ( zwi2 zwd2 zws2   0    0  )( zwx2 ) ( zwy2 )
410      !        (  0   zwi3 zwd3 zws3   0  )( zwx3 )=( zwy3 )
411      !        (        ...               )( ...  ) ( ...  )
412      !        (  0    0    0   zwik zwdk )( zwxk ) ( zwyk )
413      !
414      !   m is decomposed in the product of an upper and lower triangular matrix
415      !   The 3 diagonal terms are in 2d arrays: zwd, zws, zwi
416      !   The solution (after velocity) is in 2d array va
417      !-----------------------------------------------------------------------
418      !
419      DO_3D( 0, 0, 0, 0, 2, jpkm1 )   !==  First recurrence : Dk = Dk - Lk * Uk-1 / Dk-1   (increasing k)  ==
420         zwd(ji,jj,jk) = zwd(ji,jj,jk) - zwi(ji,jj,jk) * zws(ji,jj,jk-1) / zwd(ji,jj,jk-1)
421      END_3D
422      !
423      DO_2D( 0, 0, 0, 0 )             !==  second recurrence:    SOLk = RHSk - Lk / Dk-1  Lk-1  ==!
424         ze3va =  ( 1._wp - r_vvl ) * e3v(ji,jj,1,Kmm)    &
425            &             + r_vvl   * e3v(ji,jj,1,Kaa) 
426         pvv(ji,jj,1,Kaa) = pvv(ji,jj,1,Kaa) + zDt_2*( vtau_b(ji,jj) + vtau(ji,jj) )   &
427            &                                      / ( ze3va * rho0 ) * vmask(ji,jj,1) 
428      END_2D
429      DO_3D( 0, 0, 0, 0, 2, jpkm1 )
430         pvv(ji,jj,jk,Kaa) = pvv(ji,jj,jk,Kaa) - zwi(ji,jj,jk) / zwd(ji,jj,jk-1) * pvv(ji,jj,jk-1,Kaa)
431      END_3D
432      !
433      DO_2D( 0, 0, 0, 0 )             !==  third recurrence : SOLk = ( Lk - Uk * SOLk+1 ) / Dk  ==!
434         pvv(ji,jj,jpkm1,Kaa) = pvv(ji,jj,jpkm1,Kaa) / zwd(ji,jj,jpkm1)
435      END_2D
436      DO_3DS( 0, 0, 0, 0, jpk-2, 1, -1 )
437         pvv(ji,jj,jk,Kaa) = ( pvv(ji,jj,jk,Kaa) - zws(ji,jj,jk) * pvv(ji,jj,jk+1,Kaa) ) / zwd(ji,jj,jk)
438      END_3D
439      !
440      IF( l_trddyn )   THEN                      ! save the vertical diffusive trends for further diagnostics
441         ztrdu(:,:,:) = ( puu(:,:,:,Kaa) - puu(:,:,:,Kbb) )*r1_Dt - ztrdu(:,:,:)
442         ztrdv(:,:,:) = ( pvv(:,:,:,Kaa) - pvv(:,:,:,Kbb) )*r1_Dt - ztrdv(:,:,:)
443         CALL trd_dyn( ztrdu, ztrdv, jpdyn_zdf, kt, Kmm )
444         DEALLOCATE( ztrdu, ztrdv ) 
445      ENDIF
446      !                                          ! print mean trends (used for debugging)
447      IF(sn_cfctl%l_prtctl)   CALL prt_ctl( tab3d_1=puu(:,:,:,Kaa), clinfo1=' zdf  - Ua: ', mask1=umask,               &
448         &                                  tab3d_2=pvv(:,:,:,Kaa), clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
449         !
450      IF( ln_timing )   CALL timing_stop('dyn_zdf')
451      !
452   END SUBROUTINE dyn_zdf
453
454   !!==============================================================================
455END MODULE dynzdf
Note: See TracBrowser for help on using the repository browser.