source: NEMO/trunk/src/OCE/DYN/dynnxt.F90 @ 12026

Last change on this file since 12026 was 12026, checked in by davestorkey, 11 months ago

Small bug fixes to to initial Euler timestep and OFF timestepping to ensure
bit comparison the IMMERSE_first_steps branch with the trunk.
Tickets #2310, #2311, #2343 apply.

  • Property svn:keywords set to Id
File size: 18.8 KB
Line 
1MODULE dynnxt
2   !!=========================================================================
3   !!                       ***  MODULE  dynnxt  ***
4   !! Ocean dynamics: time stepping
5   !!=========================================================================
6   !! History :  OPA  !  1987-02  (P. Andrich, D. L Hostis)  Original code
7   !!                 !  1990-10  (C. Levy, G. Madec)
8   !!            7.0  !  1993-03  (M. Guyon)  symetrical conditions
9   !!            8.0  !  1997-02  (G. Madec & M. Imbard)  opa, release 8.0
10   !!            8.2  !  1997-04  (A. Weaver)  Euler forward step
11   !!             -   !  1997-06  (G. Madec)  lateral boudary cond., lbc routine
12   !!    NEMO    1.0  !  2002-08  (G. Madec)  F90: Free form and module
13   !!             -   !  2002-10  (C. Talandier, A-M. Treguier) Open boundary cond.
14   !!            2.0  !  2005-11  (V. Garnier) Surface pressure gradient organization
15   !!            2.3  !  2007-07  (D. Storkey) Calls to BDY routines.
16   !!            3.2  !  2009-06  (G. Madec, R.Benshila)  re-introduce the vvl option
17   !!            3.3  !  2010-09  (D. Storkey, E.O'Dea) Bug fix for BDY module
18   !!            3.3  !  2011-03  (P. Oddo) Bug fix for time-splitting+(BDY-OBC) and not VVL
19   !!            3.5  !  2013-07  (J. Chanut) Compliant with time splitting changes
20   !!            3.6  !  2014-04  (G. Madec) add the diagnostic of the time filter trends
21   !!            3.7  !  2015-11  (J. Chanut) Free surface simplification
22   !!-------------------------------------------------------------------------
23 
24   !!-------------------------------------------------------------------------
25   !!   dyn_nxt       : obtain the next (after) horizontal velocity
26   !!-------------------------------------------------------------------------
27   USE oce            ! ocean dynamics and tracers
28   USE dom_oce        ! ocean space and time domain
29   USE sbc_oce        ! Surface boundary condition: ocean fields
30   USE sbcrnf         ! river runoffs
31   USE sbcisf         ! ice shelf
32   USE phycst         ! physical constants
33   USE dynadv         ! dynamics: vector invariant versus flux form
34   USE dynspg_ts      ! surface pressure gradient: split-explicit scheme
35   USE domvvl         ! variable volume
36   USE bdy_oce   , ONLY: ln_bdy
37   USE bdydta         ! ocean open boundary conditions
38   USE bdydyn         ! ocean open boundary conditions
39   USE bdyvol         ! ocean open boundary condition (bdy_vol routines)
40   USE trd_oce        ! trends: ocean variables
41   USE trddyn         ! trend manager: dynamics
42   USE trdken         ! trend manager: kinetic energy
43   !
44   USE in_out_manager ! I/O manager
45   USE iom            ! I/O manager library
46   USE lbclnk         ! lateral boundary condition (or mpp link)
47   USE lib_mpp        ! MPP library
48   USE prtctl         ! Print control
49   USE timing         ! Timing
50#if defined key_agrif
51   USE agrif_oce_interp
52#endif
53
54   IMPLICIT NONE
55   PRIVATE
56
57   PUBLIC    dyn_nxt   ! routine called by step.F90
58
59   !!----------------------------------------------------------------------
60   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
61   !! $Id$
62   !! Software governed by the CeCILL license (see ./LICENSE)
63   !!----------------------------------------------------------------------
64CONTAINS
65
66   SUBROUTINE dyn_nxt ( kt )
67      !!----------------------------------------------------------------------
68      !!                  ***  ROUTINE dyn_nxt  ***
69      !!                   
70      !! ** Purpose :   Finalize after horizontal velocity. Apply the boundary
71      !!             condition on the after velocity, achieve the time stepping
72      !!             by applying the Asselin filter on now fields and swapping
73      !!             the fields.
74      !!
75      !! ** Method  : * Ensure after velocities transport matches time splitting
76      !!             estimate (ln_dynspg_ts=T)
77      !!
78      !!              * Apply lateral boundary conditions on after velocity
79      !!             at the local domain boundaries through lbc_lnk call,
80      !!             at the one-way open boundaries (ln_bdy=T),
81      !!             at the AGRIF zoom   boundaries (lk_agrif=T)
82      !!
83      !!              * Apply the time filter applied and swap of the dynamics
84      !!             arrays to start the next time step:
85      !!                (ub,vb) = (un,vn) + atfp [ (ub,vb) + (ua,va) - 2 (un,vn) ]
86      !!                (un,vn) = (ua,va).
87      !!             Note that with flux form advection and non linear free surface,
88      !!             the time filter is applied on thickness weighted velocity.
89      !!             As a result, dyn_nxt MUST be called after tra_nxt.
90      !!
91      !! ** Action :   ub,vb   filtered before horizontal velocity of next time-step
92      !!               un,vn   now horizontal velocity of next time-step
93      !!----------------------------------------------------------------------
94      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
95      !
96      INTEGER  ::   ji, jj, jk   ! dummy loop indices
97      INTEGER  ::   ikt          ! local integers
98      REAL(wp) ::   zue3a, zue3n, zue3b, zuf, zcoef    ! local scalars
99      REAL(wp) ::   zve3a, zve3n, zve3b, zvf, z1_2dt   !   -      -
100      REAL(wp), ALLOCATABLE, DIMENSION(:,:)   ::   zue, zve
101      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   ze3u_f, ze3v_f, zua, zva 
102      !!----------------------------------------------------------------------
103      !
104      IF( ln_timing    )   CALL timing_start('dyn_nxt')
105      IF( ln_dynspg_ts )   ALLOCATE( zue(jpi,jpj)     , zve(jpi,jpj)     )
106      IF( l_trddyn     )   ALLOCATE( zua(jpi,jpj,jpk) , zva(jpi,jpj,jpk) )
107      !
108      IF( kt == nit000 ) THEN
109         IF(lwp) WRITE(numout,*)
110         IF(lwp) WRITE(numout,*) 'dyn_nxt : time stepping'
111         IF(lwp) WRITE(numout,*) '~~~~~~~'
112      ENDIF
113
114      IF ( ln_dynspg_ts ) THEN
115         ! Ensure below that barotropic velocities match time splitting estimate
116         ! Compute actual transport and replace it with ts estimate at "after" time step
117         zue(:,:) = e3u_a(:,:,1) * ua(:,:,1) * umask(:,:,1)
118         zve(:,:) = e3v_a(:,:,1) * va(:,:,1) * vmask(:,:,1)
119         DO jk = 2, jpkm1
120            zue(:,:) = zue(:,:) + e3u_a(:,:,jk) * ua(:,:,jk) * umask(:,:,jk)
121            zve(:,:) = zve(:,:) + e3v_a(:,:,jk) * va(:,:,jk) * vmask(:,:,jk)
122         END DO
123         DO jk = 1, jpkm1
124            ua(:,:,jk) = ( ua(:,:,jk) - zue(:,:) * r1_hu_a(:,:) + ua_b(:,:) ) * umask(:,:,jk)
125            va(:,:,jk) = ( va(:,:,jk) - zve(:,:) * r1_hv_a(:,:) + va_b(:,:) ) * vmask(:,:,jk)
126         END DO
127         !
128         IF( .NOT.ln_bt_fw ) THEN
129            ! Remove advective velocity from "now velocities"
130            ! prior to asselin filtering     
131            ! In the forward case, this is done below after asselin filtering   
132            ! so that asselin contribution is removed at the same time
133            DO jk = 1, jpkm1
134               un(:,:,jk) = ( un(:,:,jk) - un_adv(:,:)*r1_hu_n(:,:) + un_b(:,:) )*umask(:,:,jk)
135               vn(:,:,jk) = ( vn(:,:,jk) - vn_adv(:,:)*r1_hv_n(:,:) + vn_b(:,:) )*vmask(:,:,jk)
136            END DO 
137         ENDIF
138      ENDIF
139
140      ! Update after velocity on domain lateral boundaries
141      ! --------------------------------------------------     
142# if defined key_agrif
143      CALL Agrif_dyn( kt )             !* AGRIF zoom boundaries
144# endif
145      !
146      CALL lbc_lnk_multi( 'dynnxt', ua, 'U', -1., va, 'V', -1. )     !* local domain boundaries
147      !
148      !                                !* BDY open boundaries
149      IF( ln_bdy .AND. ln_dynspg_exp )   CALL bdy_dyn( kt )
150      IF( ln_bdy .AND. ln_dynspg_ts  )   CALL bdy_dyn( kt, dyn3d_only=.true. )
151
152!!$   Do we need a call to bdy_vol here??
153      !
154      IF( l_trddyn ) THEN             ! prepare the atf trend computation + some diagnostics
155         z1_2dt = 1._wp / (2. * rdt)        ! Euler or leap-frog time step
156         IF( neuler == 0 .AND. kt == nit000 )   z1_2dt = 1._wp / rdt
157         !
158         !                                  ! Kinetic energy and Conversion
159         IF( ln_KE_trd  )   CALL trd_dyn( ua, va, jpdyn_ken, kt )
160         !
161         IF( ln_dyn_trd ) THEN              ! 3D output: total momentum trends
162            zua(:,:,:) = ( ua(:,:,:) - ub(:,:,:) ) * z1_2dt
163            zva(:,:,:) = ( va(:,:,:) - vb(:,:,:) ) * z1_2dt
164            CALL iom_put( "utrd_tot", zua )        ! total momentum trends, except the asselin time filter
165            CALL iom_put( "vtrd_tot", zva )
166         ENDIF
167         !
168         zua(:,:,:) = un(:,:,:)             ! save the now velocity before the asselin filter
169         zva(:,:,:) = vn(:,:,:)             ! (caution: there will be a shift by 1 timestep in the
170         !                                  !  computation of the asselin filter trends)
171      ENDIF
172
173      ! Time filter and swap of dynamics arrays
174      ! ------------------------------------------
175      IF( neuler == 0 .AND. kt == nit000 ) THEN        !* Euler at first time-step: only swap
176         DO jk = 1, jpkm1
177            ub(:,:,jk) = un(:,:,jk)                         ! ub <-- un
178            vb(:,:,jk) = vn(:,:,jk)
179            un(:,:,jk) = ua(:,:,jk)                         ! un <-- ua
180            vn(:,:,jk) = va(:,:,jk)
181         END DO
182         IF( .NOT.ln_linssh ) THEN                          ! e3._b <-- e3._n
183!!gm BUG ????    I don't understand why it is not : e3._n <-- e3._a 
184            DO jk = 1, jpkm1
185!               e3t_b(:,:,jk) = e3t_n(:,:,jk)
186!               e3u_b(:,:,jk) = e3u_n(:,:,jk)
187!               e3v_b(:,:,jk) = e3v_n(:,:,jk)
188               !
189               e3t_n(:,:,jk) = e3t_a(:,:,jk)
190               e3u_n(:,:,jk) = e3u_a(:,:,jk)
191               e3v_n(:,:,jk) = e3v_a(:,:,jk)
192            END DO
193!!gm BUG end
194         ENDIF
195                                                            !
196         
197      ELSE                                             !* Leap-Frog : Asselin filter and swap
198         !                                ! =============!
199         IF( ln_linssh ) THEN             ! Fixed volume !
200            !                             ! =============!
201            DO jk = 1, jpkm1                             
202               DO jj = 1, jpj
203                  DO ji = 1, jpi   
204                     zuf = un(ji,jj,jk) + atfp * ( ub(ji,jj,jk) - 2._wp * un(ji,jj,jk) + ua(ji,jj,jk) )
205                     zvf = vn(ji,jj,jk) + atfp * ( vb(ji,jj,jk) - 2._wp * vn(ji,jj,jk) + va(ji,jj,jk) )
206                     !
207                     ub(ji,jj,jk) = zuf                      ! ub <-- filtered velocity
208                     vb(ji,jj,jk) = zvf
209                     un(ji,jj,jk) = ua(ji,jj,jk)             ! un <-- ua
210                     vn(ji,jj,jk) = va(ji,jj,jk)
211                  END DO
212               END DO
213            END DO
214            !                             ! ================!
215         ELSE                             ! Variable volume !
216            !                             ! ================!
217            ! Before scale factor at t-points
218            ! (used as a now filtered scale factor until the swap)
219            ! ----------------------------------------------------
220            DO jk = 1, jpkm1
221               e3t_b(:,:,jk) = e3t_n(:,:,jk) + atfp * ( e3t_b(:,:,jk) - 2._wp * e3t_n(:,:,jk) + e3t_a(:,:,jk) )
222            END DO
223            ! Add volume filter correction: compatibility with tracer advection scheme
224            ! => time filter + conservation correction (only at the first level)
225            zcoef = atfp * rdt * r1_rau0
226
227            e3t_b(:,:,1) = e3t_b(:,:,1) - zcoef * ( emp_b(:,:) - emp(:,:) ) * tmask(:,:,1)
228
229            IF ( ln_rnf ) THEN
230               IF( ln_rnf_depth ) THEN
231                  DO jk = 1, jpkm1 ! Deal with Rivers separetely, as can be through depth too
232                     DO jj = 1, jpj
233                        DO ji = 1, jpi
234                           IF( jk <=  nk_rnf(ji,jj)  ) THEN
235                               e3t_b(ji,jj,jk) =   e3t_b(ji,jj,jk) - zcoef *  ( - rnf_b(ji,jj) + rnf(ji,jj) ) &
236                                      &          * ( e3t_n(ji,jj,jk) / h_rnf(ji,jj) ) * tmask(ji,jj,jk)
237                           ENDIF
238                        ENDDO
239                     ENDDO
240                  ENDDO
241               ELSE
242                  e3t_b(:,:,1) = e3t_b(:,:,1) - zcoef *  ( -rnf_b(:,:) + rnf(:,:))*tmask(:,:,1)
243               ENDIF
244            END IF
245
246            IF ( ln_isf ) THEN   ! if ice shelf melting
247               DO jk = 1, jpkm1 ! Deal with isf separetely, as can be through depth too
248                  DO jj = 1, jpj
249                     DO ji = 1, jpi
250                        IF( misfkt(ji,jj) <=jk .and. jk < misfkb(ji,jj)  ) THEN
251                           e3t_b(ji,jj,jk) = e3t_b(ji,jj,jk) - zcoef * ( fwfisf_b(ji,jj) - fwfisf(ji,jj) ) &
252                                &          * ( e3t_n(ji,jj,jk) * r1_hisf_tbl(ji,jj) ) * tmask(ji,jj,jk)
253                        ELSEIF ( jk==misfkb(ji,jj) ) THEN
254                           e3t_b(ji,jj,jk) = e3t_b(ji,jj,jk) - zcoef * ( fwfisf_b(ji,jj) - fwfisf(ji,jj) ) &
255                                &          * ( e3t_n(ji,jj,jk) * r1_hisf_tbl(ji,jj) ) * ralpha(ji,jj) * tmask(ji,jj,jk)
256                        ENDIF
257                     END DO
258                  END DO
259               END DO
260            END IF
261            !
262            IF( ln_dynadv_vec ) THEN      ! Asselin filter applied on velocity
263               ! Before filtered scale factor at (u/v)-points
264               CALL dom_vvl_interpol( e3t_b(:,:,:), e3u_b(:,:,:), 'U' )
265               CALL dom_vvl_interpol( e3t_b(:,:,:), e3v_b(:,:,:), 'V' )
266               DO jk = 1, jpkm1
267                  DO jj = 1, jpj
268                     DO ji = 1, jpi
269                        zuf = un(ji,jj,jk) + atfp * ( ub(ji,jj,jk) - 2._wp * un(ji,jj,jk) + ua(ji,jj,jk) )
270                        zvf = vn(ji,jj,jk) + atfp * ( vb(ji,jj,jk) - 2._wp * vn(ji,jj,jk) + va(ji,jj,jk) )
271                        !
272                        ub(ji,jj,jk) = zuf                      ! ub <-- filtered velocity
273                        vb(ji,jj,jk) = zvf
274                        un(ji,jj,jk) = ua(ji,jj,jk)             ! un <-- ua
275                        vn(ji,jj,jk) = va(ji,jj,jk)
276                     END DO
277                  END DO
278               END DO
279               !
280            ELSE                          ! Asselin filter applied on thickness weighted velocity
281               !
282               ALLOCATE( ze3u_f(jpi,jpj,jpk) , ze3v_f(jpi,jpj,jpk) )
283               ! Before filtered scale factor at (u/v)-points stored in ze3u_f, ze3v_f
284               CALL dom_vvl_interpol( e3t_b(:,:,:), ze3u_f, 'U' )
285               CALL dom_vvl_interpol( e3t_b(:,:,:), ze3v_f, 'V' )
286               DO jk = 1, jpkm1
287                  DO jj = 1, jpj
288                     DO ji = 1, jpi                 
289                        zue3a = e3u_a(ji,jj,jk) * ua(ji,jj,jk)
290                        zve3a = e3v_a(ji,jj,jk) * va(ji,jj,jk)
291                        zue3n = e3u_n(ji,jj,jk) * un(ji,jj,jk)
292                        zve3n = e3v_n(ji,jj,jk) * vn(ji,jj,jk)
293                        zue3b = e3u_b(ji,jj,jk) * ub(ji,jj,jk)
294                        zve3b = e3v_b(ji,jj,jk) * vb(ji,jj,jk)
295                        !
296                        zuf = ( zue3n + atfp * ( zue3b - 2._wp * zue3n  + zue3a ) ) / ze3u_f(ji,jj,jk)
297                        zvf = ( zve3n + atfp * ( zve3b - 2._wp * zve3n  + zve3a ) ) / ze3v_f(ji,jj,jk)
298                        !
299                        ub(ji,jj,jk) = zuf                     ! ub <-- filtered velocity
300                        vb(ji,jj,jk) = zvf
301                        un(ji,jj,jk) = ua(ji,jj,jk)            ! un <-- ua
302                        vn(ji,jj,jk) = va(ji,jj,jk)
303                     END DO
304                  END DO
305               END DO
306               e3u_b(:,:,1:jpkm1) = ze3u_f(:,:,1:jpkm1)        ! e3u_b <-- filtered scale factor
307               e3v_b(:,:,1:jpkm1) = ze3v_f(:,:,1:jpkm1)
308               !
309               DEALLOCATE( ze3u_f , ze3v_f )
310            ENDIF
311            !
312         ENDIF
313         !
314         IF( ln_dynspg_ts .AND. ln_bt_fw ) THEN
315            ! Revert "before" velocities to time split estimate
316            ! Doing it here also means that asselin filter contribution is removed 
317            zue(:,:) = e3u_b(:,:,1) * ub(:,:,1) * umask(:,:,1)
318            zve(:,:) = e3v_b(:,:,1) * vb(:,:,1) * vmask(:,:,1)   
319            DO jk = 2, jpkm1
320               zue(:,:) = zue(:,:) + e3u_b(:,:,jk) * ub(:,:,jk) * umask(:,:,jk)
321               zve(:,:) = zve(:,:) + e3v_b(:,:,jk) * vb(:,:,jk) * vmask(:,:,jk)   
322            END DO
323            DO jk = 1, jpkm1
324               ub(:,:,jk) = ub(:,:,jk) - (zue(:,:) * r1_hu_n(:,:) - un_b(:,:)) * umask(:,:,jk)
325               vb(:,:,jk) = vb(:,:,jk) - (zve(:,:) * r1_hv_n(:,:) - vn_b(:,:)) * vmask(:,:,jk)
326            END DO
327         ENDIF
328         !
329      ENDIF ! neuler =/0
330      !
331      ! Set "now" and "before" barotropic velocities for next time step:
332      ! JC: Would be more clever to swap variables than to make a full vertical
333      ! integration
334      !
335      !
336      IF(.NOT.ln_linssh ) THEN
337         hu_b(:,:) = e3u_b(:,:,1) * umask(:,:,1)
338         hv_b(:,:) = e3v_b(:,:,1) * vmask(:,:,1)
339         DO jk = 2, jpkm1
340            hu_b(:,:) = hu_b(:,:) + e3u_b(:,:,jk) * umask(:,:,jk)
341            hv_b(:,:) = hv_b(:,:) + e3v_b(:,:,jk) * vmask(:,:,jk)
342         END DO
343         r1_hu_b(:,:) = ssumask(:,:) / ( hu_b(:,:) + 1._wp - ssumask(:,:) )
344         r1_hv_b(:,:) = ssvmask(:,:) / ( hv_b(:,:) + 1._wp - ssvmask(:,:) )
345      ENDIF
346      !
347      un_b(:,:) = e3u_a(:,:,1) * un(:,:,1) * umask(:,:,1)
348      ub_b(:,:) = e3u_b(:,:,1) * ub(:,:,1) * umask(:,:,1)
349      vn_b(:,:) = e3v_a(:,:,1) * vn(:,:,1) * vmask(:,:,1)
350      vb_b(:,:) = e3v_b(:,:,1) * vb(:,:,1) * vmask(:,:,1)
351      DO jk = 2, jpkm1
352         un_b(:,:) = un_b(:,:) + e3u_a(:,:,jk) * un(:,:,jk) * umask(:,:,jk)
353         ub_b(:,:) = ub_b(:,:) + e3u_b(:,:,jk) * ub(:,:,jk) * umask(:,:,jk)
354         vn_b(:,:) = vn_b(:,:) + e3v_a(:,:,jk) * vn(:,:,jk) * vmask(:,:,jk)
355         vb_b(:,:) = vb_b(:,:) + e3v_b(:,:,jk) * vb(:,:,jk) * vmask(:,:,jk)
356      END DO
357      un_b(:,:) = un_b(:,:) * r1_hu_a(:,:)
358      vn_b(:,:) = vn_b(:,:) * r1_hv_a(:,:)
359      ub_b(:,:) = ub_b(:,:) * r1_hu_b(:,:)
360      vb_b(:,:) = vb_b(:,:) * r1_hv_b(:,:)
361      !
362      IF( .NOT.ln_dynspg_ts ) THEN        ! output the barotropic currents
363         CALL iom_put(  "ubar", un_b(:,:) )
364         CALL iom_put(  "vbar", vn_b(:,:) )
365      ENDIF
366      IF( l_trddyn ) THEN                ! 3D output: asselin filter trends on momentum
367         zua(:,:,:) = ( ub(:,:,:) - zua(:,:,:) ) * z1_2dt
368         zva(:,:,:) = ( vb(:,:,:) - zva(:,:,:) ) * z1_2dt
369         CALL trd_dyn( zua, zva, jpdyn_atf, kt )
370      ENDIF
371      !
372      IF(ln_ctl)   CALL prt_ctl( tab3d_1=un, clinfo1=' nxt  - Un: ', mask1=umask,   &
373         &                       tab3d_2=vn, clinfo2=' Vn: '       , mask2=vmask )
374      !
375      IF( ln_dynspg_ts )   DEALLOCATE( zue, zve )
376      IF( l_trddyn     )   DEALLOCATE( zua, zva )
377      IF( ln_timing    )   CALL timing_stop('dyn_nxt')
378      !
379   END SUBROUTINE dyn_nxt
380
381   !!=========================================================================
382END MODULE dynnxt
Note: See TracBrowser for help on using the repository browser.