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_opa_interp.F90 in branches/UKMO/dev_r8126_LIM3_couple/NEMOGCM/NEMO/NST_SRC – NEMO

source: branches/UKMO/dev_r8126_LIM3_couple/NEMOGCM/NEMO/NST_SRC/agrif_opa_interp.F90 @ 8879

Last change on this file since 8879 was 8879, checked in by frrh, 6 years ago

Merge in http://fcm3/projects/NEMO.xm/log/branches/UKMO/dev_r8183_ICEMODEL_svn_removed
revisions 8738:8847 inclusive.

File size: 49.4 KB
Line 
1MODULE agrif_opa_interp
2   !!======================================================================
3   !!                   ***  MODULE  agrif_opa_interp  ***
4   !! AGRIF: interpolation package
5   !!======================================================================
6   !! History :  2.0  !  2002-06  (XXX)  Original cade
7   !!             -   !  2005-11  (XXX)
8   !!            3.2  !  2009-04  (R. Benshila)
9   !!            3.6  !  2014-09  (R. Benshila)
10   !!----------------------------------------------------------------------
11#if defined key_agrif
12   !!----------------------------------------------------------------------
13   !!   'key_agrif'                                              AGRIF zoom
14   !!----------------------------------------------------------------------
15   !!   Agrif_tra     :
16   !!   Agrif_dyn     :
17   !!   interpu       :
18   !!   interpv       :
19   !!----------------------------------------------------------------------
20   USE par_oce
21   USE oce
22   USE dom_oce     
23   USE zdf_oce
24   USE agrif_oce
25   USE phycst
26   !
27   USE in_out_manager
28   USE agrif_opa_sponge
29   USE lib_mpp
30   USE wrk_nemo
31 
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   Agrif_tra, Agrif_dyn, Agrif_ssh, Agrif_dyn_ts, Agrif_ssh_ts, Agrif_dta_ts
36   PUBLIC   interpun, interpvn
37   PUBLIC   interptsn, interpsshn
38   PUBLIC   interpunb, interpvnb, interpub2b, interpvb2b
39   PUBLIC   interpe3t, interpumsk, interpvmsk
40# if defined key_zdftke
41   PUBLIC   Agrif_tke, interpavm
42# endif
43
44   INTEGER ::   bdy_tinterp = 0
45
46#  include "vectopt_loop_substitute.h90"
47   !!----------------------------------------------------------------------
48   !! NEMO/NST 3.7 , NEMO Consortium (2015)
49   !! $Id$
50   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
51   !!----------------------------------------------------------------------
52CONTAINS
53
54   SUBROUTINE Agrif_tra
55      !!----------------------------------------------------------------------
56      !!                  ***  ROUTINE Agrif_tra  ***
57      !!----------------------------------------------------------------------
58      !
59      IF( Agrif_Root() )   RETURN
60      !
61      Agrif_SpecialValue    = 0._wp
62      Agrif_UseSpecialValue = .TRUE.
63      !
64      CALL Agrif_Bc_variable( tsn_id, procname=interptsn )
65      !
66      Agrif_UseSpecialValue = .FALSE.
67      !
68   END SUBROUTINE Agrif_tra
69
70
71   SUBROUTINE Agrif_dyn( kt )
72      !!----------------------------------------------------------------------
73      !!                  ***  ROUTINE Agrif_DYN  ***
74      !!---------------------------------------------------------------------- 
75      INTEGER, INTENT(in) ::   kt
76      !
77      INTEGER ::   ji, jj, jk       ! dummy loop indices
78      INTEGER ::   j1, j2, i1, i2
79      REAL(wp), POINTER, DIMENSION(:,:) ::   zub, zvb
80      !!---------------------------------------------------------------------- 
81      !
82      IF( Agrif_Root() )   RETURN
83      !
84      CALL wrk_alloc( jpi,jpj,   zub, zvb )
85      !
86      Agrif_SpecialValue    = 0._wp
87      Agrif_UseSpecialValue = ln_spc_dyn
88      !
89      CALL Agrif_Bc_variable( un_interp_id, procname=interpun )
90      CALL Agrif_Bc_variable( vn_interp_id, procname=interpvn )
91      !
92      Agrif_UseSpecialValue = .FALSE.
93      !
94      ! prevent smoothing in ghost cells
95      i1 =  1   ;   i2 = jpi
96      j1 =  1   ;   j2 = jpj
97      IF( nbondj == -1 .OR. nbondj == 2 )   j1 = 3
98      IF( nbondj == +1 .OR. nbondj == 2 )   j2 = nlcj-2
99      IF( nbondi == -1 .OR. nbondi == 2 )   i1 = 3
100      IF( nbondi == +1 .OR. nbondi == 2 )   i2 = nlci-2
101
102      ! --- West --- !
103      IF( nbondi == -1 .OR. nbondi == 2 ) THEN
104         !
105         IF( .NOT.ln_dynspg_ts ) THEN  ! Store transport
106            ua_b(2:1+nbghostcells,:) = 0._wp
107            DO jk = 1, jpkm1
108               DO jj = 1, jpj
109                  ua_b(2:1+nbghostcells,jj) = ua_b(2:1+nbghostcells,jj) + e3u_a(2:1+nbghostcells,jj,jk) * ua(2:1+nbghostcells,jj,jk)
110               END DO
111            END DO
112            DO jj = 1, jpj
113               ua_b(2:1+nbghostcells,jj) = ua_b(2:1+nbghostcells,jj) * r1_hu_a(2:1+nbghostcells,jj)
114            END DO
115         ENDIF
116         !
117         ! Smoothing if only 1 ghostcell
118         ! -----------------------------
119         IF( nbghostcells == 1 ) THEN
120            DO jk=1,jpkm1                 ! Smooth
121               DO jj=j1,j2
122                  ua(2,jj,jk) = 0.25_wp*(ua(1,jj,jk)+2._wp*ua(2,jj,jk)+ua(3,jj,jk))
123                  ua(2,jj,jk) = ua(2,jj,jk) * umask(2,jj,jk)
124               END DO
125            END DO
126            !
127            zub(2,:) = 0._wp              ! Correct transport
128            DO jk = 1, jpkm1
129               DO jj = 1, jpj
130                  zub(2,jj) = zub(2,jj) + e3u_a(2,jj,jk) * ua(2,jj,jk)
131               END DO
132            END DO
133            DO jj=1,jpj
134               zub(2,jj) = zub(2,jj) * r1_hu_a(2,jj)
135            END DO
136           
137            DO jk=1,jpkm1
138               DO jj=1,jpj
139                  ua(2,jj,jk) = (ua(2,jj,jk)+ua_b(2,jj)-zub(2,jj))*umask(2,jj,jk)
140               END DO
141            END DO
142           
143            IF( ln_dynspg_ts ) THEN       ! Set tangential velocities to time splitting estimate
144               zvb(2,:) = 0._wp
145               DO jk = 1, jpkm1
146                  DO jj = 1, jpj
147                     zvb(2,jj) = zvb(2,jj) + e3v_a(2,jj,jk) * va(2,jj,jk)
148                  END DO
149               END DO
150               DO jj = 1, jpj
151                  zvb(2,jj) = zvb(2,jj) * r1_hv_a(2,jj)
152               END DO
153               DO jk = 1, jpkm1
154                  DO jj = 1, jpj
155                     va(2,jj,jk) = (va(2,jj,jk)+va_b(2,jj)-zvb(2,jj)) * vmask(2,jj,jk)
156                  END DO
157               END DO
158            ENDIF
159            !
160         ENDIF
161         !
162         ! Mask domain edges:
163         !-------------------
164!         DO jk = 1, jpkm1
165!            DO jj = 1, jpj
166!               ua(1,jj,jk) = 0._wp
167!               va(1,jj,jk) = 0._wp
168!            END DO
169!         END DO
170         !
171      ENDIF
172
173      ! --- East --- !
174      IF( nbondi == 1 .OR. nbondi == 2 ) THEN
175
176         IF( .NOT.ln_dynspg_ts ) THEN  ! Store transport
177            ua_b(nlci-nbghostcells-1:nlci-2,:) = 0._wp
178            DO jk=1,jpkm1
179               DO jj=1,jpj
180                  ua_b(nlci-nbghostcells-1:nlci-2,jj) = ua_b(nlci-nbghostcells-1:nlci-2,jj) + e3u_a(nlci-nbghostcells-1:nlci-2,jj,jk)  &
181                     &                                                                         * ua(nlci-nbghostcells-1:nlci-2,jj,jk)
182               END DO
183            END DO
184            DO jj=1,jpj
185               ua_b(nlci-nbghostcells-1:nlci-2,jj) = ua_b(nlci-nbghostcells-1:nlci-2,jj) * r1_hu_a(nlci-nbghostcells-1:nlci-2,jj) 
186            END DO
187         ENDIF
188         !
189         ! Smoothing if only 1 ghostcell
190         ! -----------------------------
191         IF( nbghostcells == 1 ) THEN
192            DO jk = 1, jpkm1              ! Smooth
193               DO jj = j1, j2
194                  ua(nlci-2,jj,jk) = 0.25_wp * umask(nlci-2,jj,jk)      &
195                     &             * ( ua(nlci-3,jj,jk) + 2._wp*ua(nlci-2,jj,jk) + ua(nlci-1,jj,jk) )
196               END DO
197            END DO
198           
199            zub(nlci-2,:) = 0._wp        ! Correct transport
200            DO jk = 1, jpkm1
201               DO jj = 1, jpj
202                  zub(nlci-2,jj) = zub(nlci-2,jj) + e3u_a(nlci-2,jj,jk) * ua(nlci-2,jj,jk)
203               END DO
204            END DO
205            DO jj = 1, jpj
206               zub(nlci-2,jj) = zub(nlci-2,jj) * r1_hu_a(nlci-2,jj)
207            END DO
208           
209            DO jk = 1, jpkm1
210               DO jj = 1, jpj
211                  ua(nlci-2,jj,jk) = ( ua(nlci-2,jj,jk) + ua_b(nlci-2,jj) - zub(nlci-2,jj) ) * umask(nlci-2,jj,jk)
212               END DO
213            END DO
214            !
215            IF( ln_dynspg_ts ) THEN       ! Set tangential velocities to time splitting estimate
216               zvb(nlci-1,:) = 0._wp
217               DO jk = 1, jpkm1
218                  DO jj = 1, jpj
219                     zvb(nlci-1,jj) = zvb(nlci-1,jj) + e3v_a(nlci-1,jj,jk) * va(nlci-1,jj,jk)
220                  END DO
221               END DO
222               DO jj=1,jpj
223                  zvb(nlci-1,jj) = zvb(nlci-1,jj) * r1_hv_a(nlci-1,jj)
224               END DO
225               DO jk = 1, jpkm1
226                  DO jj = 1, jpj
227                     va(nlci-1,jj,jk) = ( va(nlci-1,jj,jk) + va_b(nlci-1,jj) - zvb(nlci-1,jj) ) * vmask(nlci-1,jj,jk)
228                  END DO
229               END DO
230            ENDIF
231            !
232         ENDIF
233         !
234         ! Mask domain edges:
235         !-------------------
236!         DO jk = 1, jpkm1
237!            DO jj = 1, jpj
238!               ua(nlci-1,jj,jk) = 0._wp
239!               va(nlci  ,jj,jk) = 0._wp
240!            END DO
241!         END DO
242         !
243      ENDIF
244
245      ! --- South --- !
246      IF( nbondj == -1 .OR. nbondj == 2 ) THEN
247
248         IF( .NOT.ln_dynspg_ts ) THEN  ! Store transport
249            va_b(:,2:nbghostcells+1) = 0._wp
250            DO jk = 1, jpkm1
251               DO ji = 1, jpi
252                  va_b(ji,2:nbghostcells+1) = va_b(ji,2:nbghostcells+1) + e3v_a(ji,2:nbghostcells+1,jk) * va(ji,2:nbghostcells+1,jk)
253               END DO
254            END DO
255            DO ji=1,jpi
256               va_b(ji,2:nbghostcells+1) = va_b(ji,2:nbghostcells+1) * r1_hv_a(ji,2:nbghostcells+1)
257            END DO
258         ENDIF
259         !
260         ! Smoothing if only 1 ghostcell
261         ! -----------------------------
262         IF( nbghostcells == 1 ) THEN
263            DO jk = 1, jpkm1              ! Smooth
264               DO ji = i1, i2
265                  va(ji,2,jk) = 0.25_wp * vmask(ji,2,jk)    &
266                     &        * ( va(ji,1,jk) + 2._wp*va(ji,2,jk) + va(ji,3,jk) )
267               END DO
268            END DO
269            !
270            zvb(:,2) = 0._wp              ! Correct transport
271            DO jk=1,jpkm1
272               DO ji=1,jpi
273                  zvb(ji,2) = zvb(ji,2) + e3v_a(ji,2,jk) * va(ji,2,jk) * vmask(ji,2,jk)
274               END DO
275            END DO
276            DO ji = 1, jpi
277               zvb(ji,2) = zvb(ji,2) * r1_hv_a(ji,2)
278            END DO
279            DO jk = 1, jpkm1
280               DO ji = 1, jpi
281                  va(ji,2,jk) = ( va(ji,2,jk) + va_b(ji,2) - zvb(ji,2) ) * vmask(ji,2,jk)
282               END DO
283            END DO
284           
285            IF( ln_dynspg_ts ) THEN       ! Set tangential velocities to time splitting estimate
286               zub(:,2) = 0._wp
287               DO jk = 1, jpkm1
288                  DO ji = 1, jpi
289                     zub(ji,2) = zub(ji,2) + e3u_a(ji,2,jk) * ua(ji,2,jk) * umask(ji,2,jk)
290                  END DO
291               END DO
292               DO ji = 1, jpi
293                  zub(ji,2) = zub(ji,2) * r1_hu_a(ji,2)
294               END DO
295               
296               DO jk = 1, jpkm1
297                  DO ji = 1, jpi
298                     ua(ji,2,jk) = ( ua(ji,2,jk) + ua_b(ji,2) - zub(ji,2) ) * umask(ji,2,jk)
299                  END DO
300               END DO
301            ENDIF
302            !
303         ENDIF
304         !
305         ! Mask domain edges:
306         !-------------------
307!         DO jk = 1, jpkm1
308!            DO ji = 1, jpi
309!               ua(ji,1,jk) = 0._wp
310!               va(ji,1,jk) = 0._wp
311!            END DO
312!         END DO
313         !
314      ENDIF
315
316      ! --- North --- !
317      IF( nbondj == 1 .OR. nbondj == 2 ) THEN
318         !
319         IF( .NOT.ln_dynspg_ts ) THEN  ! Store transport
320            va_b(:,nlcj-nbghostcells-1:nlcj-2) = 0._wp
321            DO jk = 1, jpkm1
322               DO ji = 1, jpi
323                  va_b(ji,nlcj-nbghostcells-1:nlcj-2) = va_b(ji,nlcj-nbghostcells-1:nlcj-2) + e3v_a(ji,nlcj-nbghostcells-1:nlcj-2,jk)  &
324                     &                                                                         * va(ji,nlcj-nbghostcells-1:nlcj-2,jk)
325               END DO
326            END DO
327            DO ji = 1, jpi
328               va_b(ji,nlcj-nbghostcells-1:nlcj-2) = va_b(ji,nlcj-nbghostcells-1:nlcj-2) * r1_hv_a(ji,nlcj-nbghostcells-1:nlcj-2)
329            END DO
330         ENDIF
331         !
332         ! Smoothing if only 1 ghostcell
333         ! -----------------------------
334         IF( nbghostcells == 1 ) THEN
335            DO jk = 1, jpkm1              ! Smooth
336               DO ji = i1, i2
337                  va(ji,nlcj-2,jk) = 0.25_wp * vmask(ji,nlcj-2,jk)   &
338                     &             * ( va(ji,nlcj-3,jk) + 2._wp * va(ji,nlcj-2,jk) + va(ji,nlcj-1,jk) )
339               END DO
340            END DO
341            !
342            zvb(:,nlcj-2) = 0._wp         ! Correct transport
343            DO jk = 1, jpkm1
344               DO ji = 1, jpi
345                  zvb(ji,nlcj-2) = zvb(ji,nlcj-2) + e3v_a(ji,nlcj-2,jk) * va(ji,nlcj-2,jk) * vmask(ji,nlcj-2,jk)
346               END DO
347            END DO
348            DO ji = 1, jpi
349               zvb(ji,nlcj-2) = zvb(ji,nlcj-2) * r1_hv_a(ji,nlcj-2)
350            END DO
351            DO jk = 1, jpkm1
352               DO ji = 1, jpi
353                  va(ji,nlcj-2,jk) = ( va(ji,nlcj-2,jk) + va_b(ji,nlcj-2) - zvb(ji,nlcj-2) ) * vmask(ji,nlcj-2,jk)
354               END DO
355            END DO
356            !
357            IF( ln_dynspg_ts ) THEN       ! Set tangential velocities to time splitting estimate
358               zub(:,nlcj-1) = 0._wp
359               DO jk = 1, jpkm1
360                  DO ji = 1, jpi
361                     zub(ji,nlcj-1) = zub(ji,nlcj-1) + e3u_a(ji,nlcj-1,jk) * ua(ji,nlcj-1,jk) * umask(ji,nlcj-1,jk)
362                  END DO
363               END DO
364               DO ji = 1, jpi
365                  zub(ji,nlcj-1) = zub(ji,nlcj-1) * r1_hu_a(ji,nlcj-1)
366               END DO
367               !
368               DO jk = 1, jpkm1
369                  DO ji = 1, jpi
370                     ua(ji,nlcj-1,jk) = ( ua(ji,nlcj-1,jk) + ua_b(ji,nlcj-1) - zub(ji,nlcj-1) ) * umask(ji,nlcj-1,jk)
371                  END DO
372               END DO
373            ENDIF
374            !
375         ENDIF
376         !
377         ! Mask domain edges:
378         !-------------------
379!         DO jk = 1, jpkm1
380!            DO ji = 1, jpi
381!               ua(ji,nlcj  ,jk) = 0._wp
382!               va(ji,nlcj-1,jk) = 0._wp
383!            END DO
384!         END DO
385         !
386      ENDIF
387      !
388      CALL wrk_dealloc( jpi,jpj,   zub, zvb )
389      !
390   END SUBROUTINE Agrif_dyn
391
392
393   SUBROUTINE Agrif_dyn_ts( jn )
394      !!----------------------------------------------------------------------
395      !!                  ***  ROUTINE Agrif_dyn_ts  ***
396      !!---------------------------------------------------------------------- 
397      !!
398      INTEGER, INTENT(in) ::   jn
399      !!
400      INTEGER :: ji, jj
401      !!---------------------------------------------------------------------- 
402      !
403      IF( Agrif_Root() )   RETURN
404      !! clem ghost
405      IF((nbondi == -1).OR.(nbondi == 2)) THEN
406         DO jj=1,jpj
407            va_e(2:nbghostcells+1,jj) = vbdy_w(jj) * hvr_e(2:nbghostcells+1,jj)
408            ! Specified fluxes:
409            ua_e(2:nbghostcells+1,jj) = ubdy_w(jj) * hur_e(2:nbghostcells+1,jj)
410            ! Characteristics method (only if ghostcells=1):
411            !alt            ua_e(2,jj) = 0.5_wp * ( ubdy_w(jj) * hur_e(2,jj) + ua_e(3,jj) &
412            !alt                       &           - sqrt(grav * hur_e(2,jj)) * (sshn_e(3,jj) - hbdy_w(jj)) )
413         END DO
414      ENDIF
415      !
416      IF((nbondi == 1).OR.(nbondi == 2)) THEN
417         DO jj=1,jpj
418            va_e(nlci-nbghostcells:nlci-1,jj)   = vbdy_e(jj) * hvr_e(nlci-nbghostcells:nlci-1,jj)
419            ! Specified fluxes:
420            ua_e(nlci-nbghostcells-1:nlci-2,jj) = ubdy_e(jj) * hur_e(nlci-nbghostcells-1:nlci-2,jj)
421            ! Characteristics method (only if ghostcells=1):
422            !alt            ua_e(nlci-2,jj) = 0.5_wp * ( ubdy_e(jj) * hur_e(nlci-2,jj) + ua_e(nlci-3,jj) &
423            !alt                            &           + sqrt(grav * hur_e(nlci-2,jj)) * (sshn_e(nlci-2,jj) - hbdy_e(jj)) )
424         END DO
425      ENDIF
426      !
427      IF((nbondj == -1).OR.(nbondj == 2)) THEN
428         DO ji=1,jpi
429            ua_e(ji,2:nbghostcells+1) = ubdy_s(ji) * hur_e(ji,2:nbghostcells+1)
430            ! Specified fluxes:
431            va_e(ji,2:nbghostcells+1) = vbdy_s(ji) * hvr_e(ji,2:nbghostcells+1)
432            ! Characteristics method (only if ghostcells=1):
433            !alt            va_e(ji,2) = 0.5_wp * ( vbdy_s(ji) * hvr_e(ji,2) + va_e(ji,3) &
434            !alt                       &           - sqrt(grav * hvr_e(ji,2)) * (sshn_e(ji,3) - hbdy_s(ji)) )
435         END DO
436      ENDIF
437      !
438      IF((nbondj == 1).OR.(nbondj == 2)) THEN
439         DO ji=1,jpi
440            ua_e(ji,nlcj-nbghostcells:nlcj-1)   = ubdy_n(ji) * hur_e(ji,nlcj-nbghostcells:nlcj-1)
441            ! Specified fluxes:
442            va_e(ji,nlcj-nbghostcells-1:nlcj-2) = vbdy_n(ji) * hvr_e(ji,nlcj-nbghostcells-1:nlcj-2)
443            ! Characteristics method (only if ghostcells=1):
444            !alt            va_e(ji,nlcj-2) = 0.5_wp * ( vbdy_n(ji) * hvr_e(ji,nlcj-2)  + va_e(ji,nlcj-3) &
445            !alt                            &           + sqrt(grav * hvr_e(ji,nlcj-2)) * (sshn_e(ji,nlcj-2) - hbdy_n(ji)) )
446         END DO
447      ENDIF
448      !
449   END SUBROUTINE Agrif_dyn_ts
450
451
452   SUBROUTINE Agrif_dta_ts( kt )
453      !!----------------------------------------------------------------------
454      !!                  ***  ROUTINE Agrif_dta_ts  ***
455      !!---------------------------------------------------------------------- 
456      !!
457      INTEGER, INTENT(in) ::   kt
458      !!
459      INTEGER :: ji, jj
460      LOGICAL :: ll_int_cons
461      REAL(wp) :: zrhot, zt
462      !!---------------------------------------------------------------------- 
463      !
464      IF( Agrif_Root() )   RETURN
465      !
466      ll_int_cons = ln_bt_fw ! Assume conservative temporal integration in the forward case only
467      !
468      zrhot = Agrif_rhot()
469      !
470      ! "Central" time index for interpolation:
471      IF( ln_bt_fw ) THEN
472         zt = REAL( Agrif_NbStepint()+0.5_wp, wp ) / zrhot
473      ELSE
474         zt = REAL( Agrif_NbStepint()       , wp ) / zrhot
475      ENDIF
476      !
477      ! Linear interpolation of sea level
478      Agrif_SpecialValue    = 0._wp
479      Agrif_UseSpecialValue = .TRUE.
480      CALL Agrif_Bc_variable( sshn_id, calledweight=zt, procname=interpsshn )
481      Agrif_UseSpecialValue = .FALSE.
482      !
483      ! Interpolate barotropic fluxes
484      Agrif_SpecialValue=0.
485      Agrif_UseSpecialValue = ln_spc_dyn
486      !
487      IF( ll_int_cons ) THEN  ! Conservative interpolation
488         ! order matters here !!!!!!
489         CALL Agrif_Bc_variable( ub2b_interp_id, calledweight=1._wp, procname=interpub2b ) ! Time integrated
490         CALL Agrif_Bc_variable( vb2b_interp_id, calledweight=1._wp, procname=interpvb2b )
491         bdy_tinterp = 1
492         CALL Agrif_Bc_variable( unb_id        , calledweight=1._wp, procname=interpunb  ) ! After
493         CALL Agrif_Bc_variable( vnb_id        , calledweight=1._wp, procname=interpvnb  )
494         bdy_tinterp = 2
495         CALL Agrif_Bc_variable( unb_id        , calledweight=0._wp, procname=interpunb  ) ! Before
496         CALL Agrif_Bc_variable( vnb_id        , calledweight=0._wp, procname=interpvnb  )         
497      ELSE ! Linear interpolation
498         bdy_tinterp = 0
499         ubdy_w(:) = 0._wp   ;   vbdy_w(:) = 0._wp 
500         ubdy_e(:) = 0._wp   ;   vbdy_e(:) = 0._wp 
501         ubdy_n(:) = 0._wp   ;   vbdy_n(:) = 0._wp 
502         ubdy_s(:) = 0._wp   ;   vbdy_s(:) = 0._wp
503         CALL Agrif_Bc_variable( unb_id, calledweight=zt, procname=interpunb )
504         CALL Agrif_Bc_variable( vnb_id, calledweight=zt, procname=interpvnb )
505      ENDIF
506      Agrif_UseSpecialValue = .FALSE.
507      !
508   END SUBROUTINE Agrif_dta_ts
509
510
511   SUBROUTINE Agrif_ssh( kt )
512      !!----------------------------------------------------------------------
513      !!                  ***  ROUTINE Agrif_DYN  ***
514      !!---------------------------------------------------------------------- 
515      INTEGER, INTENT(in) ::   kt
516      !
517      INTEGER  :: ji, jj, indx
518      !!---------------------------------------------------------------------- 
519      !
520      IF( Agrif_Root() )   RETURN
521      !! clem ghost
522      ! --- West --- !
523      IF((nbondi == -1).OR.(nbondi == 2)) THEN
524         indx = 1+nbghostcells
525         DO jj = 1, jpj
526            DO ji = 2, indx
527               ssha(ji,jj)=ssha(indx+1,jj)
528               sshn(ji,jj)=sshn(indx+1,jj)
529            ENDDO
530         ENDDO
531      ENDIF
532      !
533      ! --- East --- !
534      IF((nbondi == 1).OR.(nbondi == 2)) THEN
535         indx = nlci-nbghostcells
536         DO jj = 1, jpj
537            DO ji = indx, nlci-1
538               ssha(ji,jj)=ssha(indx-1,jj)
539               sshn(ji,jj)=sshn(indx-1,jj)
540            ENDDO
541         ENDDO
542      ENDIF
543      !
544      ! --- South --- !
545      IF((nbondj == -1).OR.(nbondj == 2)) THEN
546         indx = 1+nbghostcells
547         DO jj = 2, indx
548            DO ji = 1, jpi
549               ssha(ji,jj)=ssha(ji,indx+1)
550               sshn(ji,jj)=sshn(ji,indx+1)
551            ENDDO
552         ENDDO
553      ENDIF
554      !
555      ! --- North --- !
556      IF((nbondj == 1).OR.(nbondj == 2)) THEN
557         indx = nlcj-nbghostcells
558         DO jj = indx, nlcj-1
559            DO ji = 1, jpi
560               ssha(ji,jj)=ssha(ji,indx-1)
561               sshn(ji,jj)=sshn(ji,indx-1)
562            ENDDO
563         ENDDO
564      ENDIF
565      !
566   END SUBROUTINE Agrif_ssh
567
568
569   SUBROUTINE Agrif_ssh_ts( jn )
570      !!----------------------------------------------------------------------
571      !!                  ***  ROUTINE Agrif_ssh_ts  ***
572      !!---------------------------------------------------------------------- 
573      INTEGER, INTENT(in) ::   jn
574      !!
575      INTEGER :: ji, jj
576      !!---------------------------------------------------------------------- 
577      !! clem ghost (starting at i,j=1 is important I think otherwise you introduce a grad(ssh)/=0 at point 2)
578      IF((nbondi == -1).OR.(nbondi == 2)) THEN
579         DO jj = 1, jpj
580            ssha_e(2:nbghostcells+1,jj) = hbdy_w(jj)
581         END DO
582      ENDIF
583      !
584      IF((nbondi == 1).OR.(nbondi == 2)) THEN
585         DO jj = 1, jpj
586            ssha_e(nlci-nbghostcells:nlci-1,jj) = hbdy_e(jj)
587         END DO
588      ENDIF
589      !
590      IF((nbondj == -1).OR.(nbondj == 2)) THEN
591         DO ji = 1, jpi
592            ssha_e(ji,2:nbghostcells+1) = hbdy_s(ji)
593         END DO
594      ENDIF
595      !
596      IF((nbondj == 1).OR.(nbondj == 2)) THEN
597         DO ji = 1, jpi
598            ssha_e(ji,nlcj-nbghostcells:nlcj-1) = hbdy_n(ji)
599         END DO
600      ENDIF
601      !
602   END SUBROUTINE Agrif_ssh_ts
603
604# if defined key_zdftke
605
606   SUBROUTINE Agrif_tke
607      !!----------------------------------------------------------------------
608      !!                  ***  ROUTINE Agrif_tke  ***
609      !!---------------------------------------------------------------------- 
610      REAL(wp) ::   zalpha
611      !!---------------------------------------------------------------------- 
612      !
613      zalpha = REAL( Agrif_NbStepint() + Agrif_IRhot() - 1, wp ) / REAL( Agrif_IRhot(), wp )
614      IF( zalpha > 1. )   zalpha = 1.
615      !
616      Agrif_SpecialValue    = 0.e0
617      Agrif_UseSpecialValue = .TRUE.
618      !
619      CALL Agrif_Bc_variable(avm_id ,calledweight=zalpha, procname=interpavm)       
620      !
621      Agrif_UseSpecialValue = .FALSE.
622      !
623   END SUBROUTINE Agrif_tke
624   
625# endif
626
627   SUBROUTINE interptsn( ptab, i1, i2, j1, j2, k1, k2, n1, n2, before, nb, ndir )
628      !!----------------------------------------------------------------------
629      !!   *** ROUTINE interptsn ***
630      !!----------------------------------------------------------------------
631      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) ::   ptab
632      INTEGER                                     , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2, n1, n2
633      LOGICAL                                     , INTENT(in   ) ::   before
634      INTEGER                                     , INTENT(in   ) ::   nb , ndir
635      !
636      INTEGER  ::   ji, jj, jk, jn   ! dummy loop indices
637      INTEGER  ::   imin, imax, jmin, jmax
638      REAL(wp) ::   zrhox, z1, z2, z3, z4, z5, z6, z7
639      LOGICAL  ::   western_side, eastern_side,northern_side,southern_side
640      !!----------------------------------------------------------------------
641      !
642      IF (before) THEN         
643         ptab(i1:i2,j1:j2,k1:k2,n1:n2) = tsn(i1:i2,j1:j2,k1:k2,n1:n2)
644      ELSE
645         !
646         western_side  = (nb == 1).AND.(ndir == 1)  ;  eastern_side  = (nb == 1).AND.(ndir == 2)
647         southern_side = (nb == 2).AND.(ndir == 1)  ;  northern_side = (nb == 2).AND.(ndir == 2)
648         !
649         IF( nbghostcells > 1 ) THEN  ! no smoothing
650            tsa(i1:i2,j1:j2,k1:k2,n1:n2) = ptab(i1:i2,j1:j2,k1:k2,n1:n2)
651         ELSE                         ! smoothing
652            !
653            zrhox = Agrif_Rhox()
654            z1 = ( zrhox - 1. ) * 0.5
655            z3 = ( zrhox - 1. ) / ( zrhox + 1. )
656            z6 = 2. * ( zrhox - 1. ) / ( zrhox + 1. )
657            z7 =    - ( zrhox - 1. ) / ( zrhox + 3. )
658            !
659            z2 = 1. - z1
660            z4 = 1. - z3
661            z5 = 1. - z6 - z7
662            !
663            imin = i1 ; imax = i2
664            jmin = j1 ; jmax = j2
665            !
666            ! Remove CORNERS
667            IF((nbondj == -1).OR.(nbondj == 2)) jmin = 3
668            IF((nbondj == +1).OR.(nbondj == 2)) jmax = nlcj-2
669            IF((nbondi == -1).OR.(nbondi == 2)) imin = 3
670            IF((nbondi == +1).OR.(nbondi == 2)) imax = nlci-2       
671            !
672            IF( eastern_side ) THEN
673               DO jn = 1, jpts
674                  tsa(nlci,j1:j2,k1:k2,jn) = z1 * ptab(nlci,j1:j2,k1:k2,jn) + z2 * ptab(nlci-1,j1:j2,k1:k2,jn)
675                  DO jk = 1, jpkm1
676                     DO jj = jmin,jmax
677                        IF( umask(nlci-2,jj,jk) == 0._wp ) THEN
678                           tsa(nlci-1,jj,jk,jn) = tsa(nlci,jj,jk,jn) * tmask(nlci-1,jj,jk)
679                        ELSE
680                           tsa(nlci-1,jj,jk,jn)=(z4*tsa(nlci,jj,jk,jn)+z3*tsa(nlci-2,jj,jk,jn))*tmask(nlci-1,jj,jk)
681                           IF( un(nlci-2,jj,jk) > 0._wp ) THEN
682                              tsa(nlci-1,jj,jk,jn)=( z6*tsa(nlci-2,jj,jk,jn)+z5*tsa(nlci,jj,jk,jn) & 
683                                                   + z7*tsa(nlci-3,jj,jk,jn) ) * tmask(nlci-1,jj,jk)
684                           ENDIF
685                        ENDIF
686                     END DO
687                  END DO
688                  tsa(nlci,j1:j2,k1:k2,jn) = 0._wp
689               END DO
690            ENDIF
691            !
692            IF( northern_side ) THEN           
693               DO jn = 1, jpts
694                  tsa(i1:i2,nlcj,k1:k2,jn) = z1 * ptab(i1:i2,nlcj,k1:k2,jn) + z2 * ptab(i1:i2,nlcj-1,k1:k2,jn)
695                  DO jk = 1, jpkm1
696                     DO ji = imin,imax
697                        IF( vmask(ji,nlcj-2,jk) == 0._wp ) THEN
698                           tsa(ji,nlcj-1,jk,jn) = tsa(ji,nlcj,jk,jn) * tmask(ji,nlcj-1,jk)
699                        ELSE
700                           tsa(ji,nlcj-1,jk,jn)=(z4*tsa(ji,nlcj,jk,jn)+z3*tsa(ji,nlcj-2,jk,jn))*tmask(ji,nlcj-1,jk)       
701                           IF (vn(ji,nlcj-2,jk) > 0._wp ) THEN
702                              tsa(ji,nlcj-1,jk,jn)=( z6*tsa(ji,nlcj-2,jk,jn)+z5*tsa(ji,nlcj,jk,jn)  &
703                                                   + z7*tsa(ji,nlcj-3,jk,jn) ) * tmask(ji,nlcj-1,jk)
704                           ENDIF
705                        ENDIF
706                     END DO
707                  END DO
708                  tsa(i1:i2,nlcj,k1:k2,jn) = 0._wp
709               END DO
710            ENDIF
711            !
712            IF( western_side ) THEN           
713               DO jn = 1, jpts
714                  tsa(1,j1:j2,k1:k2,jn) = z1 * ptab(1,j1:j2,k1:k2,jn) + z2 * ptab(2,j1:j2,k1:k2,jn)
715                  DO jk = 1, jpkm1
716                     DO jj = jmin,jmax
717                        IF( umask(2,jj,jk) == 0._wp ) THEN
718                           tsa(2,jj,jk,jn) = tsa(1,jj,jk,jn) * tmask(2,jj,jk)
719                        ELSE
720                           tsa(2,jj,jk,jn)=(z4*tsa(1,jj,jk,jn)+z3*tsa(3,jj,jk,jn))*tmask(2,jj,jk)       
721                           IF( un(2,jj,jk) < 0._wp ) THEN
722                              tsa(2,jj,jk,jn)=(z6*tsa(3,jj,jk,jn)+z5*tsa(1,jj,jk,jn)+z7*tsa(4,jj,jk,jn))*tmask(2,jj,jk)
723                           ENDIF
724                        ENDIF
725                     END DO
726                  END DO
727                  tsa(1,j1:j2,k1:k2,jn) = 0._wp
728               END DO
729            ENDIF
730            !
731            IF( southern_side ) THEN           
732               DO jn = 1, jpts
733                  tsa(i1:i2,1,k1:k2,jn) = z1 * ptab(i1:i2,1,k1:k2,jn) + z2 * ptab(i1:i2,2,k1:k2,jn)
734                  DO jk = 1, jpk     
735                     DO ji=imin,imax
736                        IF( vmask(ji,2,jk) == 0._wp ) THEN
737                           tsa(ji,2,jk,jn)=tsa(ji,1,jk,jn) * tmask(ji,2,jk)
738                        ELSE
739                           tsa(ji,2,jk,jn)=(z4*tsa(ji,1,jk,jn)+z3*tsa(ji,3,jk,jn))*tmask(ji,2,jk)
740                           IF( vn(ji,2,jk) < 0._wp ) THEN
741                              tsa(ji,2,jk,jn)=(z6*tsa(ji,3,jk,jn)+z5*tsa(ji,1,jk,jn)+z7*tsa(ji,4,jk,jn))*tmask(ji,2,jk)
742                           ENDIF
743                        ENDIF
744                     END DO
745                  END DO
746                  tsa(i1:i2,1,k1:k2,jn) = 0._wp
747               END DO
748            ENDIF
749            !
750            ! Treatment of corners
751            IF ((eastern_side).AND.((nbondj == -1).OR.(nbondj == 2)))   tsa(nlci-1,2,:,:) = ptab(nlci-1,2,:,:)            ! East south
752            IF ((eastern_side).AND.((nbondj ==  1).OR.(nbondj == 2)))   tsa(nlci-1,nlcj-1,:,:) = ptab(nlci-1,nlcj-1,:,:)  ! East north
753            IF ((western_side).AND.((nbondj == -1).OR.(nbondj == 2)))   tsa(2,2,:,:) = ptab(2,2,:,:)                      ! West south
754            IF ((western_side).AND.((nbondj ==  1).OR.(nbondj == 2)))   tsa(2,nlcj-1,:,:) = ptab(2,nlcj-1,:,:)            ! West north
755            !
756         ENDIF
757      ENDIF
758      !
759   END SUBROUTINE interptsn
760
761
762   SUBROUTINE interpsshn( ptab, i1, i2, j1, j2, before, nb, ndir )
763      !!----------------------------------------------------------------------
764      !!                  ***  ROUTINE interpsshn  ***
765      !!---------------------------------------------------------------------- 
766      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
767      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
768      LOGICAL                         , INTENT(in   ) ::   before
769      INTEGER                         , INTENT(in   ) ::   nb , ndir
770      !
771      LOGICAL :: western_side, eastern_side,northern_side,southern_side
772      !!---------------------------------------------------------------------- 
773      !
774      IF( before) THEN
775         ptab(i1:i2,j1:j2) = sshn(i1:i2,j1:j2)
776      ELSE
777         western_side  = (nb == 1).AND.(ndir == 1)
778         eastern_side  = (nb == 1).AND.(ndir == 2)
779         southern_side = (nb == 2).AND.(ndir == 1)
780         northern_side = (nb == 2).AND.(ndir == 2)
781         !! clem ghost
782         IF(western_side)  hbdy_w(j1:j2) = ptab(i2,j1:j2) * tmask(i2,j1:j2,1)
783         IF(eastern_side)  hbdy_e(j1:j2) = ptab(i1,j1:j2) * tmask(i1,j1:j2,1) !clem previously i1
784         IF(southern_side) hbdy_s(i1:i2) = ptab(i1:i2,j2) * tmask(i1:i2,j2,1) !clem previously j1
785         IF(northern_side) hbdy_n(i1:i2) = ptab(i1:i2,j1) * tmask(i1:i2,j1,1)
786      ENDIF
787      !
788   END SUBROUTINE interpsshn
789
790
791   SUBROUTINE interpun( ptab, i1, i2, j1, j2, k1, k2, before )
792      !!----------------------------------------------------------------------
793      !!   *** ROUTINE interpun ***
794      !!----------------------------------------------------------------------
795      INTEGER                               , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2
796      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
797      LOGICAL                               , INTENT(in   ) ::   before
798      !
799      INTEGER  ::   ji, jj, jk
800      REAL(wp) ::   zrhoy 
801      !!----------------------------------------------------------------------
802      !
803      IF( before ) THEN
804         DO jk = k1, jpk
805            ptab(i1:i2,j1:j2,jk) = e2u(i1:i2,j1:j2) * e3u_n(i1:i2,j1:j2,jk) * un(i1:i2,j1:j2,jk)
806         END DO
807      ELSE
808         zrhoy = Agrif_Rhoy()
809         DO jk = 1, jpkm1
810            DO jj=j1,j2
811               ua(i1:i2,jj,jk) = ptab(i1:i2,jj,jk) / ( zrhoy * e2u(i1:i2,jj) * e3u_n(i1:i2,jj,jk) )
812            END DO
813         END DO
814      ENDIF
815      !
816   END SUBROUTINE interpun
817
818
819   SUBROUTINE interpvn( ptab, i1, i2, j1, j2, k1, k2, before )
820      !!----------------------------------------------------------------------
821      !!   *** ROUTINE interpvn ***
822      !!----------------------------------------------------------------------
823      INTEGER                               , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2
824      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
825      LOGICAL                               , INTENT(in   ) ::   before
826      !
827      INTEGER  ::   ji, jj, jk
828      REAL(wp) ::   zrhox 
829      !!----------------------------------------------------------------------
830      !     
831      IF( before ) THEN       !interpv entre 1 et k2 et interpv2d en jpkp1
832         DO jk = k1, jpk
833            ptab(i1:i2,j1:j2,jk) = e1v(i1:i2,j1:j2) * e3v_n(i1:i2,j1:j2,jk) * vn(i1:i2,j1:j2,jk)
834         END DO
835      ELSE         
836         zrhox= Agrif_Rhox()
837         DO jk = 1, jpkm1
838            va(i1:i2,j1:j2,jk) = ptab(i1:i2,j1:j2,jk) / ( zrhox * e1v(i1:i2,j1:j2) * e3v_n(i1:i2,j1:j2,jk) )
839         END DO
840      ENDIF
841      !       
842   END SUBROUTINE interpvn
843   
844
845   SUBROUTINE interpunb( ptab, i1, i2, j1, j2, before, nb, ndir )
846      !!----------------------------------------------------------------------
847      !!                  ***  ROUTINE interpunb  ***
848      !!---------------------------------------------------------------------- 
849      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
850      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
851      LOGICAL                         , INTENT(in   ) ::   before
852      INTEGER                         , INTENT(in   ) ::   nb , ndir
853      !
854      INTEGER  ::   ji, jj
855      REAL(wp) ::   zrhoy, zrhot, zt0, zt1, ztcoeff
856      LOGICAL  ::   western_side, eastern_side,northern_side,southern_side
857      !!---------------------------------------------------------------------- 
858      !
859      IF( before ) THEN
860         ptab(i1:i2,j1:j2) = e2u(i1:i2,j1:j2) * hu_n(i1:i2,j1:j2) * un_b(i1:i2,j1:j2)
861      ELSE
862         western_side  = (nb == 1).AND.(ndir == 1)
863         eastern_side  = (nb == 1).AND.(ndir == 2)
864         southern_side = (nb == 2).AND.(ndir == 1)
865         northern_side = (nb == 2).AND.(ndir == 2)
866         zrhoy = Agrif_Rhoy()
867         zrhot = Agrif_rhot()
868         ! Time indexes bounds for integration
869         zt0 = REAL(Agrif_NbStepint()  , wp) / zrhot
870         zt1 = REAL(Agrif_NbStepint()+1, wp) / zrhot     
871         ! Polynomial interpolation coefficients:
872         IF( bdy_tinterp == 1 ) THEN
873            ztcoeff = zrhot * (  zt1**2._wp * (       zt1 - 1._wp)        &
874               &               - zt0**2._wp * (       zt0 - 1._wp)        )
875         ELSEIF( bdy_tinterp == 2 ) THEN
876            ztcoeff = zrhot * (  zt1        * (       zt1 - 1._wp)**2._wp &
877               &               - zt0        * (       zt0 - 1._wp)**2._wp )
878         ELSE
879            ztcoeff = 1
880         ENDIF
881         !! clem ghost   
882         IF(western_side)   ubdy_w(j1:j2) = ubdy_w(j1:j2) + ztcoeff * ptab(i2,j1:j2) 
883         IF(eastern_side)   ubdy_e(j1:j2) = ubdy_e(j1:j2) + ztcoeff * ptab(i1,j1:j2) !clem previously i1 
884         IF(southern_side)  ubdy_s(i1:i2) = ubdy_s(i1:i2) + ztcoeff * ptab(i1:i2,j2) !clem previously j1
885         IF(northern_side)  ubdy_n(i1:i2) = ubdy_n(i1:i2) + ztcoeff * ptab(i1:i2,j1) 
886         !           
887         IF( bdy_tinterp == 0 .OR. bdy_tinterp == 2) THEN
888            IF(western_side)   ubdy_w(j1:j2) = ubdy_w(j1:j2) / (zrhoy*e2u(i2,j1:j2)) * umask(i2,j1:j2,1)
889            IF(eastern_side)   ubdy_e(j1:j2) = ubdy_e(j1:j2) / (zrhoy*e2u(i1,j1:j2)) * umask(i1,j1:j2,1)
890            IF(southern_side)  ubdy_s(i1:i2) = ubdy_s(i1:i2) / (zrhoy*e2u(i1:i2,j2)) * umask(i1:i2,j2,1)
891            IF(northern_side)  ubdy_n(i1:i2) = ubdy_n(i1:i2) / (zrhoy*e2u(i1:i2,j1)) * umask(i1:i2,j1,1)
892         ENDIF
893      ENDIF
894      !
895   END SUBROUTINE interpunb
896
897
898   SUBROUTINE interpvnb( ptab, i1, i2, j1, j2, before, nb, ndir )
899      !!----------------------------------------------------------------------
900      !!                  ***  ROUTINE interpvnb  ***
901      !!---------------------------------------------------------------------- 
902      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
903      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
904      LOGICAL                         , INTENT(in   ) ::   before
905      INTEGER                         , INTENT(in   ) ::   nb , ndir
906      !
907      INTEGER  ::   ji,jj
908      REAL(wp) ::   zrhox, zrhot, zt0, zt1, ztcoeff   
909      LOGICAL  ::   western_side, eastern_side,northern_side,southern_side
910      !!---------------------------------------------------------------------- 
911      !
912      IF( before ) THEN
913         ptab(i1:i2,j1:j2) = e1v(i1:i2,j1:j2) * hv_n(i1:i2,j1:j2) * vn_b(i1:i2,j1:j2)
914      ELSE
915         western_side  = (nb == 1).AND.(ndir == 1)
916         eastern_side  = (nb == 1).AND.(ndir == 2)
917         southern_side = (nb == 2).AND.(ndir == 1)
918         northern_side = (nb == 2).AND.(ndir == 2)
919         zrhox = Agrif_Rhox()
920         zrhot = Agrif_rhot()
921         ! Time indexes bounds for integration
922         zt0 = REAL(Agrif_NbStepint()  , wp) / zrhot
923         zt1 = REAL(Agrif_NbStepint()+1, wp) / zrhot     
924         IF( bdy_tinterp == 1 ) THEN
925            ztcoeff = zrhot * (  zt1**2._wp * (       zt1 - 1._wp)        &
926               &               - zt0**2._wp * (       zt0 - 1._wp)        )
927         ELSEIF( bdy_tinterp == 2 ) THEN
928            ztcoeff = zrhot * (  zt1        * (       zt1 - 1._wp)**2._wp &
929               &               - zt0        * (       zt0 - 1._wp)**2._wp ) 
930         ELSE
931            ztcoeff = 1
932         ENDIF
933         !! clem ghost
934         IF(western_side)   vbdy_w(j1:j2) = vbdy_w(j1:j2) + ztcoeff * ptab(i2,j1:j2) 
935         IF(eastern_side)   vbdy_e(j1:j2) = vbdy_e(j1:j2) + ztcoeff * ptab(i1,j1:j2) !clem previously i1 
936         IF(southern_side)  vbdy_s(i1:i2) = vbdy_s(i1:i2) + ztcoeff * ptab(i1:i2,j2) !clem previously j1
937         IF(northern_side)  vbdy_n(i1:i2) = vbdy_n(i1:i2) + ztcoeff * ptab(i1:i2,j1) 
938         !           
939         IF( bdy_tinterp == 0 .OR. bdy_tinterp == 2) THEN
940            IF(western_side)   vbdy_w(j1:j2) = vbdy_w(j1:j2) / (zrhox*e1v(i2,j1:j2)) * vmask(i2,j1:j2,1)
941            IF(eastern_side)   vbdy_e(j1:j2) = vbdy_e(j1:j2) / (zrhox*e1v(i1,j1:j2)) * vmask(i1,j1:j2,1)
942            IF(southern_side)  vbdy_s(i1:i2) = vbdy_s(i1:i2) / (zrhox*e1v(i1:i2,j2)) * vmask(i1:i2,j2,1)
943            IF(northern_side)  vbdy_n(i1:i2) = vbdy_n(i1:i2) / (zrhox*e1v(i1:i2,j1)) * vmask(i1:i2,j1,1)
944         ENDIF
945      ENDIF
946      !
947   END SUBROUTINE interpvnb
948
949
950   SUBROUTINE interpub2b( ptab, i1, i2, j1, j2, before, nb, ndir )
951      !!----------------------------------------------------------------------
952      !!                  ***  ROUTINE interpub2b  ***
953      !!---------------------------------------------------------------------- 
954      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
955      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
956      LOGICAL                         , INTENT(in   ) ::   before
957      INTEGER                         , INTENT(in   ) ::   nb , ndir
958      !
959      INTEGER  ::   ji,jj
960      REAL(wp) ::   zrhot, zt0, zt1,zat
961      LOGICAL  ::   western_side, eastern_side,northern_side,southern_side
962      !!---------------------------------------------------------------------- 
963      IF( before ) THEN
964         ptab(i1:i2,j1:j2) = e2u(i1:i2,j1:j2) * ub2_b(i1:i2,j1:j2)
965      ELSE
966         western_side  = (nb == 1).AND.(ndir == 1)
967         eastern_side  = (nb == 1).AND.(ndir == 2)
968         southern_side = (nb == 2).AND.(ndir == 1)
969         northern_side = (nb == 2).AND.(ndir == 2)
970         zrhot = Agrif_rhot()
971         ! Time indexes bounds for integration
972         zt0 = REAL(Agrif_NbStepint()  , wp) / zrhot
973         zt1 = REAL(Agrif_NbStepint()+1, wp) / zrhot
974         ! Polynomial interpolation coefficients:
975         zat = zrhot * (  zt1**2._wp * (-2._wp*zt1 + 3._wp)    &
976            &           - zt0**2._wp * (-2._wp*zt0 + 3._wp)    ) 
977         !! clem ghost
978         IF(western_side ) ubdy_w(j1:j2) = zat * ptab(i2,j1:j2) 
979         IF(eastern_side ) ubdy_e(j1:j2) = zat * ptab(i1,j1:j2) !clem previously i1 
980         IF(southern_side) ubdy_s(i1:i2) = zat * ptab(i1:i2,j2) !clem previously j1
981         IF(northern_side) ubdy_n(i1:i2) = zat * ptab(i1:i2,j1) 
982      ENDIF
983      !
984   END SUBROUTINE interpub2b
985   
986
987   SUBROUTINE interpvb2b( ptab, i1, i2, j1, j2, before, nb, ndir )
988      !!----------------------------------------------------------------------
989      !!                  ***  ROUTINE interpvb2b  ***
990      !!---------------------------------------------------------------------- 
991      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
992      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
993      LOGICAL                         , INTENT(in   ) ::   before
994      INTEGER                         , INTENT(in   ) ::   nb , ndir
995      !
996      INTEGER ::   ji,jj
997      REAL(wp) ::   zrhot, zt0, zt1,zat
998      LOGICAL ::   western_side, eastern_side,northern_side,southern_side
999      !!---------------------------------------------------------------------- 
1000      !
1001      IF( before ) THEN
1002         ptab(i1:i2,j1:j2) = e1v(i1:i2,j1:j2) * vb2_b(i1:i2,j1:j2)
1003      ELSE     
1004         western_side  = (nb == 1).AND.(ndir == 1)
1005         eastern_side  = (nb == 1).AND.(ndir == 2)
1006         southern_side = (nb == 2).AND.(ndir == 1)
1007         northern_side = (nb == 2).AND.(ndir == 2)
1008         zrhot = Agrif_rhot()
1009         ! Time indexes bounds for integration
1010         zt0 = REAL(Agrif_NbStepint()  , wp) / zrhot
1011         zt1 = REAL(Agrif_NbStepint()+1, wp) / zrhot
1012         ! Polynomial interpolation coefficients:
1013         zat = zrhot * (  zt1**2._wp * (-2._wp*zt1 + 3._wp)    &
1014            &           - zt0**2._wp * (-2._wp*zt0 + 3._wp)    ) 
1015         !
1016         IF(western_side )   vbdy_w(j1:j2) = zat * ptab(i2,j1:j2) 
1017         IF(eastern_side )   vbdy_e(j1:j2) = zat * ptab(i1,j1:j2) !clem previously i1 
1018         IF(southern_side)   vbdy_s(i1:i2) = zat * ptab(i1:i2,j2) !clem previously j1
1019         IF(northern_side)   vbdy_n(i1:i2) = zat * ptab(i1:i2,j1) 
1020      ENDIF
1021      !     
1022   END SUBROUTINE interpvb2b
1023
1024
1025   SUBROUTINE interpe3t( ptab, i1, i2, j1, j2, k1, k2, before, nb, ndir )
1026      !!----------------------------------------------------------------------
1027      !!                  ***  ROUTINE interpe3t  ***
1028      !!---------------------------------------------------------------------- 
1029      INTEGER                              , INTENT(in   ) :: i1, i2, j1, j2, k1, k2
1030      REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) :: ptab
1031      LOGICAL                              , INTENT(in   ) :: before
1032      INTEGER                              , INTENT(in   ) :: nb , ndir
1033      !
1034      INTEGER :: ji, jj, jk
1035      LOGICAL :: western_side, eastern_side, northern_side, southern_side
1036      !!---------------------------------------------------------------------- 
1037      !   
1038      IF( before ) THEN
1039         ptab(i1:i2,j1:j2,k1:k2) = tmask(i1:i2,j1:j2,k1:k2) * e3t_0(i1:i2,j1:j2,k1:k2)
1040      ELSE
1041         western_side  = (nb == 1).AND.(ndir == 1)
1042         eastern_side  = (nb == 1).AND.(ndir == 2)
1043         southern_side = (nb == 2).AND.(ndir == 1)
1044         northern_side = (nb == 2).AND.(ndir == 2)
1045         !
1046         DO jk = k1, k2
1047            DO jj = j1, j2
1048               DO ji = i1, i2
1049                  !
1050                  IF( ABS( ptab(ji,jj,jk) - tmask(ji,jj,jk) * e3t_0(ji,jj,jk) ) > 1.D-2) THEN
1051                     IF (western_side) THEN
1052                        WRITE(numout,*) 'ERROR bathymetry merge at the western border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1053                     ELSEIF (eastern_side) THEN
1054                        WRITE(numout,*) 'ERROR bathymetry merge at the eastern border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1055                     ELSEIF (southern_side) THEN
1056                        WRITE(numout,*) 'ERROR bathymetry merge at the southern border ji,jj,jk', ji+nimpp-1,jj+njmpp-1,jk
1057                     ELSEIF (northern_side) THEN
1058                        WRITE(numout,*) 'ERROR bathymetry merge at the northen border ji,jj,jk', ji+nimpp-1,jj+njmpp-1,jk
1059                     ENDIF
1060                     WRITE(numout,*) '      ptab(ji,jj,jk), e3t(ji,jj,jk) ', ptab(ji,jj,jk), e3t_0(ji,jj,jk)
1061                     kindic_agr = kindic_agr + 1
1062                  ENDIF
1063               END DO
1064            END DO
1065         END DO
1066         !
1067      ENDIF
1068      !
1069   END SUBROUTINE interpe3t
1070
1071
1072   SUBROUTINE interpumsk( ptab, i1, i2, j1, j2, k1, k2, before, nb, ndir )
1073      !!----------------------------------------------------------------------
1074      !!                  ***  ROUTINE interpumsk  ***
1075      !!---------------------------------------------------------------------- 
1076      INTEGER                              , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2
1077      REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
1078      LOGICAL                              , INTENT(in   ) ::   before
1079      INTEGER                              , INTENT(in   ) ::   nb , ndir
1080      !
1081      INTEGER ::   ji, jj, jk
1082      LOGICAL ::   western_side, eastern_side   
1083      !!---------------------------------------------------------------------- 
1084      !   
1085      IF( before ) THEN
1086         ptab(i1:i2,j1:j2,k1:k2) = umask(i1:i2,j1:j2,k1:k2)
1087      ELSE
1088         western_side = (nb == 1).AND.(ndir == 1)
1089         eastern_side = (nb == 1).AND.(ndir == 2)
1090         DO jk = k1, k2
1091            DO jj = j1, j2
1092               DO ji = i1, i2
1093                   ! Velocity mask at boundary edge points:
1094                  IF (ABS(ptab(ji,jj,jk) - umask(ji,jj,jk)) > 1.D-2) THEN
1095                     IF (western_side) THEN
1096                        WRITE(numout,*) 'ERROR with umask at the western border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1097                        WRITE(numout,*) '      masks: parent, child ', ptab(ji,jj,jk), umask(ji,jj,jk)
1098                        kindic_agr = kindic_agr + 1
1099                     ELSEIF (eastern_side) THEN
1100                        WRITE(numout,*) 'ERROR with umask at the eastern border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1101                        WRITE(numout,*) '      masks: parent, child ', ptab(ji,jj,jk), umask(ji,jj,jk)
1102                        kindic_agr = kindic_agr + 1
1103                     ENDIF
1104                  ENDIF
1105               END DO
1106            END DO
1107         END DO
1108         !
1109      ENDIF
1110      !
1111   END SUBROUTINE interpumsk
1112
1113
1114   SUBROUTINE interpvmsk( ptab, i1, i2, j1, j2, k1, k2, before, nb, ndir )
1115      !!----------------------------------------------------------------------
1116      !!                  ***  ROUTINE interpvmsk  ***
1117      !!---------------------------------------------------------------------- 
1118      INTEGER                              , INTENT(in   ) ::   i1,i2,j1,j2,k1,k2
1119      REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
1120      LOGICAL                              , INTENT(in   ) ::   before
1121      INTEGER                              , INTENT(in   ) :: nb , ndir
1122      !
1123      INTEGER ::   ji, jj, jk
1124      LOGICAL ::   northern_side, southern_side     
1125      !!---------------------------------------------------------------------- 
1126      !   
1127      IF( before ) THEN
1128         ptab(i1:i2,j1:j2,k1:k2) = vmask(i1:i2,j1:j2,k1:k2)
1129      ELSE
1130         southern_side = (nb == 2).AND.(ndir == 1)
1131         northern_side = (nb == 2).AND.(ndir == 2)
1132         DO jk = k1, k2
1133            DO jj = j1, j2
1134               DO ji = i1, i2
1135                   ! Velocity mask at boundary edge points:
1136                  IF (ABS(ptab(ji,jj,jk) - vmask(ji,jj,jk)) > 1.D-2) THEN
1137                     IF (southern_side) THEN
1138                        WRITE(numout,*) 'ERROR with vmask at the southern border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1139                        WRITE(numout,*) '      masks: parent, child ', ptab(ji,jj,jk), vmask(ji,jj,jk)
1140                        kindic_agr = kindic_agr + 1
1141                     ELSEIF (northern_side) THEN
1142                        WRITE(numout,*) 'ERROR with vmask at the northern border ji,jj,jk ', ji+nimpp-1,jj+njmpp-1,jk
1143                        WRITE(numout,*) '      masks: parent, child ', ptab(ji,jj,jk), vmask(ji,jj,jk)
1144                        kindic_agr = kindic_agr + 1
1145                     ENDIF
1146                  ENDIF
1147               END DO
1148            END DO
1149         END DO
1150         !
1151      ENDIF
1152      !
1153   END SUBROUTINE interpvmsk
1154
1155# if defined key_zdftke
1156
1157   SUBROUTINE interpavm( ptab, i1, i2, j1, j2, k1, k2, before )
1158      !!----------------------------------------------------------------------
1159      !!                  ***  ROUTINE interavm  ***
1160      !!---------------------------------------------------------------------- 
1161      INTEGER                              , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2
1162      REAL(wp),DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
1163      LOGICAL                              , INTENT(in   ) ::   before
1164      !!---------------------------------------------------------------------- 
1165      !     
1166      IF( before ) THEN
1167         ptab (i1:i2,j1:j2,k1:k2) = avm_k(i1:i2,j1:j2,k1:k2)
1168      ELSE
1169         avm_k(i1:i2,j1:j2,k1:k2) = ptab (i1:i2,j1:j2,k1:k2)
1170      ENDIF
1171      !
1172   END SUBROUTINE interpavm
1173
1174# endif /* key_zdftke */
1175
1176#else
1177   !!----------------------------------------------------------------------
1178   !!   Empty module                                          no AGRIF zoom
1179   !!----------------------------------------------------------------------
1180CONTAINS
1181   SUBROUTINE Agrif_OPA_Interp_empty
1182      WRITE(*,*)  'agrif_opa_interp : You should not have seen this print! error?'
1183   END SUBROUTINE Agrif_OPA_Interp_empty
1184#endif
1185
1186   !!======================================================================
1187END MODULE agrif_opa_interp
Note: See TracBrowser for help on using the repository browser.