source: branches/2013/dev_r3858_CNRS3_Ediag/NEMOGCM/NEMO/OPA_SRC/DYN/dynvor.F90 @ 3876

Last change on this file since 3876 was 3876, checked in by gm, 8 years ago

dev_r3858_CNRS3_Ediag: #927 phasing with 2011/dev_r3309_LOCEAN12_Ediag branche + mxl diag update

  • Property svn:keywords set to Id
File size: 39.6 KB
Line 
1MODULE dynvor
2   !!======================================================================
3   !!                       ***  MODULE  dynvor  ***
4   !! Ocean dynamics: Update the momentum trend with the relative and
5   !!                 planetary vorticity trends
6   !!======================================================================
7   !! History :  OPA  ! 1989-12  (P. Andrich)  vor_ens: Original code
8   !!            5.0  ! 1991-11  (G. Madec) vor_ene, vor_mix: Original code
9   !!            6.0  ! 1996-01  (G. Madec)  s-coord, suppress work arrays
10   !!   NEMO     0.5  ! 2002-08  (G. Madec)  F90: Free form and module
11   !!            1.0  ! 2004-02  (G. Madec)  vor_een: Original code
12   !!             -   ! 2003-08  (G. Madec)  add vor_ctl
13   !!             -   ! 2005-11  (G. Madec)  add dyn_vor (new step architecture)
14   !!            2.0  ! 2006-11  (G. Madec)  flux form advection: add metric term
15   !!            3.2  ! 2009-04  (R. Benshila)  vvl: correction of een scheme
16   !!            3.3  ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
17   !!            3.5  ! 2012-02  (G. Madec) trend simplification: suppress jpdyn_trd_dat vorticity
18   !!----------------------------------------------------------------------
19
20   !!----------------------------------------------------------------------
21   !!   dyn_vor      : Update the momentum trend with the vorticity trend
22   !!       vor_ens  : enstrophy conserving scheme       (ln_dynvor_ens=T)
23   !!       vor_ene  : energy conserving scheme          (ln_dynvor_ene=T)
24   !!       vor_mix  : mixed enstrophy/energy conserving (ln_dynvor_mix=T)
25   !!       vor_een  : energy and enstrophy conserving   (ln_dynvor_een=T)
26   !!   dyn_vor_init : set and control of the different vorticity option
27   !!----------------------------------------------------------------------
28   USE oce            ! ocean dynamics and tracers
29   USE dom_oce        ! ocean space and time domain
30   USE dommsk         ! ocean mask
31   USE dynadv         ! momentum advection (use ln_dynadv_vec value)
32   USE trd_oce        ! trends: ocean variables
33   USE trddyn         ! trend manager: dynamics
34   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
35   USE prtctl         ! Print control
36   USE in_out_manager ! I/O manager
37   USE lib_mpp        ! MPP library
38   USE wrk_nemo       ! Memory Allocation
39   USE timing         ! Timing
40
41
42   IMPLICIT NONE
43   PRIVATE
44
45   PUBLIC   dyn_vor        ! routine called by step.F90
46   PUBLIC   dyn_vor_init   ! routine called by opa.F90
47
48   !                                             !!* Namelist namdyn_vor: vorticity term
49   LOGICAL, PUBLIC ::   ln_dynvor_ene = .FALSE.   !: energy conserving scheme
50   LOGICAL, PUBLIC ::   ln_dynvor_ens = .TRUE.    !: enstrophy conserving scheme
51   LOGICAL, PUBLIC ::   ln_dynvor_mix = .FALSE.   !: mixed scheme
52   LOGICAL, PUBLIC ::   ln_dynvor_een = .FALSE.   !: energy and enstrophy conserving scheme
53
54   INTEGER ::   nvor = 0   ! type of vorticity trend used
55   INTEGER ::   ncor = 1   ! coriolis
56   INTEGER ::   nrvm = 2   ! =2 relative vorticity ; =3 metric term
57   INTEGER ::   ntot = 4   ! =4 total vorticity (relative + planetary) ; =5 coriolis + metric term
58
59   !! * Substitutions
60#  include "domzgr_substitute.h90"
61#  include "vectopt_loop_substitute.h90"
62   !!----------------------------------------------------------------------
63   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
64   !! $Id$
65   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
66   !!----------------------------------------------------------------------
67CONTAINS
68
69   SUBROUTINE dyn_vor( kt )
70      !!----------------------------------------------------------------------
71      !!
72      !! ** Purpose :   compute the lateral ocean tracer physics.
73      !!
74      !! ** Action : - Update (ua,va) with the now vorticity term trend
75      !!             - save the trends in (ztrdu,ztrdv) in 2 parts (relative
76      !!               and planetary vorticity trends) (l_trddyn=T)
77      !!----------------------------------------------------------------------
78      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
79      !
80      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
81      !!----------------------------------------------------------------------
82      !
83      IF( nn_timing == 1 )  CALL timing_start('dyn_vor')
84      !
85      IF( l_trddyn )   CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv )
86      !
87      !                                          ! vorticity term
88      SELECT CASE ( nvor )                       ! compute the vorticity trend and add it to the general trend
89      !
90      CASE ( -1 )                                      ! esopa: test all possibility with control print
91         CALL vor_ene( kt, ntot, ua, va )
92         CALL prt_ctl( tab3d_1=ua, clinfo1=' vor0 - Ua: ', mask1=umask, &
93            &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
94         CALL vor_ens( kt, ntot, ua, va )
95         CALL prt_ctl( tab3d_1=ua, clinfo1=' vor1 - Ua: ', mask1=umask, &
96            &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
97         CALL vor_mix( kt )
98         CALL prt_ctl( tab3d_1=ua, clinfo1=' vor2 - Ua: ', mask1=umask, &
99            &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
100         CALL vor_een( kt, ntot, ua, va )
101         CALL prt_ctl( tab3d_1=ua, clinfo1=' vor3 - Ua: ', mask1=umask, &
102            &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
103         !
104      CASE ( 0 )                                       ! energy conserving scheme
105         IF( l_trddyn )   THEN
106            ztrdu(:,:,:) = ua(:,:,:)
107            ztrdv(:,:,:) = va(:,:,:)
108            CALL vor_ene( kt, nrvm, ua, va )                ! relative vorticity or metric trend
109            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
110            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
111            CALL trd_dyn( ztrdu, ztrdv, jpdyn_rvo, kt )
112            ztrdu(:,:,:) = ua(:,:,:)
113            ztrdv(:,:,:) = va(:,:,:)
114            CALL vor_ene( kt, ncor, ua, va )                ! planetary vorticity trend
115            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
116            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
117            CALL trd_dyn( ztrdu, ztrdv, jpdyn_pvo, kt )
118         ELSE
119            CALL vor_ene( kt, ntot, ua, va )                ! total vorticity
120         ENDIF
121         !
122      CASE ( 1 )                                       ! enstrophy conserving scheme
123         IF( l_trddyn )   THEN   
124            ztrdu(:,:,:) = ua(:,:,:)
125            ztrdv(:,:,:) = va(:,:,:)
126            CALL vor_ens( kt, nrvm, ua, va )                ! relative vorticity or metric trend
127            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
128            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
129            CALL trd_dyn( ztrdu, ztrdv, jpdyn_rvo, kt )
130            ztrdu(:,:,:) = ua(:,:,:)
131            ztrdv(:,:,:) = va(:,:,:)
132            CALL vor_ens( kt, ncor, ua, va )                ! planetary vorticity trend
133            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
134            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
135            CALL trd_dyn( ztrdu, ztrdv, jpdyn_pvo, kt )
136         ELSE
137            CALL vor_ens( kt, ntot, ua, va )                ! total vorticity
138         ENDIF
139         !
140      CASE ( 2 )                                       ! mixed ene-ens scheme
141         IF( l_trddyn )   THEN
142            ztrdu(:,:,:) = ua(:,:,:)
143            ztrdv(:,:,:) = va(:,:,:)
144            CALL vor_ens( kt, nrvm, ua, va )                ! relative vorticity or metric trend (ens)
145            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
146            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
147            CALL trd_dyn( ztrdu, ztrdv, jpdyn_rvo, kt )
148            ztrdu(:,:,:) = ua(:,:,:)
149            ztrdv(:,:,:) = va(:,:,:)
150            CALL vor_ene( kt, ncor, ua, va )                ! planetary vorticity trend (ene)
151            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
152            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
153            CALL trd_dyn( ztrdu, ztrdv, jpdyn_pvo, kt )
154         ELSE
155            CALL vor_mix( kt )                               ! total vorticity (mix=ens-ene)
156         ENDIF
157         !
158      CASE ( 3 )                                       ! energy and enstrophy conserving scheme
159         IF( l_trddyn )   THEN
160            ztrdu(:,:,:) = ua(:,:,:)
161            ztrdv(:,:,:) = va(:,:,:)
162            CALL vor_een( kt, nrvm, ua, va )                ! relative vorticity or metric trend
163            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
164            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
165            CALL trd_dyn( ztrdu, ztrdv, jpdyn_rvo, kt )
166            ztrdu(:,:,:) = ua(:,:,:)
167            ztrdv(:,:,:) = va(:,:,:)
168            CALL vor_een( kt, ncor, ua, va )                ! planetary vorticity trend
169            ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
170            ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
171            CALL trd_dyn( ztrdu, ztrdv, jpdyn_pvo, kt )
172         ELSE
173            CALL vor_een( kt, ntot, ua, va )                ! total vorticity
174         ENDIF
175         !
176      END SELECT
177      !
178      !                       ! print sum trends (used for debugging)
179      IF(ln_ctl) CALL prt_ctl( tab3d_1=ua, clinfo1=' vor  - Ua: ', mask1=umask,               &
180         &                     tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
181      !
182      IF( l_trddyn )   CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv )
183      !
184      IF( nn_timing == 1 )  CALL timing_stop('dyn_vor')
185      !
186   END SUBROUTINE dyn_vor
187
188
189   SUBROUTINE vor_ene( kt, kvor, pua, pva )
190      !!----------------------------------------------------------------------
191      !!                  ***  ROUTINE vor_ene  ***
192      !!
193      !! ** Purpose :   Compute the now total vorticity trend and add it to
194      !!      the general trend of the momentum equation.
195      !!
196      !! ** Method  :   Trend evaluated using now fields (centered in time)
197      !!      and the Sadourny (1975) flux form formulation : conserves the
198      !!      horizontal kinetic energy.
199      !!      The trend of the vorticity term is given by:
200      !!       * s-coordinate (ln_sco=T), the e3. are inside the derivatives:
201      !!          voru = 1/e1u  mj-1[ (rotn+f)/e3f  mi(e1v*e3v vn) ]
202      !!          vorv = 1/e2v  mi-1[ (rotn+f)/e3f  mj(e2u*e3u un) ]
203      !!       * z-coordinate (default key), e3t=e3u=e3v, the trend becomes:
204      !!          voru = 1/e1u  mj-1[ (rotn+f)  mi(e1v vn) ]
205      !!          vorv = 1/e2v  mi-1[ (rotn+f)  mj(e2u un) ]
206      !!      Add this trend to the general momentum trend (ua,va):
207      !!          (ua,va) = (ua,va) + ( voru , vorv )
208      !!
209      !! ** Action : - Update (ua,va) with the now vorticity term trend
210      !!
211      !! References : Sadourny, r., 1975, j. atmos. sciences, 32, 680-689.
212      !!----------------------------------------------------------------------
213      !
214      INTEGER , INTENT(in   )                         ::   kt     ! ocean time-step index
215      INTEGER , INTENT(in   )                         ::   kvor   ! =ncor (planetary) ; =ntot (total) ;
216      !                                                           ! =nrvm (relative vorticity or metric)
217      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pua    ! total u-trend
218      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pva    ! total v-trend
219      !
220      INTEGER  ::   ji, jj, jk   ! dummy loop indices
221      REAL(wp) ::   zx1, zy1, zfact2, zx2, zy2   ! local scalars
222      REAL(wp), POINTER, DIMENSION(:,:) :: zwx, zwy, zwz
223      !!----------------------------------------------------------------------
224      !
225      IF( nn_timing == 1 )  CALL timing_start('vor_ene')
226      !
227      CALL wrk_alloc( jpi, jpj, zwx, zwy, zwz ) 
228      !
229      IF( kt == nit000 ) THEN
230         IF(lwp) WRITE(numout,*)
231         IF(lwp) WRITE(numout,*) 'dyn:vor_ene : vorticity term: energy conserving scheme'
232         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
233      ENDIF
234
235      zfact2 = 0.5 * 0.5      ! Local constant initialization
236
237!CDIR PARALLEL DO PRIVATE( zwx, zwy, zwz )
238      !                                                ! ===============
239      DO jk = 1, jpkm1                                 ! Horizontal slab
240         !                                             ! ===============
241         !
242         ! Potential vorticity and horizontal fluxes
243         ! -----------------------------------------
244         SELECT CASE( kvor )      ! vorticity considered
245         CASE ( 1 )   ;   zwz(:,:) =                  ff(:,:)      ! planetary vorticity (Coriolis)
246         CASE ( 2 )   ;   zwz(:,:) =   rotn(:,:,jk)                ! relative  vorticity
247         CASE ( 3 )                                                ! metric term
248            DO jj = 1, jpjm1
249               DO ji = 1, fs_jpim1   ! vector opt.
250                  zwz(ji,jj) = (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
251                       &         - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
252                       &     * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) )
253               END DO
254            END DO
255         CASE ( 4 )   ;   zwz(:,:) = ( rotn(:,:,jk) + ff(:,:) )    ! total (relative + planetary vorticity)
256         CASE ( 5 )                                                ! total (coriolis + metric)
257            DO jj = 1, jpjm1
258               DO ji = 1, fs_jpim1   ! vector opt.
259                  zwz(ji,jj) = ( ff (ji,jj)                                                                       &
260                       &       + (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
261                       &           - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
262                       &       * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) )                                               &
263                       &       )
264               END DO
265            END DO
266         END SELECT
267
268         IF( ln_sco ) THEN
269            zwz(:,:) = zwz(:,:) / fse3f(:,:,jk)
270            zwx(:,:) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
271            zwy(:,:) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
272         ELSE
273            zwx(:,:) = e2u(:,:) * un(:,:,jk)
274            zwy(:,:) = e1v(:,:) * vn(:,:,jk)
275         ENDIF
276
277         ! Compute and add the vorticity term trend
278         ! ----------------------------------------
279         DO jj = 2, jpjm1
280            DO ji = fs_2, fs_jpim1   ! vector opt.
281               zy1 = zwy(ji,jj-1) + zwy(ji+1,jj-1)
282               zy2 = zwy(ji,jj  ) + zwy(ji+1,jj  )
283               zx1 = zwx(ji-1,jj) + zwx(ji-1,jj+1)
284               zx2 = zwx(ji  ,jj) + zwx(ji  ,jj+1)
285               pua(ji,jj,jk) = pua(ji,jj,jk) + zfact2 / e1u(ji,jj) * ( zwz(ji  ,jj-1) * zy1 + zwz(ji,jj) * zy2 )
286               pva(ji,jj,jk) = pva(ji,jj,jk) - zfact2 / e2v(ji,jj) * ( zwz(ji-1,jj  ) * zx1 + zwz(ji,jj) * zx2 ) 
287            END DO 
288         END DO 
289         !                                             ! ===============
290      END DO                                           !   End of slab
291      !                                                ! ===============
292      CALL wrk_dealloc( jpi, jpj, zwx, zwy, zwz ) 
293      !
294      IF( nn_timing == 1 )  CALL timing_stop('vor_ene')
295      !
296   END SUBROUTINE vor_ene
297
298
299   SUBROUTINE vor_mix( kt )
300      !!----------------------------------------------------------------------
301      !!                 ***  ROUTINE vor_mix  ***
302      !!
303      !! ** Purpose :   Compute the now total vorticity trend and add it to
304      !!      the general trend of the momentum equation.
305      !!
306      !! ** Method  :   Trend evaluated using now fields (centered in time)
307      !!      Mixte formulation : conserves the potential enstrophy of a hori-
308      !!      zontally non-divergent flow for (rotzu x uh), the relative vor-
309      !!      ticity term and the horizontal kinetic energy for (f x uh), the
310      !!      coriolis term. the now trend of the vorticity term is given by:
311      !!       * s-coordinate (ln_sco=T), the e3. are inside the derivatives:
312      !!          voru = 1/e1u  mj-1(rotn/e3f) mj-1[ mi(e1v*e3v vn) ]
313      !!              +1/e1u  mj-1[ f/e3f          mi(e1v*e3v vn) ]
314      !!          vorv = 1/e2v  mi-1(rotn/e3f) mi-1[ mj(e2u*e3u un) ]
315      !!              +1/e2v  mi-1[ f/e3f          mj(e2u*e3u un) ]
316      !!       * z-coordinate (default key), e3t=e3u=e3v, the trend becomes:
317      !!          voru = 1/e1u  mj-1(rotn) mj-1[ mi(e1v vn) ]
318      !!              +1/e1u  mj-1[ f          mi(e1v vn) ]
319      !!          vorv = 1/e2v  mi-1(rotn) mi-1[ mj(e2u un) ]
320      !!              +1/e2v  mi-1[ f          mj(e2u un) ]
321      !!      Add this now trend to the general momentum trend (ua,va):
322      !!          (ua,va) = (ua,va) + ( voru , vorv )
323      !!
324      !! ** Action : - Update (ua,va) arrays with the now vorticity term trend
325      !!
326      !! References : Sadourny, r., 1975, j. atmos. sciences, 32, 680-689.
327      !!----------------------------------------------------------------------
328      !
329      INTEGER, INTENT(in) ::   kt   ! ocean timestep index
330      !
331      INTEGER  ::   ji, jj, jk   ! dummy loop indices
332      REAL(wp) ::   zfact1, zua, zcua, zx1, zy1   ! local scalars
333      REAL(wp) ::   zfact2, zva, zcva, zx2, zy2   !   -      -
334      REAL(wp), POINTER, DIMENSION(:,:) :: zwx, zwy, zwz, zww
335      !!----------------------------------------------------------------------
336      !
337      IF( nn_timing == 1 )  CALL timing_start('vor_mix')
338      !
339      CALL wrk_alloc( jpi, jpj, zwx, zwy, zwz, zww ) 
340      !
341      IF( kt == nit000 ) THEN
342         IF(lwp) WRITE(numout,*)
343         IF(lwp) WRITE(numout,*) 'dyn:vor_mix : vorticity term: mixed energy/enstrophy conserving scheme'
344         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
345      ENDIF
346
347      zfact1 = 0.5 * 0.25      ! Local constant initialization
348      zfact2 = 0.5 * 0.5
349
350!CDIR PARALLEL DO PRIVATE( zwx, zwy, zwz, zww )
351      !                                                ! ===============
352      DO jk = 1, jpkm1                                 ! Horizontal slab
353         !                                             ! ===============
354         !
355         ! Relative and planetary potential vorticity and horizontal fluxes
356         ! ----------------------------------------------------------------
357         IF( ln_sco ) THEN       
358            IF( ln_dynadv_vec ) THEN
359               zww(:,:) = rotn(:,:,jk) / fse3f(:,:,jk)
360            ELSE                       
361               DO jj = 1, jpjm1
362                  DO ji = 1, fs_jpim1   ! vector opt.
363                     zww(ji,jj) = (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
364                        &           - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
365                        &       * 0.5 / ( e1f(ji,jj) * e2f (ji,jj) * fse3f(ji,jj,jk) )
366                  END DO
367               END DO
368            ENDIF
369            zwz(:,:) = ff  (:,:)    / fse3f(:,:,jk)
370            zwx(:,:) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
371            zwy(:,:) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
372         ELSE
373            IF( ln_dynadv_vec ) THEN
374               zww(:,:) = rotn(:,:,jk)
375            ELSE                       
376               DO jj = 1, jpjm1
377                  DO ji = 1, fs_jpim1   ! vector opt.
378                     zww(ji,jj) = (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
379                        &           - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
380                        &       * 0.5 / ( e1f(ji,jj) * e2f (ji,jj) )
381                  END DO
382               END DO
383            ENDIF
384            zwz(:,:) = ff (:,:)
385            zwx(:,:) = e2u(:,:) * un(:,:,jk)
386            zwy(:,:) = e1v(:,:) * vn(:,:,jk)
387         ENDIF
388
389         ! Compute and add the vorticity term trend
390         ! ----------------------------------------
391         DO jj = 2, jpjm1
392            DO ji = fs_2, fs_jpim1   ! vector opt.
393               zy1 = ( zwy(ji,jj-1) + zwy(ji+1,jj-1) ) / e1u(ji,jj)
394               zy2 = ( zwy(ji,jj  ) + zwy(ji+1,jj  ) ) / e1u(ji,jj)
395               zx1 = ( zwx(ji-1,jj) + zwx(ji-1,jj+1) ) / e2v(ji,jj)
396               zx2 = ( zwx(ji  ,jj) + zwx(ji  ,jj+1) ) / e2v(ji,jj)
397               ! enstrophy conserving formulation for relative vorticity term
398               zua = zfact1 * ( zww(ji  ,jj-1) + zww(ji,jj) ) * ( zy1 + zy2 )
399               zva =-zfact1 * ( zww(ji-1,jj  ) + zww(ji,jj) ) * ( zx1 + zx2 )
400               ! energy conserving formulation for planetary vorticity term
401               zcua = zfact2 * ( zwz(ji  ,jj-1) * zy1 + zwz(ji,jj) * zy2 )
402               zcva =-zfact2 * ( zwz(ji-1,jj  ) * zx1 + zwz(ji,jj) * zx2 )
403               ! mixed vorticity trend added to the momentum trends
404               ua(ji,jj,jk) = ua(ji,jj,jk) + zcua + zua
405               va(ji,jj,jk) = va(ji,jj,jk) + zcva + zva
406            END DO 
407         END DO 
408         !                                             ! ===============
409      END DO                                           !   End of slab
410      !                                                ! ===============
411      CALL wrk_dealloc( jpi, jpj, zwx, zwy, zwz, zww ) 
412      !
413      IF( nn_timing == 1 )  CALL timing_stop('vor_mix')
414      !
415   END SUBROUTINE vor_mix
416
417
418   SUBROUTINE vor_ens( kt, kvor, pua, pva )
419      !!----------------------------------------------------------------------
420      !!                ***  ROUTINE vor_ens  ***
421      !!
422      !! ** Purpose :   Compute the now total vorticity trend and add it to
423      !!      the general trend of the momentum equation.
424      !!
425      !! ** Method  :   Trend evaluated using now fields (centered in time)
426      !!      and the Sadourny (1975) flux FORM formulation : conserves the
427      !!      potential enstrophy of a horizontally non-divergent flow. the
428      !!      trend of the vorticity term is given by:
429      !!       * s-coordinate (ln_sco=T), the e3. are inside the derivative:
430      !!          voru = 1/e1u  mj-1[ (rotn+f)/e3f ]  mj-1[ mi(e1v*e3v vn) ]
431      !!          vorv = 1/e2v  mi-1[ (rotn+f)/e3f ]  mi-1[ mj(e2u*e3u un) ]
432      !!       * z-coordinate (default key), e3t=e3u=e3v, the trend becomes:
433      !!          voru = 1/e1u  mj-1[ rotn+f ]  mj-1[ mi(e1v vn) ]
434      !!          vorv = 1/e2v  mi-1[ rotn+f ]  mi-1[ mj(e2u un) ]
435      !!      Add this trend to the general momentum trend (ua,va):
436      !!          (ua,va) = (ua,va) + ( voru , vorv )
437      !!
438      !! ** Action : - Update (ua,va) arrays with the now vorticity term trend
439      !!
440      !! References : Sadourny, r., 1975, j. atmos. sciences, 32, 680-689.
441      !!----------------------------------------------------------------------
442      !
443      INTEGER , INTENT(in   )                         ::   kt     ! ocean time-step index
444      INTEGER , INTENT(in   )                         ::   kvor   ! =ncor (planetary) ; =ntot (total) ;
445         !                                                        ! =nrvm (relative vorticity or metric)
446      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pua    ! total u-trend
447      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pva    ! total v-trend
448      !
449      INTEGER  ::   ji, jj, jk           ! dummy loop indices
450      REAL(wp) ::   zfact1, zuav, zvau   ! temporary scalars
451      REAL(wp), POINTER, DIMENSION(:,:) :: zwx, zwy, zwz, zww
452      !!----------------------------------------------------------------------
453      !
454      IF( nn_timing == 1 )  CALL timing_start('vor_ens')
455      !
456      CALL wrk_alloc( jpi, jpj, zwx, zwy, zwz ) 
457      !
458      IF( kt == nit000 ) THEN
459         IF(lwp) WRITE(numout,*)
460         IF(lwp) WRITE(numout,*) 'dyn:vor_ens : vorticity term: enstrophy conserving scheme'
461         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
462      ENDIF
463
464      zfact1 = 0.5 * 0.25      ! Local constant initialization
465
466!CDIR PARALLEL DO PRIVATE( zwx, zwy, zwz )
467      !                                                ! ===============
468      DO jk = 1, jpkm1                                 ! Horizontal slab
469         !                                             ! ===============
470         !
471         ! Potential vorticity and horizontal fluxes
472         ! -----------------------------------------
473         SELECT CASE( kvor )      ! vorticity considered
474         CASE ( 1 )   ;   zwz(:,:) =                  ff(:,:)      ! planetary vorticity (Coriolis)
475         CASE ( 2 )   ;   zwz(:,:) =   rotn(:,:,jk)                ! relative  vorticity
476         CASE ( 3 )                                                ! metric term
477            DO jj = 1, jpjm1
478               DO ji = 1, fs_jpim1   ! vector opt.
479                  zwz(ji,jj) = (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
480                       &         - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
481                       &     * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) )
482               END DO
483            END DO
484         CASE ( 4 )   ;   zwz(:,:) = ( rotn(:,:,jk) + ff(:,:) )    ! total (relative + planetary vorticity)
485         CASE ( 5 )                                                ! total (coriolis + metric)
486            DO jj = 1, jpjm1
487               DO ji = 1, fs_jpim1   ! vector opt.
488                  zwz(ji,jj) = ( ff (ji,jj)                                                                       &
489                       &       + (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
490                       &           - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
491                       &       * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) )                                                &
492                       &       )
493               END DO
494            END DO
495         END SELECT
496         !
497         IF( ln_sco ) THEN
498            DO jj = 1, jpj                      ! caution: don't use (:,:) for this loop
499               DO ji = 1, jpi                   ! it causes optimization problems on NEC in auto-tasking
500                  zwz(ji,jj) = zwz(ji,jj) / fse3f(ji,jj,jk)
501                  zwx(ji,jj) = e2u(ji,jj) * fse3u(ji,jj,jk) * un(ji,jj,jk)
502                  zwy(ji,jj) = e1v(ji,jj) * fse3v(ji,jj,jk) * vn(ji,jj,jk)
503               END DO
504            END DO
505         ELSE
506            DO jj = 1, jpj                      ! caution: don't use (:,:) for this loop
507               DO ji = 1, jpi                   ! it causes optimization problems on NEC in auto-tasking
508                  zwx(ji,jj) = e2u(ji,jj) * un(ji,jj,jk)
509                  zwy(ji,jj) = e1v(ji,jj) * vn(ji,jj,jk)
510               END DO
511            END DO
512         ENDIF
513         !
514         ! Compute and add the vorticity term trend
515         ! ----------------------------------------
516         DO jj = 2, jpjm1
517            DO ji = fs_2, fs_jpim1   ! vector opt.
518               zuav = zfact1 / e1u(ji,jj) * ( zwy(ji  ,jj-1) + zwy(ji+1,jj-1)   &
519                  &                         + zwy(ji  ,jj  ) + zwy(ji+1,jj  ) )
520               zvau =-zfact1 / e2v(ji,jj) * ( zwx(ji-1,jj  ) + zwx(ji-1,jj+1)   &
521                  &                         + zwx(ji  ,jj  ) + zwx(ji  ,jj+1) )
522               pua(ji,jj,jk) = pua(ji,jj,jk) + zuav * ( zwz(ji  ,jj-1) + zwz(ji,jj) )
523               pva(ji,jj,jk) = pva(ji,jj,jk) + zvau * ( zwz(ji-1,jj  ) + zwz(ji,jj) )
524            END DO 
525         END DO 
526         !                                             ! ===============
527      END DO                                           !   End of slab
528      !                                                ! ===============
529      CALL wrk_dealloc( jpi, jpj, zwx, zwy, zwz ) 
530      !
531      IF( nn_timing == 1 )  CALL timing_stop('vor_ens')
532      !
533   END SUBROUTINE vor_ens
534
535
536   SUBROUTINE vor_een( kt, kvor, pua, pva )
537      !!----------------------------------------------------------------------
538      !!                ***  ROUTINE vor_een  ***
539      !!
540      !! ** Purpose :   Compute the now total vorticity trend and add it to
541      !!      the general trend of the momentum equation.
542      !!
543      !! ** Method  :   Trend evaluated using now fields (centered in time)
544      !!      and the Arakawa and Lamb (1980) flux form formulation : conserves
545      !!      both the horizontal kinetic energy and the potential enstrophy
546      !!      when horizontal divergence is zero (see the NEMO documentation)
547      !!      Add this trend to the general momentum trend (ua,va).
548      !!
549      !! ** Action : - Update (ua,va) with the now vorticity term trend
550      !!
551      !! References : Arakawa and Lamb 1980, Mon. Wea. Rev., 109, 18-36
552      !!----------------------------------------------------------------------
553      !
554      INTEGER , INTENT(in   )                         ::   kt     ! ocean time-step index
555      INTEGER , INTENT(in   )                         ::   kvor   ! =ncor (planetary) ; =ntot (total) ;
556      !                                                           ! =nrvm (relative vorticity or metric)
557      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pua    ! total u-trend
558      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   pva    ! total v-trend
559      !!
560      INTEGER  ::   ji, jj, jk                                    ! dummy loop indices
561      INTEGER  ::   ierr                                          ! local integer
562      REAL(wp) ::   zfac12, zua, zva                              ! local scalars
563      !                                                           !  3D workspace
564      REAL(wp), POINTER    , DIMENSION(:,:  )         :: zwx, zwy, zwz
565      REAL(wp), POINTER    , DIMENSION(:,:  )         :: ztnw, ztne, ztsw, ztse
566#if defined key_vvl
567      REAL(wp), POINTER    , DIMENSION(:,:,:)         :: ze3f     !  3D workspace (lk_vvl=T)
568#endif
569#if ! defined key_vvl
570      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:), SAVE   :: ze3f     ! lk_vvl=F, ze3f=1/e3f saved one for all
571#endif
572      !!----------------------------------------------------------------------
573      !
574      IF( nn_timing == 1 )  CALL timing_start('vor_een')
575      !
576      CALL wrk_alloc( jpi, jpj,      zwx , zwy , zwz        ) 
577      CALL wrk_alloc( jpi, jpj,      ztnw, ztne, ztsw, ztse ) 
578#if defined key_vvl
579      CALL wrk_alloc( jpi, jpj, jpk, ze3f                   )
580#endif
581      !
582      IF( kt == nit000 ) THEN
583         IF(lwp) WRITE(numout,*)
584         IF(lwp) WRITE(numout,*) 'dyn:vor_een : vorticity term: energy and enstrophy conserving scheme'
585         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
586#if ! defined key_vvl
587         IF( .NOT.ALLOCATED(ze3f) ) THEN
588            ALLOCATE( ze3f(jpi,jpj,jpk) , STAT=ierr )
589            IF( lk_mpp    )   CALL mpp_sum ( ierr )
590            IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'dyn:vor_een : unable to allocate arrays' )
591         ENDIF
592#endif
593      ENDIF
594
595      IF( kt == nit000 .OR. lk_vvl ) THEN      ! reciprocal of e3 at F-point (masked averaging of e3t)
596         DO jk = 1, jpk
597            DO jj = 1, jpjm1
598               DO ji = 1, jpim1
599                  ze3f(ji,jj,jk) = ( fse3t(ji,jj+1,jk)*tmask(ji,jj+1,jk) + fse3t(ji+1,jj+1,jk)*tmask(ji+1,jj+1,jk)   &
600                     &             + fse3t(ji,jj  ,jk)*tmask(ji,jj  ,jk) + fse3t(ji+1,jj  ,jk)*tmask(ji+1,jj  ,jk) ) * 0.25
601                  IF( ze3f(ji,jj,jk) /= 0._wp )   ze3f(ji,jj,jk) = 1._wp / ze3f(ji,jj,jk)
602               END DO
603            END DO
604         END DO
605         CALL lbc_lnk( ze3f, 'F', 1. )
606      ENDIF
607
608      zfac12 = 1._wp / 12._wp    ! Local constant initialization
609
610     
611!CDIR PARALLEL DO PRIVATE( zwx, zwy, zwz, ztnw, ztne, ztsw, ztse )
612      !                                                ! ===============
613      DO jk = 1, jpkm1                                 ! Horizontal slab
614         !                                             ! ===============
615         
616         ! Potential vorticity and horizontal fluxes
617         ! -----------------------------------------
618         SELECT CASE( kvor )      ! vorticity considered
619         CASE ( 1 )                                                ! planetary vorticity (Coriolis)
620            zwz(:,:) = ff(:,:)      * ze3f(:,:,jk)
621         CASE ( 2 )                                                ! relative  vorticity
622            zwz(:,:) = rotn(:,:,jk) * ze3f(:,:,jk)
623         CASE ( 3 )                                                ! metric term
624            DO jj = 1, jpjm1
625               DO ji = 1, fs_jpim1   ! vector opt.
626                  zwz(ji,jj) = (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
627                       &         - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
628                       &     * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) ) * ze3f(ji,jj,jk)
629               END DO
630            END DO
631            CALL lbc_lnk( zwz, 'F', 1. )
632        CASE ( 4 )                                                ! total (relative + planetary vorticity)
633            zwz(:,:) = ( rotn(:,:,jk) + ff(:,:) ) * ze3f(:,:,jk)
634         CASE ( 5 )                                                ! total (coriolis + metric)
635            DO jj = 1, jpjm1
636               DO ji = 1, fs_jpim1   ! vector opt.
637                  zwz(ji,jj) = ( ff (ji,jj)                                                                       &
638                       &       + (   ( vn(ji+1,jj  ,jk) + vn (ji,jj,jk) ) * ( e2v(ji+1,jj  ) - e2v(ji,jj) )       &
639                       &           - ( un(ji  ,jj+1,jk) + un (ji,jj,jk) ) * ( e1u(ji  ,jj+1) - e1u(ji,jj) )   )   &
640                       &       * 0.5 / ( e1f(ji,jj) * e2f(ji,jj) )                                                &
641                       &       ) * ze3f(ji,jj,jk)
642               END DO
643            END DO
644            CALL lbc_lnk( zwz, 'F', 1. )
645         END SELECT
646
647         zwx(:,:) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
648         zwy(:,:) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
649
650         ! Compute and add the vorticity term trend
651         ! ----------------------------------------
652         jj = 2
653         ztne(1,:) = 0   ;   ztnw(1,:) = 0   ;   ztse(1,:) = 0   ;   ztsw(1,:) = 0
654         DO ji = 2, jpi   
655               ztne(ji,jj) = zwz(ji-1,jj  ) + zwz(ji  ,jj  ) + zwz(ji  ,jj-1)
656               ztnw(ji,jj) = zwz(ji-1,jj-1) + zwz(ji-1,jj  ) + zwz(ji  ,jj  )
657               ztse(ji,jj) = zwz(ji  ,jj  ) + zwz(ji  ,jj-1) + zwz(ji-1,jj-1)
658               ztsw(ji,jj) = zwz(ji  ,jj-1) + zwz(ji-1,jj-1) + zwz(ji-1,jj  )
659         END DO
660         DO jj = 3, jpj
661            DO ji = fs_2, jpi   ! vector opt. ok because we start at jj = 3
662               ztne(ji,jj) = zwz(ji-1,jj  ) + zwz(ji  ,jj  ) + zwz(ji  ,jj-1)
663               ztnw(ji,jj) = zwz(ji-1,jj-1) + zwz(ji-1,jj  ) + zwz(ji  ,jj  )
664               ztse(ji,jj) = zwz(ji  ,jj  ) + zwz(ji  ,jj-1) + zwz(ji-1,jj-1)
665               ztsw(ji,jj) = zwz(ji  ,jj-1) + zwz(ji-1,jj-1) + zwz(ji-1,jj  )
666            END DO
667         END DO
668         DO jj = 2, jpjm1
669            DO ji = fs_2, fs_jpim1   ! vector opt.
670               zua = + zfac12 / e1u(ji,jj) * (  ztne(ji,jj  ) * zwy(ji  ,jj  ) + ztnw(ji+1,jj) * zwy(ji+1,jj  )   &
671                  &                           + ztse(ji,jj  ) * zwy(ji  ,jj-1) + ztsw(ji+1,jj) * zwy(ji+1,jj-1) )
672               zva = - zfac12 / e2v(ji,jj) * (  ztsw(ji,jj+1) * zwx(ji-1,jj+1) + ztse(ji,jj+1) * zwx(ji  ,jj+1)   &
673                  &                           + ztnw(ji,jj  ) * zwx(ji-1,jj  ) + ztne(ji,jj  ) * zwx(ji  ,jj  ) )
674               pua(ji,jj,jk) = pua(ji,jj,jk) + zua
675               pva(ji,jj,jk) = pva(ji,jj,jk) + zva
676            END DO 
677         END DO 
678         !                                             ! ===============
679      END DO                                           !   End of slab
680      !                                                ! ===============
681      CALL wrk_dealloc( jpi, jpj,      zwx , zwy , zwz        ) 
682      CALL wrk_dealloc( jpi, jpj,      ztnw, ztne, ztsw, ztse ) 
683#if defined key_vvl
684      CALL wrk_dealloc( jpi, jpj, jpk, ze3f                   )
685#endif
686      !
687      IF( nn_timing == 1 )  CALL timing_stop('vor_een')
688      !
689   END SUBROUTINE vor_een
690
691
692   SUBROUTINE dyn_vor_init
693      !!---------------------------------------------------------------------
694      !!                  ***  ROUTINE dyn_vor_init  ***
695      !!
696      !! ** Purpose :   Control the consistency between cpp options for
697      !!              tracer advection schemes
698      !!----------------------------------------------------------------------
699      INTEGER ::   ioptio          ! local integer
700      INTEGER ::   ji, jj, jk      ! dummy loop indices
701      !!
702      NAMELIST/namdyn_vor/ ln_dynvor_ens, ln_dynvor_ene, ln_dynvor_mix, ln_dynvor_een
703      !!----------------------------------------------------------------------
704
705      REWIND ( numnam )               ! Read Namelist namdyn_vor : Vorticity scheme options
706      READ   ( numnam, namdyn_vor )
707
708      IF(lwp) THEN                    ! Namelist print
709         WRITE(numout,*)
710         WRITE(numout,*) 'dyn_vor_init : vorticity term : read namelist and control the consistency'
711         WRITE(numout,*) '~~~~~~~~~~~~'
712         WRITE(numout,*) '        Namelist namdyn_vor : oice of the vorticity term scheme'
713         WRITE(numout,*) '           energy    conserving scheme                ln_dynvor_ene = ', ln_dynvor_ene
714         WRITE(numout,*) '           enstrophy conserving scheme                ln_dynvor_ens = ', ln_dynvor_ens
715         WRITE(numout,*) '           mixed enstrophy/energy conserving scheme   ln_dynvor_mix = ', ln_dynvor_mix
716         WRITE(numout,*) '           enstrophy and energy conserving scheme     ln_dynvor_een = ', ln_dynvor_een
717      ENDIF
718
719      ! If energy, enstrophy or mixed advection of momentum in vector form change the value for masks
720      ! at angles with three ocean points and one land point
721      IF( ln_vorlat .AND. ( ln_dynvor_ene .OR. ln_dynvor_ens .OR. ln_dynvor_mix ) ) THEN
722         DO jk = 1, jpk
723            DO jj = 2, jpjm1
724               DO ji = 2, jpim1
725                  IF( tmask(ji,jj,jk)+tmask(ji+1,jj,jk)+tmask(ji,jj+1,jk)+tmask(ji+1,jj+1,jk) == 3._wp ) &
726                      fmask(ji,jj,jk) = 1._wp
727               END DO
728            END DO
729         END DO
730          !
731          CALL lbc_lnk( fmask, 'F', 1._wp )      ! Lateral boundary conditions on fmask
732          !
733      ENDIF
734
735      ioptio = 0                     ! Control of vorticity scheme options
736      IF( ln_dynvor_ene )   ioptio = ioptio + 1
737      IF( ln_dynvor_ens )   ioptio = ioptio + 1
738      IF( ln_dynvor_mix )   ioptio = ioptio + 1
739      IF( ln_dynvor_een )   ioptio = ioptio + 1
740      IF( lk_esopa      )   ioptio =          1
741
742      IF( ioptio /= 1 ) CALL ctl_stop( ' use ONE and ONLY one vorticity scheme' )
743
744      !                              ! Set nvor (type of scheme for vorticity)
745      IF( ln_dynvor_ene )   nvor =  0
746      IF( ln_dynvor_ens )   nvor =  1
747      IF( ln_dynvor_mix )   nvor =  2
748      IF( ln_dynvor_een )   nvor =  3
749      IF( lk_esopa      )   nvor = -1
750     
751      !                              ! Set ncor, nrvm, ntot (type of vorticity)
752      IF(lwp) WRITE(numout,*)
753      ncor = 1
754      IF( ln_dynadv_vec ) THEN     
755         IF(lwp) WRITE(numout,*) '         Vector form advection : vorticity = Coriolis + relative vorticity'
756         nrvm = 2
757         ntot = 4
758      ELSE                       
759         IF(lwp) WRITE(numout,*) '         Flux form advection   : vorticity = Coriolis + metric term'
760         nrvm = 3
761         ntot = 5
762      ENDIF
763     
764      IF(lwp) THEN                   ! Print the choice
765         WRITE(numout,*)
766         IF( nvor ==  0 )   WRITE(numout,*) '         vorticity scheme : energy conserving scheme'
767         IF( nvor ==  1 )   WRITE(numout,*) '         vorticity scheme : enstrophy conserving scheme'
768         IF( nvor ==  2 )   WRITE(numout,*) '         vorticity scheme : mixed enstrophy/energy conserving scheme'
769         IF( nvor ==  3 )   WRITE(numout,*) '         vorticity scheme : energy and enstrophy conserving scheme'
770         IF( nvor == -1 )   WRITE(numout,*) '         esopa test: use all lateral physics options'
771      ENDIF
772      !
773   END SUBROUTINE dyn_vor_init
774
775   !!==============================================================================
776END MODULE dynvor
Note: See TracBrowser for help on using the repository browser.