source: NEMO/trunk/src/NST/agrif_oce_sponge.F90 @ 14976

Last change on this file since 14976 was 14976, checked in by jchanut, 3 months ago

#2638, merge dev_14608_AGRIF_domcfg branch into trunk

  • Property svn:keywords set to Id
File size: 44.8 KB
Line 
1#define SPONGE && define SPONGE_TOP
2
3MODULE agrif_oce_sponge
4   !!======================================================================
5   !!                   ***  MODULE  agrif_oce_interp  ***
6   !! AGRIF: sponge package for the ocean dynamics (OCE)
7   !!======================================================================
8   !! History :  2.0  !  2002-06  (XXX)  Original cade
9   !!             -   !  2005-11  (XXX)
10   !!            3.2  !  2009-04  (R. Benshila)
11   !!            3.6  !  2014-09  (R. Benshila)
12   !!----------------------------------------------------------------------
13#if defined key_agrif
14   !!----------------------------------------------------------------------
15   !!   'key_agrif'                                              AGRIF zoom
16   !!----------------------------------------------------------------------
17   USE par_oce
18   USE oce
19   USE dom_oce
20   !
21   USE in_out_manager
22   USE agrif_oce
23   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
24   USE iom
25   USE vremap
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC Agrif_Sponge, Agrif_Sponge_2d, Agrif_Sponge_Tra, Agrif_Sponge_Dyn
31   PUBLIC interptsn_sponge, interpun_sponge, interpvn_sponge
32   PUBLIC interpunb_sponge, interpvnb_sponge
33
34   !! * Substitutions
35#  include "domzgr_substitute.h90"
36#  include "do_loop_substitute.h90"
37   !!----------------------------------------------------------------------
38   !! NEMO/NST 4.0 , NEMO Consortium (2018)
39   !! $Id$
40   !! Software governed by the CeCILL license (see ./LICENSE)
41   !!----------------------------------------------------------------------
42CONTAINS
43
44   SUBROUTINE Agrif_Sponge_Tra
45      !!----------------------------------------------------------------------
46      !!                 *** ROUTINE Agrif_Sponge_Tra ***
47      !!----------------------------------------------------------------------
48      REAL(wp) ::   zcoef   ! local scalar
49      INTEGER  :: istart, iend, jstart, jend 
50      !!----------------------------------------------------------------------
51      !
52#if defined SPONGE
53      !! Assume persistence:
54      zcoef = REAL(Agrif_rhot()-1,wp)/REAL(Agrif_rhot())
55
56      Agrif_SpecialValue    = 0._wp
57      Agrif_UseSpecialValue = .TRUE.
58      l_vremap              = ln_vert_remap
59      tabspongedone_tsn     = .FALSE.
60      !
61      CALL Agrif_Bc_Variable( ts_sponge_id, calledweight=zcoef, procname=interptsn_sponge )
62      !
63      Agrif_UseSpecialValue = .FALSE.
64      l_vremap              = .FALSE.
65#endif
66      !
67      CALL iom_put( 'agrif_spu', fspu(:,:))
68      CALL iom_put( 'agrif_spv', fspv(:,:))
69      !
70   END SUBROUTINE Agrif_Sponge_Tra
71
72
73   SUBROUTINE Agrif_Sponge_dyn
74      !!----------------------------------------------------------------------
75      !!                 *** ROUTINE Agrif_Sponge_dyn ***
76      !!----------------------------------------------------------------------
77      REAL(wp) ::   zcoef   ! local scalar
78      !!----------------------------------------------------------------------
79      !
80#if defined SPONGE
81      zcoef = REAL(Agrif_rhot()-1,wp)/REAL(Agrif_rhot())
82
83      Agrif_SpecialValue    = 0._wp
84      Agrif_UseSpecialValue = ln_spc_dyn
85      l_vremap              = ln_vert_remap
86      use_sign_north        = .TRUE.
87      sign_north            = -1._wp
88      !
89      tabspongedone_u = .FALSE.
90      tabspongedone_v = .FALSE.         
91      CALL Agrif_Bc_Variable( un_sponge_id, calledweight=zcoef, procname=interpun_sponge )
92      !
93      tabspongedone_u = .FALSE.
94      tabspongedone_v = .FALSE.
95      CALL Agrif_Bc_Variable( vn_sponge_id, calledweight=zcoef, procname=interpvn_sponge )
96     
97      IF ( nn_shift_bar>0 ) THEN ! then split sponge between 2d and 3d
98         zcoef = REAL(Agrif_NbStepint(),wp)/REAL(Agrif_rhot()) ! forward tsplit
99         tabspongedone_u = .FALSE.
100         tabspongedone_v = .FALSE.         
101         CALL Agrif_Bc_Variable( unb_sponge_id, calledweight=zcoef, procname=interpunb_sponge )
102         !
103         tabspongedone_u = .FALSE.
104         tabspongedone_v = .FALSE.
105         CALL Agrif_Bc_Variable( vnb_sponge_id, calledweight=zcoef, procname=interpvnb_sponge )
106      ENDIF
107      !
108      Agrif_UseSpecialValue = .FALSE.
109      use_sign_north        = .FALSE.
110      l_vremap              = .FALSE.
111      !
112#endif
113      !
114      CALL iom_put( 'agrif_spt', fspt(:,:))
115      CALL iom_put( 'agrif_spf', fspf(:,:))
116      !
117   END SUBROUTINE Agrif_Sponge_dyn
118
119
120   SUBROUTINE Agrif_Sponge
121      !!----------------------------------------------------------------------
122      !!                 *** ROUTINE  Agrif_Sponge ***
123      !!----------------------------------------------------------------------
124      INTEGER  ::   ji, jj, ind1, ind2
125      INTEGER  ::   ispongearea, jspongearea
126      REAL(wp) ::   z1_ispongearea, z1_jspongearea
127      REAL(wp), DIMENSION(jpi,jpj) :: ztabramp
128      !!----------------------------------------------------------------------
129      !
130      ! Sponge 1d example with:
131      !      iraf = 3 ; nbghost = 3 ; nn_sponge_len = 2
132      !                       
133      !coarse :     U     T     U     T     U     T     U
134      !|            |           |           |           |
135      !fine :     t u t u t u t u t u t u t u t u t u t u t
136      !sponge val:0 1   1   1   1  5/6 4/6 3/6 2/6 1/6  0
137      !           |   ghost     | <-- sponge area  -- > |
138      !           |   points    |                       |
139      !                         |--> dynamical interface
140
141#if defined SPONGE || defined SPONGE_TOP
142      ! Define ramp from boundaries towards domain interior at F-points
143      ! Store it in ztabramp
144
145      ispongearea    = nn_sponge_len * Agrif_irhox()
146      z1_ispongearea = 1._wp / REAL( MAX(ispongearea,1), wp )
147      jspongearea    = nn_sponge_len * Agrif_irhoy()
148      z1_jspongearea = 1._wp / REAL( MAX(jspongearea,1), wp )
149         
150      ztabramp(:,:) = 0._wp
151
152      IF( lk_west ) THEN                            ! --- West --- !
153         ind1 = nn_hls + nbghostcells               ! halo + nbghostcells
154         ind2 = nn_hls + nbghostcells + ispongearea 
155         DO ji = mi0(ind1), mi1(ind2)   
156            DO jj = 1, jpj               
157               ztabramp(ji,jj) =                       REAL(ind2 - mig(ji), wp) * z1_ispongearea
158            END DO
159         END DO
160         ! ghost cells:
161         ind1 = 1
162         ind2 = nn_hls +  nbghostcells              ! halo + nbghostcells
163         DO ji = mi0(ind1), mi1(ind2)   
164            DO jj = 1, jpj               
165               ztabramp(ji,jj) = 1._wp
166            END DO
167         END DO
168      ENDIF
169      IF( lk_east ) THEN                             ! --- East --- !
170         ind1 = jpiglo - ( nn_hls + nbghostcells -1 ) - ispongearea - 1
171         ind2 = jpiglo - ( nn_hls + nbghostcells -1 ) - 1    ! halo + land + nbghostcells - 1
172         DO ji = mi0(ind1), mi1(ind2)
173            DO jj = 1, jpj
174               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(mig(ji) - ind1, wp) * z1_ispongearea ) 
175            END DO
176         END DO
177         ! ghost cells:
178         ind1 = jpiglo - ( nn_hls + nbghostcells -1 ) - 1    ! halo + land + nbghostcells - 1
179         ind2 = jpiglo - 1
180         DO ji = mi0(ind1), mi1(ind2)
181            DO jj = 1, jpj
182               ztabramp(ji,jj) = 1._wp
183            END DO
184         END DO
185      ENDIF     
186      IF( lk_south ) THEN                            ! --- South --- !
187         ind1 = nn_hls + nbghostcells                ! halo + nbghostcells
188         ind2 = nn_hls + nbghostcells + jspongearea 
189         DO jj = mj0(ind1), mj1(ind2) 
190            DO ji = 1, jpi
191               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(ind2 - mjg(jj), wp) * z1_jspongearea )
192            END DO
193         END DO
194         ! ghost cells:
195         ind1 = 1
196         ind2 = nn_hls + nbghostcells                ! halo + nbghostcells
197         DO jj = mj0(ind1), mj1(ind2) 
198            DO ji = 1, jpi
199               ztabramp(ji,jj) = 1._wp
200            END DO
201         END DO
202      ENDIF
203      IF( lk_north ) THEN                            ! --- North --- !
204         ind1 = jpjglo - ( nn_hls + nbghostcells -1 ) - jspongearea - 1
205         ind2 = jpjglo - ( nn_hls + nbghostcells -1 ) - 1    ! halo + nbghostcells - 1
206         DO jj = mj0(ind1), mj1(ind2)
207            DO ji = 1, jpi
208               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(mjg(jj) - ind1, wp) * z1_jspongearea ) 
209            END DO
210         END DO
211         ! ghost cells:
212         ind1 = jpjglo - ( nn_hls + nbghostcells -1 )      ! halo + land + nbghostcells - 1
213         ind2 = jpjglo
214         DO jj = mj0(ind1), mj1(ind2)
215            DO ji = 1, jpi
216               ztabramp(ji,jj) = 1._wp
217            END DO
218         END DO
219      ENDIF     
220      !
221      ! Tracers
222      fspu(:,:) = 0._wp
223      fspv(:,:) = 0._wp
224      DO_2D( 0, 0, 0, 0 )
225         fspu(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji,jj-1) ) * ssumask(ji,jj)
226         fspv(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji-1,jj) ) * ssvmask(ji,jj)
227      END_2D
228
229      ! Dynamics
230      fspt(:,:) = 0._wp
231      fspf(:,:) = 0._wp
232      DO_2D( 0, 0, 0, 0 )
233         fspt(ji,jj) = 0.25_wp * ( ztabramp(ji  ,jj  ) + ztabramp(ji-1,jj  ) &
234                               &  +ztabramp(ji  ,jj-1) + ztabramp(ji-1,jj-1) ) * ssmask(ji,jj)
235         fspf(ji,jj) = ztabramp(ji,jj) * ssvmask(ji,jj) * ssvmask(ji,jj+1)
236      END_2D
237     
238      CALL lbc_lnk( 'agrif_Sponge', fspu, 'U', 1._wp, fspv, 'V', 1._wp, fspt, 'T', 1._wp, fspf, 'F', 1._wp )
239      !
240      ! Remove vertical interpolation where not needed:
241      ! (A null value in mbkx arrays does the job)
242      WHERE (fspu(:,:) == 0._wp) mbku_parent(:,:) = 0
243      WHERE (fspv(:,:) == 0._wp) mbkv_parent(:,:) = 0
244      WHERE (fspt(:,:) == 0._wp) mbkt_parent(:,:) = 0
245      !
246#endif
247      !
248   END SUBROUTINE Agrif_Sponge
249
250
251   SUBROUTINE Agrif_Sponge_2d
252      !!----------------------------------------------------------------------
253      !!                 *** ROUTINE  Agrif_Sponge_2d ***
254      !!----------------------------------------------------------------------
255      INTEGER  ::   ji, jj, ind1, ind2, ishift, jshift
256      INTEGER  ::   ispongearea, jspongearea
257      REAL(wp) ::   z1_ispongearea, z1_jspongearea
258      REAL(wp), DIMENSION(jpi,jpj) :: ztabramp
259      !!----------------------------------------------------------------------
260      !
261      ! Sponge 1d example with:
262      !      iraf = 3 ; nbghost = 3 ; nn_sponge_len = 2
263      !                       
264      !coarse :     U     T     U     T     U     T     U
265      !|            |           |           |           |
266      !fine :     t u t u t u t u t u t u t u t u t u t u t
267      !sponge val:0 1   1   1   1  5/6 4/6 3/6 2/6 1/6  0
268      !           |   ghost     | <-- sponge area  -- > |
269      !           |   points    |                       |
270      !                         |--> dynamical interface
271
272#if defined SPONGE || defined SPONGE_TOP
273      ! Define ramp from boundaries towards domain interior at F-points
274      ! Store it in ztabramp
275
276      ispongearea    = nn_sponge_len * Agrif_irhox()
277      z1_ispongearea = 1._wp / REAL( MAX(ispongearea,1), wp )
278      jspongearea    = nn_sponge_len * Agrif_irhoy()
279      z1_jspongearea = 1._wp / REAL( MAX(jspongearea,1), wp )
280      ishift = nn_shift_bar * Agrif_irhox()
281      jshift = nn_shift_bar * Agrif_irhoy()
282       
283      ztabramp(:,:) = 0._wp
284
285      IF( lk_west ) THEN                             ! --- West --- !
286         ind1 = nn_hls + nbghostcells + ishift
287         ind2 = nn_hls + nbghostcells + ishift + ispongearea 
288         DO ji = mi0(ind1), mi1(ind2)   
289            DO jj = 1, jpj               
290               ztabramp(ji,jj) =                       REAL(ind2 - mig(ji), wp) * z1_ispongearea
291            END DO
292         END DO
293         ! ghost cells:
294         ind1 = 1
295         ind2 = nn_hls + nbghostcells + ishift               ! halo + nbghostcells
296         DO ji = mi0(ind1), mi1(ind2)   
297            DO jj = 1, jpj               
298               ztabramp(ji,jj) = 1._wp
299            END DO
300         END DO
301      ENDIF
302      IF( lk_east ) THEN                             ! --- East --- !
303         ind1 = jpiglo - ( nn_hls + nbghostcells -1  + ishift) - ispongearea - 1
304         ind2 = jpiglo - ( nn_hls + nbghostcells -1  + ishift) - 1    ! halo + nbghostcells - 1
305         DO ji = mi0(ind1), mi1(ind2)
306            DO jj = 1, jpj
307               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(mig(ji) - ind1, wp) * z1_ispongearea ) 
308            END DO
309         END DO
310         ! ghost cells:
311         ind1 = jpiglo - ( nn_hls + nbghostcells -1 + ishift) - 1    ! halo + nbghostcells - 1
312         ind2 = jpiglo - 1
313         DO ji = mi0(ind1), mi1(ind2)
314            DO jj = 1, jpj
315               ztabramp(ji,jj) = 1._wp
316            END DO
317         END DO
318      ENDIF     
319      IF( lk_south ) THEN                            ! --- South --- !
320         ind1 = nn_hls + nbghostcells + jshift                ! halo + nbghostcells
321         ind2 = nn_hls + nbghostcells + jshift + jspongearea 
322         DO jj = mj0(ind1), mj1(ind2) 
323            DO ji = 1, jpi
324               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(ind2 - mjg(jj), wp) * z1_jspongearea )
325            END DO
326         END DO
327         ! ghost cells:
328         ind1 = 1
329         ind2 = nn_hls + nbghostcells + jshift                ! halo + land + nbghostcells
330         DO jj = mj0(ind1), mj1(ind2) 
331            DO ji = 1, jpi
332               ztabramp(ji,jj) = 1._wp
333            END DO
334         END DO
335      ENDIF
336      IF( lk_north ) THEN                            ! --- North --- !
337         ind1 = jpjglo - ( nn_hls + nbghostcells -1 + jshift) - jspongearea - 1
338         ind2 = jpjglo - ( nn_hls + nbghostcells -1 + jshift) - 1    ! halo + land + nbghostcells - 1
339         DO jj = mj0(ind1), mj1(ind2)
340            DO ji = 1, jpi
341               ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL(mjg(jj) - ind1, wp) * z1_jspongearea ) 
342            END DO
343         END DO
344         ! ghost cells:
345         ind1 = jpjglo - ( nn_hls + nbghostcells -1 + jshift)      ! halo + land + nbghostcells - 1
346         ind2 = jpjglo
347         DO jj = mj0(ind1), mj1(ind2)
348            DO ji = 1, jpi
349               ztabramp(ji,jj) = 1._wp
350            END DO
351         END DO
352      ENDIF
353      !
354      ! Tracers
355      fspu_2d(:,:) = 0._wp
356      fspv_2d(:,:) = 0._wp
357      DO_2D( 0, 0, 0, 0 )
358         fspu_2d(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji,jj-1) ) * ssumask(ji,jj)
359         fspv_2d(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji-1,jj) ) * ssvmask(ji,jj)
360      END_2D
361
362      ! Dynamics
363      fspt_2d(:,:) = 0._wp
364      fspf_2d(:,:) = 0._wp
365      DO_2D( 0, 0, 0, 0 )
366         fspt_2d(ji,jj) = 0.25_wp * ( ztabramp(ji  ,jj  ) + ztabramp(ji-1,jj  ) &
367                               &  +ztabramp(ji  ,jj-1) + ztabramp(ji-1,jj-1) ) * ssmask(ji,jj)
368         fspf_2d(ji,jj) = ztabramp(ji,jj) * ssvmask(ji,jj) * ssvmask(ji,jj+1)
369         END_2D
370      CALL lbc_lnk( 'agrif_Sponge_2d', fspu_2d, 'U', 1._wp, fspv_2d, 'V', 1._wp, fspt_2d, 'T', 1._wp, fspf_2d, 'F', 1._wp )
371      !
372#endif
373      !
374   END SUBROUTINE Agrif_Sponge_2d
375
376
377   SUBROUTINE interptsn_sponge( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before) 
378      !!----------------------------------------------------------------------
379      !!                 *** ROUTINE interptsn_sponge ***
380      !!----------------------------------------------------------------------
381      INTEGER                                     , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2, n1, n2
382      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) ::   tabres
383      LOGICAL                                     , INTENT(in   ) ::   before
384      !
385      INTEGER  ::   ji, jj, jk, jn   ! dummy loop indices
386      INTEGER  ::   iku, ikv
387      REAL(wp) :: ztsa, zabe1, zabe2, zbtr, zhtot
388      REAL(wp), DIMENSION(i1-1:i2,j1-1:j2,jpk) :: ztu, ztv
389      REAL(wp), DIMENSION(i1:i2,j1:j2,jpk,n1:n2) ::tsbdiff
390      ! vertical interpolation:
391      REAL(wp), DIMENSION(i1:i2,j1:j2,jpk,n1:n2) ::tabres_child
392      REAL(wp), DIMENSION(k1:k2,n1:n2-1) :: tabin, tabin_i
393      REAL(wp), DIMENSION(k1:k2) :: z_in, z_in_i, h_in_i
394      REAL(wp), DIMENSION(1:jpk) :: h_out, z_out
395      INTEGER :: N_in, N_out
396      !!----------------------------------------------------------------------
397      !
398      IF( before ) THEN
399         DO jn = 1, jpts
400            DO jk=k1,k2
401               DO jj=j1,j2
402                  DO ji=i1,i2
403                     tabres(ji,jj,jk,jn) = ts(ji,jj,jk,jn,Kbb_a)
404                  END DO
405               END DO
406            END DO
407         END DO
408
409         IF ( l_vremap.OR.ln_zps ) THEN
410
411            ! Fill cell depths (i.e. gdept) to be interpolated
412            ! Warning: these are masked, hence extrapolated prior interpolation.
413            DO jj=j1,j2
414               DO ji=i1,i2
415                  tabres(ji,jj,k1,jpts+1) = 0.5_wp * tmask(ji,jj,k1) * e3t(ji,jj,k1,Kbb_a)
416                  DO jk=k1+1,k2
417                     tabres(ji,jj,jk,jpts+1) = tmask(ji,jj,jk) * &
418                        & ( tabres(ji,jj,jk-1,jpts+1) + 0.5_wp * (e3t(ji,jj,jk-1,Kbb_a)+e3t(ji,jj,jk,Kbb_a)) )
419                  END DO
420               END DO
421            END DO
422
423            ! Save ssh at last level:
424            IF ( .NOT.ln_linssh ) THEN
425               tabres(i1:i2,j1:j2,k2,jpts+1) = ssh(i1:i2,j1:j2,Kbb_a)*tmask(i1:i2,j1:j2,1) 
426            END IF 
427   
428         END IF
429
430      ELSE 
431         !
432         IF ( l_vremap ) THEN
433
434            IF (ln_linssh) tabres(i1:i2,j1:j2,k2,n2) = 0._wp
435
436            DO jj=j1,j2
437               DO ji=i1,i2
438
439                  tabres_child(ji,jj,:,:) = 0._wp 
440                  ! Build vertical grids:
441                  N_in = mbkt_parent(ji,jj)
442                  ! Input grid (account for partial cells if any):
443                  IF ( N_in > 0 ) THEN
444                     DO jk=1,N_in
445                        z_in(jk) = tabres(ji,jj,jk,n2) - tabres(ji,jj,k2,n2)
446                        tabin(jk,1:jpts) = tabres(ji,jj,jk,1:jpts)
447                     END DO
448                 
449                     ! Intermediate grid:
450                     DO jk = 1, N_in
451                        h_in_i(jk) = e3t0_parent(ji,jj,jk) * & 
452                          &       (1._wp + tabres(ji,jj,k2,n2)/(ht0_parent(ji,jj)*ssmask(ji,jj) + 1._wp - ssmask(ji,jj)))
453                     END DO
454                     z_in_i(1) = 0.5_wp * h_in_i(1)
455                     DO jk=2,N_in
456                        z_in_i(jk) = z_in_i(jk-1) + 0.5_wp * ( h_in_i(jk) + h_in_i(jk-1) )
457                     END DO
458                     z_in_i(1:N_in) = z_in_i(1:N_in)  - tabres(ji,jj,k2,n2)
459                  END IF
460                  ! Output (Child) grid:
461                  N_out = mbkt(ji,jj)
462                  DO jk=1,N_out
463                     h_out(jk) = e3t(ji,jj,jk,Kbb_a)
464                  END DO
465                  z_out(1) = 0.5_wp * h_out(1)
466                  DO jk=2,N_out
467                     z_out(jk) = z_out(jk-1) + 0.5_wp * ( h_out(jk)+h_out(jk-1) )
468                  END DO
469                  IF (.NOT.ln_linssh) z_out(1:N_out) = z_out(1:N_out)  - ssh(ji,jj,Kbb_a)
470
471                  ! Account for small differences in the free-surface
472                  IF ( sum(h_out(1:N_out)) > sum(h_in_i(1:N_in) )) THEN
473                     h_out(1) = h_out(1)  - ( sum(h_out(1:N_out))-sum(h_in_i(1:N_in)) )
474                  ELSE
475                     h_in_i(1)= h_in_i(1) - ( sum(h_in_i(1:N_in))-sum(h_out(1:N_out)) )
476                  END IF
477                  IF (N_in*N_out > 0) THEN
478                     CALL remap_linear(tabin(1:N_in,1:jpts),z_in(1:N_in),tabin_i(1:N_in,1:jpts),z_in_i(1:N_in),N_in,N_in,jpts)
479                     CALL reconstructandremap(tabin_i(1:N_in,1:jpts),h_in_i(1:N_in),tabres_child(ji,jj,1:N_out,1:jpts),h_out(1:N_out),N_in,N_out,jpts)
480!                     CALL remap_linear(tabin(1:N_in,1:jpts),z_in(1:N_in),tabres_child(ji,jj,1:N_out,1:jpts),z_out(1:N_in),N_in,N_out,jpts) 
481                  ENDIF
482               END DO
483            END DO
484
485            DO jj=j1,j2
486               DO ji=i1,i2
487                  DO jk=1,jpkm1
488                     tsbdiff(ji,jj,jk,1:jpts) = (ts(ji,jj,jk,1:jpts,Kbb_a) - tabres_child(ji,jj,jk,1:jpts)) * tmask(ji,jj,jk)
489                  END DO
490               END DO
491            END DO
492
493         ELSE
494
495            IF ( Agrif_Parent(ln_zps) ) THEN ! Account for partial cells
496
497               DO jj=j1,j2
498                  DO ji=i1,i2
499                     !
500                     N_in  = mbkt(ji,jj) 
501                     N_out = mbkt(ji,jj) 
502                     z_in(1) = tabres(ji,jj,1,n2)
503                     tabin(1,1:jpts) = tabres(ji,jj,1,1:jpts)
504                     DO jk=2, N_in
505                        z_in(jk) = tabres(ji,jj,jk,n2)
506                        tabin(jk,1:jpts) = tabres(ji,jj,jk,1:jpts)
507                     END DO
508                     IF (.NOT.ln_linssh) z_in(1:N_in) = z_in(1:N_in) - tabres(ji,jj,k2,n2)
509
510                     z_out(1) = 0.5_wp * e3t(ji,jj,1,Kbb_a)
511                     DO jk=2, N_out
512                        z_out(jk) = z_out(jk-1) + 0.5_wp * (e3t(ji,jj,jk-1,Kbb_a) + e3t(ji,jj,jk,Kbb_a)) 
513                     END DO
514                     IF (.NOT.ln_linssh) z_out(1:N_out) = z_out(1:N_out) - ssh(ji,jj,Kbb_a)
515
516                     CALL remap_linear(tabin(1:N_in,1:jpts), z_in(1:N_in), tabres(ji,jj,1:N_out,1:jpts), &
517                                         &   z_out(1:N_out), N_in, N_out, jpts)
518                  END DO
519               END DO
520            ENDIF
521
522            DO jj=j1,j2
523               DO ji=i1,i2
524                  DO jk=1,jpkm1
525                     tsbdiff(ji,jj,jk,1:jpts) = (ts(ji,jj,jk,1:jpts,Kbb_a) - tabres(ji,jj,jk,1:jpts))*tmask(ji,jj,jk)
526                  END DO
527               END DO
528            END DO
529
530         END IF
531
532         DO jn = 1, jpts           
533            DO jk = 1, jpkm1
534               ztu(i1-1:i2,j1-1:j2,jk) = 0._wp
535               DO jj = j1,j2
536                  DO ji = i1,i2-1
537                     zabe1 = rn_sponge_tra * r1_Dt * umask(ji,jj,jk) * e1e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a)
538                     ztu(ji,jj,jk) = zabe1 * fspu(ji,jj) * ( tsbdiff(ji+1,jj  ,jk,jn) - tsbdiff(ji,jj,jk,jn) ) 
539                  END DO
540               END DO
541               ztv(i1-1:i2,j1-1:j2,jk) = 0._wp
542               DO ji = i1,i2
543                  DO jj = j1,j2-1
544                     zabe2 = rn_sponge_tra * r1_Dt * vmask(ji,jj,jk) * e1e2v(ji,jj) * e3v(ji,jj,jk,Kmm_a)
545                     ztv(ji,jj,jk) = zabe2 * fspv(ji,jj) * ( tsbdiff(ji  ,jj+1,jk,jn) - tsbdiff(ji,jj,jk,jn) )
546                  END DO
547               END DO
548               !
549               IF( ln_zps ) THEN      ! set gradient at partial step level
550                  DO jj = j1,j2
551                     DO ji = i1,i2
552                        ! last level
553                        iku = mbku(ji,jj)
554                        ikv = mbkv(ji,jj)
555                        IF( iku == jk )   ztu(ji,jj,jk) = 0._wp
556                        IF( ikv == jk )   ztv(ji,jj,jk) = 0._wp
557                     END DO
558                  END DO
559               ENDIF
560            END DO
561            !
562! JC: there is something wrong with the Laplacian in corners
563            DO jk = 1, jpkm1
564               DO jj = j1,j2
565                  DO ji = i1,i2
566                     IF (.NOT. tabspongedone_tsn(ji,jj)) THEN
567                        zbtr = r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm_a)
568                        ! horizontal diffusive trends
569                        ztsa = zbtr * ( ztu(ji,jj,jk) - ztu(ji-1,jj,jk)   & 
570                          &           + ztv(ji,jj,jk) - ztv(ji,jj-1,jk) ) &
571                          &   - rn_trelax_tra * r1_Dt * fspt(ji,jj) * tsbdiff(ji,jj,jk,jn)
572                        ! add it to the general tracer trends
573                        ts(ji,jj,jk,jn,Krhs_a) = ts(ji,jj,jk,jn,Krhs_a) + ztsa
574                     ENDIF
575                  END DO
576               END DO
577
578            END DO
579            !
580         END DO
581         !
582         tabspongedone_tsn(i1:i2,j1:j2) = .TRUE.
583         !
584      ENDIF
585      !
586   END SUBROUTINE interptsn_sponge
587
588   
589   SUBROUTINE interpun_sponge(tabres,i1,i2,j1,j2,k1,k2,m1,m2, before)
590      !!---------------------------------------------
591      !!   *** ROUTINE interpun_sponge ***
592      !!---------------------------------------------   
593      INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,m1,m2
594      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,m1:m2), INTENT(inout) :: tabres
595      LOGICAL, INTENT(in) :: before
596
597      INTEGER  :: ji,jj,jk,jmax
598      INTEGER  :: ind1
599      ! sponge parameters
600      REAL(wp) :: ze2u, ze1v, zua, zva, zbtr, zhtot
601      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: ubdiff
602      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: rotdiff, hdivdiff
603      ! vertical interpolation:
604      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
605      REAL(wp), DIMENSION(k1:k2) :: tabin, h_in
606      REAL(wp), DIMENSION(1:jpk) :: h_out
607      INTEGER ::N_in, N_out
608      !!---------------------------------------------   
609      !
610      IF( before ) THEN
611         DO jk=k1,k2
612            DO jj=j1,j2
613               DO ji=i1,i2
614                  tabres(ji,jj,jk,m1) = uu(ji,jj,jk,Kbb_a)
615               END DO
616            END DO
617         END DO
618
619         IF ( l_vremap ) THEN
620
621            DO jk=k1,k2
622               DO jj=j1,j2
623                  DO ji=i1,i2
624                     tabres(ji,jj,jk,m2) = e3u(ji,jj,jk,Kbb_a)*umask(ji,jj,jk)
625                  END DO
626               END DO
627            END DO
628
629            ! Extrapolate thicknesses in partial bottom cells:
630            ! Set them to Agrif_SpecialValue (0.). Correct bottom thicknesses are retrieved later on
631            IF (ln_zps) THEN
632               DO jj=j1,j2
633                  DO ji=i1,i2
634                     jk = mbku(ji,jj)
635                     tabres(ji,jj,jk,m2) = 0._wp
636                  END DO
637               END DO           
638            END IF
639            ! Save ssh at last level:
640            tabres(i1:i2,j1:j2,k2,m2) = 0._wp
641            IF (.NOT.ln_linssh) THEN
642               ! This vertical sum below should be replaced by the sea-level at U-points (optimization):
643               DO jk=1,jpk
644                  tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) + e3u(i1:i2,j1:j2,jk,Kbb_a) * umask(i1:i2,j1:j2,jk)
645               END DO
646               tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) - hu_0(i1:i2,j1:j2)
647            END IF
648         END IF
649
650      ELSE
651
652         IF ( l_vremap ) THEN
653
654            IF (ln_linssh) tabres(i1:i2,j1:j2,k2,m2) = 0._wp
655
656            DO jj=j1,j2
657               DO ji=i1,i2
658                  tabres_child(ji,jj,:) = 0._wp
659                  N_in = mbku_parent(ji,jj)
660                  N_out = mbku(ji,jj)
661                  IF (N_in * N_out > 0) THEN
662                     zhtot = 0._wp
663                     DO jk=1,N_in
664                        !IF (jk==N_in) THEN
665                        !   h_in(jk) = hu0_parent(ji,jj) + tabres(ji,jj,k2,m2) - zhtot
666                        !ELSE
667                        !   h_in(jk) = tabres(ji,jj,jk,m2)
668                        !ENDIF
669                        h_in(jk) = e3u0_parent(ji,jj,jk)
670                        zhtot = zhtot + h_in(jk)
671                        tabin(jk) = tabres(ji,jj,jk,m1)
672                     END DO
673                     !         
674                     DO jk=1,N_out
675                        h_out(jk) = e3u(ji,jj,jk,Kbb_a)
676                     END DO
677
678                     ! Account for small differences in free-surface
679                     IF ( sum(h_out(1:N_out)) > sum(h_in(1:N_in) )) THEN
680                        h_out(1) = h_out(1) - ( sum(h_out(1:N_out))-sum(h_in(1:N_in)) )
681                     ELSE
682                        h_in(1)   = h_in(1)   - (sum(h_in(1:N_in))-sum(h_out(1:N_out)) )
683                     ENDIF
684                 
685                     CALL reconstructandremap(tabin(1:N_in),h_in(1:N_in),tabres_child(ji,jj,1:N_out),h_out(1:N_out),N_in,N_out,1)
686                  ENDIF
687               END DO
688            END DO
689
690            ubdiff(i1:i2,j1:j2,:) = (uu(i1:i2,j1:j2,:,Kbb_a) - tabres_child(i1:i2,j1:j2,:))*umask(i1:i2,j1:j2,:)
691         ELSE
692
693            ubdiff(i1:i2,j1:j2,:) = (uu(i1:i2,j1:j2,:,Kbb_a) - tabres(i1:i2,j1:j2,:,1))*umask(i1:i2,j1:j2,:)
694 
695         ENDIF
696         !
697         DO jk = 1, jpkm1                                 ! Horizontal slab
698            !                                             ! ===============
699
700            !                                             ! --------
701            ! Horizontal divergence                       !   div
702            !                                             ! --------
703            DO jj = j1,j2
704               DO ji = i1+1,i2   ! vector opt.
705                  zbtr = rn_sponge_dyn * r1_Dt * fspt(ji,jj) / e3t(ji,jj,jk,Kbb_a)
706                  hdivdiff(ji,jj,jk) = (  e2u(ji  ,jj)*e3u(ji  ,jj,jk,Kbb_a) * ubdiff(ji  ,jj,jk) &
707                                     &   -e2u(ji-1,jj)*e3u(ji-1,jj,jk,Kbb_a) * ubdiff(ji-1,jj,jk) ) * zbtr
708               END DO
709            END DO
710
711            DO jj = j1,j2-1
712               DO ji = i1,i2   ! vector opt.
713                  zbtr = rn_sponge_dyn * r1_Dt * fspf(ji,jj) * e3f(ji,jj,jk) 
714                  rotdiff(ji,jj,jk) = ( -e1u(ji,jj+1) * ubdiff(ji,jj+1,jk)   &
715                                    &   +e1u(ji,jj  ) * ubdiff(ji,jj  ,jk) ) * fmask(ji,jj,jk) * zbtr 
716               END DO
717            END DO
718         END DO
719         !
720         DO jj = j1+1, j2-1
721            DO ji = i1+1, i2-1   ! vector opt.
722
723               IF (.NOT. tabspongedone_u(ji,jj)) THEN
724                  DO jk = 1, jpkm1                                 ! Horizontal slab
725                     ze2u = rotdiff (ji,jj,jk)
726                     ze1v = hdivdiff(ji,jj,jk)
727                     ! horizontal diffusive trends
728                     zua = - ( ze2u - rotdiff (ji,jj-1,jk) ) / ( e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a) )   &
729                         & + ( hdivdiff(ji+1,jj,jk) - ze1v ) * r1_e1u(ji,jj) & 
730                         & - rn_trelax_dyn * r1_Dt * fspu(ji,jj) * ubdiff(ji,jj,jk)
731
732                     ! add it to the general momentum trends
733                     uu(ji,jj,jk,Krhs_a) = uu(ji,jj,jk,Krhs_a) + zua                                 
734                  END DO
735               ENDIF
736
737            END DO
738         END DO
739
740         tabspongedone_u(i1+1:i2-1,j1+1:j2-1) = .TRUE.
741
742         jmax = j2-1
743         ind1 = jpjglo - ( nn_hls + nbghostcells + 1 )   ! North
744         DO jj = mj0(ind1), mj1(ind1)                 
745            jmax = MIN(jmax,jj)
746         END DO
747
748         DO jj = j1+1, jmax
749            DO ji = i1+1, i2   ! vector opt.
750
751               IF (.NOT. tabspongedone_v(ji,jj)) THEN
752                  DO jk = 1, jpkm1                                 ! Horizontal slab
753                     ze2u = rotdiff (ji,jj,jk)
754                     ze1v = hdivdiff(ji,jj,jk)
755
756                     ! horizontal diffusive trends
757                     zva = + ( ze2u - rotdiff (ji-1,jj,jk) ) / ( e1v(ji,jj) * e3v(ji,jj,jk,Kmm_a) )   &
758                           + ( hdivdiff(ji,jj+1,jk) - ze1v ) * r1_e2v(ji,jj)
759
760                     ! add it to the general momentum trends
761                     vv(ji,jj,jk,Krhs_a) = vv(ji,jj,jk,Krhs_a) + zva
762                  END DO
763               ENDIF
764               !
765            END DO
766         END DO
767         !
768         tabspongedone_v(i1+1:i2,j1+1:jmax) = .TRUE.
769         !
770      ENDIF
771      !
772   END SUBROUTINE interpun_sponge
773
774   
775   SUBROUTINE interpvn_sponge(tabres,i1,i2,j1,j2,k1,k2,m1,m2, before)
776      !!---------------------------------------------
777      !!   *** ROUTINE interpvn_sponge ***
778      !!---------------------------------------------
779      INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,m1,m2
780      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,m1:m2), INTENT(inout) :: tabres
781      LOGICAL, INTENT(in) :: before
782      !
783      INTEGER  ::   ji, jj, jk, imax
784      INTEGER  :: ind1
785      REAL(wp) ::   ze2u, ze1v, zua, zva, zbtr, zhtot
786      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: vbdiff
787      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: rotdiff, hdivdiff
788      ! vertical interpolation:
789      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
790      REAL(wp), DIMENSION(k1:k2) :: tabin, h_in
791      REAL(wp), DIMENSION(1:jpk) :: h_out
792      INTEGER :: N_in, N_out
793      !!---------------------------------------------
794     
795      IF( before ) THEN
796         DO jk=k1,k2
797            DO jj=j1,j2
798               DO ji=i1,i2
799                  tabres(ji,jj,jk,m1) = vv(ji,jj,jk,Kbb_a)
800               END DO
801            END DO
802         END DO
803
804         IF ( l_vremap ) THEN
805
806            DO jk=k1,k2
807               DO jj=j1,j2
808                  DO ji=i1,i2
809                     tabres(ji,jj,jk,m2) = vmask(ji,jj,jk) * e3v(ji,jj,jk,Kbb_a)
810                  END DO
811               END DO
812            END DO
813            ! Extrapolate thicknesses in partial bottom cells:
814            ! Set them to Agrif_SpecialValue (0.). Correct bottom thicknesses are retrieved later on
815            IF (ln_zps) THEN
816               DO jj=j1,j2
817                  DO ji=i1,i2
818                     jk = mbkv(ji,jj)
819                     tabres(ji,jj,jk,m2) = 0._wp
820                  END DO
821               END DO           
822            END IF
823            ! Save ssh at last level:
824            tabres(i1:i2,j1:j2,k2,m2) = 0._wp
825            IF (.NOT.ln_linssh) THEN
826               ! This vertical sum below should be replaced by the sea-level at V-points (optimization):
827               DO jk=1,jpk
828                  tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) + e3v(i1:i2,j1:j2,jk,Kbb_a) * vmask(i1:i2,j1:j2,jk)
829               END DO
830               tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) - hv_0(i1:i2,j1:j2)
831            END IF
832
833         END IF
834
835      ELSE
836
837         IF ( l_vremap ) THEN
838            IF (ln_linssh) tabres(i1:i2,j1:j2,k2,m2) = 0._wp
839            DO jj=j1,j2
840               DO ji=i1,i2
841                  tabres_child(ji,jj,:) = 0._wp
842                  N_in = mbkv_parent(ji,jj)
843                  N_out = mbkv(ji,jj)
844                  IF (N_in * N_out > 0) THEN
845                     zhtot = 0._wp
846                     DO jk=1,N_in
847                        !IF (jk==N_in) THEN
848                        !   h_in(jk) = hv0_parent(ji,jj) + tabres(ji,jj,k2,m2) - zhtot
849                        !ELSE
850                        !   h_in(jk) = tabres(ji,jj,jk,m2)
851                        !ENDIF
852                        h_in(jk) = e3v0_parent(ji,jj,jk)
853                        zhtot = zhtot + h_in(jk)
854                        tabin(jk) = tabres(ji,jj,jk,m1)
855                     END DO
856                     !         
857                     DO jk=1,N_out
858                        h_out(jk) = e3v(ji,jj,jk,Kbb_a)
859                     END DO
860
861                     ! Account for small differences in free-surface
862                     IF ( sum(h_out(1:N_out)) > sum(h_in(1:N_in) )) THEN
863                        h_out(1) = h_out(1) - ( sum(h_out(1:N_out))-sum(h_in(1:N_in)) )
864                     ELSE
865                        h_in(1)   = h_in(1) - (  sum(h_in(1:N_in))-sum(h_out(1:N_out)) )
866                     ENDIF
867         
868                     CALL reconstructandremap(tabin(1:N_in),h_in(1:N_in),tabres_child(ji,jj,1:N_out),h_out(1:N_out),N_in,N_out,1)
869
870                  ENDIF
871               END DO
872            END DO
873
874            vbdiff(i1:i2,j1:j2,:) = (vv(i1:i2,j1:j2,:,Kbb_a) - tabres_child(i1:i2,j1:j2,:))*vmask(i1:i2,j1:j2,:) 
875         ELSE
876
877            vbdiff(i1:i2,j1:j2,:) = (vv(i1:i2,j1:j2,:,Kbb_a) - tabres(i1:i2,j1:j2,:,1))*vmask(i1:i2,j1:j2,:)
878
879         ENDIF
880         !
881         DO jk = 1, jpkm1                                 ! Horizontal slab
882            !                                             ! ===============
883
884            !                                             ! --------
885            ! Horizontal divergence                       !   div
886            !                                             ! --------
887            DO jj = j1+1,j2
888               DO ji = i1,i2   ! vector opt.
889                  zbtr = rn_sponge_dyn * r1_Dt * fspt(ji,jj) / e3t(ji,jj,jk,Kbb_a)
890                  hdivdiff(ji,jj,jk) = ( e1v(ji,jj  ) * e3v(ji,jj  ,jk,Kbb_a) * vbdiff(ji,jj  ,jk)  &
891                                     &  -e1v(ji,jj-1) * e3v(ji,jj-1,jk,Kbb_a) * vbdiff(ji,jj-1,jk)  ) * zbtr
892               END DO
893            END DO
894            DO jj = j1,j2
895               DO ji = i1,i2-1   ! vector opt.
896                  zbtr = rn_sponge_dyn * r1_Dt * fspf(ji,jj) * e3f(ji,jj,jk) 
897                  rotdiff(ji,jj,jk) = ( e2v(ji+1,jj) * vbdiff(ji+1,jj,jk) & 
898                                    &  -e2v(ji  ,jj) * vbdiff(ji  ,jj,jk)  ) * fmask(ji,jj,jk) * zbtr
899               END DO
900            END DO
901         END DO
902
903         !                                                ! ===============
904         !                                               
905
906         imax = i2 - 1
907         ind1 = jpiglo - ( nn_hls + nbghostcells + 1 )   ! East
908         DO ji = mi0(ind1), mi1(ind1)               
909            imax = MIN(imax,ji)
910         END DO
911         
912         DO jj = j1+1, j2
913            DO ji = i1+1, imax   ! vector opt.
914               IF( .NOT. tabspongedone_u(ji,jj) ) THEN
915                  DO jk = 1, jpkm1
916                     uu(ji,jj,jk,Krhs_a) = uu(ji,jj,jk,Krhs_a)                                                     &
917                        & - ( rotdiff (ji  ,jj,jk) - rotdiff (ji,jj-1,jk)) / ( e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a) )  &
918                        & + ( hdivdiff(ji+1,jj,jk) - hdivdiff(ji,jj  ,jk)) * r1_e1u(ji,jj)
919                  END DO
920               ENDIF
921            END DO
922         END DO
923         !
924         tabspongedone_u(i1+1:imax,j1+1:j2) = .TRUE.
925         !
926         DO jj = j1+1, j2-1
927            DO ji = i1+1, i2-1   ! vector opt.
928               IF( .NOT. tabspongedone_v(ji,jj) ) THEN
929                  DO jk = 1, jpkm1
930                     vv(ji,jj,jk,Krhs_a) = vv(ji,jj,jk,Krhs_a)                                                        &
931                        &  + ( rotdiff (ji,jj  ,jk) - rotdiff (ji-1,jj,jk) ) / ( e1v(ji,jj) * e3v(ji,jj,jk,Kmm_a) )   &
932                        &  + ( hdivdiff(ji,jj+1,jk) - hdivdiff(ji  ,jj,jk) ) * r1_e2v(ji,jj)                          &
933                        &  - rn_trelax_dyn * r1_Dt * fspv(ji,jj) * vbdiff(ji,jj,jk)
934                  END DO
935               ENDIF
936            END DO
937         END DO
938         tabspongedone_v(i1+1:i2-1,j1+1:j2-1) = .TRUE.
939      ENDIF
940      !
941   END SUBROUTINE interpvn_sponge
942
943   SUBROUTINE interpunb_sponge(tabres,i1,i2,j1,j2, before)
944      !!---------------------------------------------
945      !!   *** ROUTINE interpunb_sponge ***
946      !!---------------------------------------------   
947      INTEGER, INTENT(in) :: i1,i2,j1,j2
948      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
949      LOGICAL, INTENT(in) :: before
950
951      INTEGER  :: ji, jj, ind1, jmax
952      ! sponge parameters
953      REAL(wp) :: ze2u, ze1v, zua, zva, zbtr
954      REAL(wp), DIMENSION(i1:i2,j1:j2) :: ubdiff
955      REAL(wp), DIMENSION(i1:i2,j1:j2) :: rotdiff, hdivdiff
956      !!---------------------------------------------   
957      !
958      IF( before ) THEN
959         DO jj=j1,j2
960            DO ji=i1,i2
961               tabres(ji,jj) = uu_b(ji,jj,Kmm_a)
962            END DO
963         END DO
964
965      ELSE
966
967         ubdiff(i1:i2,j1:j2) = (uu_b(i1:i2,j1:j2,Kmm_a) - tabres(i1:i2,j1:j2))*umask(i1:i2,j1:j2,1)
968         !
969         !                                             ! --------
970         ! Horizontal divergence                       !   div
971         !                                             ! --------
972         DO jj = j1,j2
973            DO ji = i1+1,i2   ! vector opt.
974               zbtr = rn_sponge_dyn * r1_Dt * fspt_2d(ji,jj) * r1_ht_0(ji,jj)
975               hdivdiff(ji,jj) = (  e2u(ji  ,jj)*hu(ji  ,jj,Kbb_a) * ubdiff(ji  ,jj) &
976                                  &-e2u(ji-1,jj)*hu(ji-1,jj,Kbb_a) * ubdiff(ji-1,jj) ) * zbtr
977            END DO
978         END DO
979
980         DO jj = j1,j2-1
981            DO ji = i1,i2   ! vector opt.
982               zbtr = rn_sponge_dyn * r1_Dt * fspf_2d(ji,jj) * hf_0(ji,jj)
983               rotdiff(ji,jj) = ( -e1u(ji,jj+1) * ubdiff(ji,jj+1)   &
984                              &   +e1u(ji,jj  ) * ubdiff(ji,jj  ) ) * fmask(ji,jj,1) * zbtr 
985            END DO
986         END DO
987         !
988         DO jj = j1+1, j2-1
989            DO ji = i1+1, i2-1   ! vector opt.
990               IF (.NOT. tabspongedone_u(ji,jj)) THEN
991                  ze2u = rotdiff (ji,jj)
992                  ze1v = hdivdiff(ji,jj)
993                  ! horizontal diffusive trends
994                  zua = - ( ze2u - rotdiff (ji,jj-1) ) * r1_e2u(ji,jj) * r1_hu(ji,jj,Kmm_a)  &
995                      & + ( hdivdiff(ji+1,jj) - ze1v ) * r1_e1u(ji,jj)                       & 
996                      & - rn_trelax_dyn * r1_Dt * fspu_2d(ji,jj) * ubdiff(ji,jj)
997
998                  ! add it to the general momentum trends
999                  uu(ji,jj,:,Krhs_a) = uu(ji,jj,:,Krhs_a) + zua                                 
1000               ENDIF
1001            END DO
1002         END DO
1003
1004         tabspongedone_u(i1+1:i2-1,j1+1:j2-1) = .TRUE.
1005
1006         jmax = j2-1
1007         ind1 = jpjglo - ( nn_hls + nbghostcells + 1 )   ! North
1008         DO jj = mj0(ind1), mj1(ind1)                 
1009            jmax = MIN(jmax,jj)
1010         END DO
1011
1012         DO jj = j1+1, jmax
1013            DO ji = i1+1, i2   ! vector opt.
1014               IF (.NOT. tabspongedone_v(ji,jj)) THEN
1015                     ze2u = rotdiff (ji,jj)
1016                     ze1v = hdivdiff(ji,jj)
1017                     zva = + ( ze2u - rotdiff (ji-1,jj) ) * r1_e1v(ji,jj) * r1_hv(ji,jj,Kmm_a) &
1018                           + ( hdivdiff(ji,jj+1) - ze1v ) * r1_e2v(ji,jj)
1019                     vv(ji,jj,:,Krhs_a) = vv(ji,jj,:,Krhs_a) + zva
1020               ENDIF
1021            END DO
1022         END DO
1023         !
1024         tabspongedone_v(i1+1:i2,j1+1:jmax) = .TRUE.
1025         !
1026      ENDIF
1027      !
1028   END SUBROUTINE interpunb_sponge
1029
1030   
1031   SUBROUTINE interpvnb_sponge(tabres,i1,i2,j1,j2, before)
1032      !!---------------------------------------------
1033      !!   *** ROUTINE interpvnb_sponge ***
1034      !!---------------------------------------------
1035      INTEGER, INTENT(in) :: i1,i2,j1,j2
1036      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) :: tabres
1037      LOGICAL, INTENT(in) :: before
1038      !
1039      INTEGER  ::   ji, jj, ind1, imax
1040      REAL(wp) ::   ze2u, ze1v, zua, zva, zbtr
1041      REAL(wp), DIMENSION(i1:i2,j1:j2) :: vbdiff
1042      REAL(wp), DIMENSION(i1:i2,j1:j2) :: rotdiff, hdivdiff
1043      !!---------------------------------------------
1044     
1045      IF( before ) THEN
1046         DO jj=j1,j2
1047            DO ji=i1,i2
1048               tabres(ji,jj) = vv_b(ji,jj,Kmm_a)
1049            END DO
1050         END DO
1051      ELSE
1052         vbdiff(i1:i2,j1:j2) = (vv_b(i1:i2,j1:j2,Kmm_a) - tabres(i1:i2,j1:j2))*vmask(i1:i2,j1:j2,1)
1053         !                                             ! --------
1054         ! Horizontal divergence                       !   div
1055         !                                             ! --------
1056         DO jj = j1+1,j2
1057            DO ji = i1,i2   ! vector opt.
1058               zbtr = rn_sponge_dyn * r1_Dt * fspt_2d(ji,jj) * r1_ht_0(ji,jj)
1059               hdivdiff(ji,jj) = ( e1v(ji,jj  ) * hv(ji,jj  ,Kbb_a) * vbdiff(ji,jj  )  &
1060                               &  -e1v(ji,jj-1) * hv(ji,jj-1,Kbb_a) * vbdiff(ji,jj-1)  ) * zbtr
1061            END DO
1062         END DO
1063         DO jj = j1,j2
1064            DO ji = i1,i2-1   ! vector opt.
1065               zbtr = rn_sponge_dyn * r1_Dt * fspf_2d(ji,jj) * hf_0(ji,jj) 
1066               rotdiff(ji,jj) = ( e2v(ji+1,jj) * vbdiff(ji+1,jj) & 
1067                              &  -e2v(ji  ,jj) * vbdiff(ji  ,jj)  ) * fmask(ji,jj,1) * zbtr
1068            END DO
1069         END DO
1070         !                                                ! ===============
1071         !                                               
1072
1073         imax = i2 - 1
1074         ind1 = jpiglo - ( nn_hls + nbghostcells + 1 )   ! East
1075         DO ji = mi0(ind1), mi1(ind1)               
1076            imax = MIN(imax,ji)
1077         END DO
1078         
1079         DO jj = j1+1, j2
1080            DO ji = i1+1, imax   ! vector opt.
1081               IF( .NOT. tabspongedone_u(ji,jj) ) THEN                                                     
1082                  zua = - ( rotdiff (ji  ,jj) - rotdiff (ji,jj-1)) * r1_e2u(ji,jj) * r1_hu(ji,jj,Kmm_a)  &
1083                      & + ( hdivdiff(ji+1,jj) - hdivdiff(ji,jj  )) * r1_e1u(ji,jj)
1084                  uu(ji,jj,:,Krhs_a) = uu(ji,jj,:,Krhs_a) + zua
1085               ENDIF
1086            END DO
1087         END DO
1088         !
1089         tabspongedone_u(i1+1:imax,j1+1:j2) = .TRUE.
1090         !
1091         DO jj = j1+1, j2-1
1092            DO ji = i1+1, i2-1   ! vector opt.
1093               IF( .NOT. tabspongedone_v(ji,jj) ) THEN
1094                  zva  =  ( rotdiff (ji,jj  ) - rotdiff (ji-1,jj) ) * r1_e1v(ji,jj) *r1_hv(ji,jj,Kmm_a) &
1095                     &  + ( hdivdiff(ji,jj+1) - hdivdiff(ji  ,jj) ) * r1_e2v(ji,jj)                     &
1096                     &  - rn_trelax_dyn * r1_Dt * fspv_2d(ji,jj) * vbdiff(ji,jj)
1097                  vv(ji,jj,:,Krhs_a) = vv(ji,jj,:,Krhs_a) + zva
1098               ENDIF
1099            END DO
1100         END DO
1101         tabspongedone_v(i1+1:i2-1,j1+1:j2-1) = .TRUE.
1102      ENDIF
1103      !
1104   END SUBROUTINE interpvnb_sponge
1105
1106
1107#else
1108   !!----------------------------------------------------------------------
1109   !!   Empty module                                          no AGRIF zoom
1110   !!----------------------------------------------------------------------
1111CONTAINS
1112   SUBROUTINE agrif_oce_sponge_empty
1113      WRITE(*,*)  'agrif_oce_sponge : You should not have seen this print! error?'
1114   END SUBROUTINE agrif_oce_sponge_empty
1115#endif
1116
1117   !!======================================================================
1118END MODULE agrif_oce_sponge
Note: See TracBrowser for help on using the repository browser.