New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
agrif_oce_sponge.F90 in NEMO/branches/2020/dev_r13312_AGRIF-03-04_jchanut_vinterp_tstep/src/NST – NEMO

source: NEMO/branches/2020/dev_r13312_AGRIF-03-04_jchanut_vinterp_tstep/src/NST/agrif_oce_sponge.F90 @ 13351

Last change on this file since 13351 was 13351, checked in by jchanut, 4 years ago

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