source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/NST/agrif_oce_sponge.F90

Last change on this file was 13228, checked in by smasson, 4 months ago

better e3: update with trunk@13227 see #2385

  • Property svn:keywords set to Id
File size: 32.4 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 (OPA)
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_Tra, Agrif_Sponge_Dyn
31   PUBLIC interptsn_sponge, interpun_sponge, interpvn_sponge
32
33   !! * Substitutions
34#  include "do_loop_substitute.h90"
35   !!----------------------------------------------------------------------
36   !! NEMO/NST 4.0 , NEMO Consortium (2018)
37   !! $Id$
38   !! Software governed by the CeCILL license (see ./LICENSE)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE Agrif_Sponge_Tra
43      !!----------------------------------------------------------------------
44      !!                 *** ROUTINE Agrif_Sponge_Tra ***
45      !!----------------------------------------------------------------------
46      REAL(wp) ::   zcoef   ! local scalar
47     
48      !!----------------------------------------------------------------------
49      !
50#if defined SPONGE
51      !! Assume persistence:
52      zcoef = REAL(Agrif_rhot()-1,wp)/REAL(Agrif_rhot())
53
54      CALL Agrif_Sponge
55      Agrif_SpecialValue    = 0._wp
56      Agrif_UseSpecialValue = .TRUE.
57      tabspongedone_tsn     = .FALSE.
58      !
59      CALL Agrif_Bc_Variable( tsn_sponge_id, calledweight=zcoef, procname=interptsn_sponge )
60      !
61      Agrif_UseSpecialValue = .FALSE.
62#endif
63      !
64      CALL iom_put( 'agrif_spu', fspu(:,:))
65      CALL iom_put( 'agrif_spv', fspv(:,:))
66      !
67   END SUBROUTINE Agrif_Sponge_Tra
68
69
70   SUBROUTINE Agrif_Sponge_dyn
71      !!----------------------------------------------------------------------
72      !!                 *** ROUTINE Agrif_Sponge_dyn ***
73      !!----------------------------------------------------------------------
74      REAL(wp) ::   zcoef   ! local scalar
75      !!----------------------------------------------------------------------
76      !
77#if defined SPONGE
78      zcoef = REAL(Agrif_rhot()-1,wp)/REAL(Agrif_rhot())
79
80      Agrif_SpecialValue=0.
81      Agrif_UseSpecialValue = ln_spc_dyn
82      use_sign_north = .TRUE.
83      sign_north = -1.
84      !
85      tabspongedone_u = .FALSE.
86      tabspongedone_v = .FALSE.         
87      CALL Agrif_Bc_Variable( un_sponge_id, calledweight=zcoef, procname=interpun_sponge )
88      !
89      tabspongedone_u = .FALSE.
90      tabspongedone_v = .FALSE.
91      CALL Agrif_Bc_Variable( vn_sponge_id, calledweight=zcoef, procname=interpvn_sponge )
92      !
93      Agrif_UseSpecialValue = .FALSE.
94      use_sign_north = .FALSE.
95#endif
96      !
97      CALL iom_put( 'agrif_spt', fspt(:,:))
98      CALL iom_put( 'agrif_spf', fspf(:,:))
99      !
100   END SUBROUTINE Agrif_Sponge_dyn
101
102
103   SUBROUTINE Agrif_Sponge
104      !!----------------------------------------------------------------------
105      !!                 *** ROUTINE  Agrif_Sponge ***
106      !!----------------------------------------------------------------------
107      INTEGER  ::   ji, jj, ind1, ind2
108      INTEGER  ::   ispongearea, jspongearea
109      REAL(wp) ::   z1_ispongearea, z1_jspongearea
110      REAL(wp), DIMENSION(jpi,jpj) :: ztabramp
111      REAL(wp), DIMENSION(jpjmax)  :: zmskwest,  zmskeast
112      REAL(wp), DIMENSION(jpimax)  :: zmsknorth, zmsksouth
113      !!----------------------------------------------------------------------
114      !
115      ! Sponge 1d example with:
116      !      iraf = 3 ; nbghost = 3 ; nn_sponge_len = 2
117      !                       
118      !coarse :     U     T     U     T     U     T     U
119      !|            |           |           |           |
120      !fine :     t u t u t u t u t u t u t u t u t u t u t
121      !sponge val:0   0   0   1  5/6 4/6 3/6 2/6 1/6  0   0
122      !           |   ghost     | <-- sponge area  -- > |
123      !           |   points    |                       |
124      !                         |--> dynamical interface
125
126#if defined SPONGE || defined SPONGE_TOP
127      IF (( .NOT. spongedoneT ).OR.( .NOT. spongedoneU )) THEN
128         !
129         ! Retrieve masks at open boundaries:
130
131         ! --- West --- !
132         IF( lk_west) THEN
133            ztabramp(:,:) = 0._wp
134            ind1 = 1+nbghostcells
135            DO ji = mi0(ind1), mi1(ind1)               
136               ztabramp(ji,:) = ssumask(ji,:)
137            END DO
138            !
139            zmskwest(:) = 0._wp
140            zmskwest(1:jpj) = MAXVAL(ztabramp(:,:), dim=1)
141         ENDIF
142
143         ! --- East --- !
144         IF( lk_east ) THEN
145            ztabramp(:,:) = 0._wp
146            ind1 = jpiglo - nbghostcells - 1
147            DO ji = mi0(ind1), mi1(ind1)                 
148               ztabramp(ji,:) = ssumask(ji,:)
149            END DO
150            !
151            zmskeast(:) = 0._wp
152            zmskeast(1:jpj) = MAXVAL(ztabramp(:,:), dim=1)
153         ENDIF
154
155         ! --- South --- !
156         IF( lk_south ) THEN
157            ztabramp(:,:) = 0._wp
158            ind1 = 1+nbghostcells
159            DO jj = mj0(ind1), mj1(ind1)                 
160               ztabramp(:,jj) = ssvmask(:,jj)
161            END DO
162            !
163            zmsksouth(:) = 0._wp
164            zmsksouth(1:jpi) = MAXVAL(ztabramp(:,:), dim=2)
165         ENDIF
166
167         ! --- North --- !
168         IF( lk_north) THEN
169            ztabramp(:,:) = 0._wp
170            ind1 = jpjglo - nbghostcells - 1
171            DO jj = mj0(ind1), mj1(ind1)                 
172               ztabramp(:,jj) = ssvmask(:,jj)
173            END DO
174            !
175            zmsknorth(:) = 0._wp
176            zmsknorth(1:jpi) = MAXVAL(ztabramp(:,:), dim=2)
177         ENDIF
178
179         ! JC: SPONGE MASKING TO BE SORTED OUT:
180         zmskwest(:)  = 1._wp
181         zmskeast(:)  = 1._wp
182         zmsknorth(:) = 1._wp
183         zmsksouth(:) = 1._wp
184#if defined key_mpp_mpi
185!         CALL mpp_max( 'AGRIF_sponge', zmskwest(:) , jpjmax )
186!         CALL mpp_max( 'AGRIF_Sponge', zmskeast(:) , jpjmax )
187!         CALL mpp_max( 'AGRIF_Sponge', zmsksouth(:), jpimax )
188!         CALL mpp_max( 'AGRIF_Sponge', zmsknorth(:), jpimax )
189#endif
190
191         ! Define ramp from boundaries towards domain interior at T-points
192         ! Store it in ztabramp
193
194         ispongearea  = nn_sponge_len * Agrif_irhox()
195         z1_ispongearea = 1._wp / REAL( ispongearea )
196         jspongearea  = nn_sponge_len * Agrif_irhoy()
197         z1_jspongearea = 1._wp / REAL( jspongearea )
198         
199         ztabramp(:,:) = 0._wp
200
201         ! Trick to remove sponge in 2DV domains:
202         IF ( nbcellsx <= 3 ) ispongearea = -1
203         IF ( nbcellsy <= 3 ) jspongearea = -1
204
205         ! --- West --- !
206         IF(lk_west) THEN
207            ind1 = 1+nbghostcells
208            ind2 = 1+nbghostcells + ispongearea 
209            DO ji = mi0(ind1), mi1(ind2)   
210               DO jj = 1, jpj               
211                  ztabramp(ji,jj) = REAL( ind2 - mig(ji) ) * z1_ispongearea * zmskwest(jj)
212               END DO
213            END DO         
214
215            ! ghost cells:
216            ind1 = 1
217            ind2 = nbghostcells + 1
218            DO ji = mi0(ind1), mi1(ind2)   
219               DO jj = 1, jpj               
220                  ztabramp(ji,jj) = zmskwest(jj)
221               END DO
222            END DO
223         ENDIF
224
225         ! --- East --- !
226         IF(lk_east) THEN
227            ind1 = jpiglo - nbghostcells - ispongearea
228            ind2 = jpiglo - nbghostcells
229            DO ji = mi0(ind1), mi1(ind2)
230
231               DO jj = 1, jpj
232                  ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL( mig(ji) - ind1 ) * z1_ispongearea) * zmskeast(jj)
233               ENDDO
234            END DO
235
236            ! ghost cells:
237            ind1 = jpiglo - nbghostcells
238            ind2 = jpiglo
239            DO ji = mi0(ind1), mi1(ind2)
240
241               DO jj = 1, jpj
242                  ztabramp(ji,jj) = zmskeast(jj)
243               ENDDO
244            END DO
245         ENDIF
246
247         ! --- South --- !
248         IF( lk_south ) THEN
249            ind1 = 1+nbghostcells
250            ind2 = 1+nbghostcells + jspongearea
251            DO jj = mj0(ind1), mj1(ind2) 
252               DO ji = 1, jpi
253                  ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL( ind2 - mjg(jj) ) * z1_jspongearea) * zmsksouth(ji)
254               END DO
255            END DO
256
257            ! ghost cells:
258            ind1 = 1
259            ind2 = nbghostcells + 1
260            DO jj = mj0(ind1), mj1(ind2) 
261               DO ji = 1, jpi
262                  ztabramp(ji,jj) = zmsksouth(ji)
263               END DO
264            END DO
265         ENDIF
266
267         ! --- North --- !
268         IF( lk_north ) THEN 
269            ind1 = jpjglo - nbghostcells - jspongearea
270            ind2 = jpjglo - nbghostcells
271            DO jj = mj0(ind1), mj1(ind2)
272               DO ji = 1, jpi
273                  ztabramp(ji,jj) = MAX( ztabramp(ji,jj), REAL( mjg(jj) - ind1 ) * z1_jspongearea) * zmsknorth(ji)
274               END DO
275            END DO
276
277            ! ghost cells:
278            ind1 = jpjglo - nbghostcells
279            ind2 = jpjglo
280            DO jj = mj0(ind1), mj1(ind2)
281               DO ji = 1, jpi
282                  ztabramp(ji,jj) = zmsknorth(ji)
283               END DO
284            END DO
285         ENDIF
286     
287      ENDIF
288
289      ! Tracers
290      IF( .NOT. spongedoneT ) THEN
291         fspu(:,:) = 0._wp
292         fspv(:,:) = 0._wp
293         DO_2D_00_00
294            fspu(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji+1,jj  ) ) * ssumask(ji,jj)
295            fspv(ji,jj) = 0.5_wp * ( ztabramp(ji,jj) + ztabramp(ji  ,jj+1) ) * ssvmask(ji,jj)
296         END_2D
297         CALL lbc_lnk( 'agrif_Sponge', fspu, 'U', 1.0_wp )   ! Lateral boundary conditions
298         CALL lbc_lnk( 'agrif_Sponge', fspv, 'V', 1.0_wp )
299
300         spongedoneT = .TRUE.
301      ENDIF
302
303      ! Dynamics
304      IF( .NOT. spongedoneU ) THEN
305         fspt(:,:) = 0._wp
306         fspf(:,:) = 0._wp
307         DO_2D_00_00
308            fspt(ji,jj) = ztabramp(ji,jj) * ssmask(ji,jj)
309            fspf(ji,jj) = 0.25_wp * ( ztabramp(ji  ,jj  ) + ztabramp(ji  ,jj+1)   &
310                                  &  +ztabramp(ji+1,jj+1) + ztabramp(ji+1,jj  ) ) &
311                                  &  * ssvmask(ji,jj) * ssvmask(ji,jj+1)
312         END_2D
313         CALL lbc_lnk( 'agrif_Sponge', fspt, 'T', 1.0_wp )   ! Lateral boundary conditions
314         CALL lbc_lnk( 'agrif_Sponge', fspf, 'F', 1.0_wp )
315         
316         spongedoneU = .TRUE.
317      ENDIF
318
319#if defined key_vertical
320      ! Remove vertical interpolation where not needed:
321      DO_2D_00_00
322         IF ((fspu(ji-1,jj)==0._wp).AND.(fspu(ji,jj)==0._wp).AND. &
323         &   (fspv(ji,jj-1)==0._wp).AND.(fspv(ji,jj)==0._wp)) mbkt_parent(ji,jj) = 0
324!
325         IF ((fspt(ji+1,jj)==0._wp).AND.(fspt(ji,jj)==0._wp).AND. &
326         &   (fspf(ji,jj-1)==0._wp).AND.(fspf(ji,jj)==0._wp)) mbku_parent(ji,jj) = 0
327!
328         IF ((fspt(ji,jj+1)==0._wp).AND.(fspt(ji,jj)==0._wp).AND. &
329         &   (fspf(ji-1,jj)==0._wp).AND.(fspf(ji,jj)==0._wp)) mbkv_parent(ji,jj) = 0
330!
331         IF ( ssmask(ji,jj) == 0._wp) mbkt_parent(ji,jj) = 0
332         IF (ssumask(ji,jj) == 0._wp) mbku_parent(ji,jj) = 0
333         IF (ssvmask(ji,jj) == 0._wp) mbkv_parent(ji,jj) = 0
334      END_2D
335      !
336      ztabramp(:,:) = REAL( mbkt_parent(:,:), wp )   ;   CALL lbc_lnk( 'Agrif_Sponge', ztabramp, 'T', 1.0_wp )
337      mbkt_parent(:,:) = NINT( ztabramp(:,:) )
338      ztabramp(:,:) = REAL( mbku_parent(:,:), wp )   ;   CALL lbc_lnk( 'Agrif_Sponge', ztabramp, 'U', 1.0_wp )
339      mbku_parent(:,:) = NINT( ztabramp(:,:) )
340      ztabramp(:,:) = REAL( mbkv_parent(:,:), wp )   ;   CALL lbc_lnk( 'Agrif_Sponge', ztabramp, 'V', 1.0_wp )
341      mbkv_parent(:,:) = NINT( ztabramp(:,:) )
342#endif
343      !
344#endif
345      !
346   END SUBROUTINE Agrif_Sponge
347
348   SUBROUTINE interptsn_sponge( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before )
349      !!----------------------------------------------------------------------
350      !!                 *** ROUTINE interptsn_sponge ***
351      !!----------------------------------------------------------------------
352      INTEGER                                     , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2, n1, n2
353      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) ::   tabres
354      LOGICAL                                     , INTENT(in   ) ::   before
355      !
356      INTEGER  ::   ji, jj, jk, jn   ! dummy loop indices
357      INTEGER  ::   iku, ikv
358      REAL(wp) :: ztsa, zabe1, zabe2, zbtr, zhtot
359      REAL(wp), DIMENSION(i1:i2,j1:j2,jpk) :: ztu, ztv
360      REAL(wp), DIMENSION(i1:i2,j1:j2,jpk,n1:n2) ::tsbdiff
361      ! vertical interpolation:
362      REAL(wp), DIMENSION(i1:i2,j1:j2,jpk,n1:n2) ::tabres_child
363      REAL(wp), DIMENSION(k1:k2,n1:n2-1) :: tabin
364      REAL(wp), DIMENSION(k1:k2) :: h_in
365      REAL(wp), DIMENSION(1:jpk) :: h_out
366      INTEGER :: N_in, N_out
367      !!----------------------------------------------------------------------
368      !
369      IF( before ) THEN
370         DO jn = 1, jpts
371            DO jk=k1,k2
372               DO jj=j1,j2
373                  DO ji=i1,i2
374                     tabres(ji,jj,jk,jn) = ts(ji,jj,jk,jn,Kbb_a)
375                  END DO
376               END DO
377            END DO
378         END DO
379
380# if defined key_vertical
381        ! Interpolate thicknesses
382        ! Warning: these are masked, hence extrapolated prior interpolation.
383        DO jk=k1,k2
384           DO jj=j1,j2
385              DO ji=i1,i2
386                  tabres(ji,jj,jk,jpts+1) = tmask(ji,jj,jk) * e3t(ji,jj,jk,Kbb_a)
387              END DO
388           END DO
389        END DO
390
391        ! Extrapolate thicknesses in partial bottom cells:
392        ! Set them to Agrif_SpecialValue (0.). Correct bottom thicknesses are retrieved later on
393        IF (ln_zps) THEN
394           DO jj=j1,j2
395              DO ji=i1,i2
396                  jk = mbkt(ji,jj)
397                  tabres(ji,jj,jk,jpts+1) = 0._wp
398              END DO
399           END DO           
400        END IF
401     
402        ! Save ssh at last level:
403        IF (.NOT.ln_linssh) THEN
404           tabres(i1:i2,j1:j2,k2,jpts+1) = ssh(i1:i2,j1:j2,Kbb_a)*tmask(i1:i2,j1:j2,1) 
405        ELSE
406           tabres(i1:i2,j1:j2,k2,jpts+1) = 0._wp
407        END IF     
408# endif
409
410      ELSE   
411         !
412# if defined key_vertical
413
414         IF (ln_linssh) tabres(i1:i2,j1:j2,k2,n2) = 0._wp
415
416         DO jj=j1,j2
417            DO ji=i1,i2
418               tabres_child(ji,jj,:,:) = 0._wp 
419               N_in = mbkt_parent(ji,jj)
420               zhtot = 0._wp
421               DO jk=1,N_in !k2 = jpk of parent grid
422                  IF (jk==N_in) THEN
423                     h_in(jk) = ht0_parent(ji,jj) + tabres(ji,jj,k2,n2) - zhtot
424                  ELSE
425                     h_in(jk) = tabres(ji,jj,jk,n2)
426                  ENDIF
427                  zhtot = zhtot + h_in(jk)
428                  tabin(jk,:) = tabres(ji,jj,jk,n1:n2-1)
429               END DO
430               N_out = 0
431               DO jk=1,jpk ! jpk of child grid
432                  IF (tmask(ji,jj,jk) == 0) EXIT
433                  N_out = N_out + 1
434                  h_out(jk) = e3t(ji,jj,jk,Kbb_a) !Child grid scale factors. Could multiply by e1e2t here instead of division above
435               ENDDO
436
437               ! Account for small differences in free-surface
438               IF ( sum(h_out(1:N_out)) > sum(h_in(1:N_in) )) THEN
439                  h_out(1) = h_out(1) - ( sum(h_out(1:N_out))-sum(h_in(1:N_in)) )
440               ELSE
441                  h_in(1)   = h_in(1)   - (sum(h_in(1:N_in))-sum(h_out(1:N_out)) )
442               ENDIF
443               IF (N_in*N_out > 0) THEN
444                  CALL reconstructandremap(tabin(1:N_in,1:jpts),h_in(1:N_in),tabres_child(ji,jj,1:N_out,1:jpts),h_out(1:N_out),N_in,N_out,jpts)
445               ENDIF
446            ENDDO
447         ENDDO
448# endif
449
450         DO jj=j1,j2
451            DO ji=i1,i2
452               DO jk=1,jpkm1
453# if defined key_vertical
454                  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)
455# else
456                  tsbdiff(ji,jj,jk,1:jpts) = (ts(ji,jj,jk,1:jpts,Kbb_a) - tabres(ji,jj,jk,1:jpts))*tmask(ji,jj,jk)
457# endif
458               ENDDO
459            ENDDO
460         ENDDO
461
462         DO jn = 1, jpts           
463            DO jk = 1, jpkm1
464               ztu(i1:i2,j1:j2,jk) = 0._wp
465               DO jj = j1,j2
466                  DO ji = i1,i2-1
467                     zabe1 = rn_sponge_tra * r1_Dt * fspu(ji,jj) * umask(ji,jj,jk) * e1e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a)
468                     ztu(ji,jj,jk) = zabe1 * ( tsbdiff(ji+1,jj  ,jk,jn) - tsbdiff(ji,jj,jk,jn) ) 
469                  END DO
470               END DO
471               ztv(i1:i2,j1:j2,jk) = 0._wp
472               DO ji = i1,i2
473                  DO jj = j1,j2-1
474                     zabe2 = rn_sponge_tra * r1_Dt * fspv(ji,jj) * vmask(ji,jj,jk) * e1e2v(ji,jj) * e3v(ji,jj,jk,Kmm_a)
475                     ztv(ji,jj,jk) = zabe2 * ( tsbdiff(ji  ,jj+1,jk,jn) - tsbdiff(ji,jj,jk,jn) )
476                  END DO
477               END DO
478               !
479               IF( ln_zps ) THEN      ! set gradient at partial step level
480                  DO jj = j1,j2
481                     DO ji = i1,i2
482                        ! last level
483                        iku = mbku(ji,jj)
484                        ikv = mbkv(ji,jj)
485                        IF( iku == jk )   ztu(ji,jj,jk) = 0._wp
486                        IF( ikv == jk )   ztv(ji,jj,jk) = 0._wp
487                     END DO
488                  END DO
489               ENDIF
490            END DO
491            !
492            DO jk = 1, jpkm1
493               DO jj = j1+1,j2-1
494                  DO ji = i1+1,i2-1
495                     IF (.NOT. tabspongedone_tsn(ji,jj)) THEN
496                        zbtr = r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm_a)
497                        ! horizontal diffusive trends
498                        ztsa = zbtr * (  ztu(ji,jj,jk) - ztu(ji-1,jj,jk) + ztv(ji,jj,jk) - ztv(ji,jj-1,jk)  ) &
499                             &  - rn_trelax_tra * r1_Dt * fspt(ji,jj) * tsbdiff(ji,jj,jk,jn) 
500                        ! add it to the general tracer trends
501                        ts(ji,jj,jk,jn,Krhs_a) = ts(ji,jj,jk,jn,Krhs_a) + ztsa
502                     ENDIF
503                  END DO
504               END DO
505            END DO
506            !
507         END DO
508         !
509         tabspongedone_tsn(i1+1:i2-1,j1+1:j2-1) = .TRUE.
510         !
511      ENDIF
512      !
513   END SUBROUTINE interptsn_sponge
514
515   SUBROUTINE interpun_sponge(tabres,i1,i2,j1,j2,k1,k2,m1,m2, before)
516      !!---------------------------------------------
517      !!   *** ROUTINE interpun_sponge ***
518      !!---------------------------------------------   
519      INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,m1,m2
520      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,m1:m2), INTENT(inout) :: tabres
521      LOGICAL, INTENT(in) :: before
522
523      INTEGER :: ji,jj,jk,jmax
524
525      ! sponge parameters
526      REAL(wp) :: ze2u, ze1v, zua, zva, zbtr, zhtot
527      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: ubdiff
528      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: rotdiff, hdivdiff
529      ! vertical interpolation:
530      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
531      REAL(wp), DIMENSION(k1:k2) :: tabin, h_in
532      REAL(wp), DIMENSION(1:jpk) :: h_out
533      INTEGER ::N_in, N_out
534      !!---------------------------------------------   
535      !
536      IF( before ) THEN
537         DO jk=k1,k2
538            DO jj=j1,j2
539               DO ji=i1,i2
540                  tabres(ji,jj,jk,m1) = uu(ji,jj,jk,Kbb_a)
541# if defined key_vertical
542                  tabres(ji,jj,jk,m2) = e3u(ji,jj,jk,Kbb_a)*umask(ji,jj,jk)
543# endif
544               END DO
545            END DO
546         END DO
547
548# if defined key_vertical
549         ! Extrapolate thicknesses in partial bottom cells:
550         ! Set them to Agrif_SpecialValue (0.). Correct bottom thicknesses are retrieved later on
551         IF (ln_zps) THEN
552            DO jj=j1,j2
553               DO ji=i1,i2
554                  jk = mbku(ji,jj)
555                  tabres(ji,jj,jk,m2) = 0._wp
556               END DO
557            END DO           
558         END IF
559        ! Save ssh at last level:
560        tabres(i1:i2,j1:j2,k2,m2) = 0._wp
561        IF (.NOT.ln_linssh) THEN
562           ! This vertical sum below should be replaced by the sea-level at U-points (optimization):
563           DO jk=1,jpk
564              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)
565           END DO
566           tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) - hu_0(i1:i2,j1:j2)
567        END IF 
568# endif
569
570      ELSE
571
572# if defined key_vertical
573         IF (ln_linssh) tabres(i1:i2,j1:j2,k2,m2) = 0._wp
574
575         DO jj=j1,j2
576            DO ji=i1,i2
577               tabres_child(ji,jj,:) = 0._wp
578               N_in = mbku_parent(ji,jj)
579               zhtot = 0._wp
580               DO jk=1,N_in
581                  IF (jk==N_in) THEN
582                     h_in(jk) = hu0_parent(ji,jj) + tabres(ji,jj,k2,m2) - zhtot
583                  ELSE
584                     h_in(jk) = tabres(ji,jj,jk,m2)
585                  ENDIF
586                  zhtot = zhtot + h_in(jk)
587                  tabin(jk) = tabres(ji,jj,jk,m1)
588               ENDDO
589               !         
590               N_out = 0
591               DO jk=1,jpk
592                  IF (umask(ji,jj,jk) == 0) EXIT
593                  N_out = N_out + 1
594                  h_out(N_out) = e3u(ji,jj,jk,Kbb_a)
595               ENDDO
596
597               ! Account for small differences in free-surface
598               IF ( sum(h_out(1:N_out)) > sum(h_in(1:N_in) )) THEN
599                  h_out(1) = h_out(1) - ( sum(h_out(1:N_out))-sum(h_in(1:N_in)) )
600               ELSE
601                  h_in(1)   = h_in(1)   - (sum(h_in(1:N_in))-sum(h_out(1:N_out)) )
602               ENDIF
603                 
604               IF (N_in * N_out > 0) THEN
605                  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)
606               ENDIF
607            ENDDO
608         ENDDO
609
610         ubdiff(i1:i2,j1:j2,:) = (uu(i1:i2,j1:j2,:,Kbb_a) - tabres_child(i1:i2,j1:j2,:))*umask(i1:i2,j1:j2,:)
611#else
612         ubdiff(i1:i2,j1:j2,:) = (uu(i1:i2,j1:j2,:,Kbb_a) - tabres(i1:i2,j1:j2,:,1))*umask(i1:i2,j1:j2,:)
613#endif
614         !
615         DO jk = 1, jpkm1                                 ! Horizontal slab
616            !                                             ! ===============
617
618            !                                             ! --------
619            ! Horizontal divergence                       !   div
620            !                                             ! --------
621            DO jj = j1,j2
622               DO ji = i1+1,i2   ! vector opt.
623                  zbtr = rn_sponge_dyn * r1_Dt * fspt(ji,jj) / e3t(ji,jj,jk,Kbb_a)
624                  hdivdiff(ji,jj,jk) = (  e2u(ji  ,jj)*e3u(ji  ,jj,jk,Kbb_a) * ubdiff(ji  ,jj,jk) &
625                                     &   -e2u(ji-1,jj)*e3u(ji-1,jj,jk,Kbb_a) * ubdiff(ji-1,jj,jk) ) * zbtr
626               END DO
627            END DO
628
629            DO jj = j1,j2-1
630               DO ji = i1,i2   ! vector opt.
631                  zbtr = rn_sponge_dyn * r1_Dt * fspf(ji,jj) * e3f(ji,jj,jk) 
632                  rotdiff(ji,jj,jk) = ( -e1u(ji,jj+1) * ubdiff(ji,jj+1,jk)   &
633                                    &   +e1u(ji,jj  ) * ubdiff(ji,jj  ,jk) ) * fmask(ji,jj,jk) * zbtr 
634               END DO
635            END DO
636         END DO
637         !
638         DO jj = j1+1, j2-1
639            DO ji = i1+1, i2-1   ! vector opt.
640
641               IF (.NOT. tabspongedone_u(ji,jj)) THEN
642                  DO jk = 1, jpkm1                                 ! Horizontal slab
643                     ze2u = rotdiff (ji,jj,jk)
644                     ze1v = hdivdiff(ji,jj,jk)
645                     ! horizontal diffusive trends
646                     zua = - ( ze2u - rotdiff (ji,jj-1,jk) ) / ( e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a) )   &
647                         & + ( hdivdiff(ji+1,jj,jk) - ze1v ) * r1_e1u(ji,jj) & 
648                         & - rn_trelax_dyn * r1_Dt * fspu(ji,jj) * ubdiff(ji,jj,jk)
649
650                     ! add it to the general momentum trends
651                     uu(ji,jj,jk,Krhs_a) = uu(ji,jj,jk,Krhs_a) + zua                                 
652                  END DO
653               ENDIF
654
655            END DO
656         END DO
657
658         tabspongedone_u(i1+1:i2-1,j1+1:j2-1) = .TRUE.
659
660         jmax = j2-1
661        ! IF (lk_north) jmax = MIN(jmax,nlcj-nbghostcells-2)   ! North
662         IF ((nbondj == 1).OR.(nbondj == 2)) jmax = MIN(jmax,nlcj-nbghostcells-2)   ! North
663
664         DO jj = j1+1, jmax
665            DO ji = i1+1, i2   ! vector opt.
666
667               IF (.NOT. tabspongedone_v(ji,jj)) THEN
668                  DO jk = 1, jpkm1                                 ! Horizontal slab
669                     ze2u = rotdiff (ji,jj,jk)
670                     ze1v = hdivdiff(ji,jj,jk)
671
672                     ! horizontal diffusive trends
673                     zva = + ( ze2u - rotdiff (ji-1,jj,jk) ) / ( e1v(ji,jj) * e3v(ji,jj,jk,Kmm_a) )   &
674                           + ( hdivdiff(ji,jj+1,jk) - ze1v ) * r1_e2v(ji,jj)
675
676                     ! add it to the general momentum trends
677                     vv(ji,jj,jk,Krhs_a) = vv(ji,jj,jk,Krhs_a) + zva
678                  END DO
679               ENDIF
680               !
681            END DO
682         END DO
683         !
684         tabspongedone_v(i1+1:i2,j1+1:jmax) = .TRUE.
685         !
686      ENDIF
687      !
688   END SUBROUTINE interpun_sponge
689
690   SUBROUTINE interpvn_sponge(tabres,i1,i2,j1,j2,k1,k2,m1,m2, before,nb,ndir)
691      !!---------------------------------------------
692      !!   *** ROUTINE interpvn_sponge ***
693      !!---------------------------------------------
694      INTEGER, INTENT(in) :: i1,i2,j1,j2,k1,k2,m1,m2
695      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,m1:m2), INTENT(inout) :: tabres
696      LOGICAL, INTENT(in) :: before
697      INTEGER, INTENT(in) :: nb , ndir
698      !
699      INTEGER  ::   ji, jj, jk, imax
700      REAL(wp) ::   ze2u, ze1v, zua, zva, zbtr, zhtot
701      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: vbdiff
702      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: rotdiff, hdivdiff
703      ! vertical interpolation:
704      REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk) :: tabres_child
705      REAL(wp), DIMENSION(k1:k2) :: tabin, h_in
706      REAL(wp), DIMENSION(1:jpk) :: h_out
707      INTEGER :: N_in, N_out
708      !!---------------------------------------------
709     
710      IF( before ) THEN
711         DO jk=k1,k2
712            DO jj=j1,j2
713               DO ji=i1,i2
714                  tabres(ji,jj,jk,m1) = vv(ji,jj,jk,Kbb_a)
715# if defined key_vertical
716                  tabres(ji,jj,jk,m2) = vmask(ji,jj,jk) * e3v(ji,jj,jk,Kbb_a)
717# endif
718               END DO
719            END DO
720         END DO
721
722# if defined key_vertical
723         ! Extrapolate thicknesses in partial bottom cells:
724         ! Set them to Agrif_SpecialValue (0.). Correct bottom thicknesses are retrieved later on
725         IF (ln_zps) THEN
726            DO jj=j1,j2
727               DO ji=i1,i2
728                  jk = mbkv(ji,jj)
729                  tabres(ji,jj,jk,m2) = 0._wp
730               END DO
731            END DO           
732         END IF
733        ! Save ssh at last level:
734        tabres(i1:i2,j1:j2,k2,m2) = 0._wp
735        IF (.NOT.ln_linssh) THEN
736           ! This vertical sum below should be replaced by the sea-level at V-points (optimization):
737           DO jk=1,jpk
738              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)
739           END DO
740           tabres(i1:i2,j1:j2,k2,m2) = tabres(i1:i2,j1:j2,k2,m2) - hv_0(i1:i2,j1:j2)
741        END IF 
742# endif
743
744      ELSE
745
746# if defined key_vertical
747         IF (ln_linssh) tabres(i1:i2,j1:j2,k2,m2) = 0._wp
748         DO jj=j1,j2
749            DO ji=i1,i2
750               tabres_child(ji,jj,:) = 0._wp
751               N_in = mbkv_parent(ji,jj)
752               zhtot = 0._wp
753               DO jk=1,N_in
754                  IF (jk==N_in) THEN
755                     h_in(jk) = hv0_parent(ji,jj) + tabres(ji,jj,k2,m2) - zhtot
756                  ELSE
757                     h_in(jk) = tabres(ji,jj,jk,m2)
758                  ENDIF
759                  zhtot = zhtot + h_in(jk)
760                  tabin(jk) = tabres(ji,jj,jk,m1)
761               ENDDO
762               !         
763               N_out = 0
764               DO jk=1,jpk
765                  IF (vmask(ji,jj,jk) == 0) EXIT
766                  N_out = N_out + 1
767                  h_out(N_out) = e3v(ji,jj,jk,Kbb_a)
768               ENDDO
769
770               ! Account for small differences in free-surface
771               IF ( sum(h_out(1:N_out)) > sum(h_in(1:N_in) )) THEN
772                  h_out(1) = h_out(1) - ( sum(h_out(1:N_out))-sum(h_in(1:N_in)) )
773               ELSE
774                  h_in(1)   = h_in(1) - (  sum(h_in(1:N_in))-sum(h_out(1:N_out)) )
775               ENDIF
776         
777               IF (N_in * N_out > 0) THEN
778                  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)
779               ENDIF
780            ENDDO
781         ENDDO
782
783         vbdiff(i1:i2,j1:j2,:) = (vv(i1:i2,j1:j2,:,Kbb_a) - tabres_child(i1:i2,j1:j2,:))*vmask(i1:i2,j1:j2,:) 
784# else
785         vbdiff(i1:i2,j1:j2,:) = (vv(i1:i2,j1:j2,:,Kbb_a) - tabres(i1:i2,j1:j2,:,1))*vmask(i1:i2,j1:j2,:)
786# endif
787         !
788         DO jk = 1, jpkm1                                 ! Horizontal slab
789            !                                             ! ===============
790
791            !                                             ! --------
792            ! Horizontal divergence                       !   div
793            !                                             ! --------
794            DO jj = j1+1,j2
795               DO ji = i1,i2   ! vector opt.
796                  zbtr = rn_sponge_dyn * r1_Dt * fspt(ji,jj) / e3t(ji,jj,jk,Kbb_a)
797                  hdivdiff(ji,jj,jk) = ( e1v(ji,jj  ) * e3v(ji,jj  ,jk,Kbb_a) * vbdiff(ji,jj  ,jk)  &
798                                     &  -e1v(ji,jj-1) * e3v(ji,jj-1,jk,Kbb_a) * vbdiff(ji,jj-1,jk)  ) * zbtr
799               END DO
800            END DO
801            DO jj = j1,j2
802               DO ji = i1,i2-1   ! vector opt.
803                  zbtr = rn_sponge_dyn * r1_Dt * fspf(ji,jj) * e3f(ji,jj,jk) 
804                  rotdiff(ji,jj,jk) = ( e2v(ji+1,jj) * vbdiff(ji+1,jj,jk) & 
805                                    &  -e2v(ji  ,jj) * vbdiff(ji  ,jj,jk)  ) * fmask(ji,jj,jk) * zbtr
806               END DO
807            END DO
808         END DO
809
810         !                                                ! ===============
811         !                                               
812
813         imax = i2 - 1
814      !   IF(lk_east) imax = MIN(imax,nlci-nbghostcells-2)   ! East
815         IF ((nbondi == 1).OR.(nbondi == 2))   imax = MIN(imax,nlci-nbghostcells-2)   ! East
816
817         DO jj = j1+1, j2
818            DO ji = i1+1, imax   ! vector opt.
819               IF( .NOT. tabspongedone_u(ji,jj) ) THEN
820                  DO jk = 1, jpkm1
821                     uu(ji,jj,jk,Krhs_a) = uu(ji,jj,jk,Krhs_a)                                                     &
822                        & - ( rotdiff (ji  ,jj,jk) - rotdiff (ji,jj-1,jk)) / ( e2u(ji,jj) * e3u(ji,jj,jk,Kmm_a) )  &
823                        & + ( hdivdiff(ji+1,jj,jk) - hdivdiff(ji,jj  ,jk)) * r1_e1u(ji,jj)
824                  END DO
825               ENDIF
826            END DO
827         END DO
828         !
829         tabspongedone_u(i1+1:imax,j1+1:j2) = .TRUE.
830         !
831         DO jj = j1+1, j2-1
832            DO ji = i1+1, i2-1   ! vector opt.
833               IF( .NOT. tabspongedone_v(ji,jj) ) THEN
834                  DO jk = 1, jpkm1
835                     vv(ji,jj,jk,Krhs_a) = vv(ji,jj,jk,Krhs_a)                                                        &
836                        &  + ( rotdiff (ji,jj  ,jk) - rotdiff (ji-1,jj,jk) ) / ( e1v(ji,jj) * e3v(ji,jj,jk,Kmm_a) )   &
837                        &  + ( hdivdiff(ji,jj+1,jk) - hdivdiff(ji  ,jj,jk) ) * r1_e2v(ji,jj)                          &
838                        &  - rn_trelax_dyn * r1_Dt * fspv(ji,jj) * vbdiff(ji,jj,jk)
839                  END DO
840               ENDIF
841            END DO
842         END DO
843         tabspongedone_v(i1+1:i2-1,j1+1:j2-1) = .TRUE.
844      ENDIF
845      !
846   END SUBROUTINE interpvn_sponge
847
848#else
849   !!----------------------------------------------------------------------
850   !!   Empty module                                          no AGRIF zoom
851   !!----------------------------------------------------------------------
852CONTAINS
853   SUBROUTINE agrif_oce_sponge_empty
854      WRITE(*,*)  'agrif_oce_sponge : You should not have seen this print! error?'
855   END SUBROUTINE agrif_oce_sponge_empty
856#endif
857
858   !!======================================================================
859END MODULE agrif_oce_sponge
Note: See TracBrowser for help on using the repository browser.