source: NEMO/branches/2020/dev_r12973_AGRIF_CMEMS/src/NST/agrif_user.F90 @ 13182

Last change on this file since 13182 was 13182, checked in by rblod, 3 months ago

#2129 : move lk_south declaration + compatibility with SAS

  • Property svn:keywords set to Id
File size: 50.5 KB
Line 
1#undef UPD_HIGH   /* MIX HIGH UPDATE */
2#if defined key_agrif
3   !! * Substitutions
4#  include "do_loop_substitute.h90"
5   !!----------------------------------------------------------------------
6   !! NEMO/NST 4.0 , NEMO Consortium (2018)
7   !! $Id$
8   !! Software governed by the CeCILL license (see ./LICENSE)
9   !!----------------------------------------------------------------------
10   SUBROUTINE agrif_user
11   END SUBROUTINE agrif_user
12
13   SUBROUTINE agrif_before_regridding
14   END SUBROUTINE agrif_before_regridding
15
16   SUBROUTINE Agrif_InitWorkspace
17   END SUBROUTINE Agrif_InitWorkspace
18
19   SUBROUTINE Agrif_InitValues
20      !!----------------------------------------------------------------------
21      !!                 *** ROUTINE Agrif_InitValues ***
22      !!----------------------------------------------------------------------
23      USE nemogcm
24      !!----------------------------------------------------------------------
25      !
26      CALL nemo_init       !* Initializations of each fine grid
27      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
28      !
29      !                    !* Agrif initialization
30      CALL Agrif_InitValues_cont
31# if defined key_top
32      CALL Agrif_InitValues_cont_top
33# endif
34# if defined key_si3
35      CALL Agrif_InitValues_cont_ice
36# endif
37      !   
38   END SUBROUTINE Agrif_initvalues
39
40   SUBROUTINE agrif_istate( Kbb, Kmm, Kaa )
41
42       USE domvvl
43       USE domain
44       USE par_oce
45       USE agrif_oce
46       USE agrif_oce_interp
47       USE oce
48       USE lib_mpp
49       USe lbclnk
50
51      INTEGER, INTENT(in)  :: Kbb, Kmm, Kaa
52      INTEGER :: jn
53
54      IF(lwp) WRITE(numout,*) ' '
55      IF(lwp) WRITE(numout,*) 'AGRIF: interp child initial state from parent'
56      IF(lwp) WRITE(numout,*) ' '
57
58      l_ini_child = .TRUE.
59      Agrif_SpecialValue    = 0._wp
60      Agrif_UseSpecialValue = .TRUE.
61      uu(:,:,:,:) = 0.  ;  vv(:,:,:,:) = 0.   ;  ts(:,:,:,:,:) = 0.
62       
63      Krhs_a = Kbb ; Kmm_a = Kbb
64
65      ! Brutal fix to pas 1x1 refinment.
66  !    IF(Agrif_Irhox() == 1) THEN
67  !       CALL Agrif_Init_Variable(tsini_id, procname=agrif_initts)
68  !    ELSE
69      CALL Agrif_Init_Variable(tsini_id, procname=interptsn)
70
71  !    ENDIF
72! just for VORTEX because Parent velocities can actually be exactly zero
73!      Agrif_UseSpecialValue = .FALSE.
74      Agrif_UseSpecialValue = ln_spc_dyn
75      use_sign_north = .TRUE.
76      sign_north = -1.
77      CALL Agrif_Init_Variable(uini_id , procname=interpun )
78      CALL Agrif_Init_Variable(vini_id , procname=interpvn )
79      use_sign_north = .FALSE.
80
81      Agrif_UseSpecialValue = .FALSE.            !
82      l_ini_child = .FALSE.
83
84      Krhs_a = Kaa ; Kmm_a = Kmm
85
86      DO jn = 1, jpts
87         ts(:,:,:,jn,Kbb) = ts(:,:,:,jn,Kbb)*tmask(:,:,:)
88      END DO
89      uu(:,:,:,Kbb) =  uu(:,:,:,Kbb) * umask(:,:,:)     
90      vv(:,:,:,Kbb) =  vv(:,:,:,Kbb) * vmask(:,:,:) 
91
92
93      CALL lbc_lnk_multi( 'agrif_istate', uu(:,:,:,Kbb), 'U', -1. , vv(:,:,:,Kbb), 'V', -1. )
94      CALL lbc_lnk( 'agrif_istate', ts(:,:,:,:,Kbb), 'T', 1. )
95
96   END SUBROUTINE agrif_istate   
97
98   SUBROUTINE agrif_declare_var_ini
99      !!----------------------------------------------------------------------
100      !!                 *** ROUTINE agrif_declare_var ***
101      !!----------------------------------------------------------------------
102      USE agrif_util
103      USE agrif_oce
104      USE par_oce
105      USE zdf_oce 
106      USE oce
107      USE dom_oce
108      !
109      IMPLICIT NONE
110      !
111      INTEGER :: ind1, ind2, ind3
112      External :: nemo_mapping
113      !!----------------------------------------------------------------------
114
115! In case of East-West periodicity, prevent AGRIF interpolation at east and west boundaries
116! The procnames will not be called at these boundaries
117      IF (jperio == 1) THEN
118         CALL Agrif_Set_NearCommonBorderX(.TRUE.)
119         CALL Agrif_Set_DistantCommonBorderX(.TRUE.)
120      ENDIF
121
122      IF ( .NOT. lk_south ) THEN
123         CALL Agrif_Set_NearCommonBorderY(.TRUE.)
124      ENDIF
125
126      ! 1. Declaration of the type of variable which have to be interpolated
127      !---------------------------------------------------------------------
128      ind1 =     nbghostcells
129      ind2 = 2 + nbghostcells_x
130      ind3 = 2 + nbghostcells_y_s
131
132      CALL agrif_declare_variable((/2,2,0/),(/ind2,ind3,0/),(/'x','y','N'/),(/1,1,1/),(/nlci,nlcj,jpk/),e3t_id)
133      CALL agrif_declare_variable((/2,2/)  ,(/ind2,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),mbkt_id)
134      CALL agrif_declare_variable((/2,2/)  ,(/ind2,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),ht0_id)
135
136      CALL agrif_declare_variable((/1,2/),(/ind2-1,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),e1u_id)
137      CALL agrif_declare_variable((/2,1/),(/ind2,ind3-1/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),e2v_id)
138
139   
140      ! Initial or restart velues
141     
142      CALL agrif_declare_variable((/2,2,0,0/),(/ind2  ,ind3  ,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jpts+1/),tsini_id)
143      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3  ,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/)     ,uini_id ) 
144      CALL agrif_declare_variable((/2,1,0,0/),(/ind2  ,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/)     ,vini_id )
145      CALL agrif_declare_variable((/2,2/)    ,(/ind2,ind3/)        ,(/'x','y'/),(/1,1/),(/nlci,nlcj/),sshini_id)
146      !
147     
148      ! 2. Type of interpolation
149      !-------------------------
150      CALL Agrif_Set_bcinterp(e3t_id,interp=AGRIF_constant)
151
152      CALL Agrif_Set_bcinterp(mbkt_id,interp=AGRIF_constant)
153      CALL Agrif_Set_interp  (mbkt_id,interp=AGRIF_constant)
154      CALL Agrif_Set_bcinterp(ht0_id ,interp=AGRIF_constant)
155      CALL Agrif_Set_interp  (ht0_id ,interp=AGRIF_constant)
156
157      CALL Agrif_Set_bcinterp( e1u_id, interp1=Agrif_linear, interp2=AGRIF_ppm    )
158      CALL Agrif_Set_bcinterp( e2v_id, interp1=AGRIF_ppm   , interp2=Agrif_linear )
159
160      ! Initial fields
161      CALL Agrif_Set_bcinterp(tsini_id ,interp=AGRIF_linear)
162      CALL Agrif_Set_interp  (tsini_id ,interp=AGRIF_linear)
163      CALL Agrif_Set_bcinterp(uini_id  ,interp=AGRIF_linear)
164      CALL Agrif_Set_interp  (uini_id  ,interp=AGRIF_linear)
165      CALL Agrif_Set_bcinterp(vini_id  ,interp=AGRIF_linear)
166      CALL Agrif_Set_interp  (vini_id  ,interp=AGRIF_linear)
167      CALL Agrif_Set_bcinterp(sshini_id,interp=AGRIF_linear)
168      CALL Agrif_Set_interp  (sshini_id,interp=AGRIF_linear)
169
170       ! 3. Location of interpolation
171      !-----------------------------
172!      CALL Agrif_Set_bc(  e3t_id, (/-nn_sponge_len*Agrif_irhox(),ind1-1/) ) 
173! JC: check near the boundary only until matching in sponge has been sorted out:
174      CALL Agrif_Set_bc(  e3t_id, (/0,ind1-1/) ) 
175
176      ! extend the interpolation zone by 1 more point than necessary:
177      ! RB check here
178      CALL Agrif_Set_bc(  mbkt_id, (/-nn_sponge_len*Agrif_irhox()-2,ind1/) )
179      CALL Agrif_Set_bc(  ht0_id,  (/-nn_sponge_len*Agrif_irhox()-2,ind1/) )
180     
181      CALL Agrif_Set_bc(e1u_id,(/0,ind1-1/))
182      CALL Agrif_Set_bc(e2v_id,(/0,ind1-1/)) 
183
184      CALL Agrif_Set_bc( tsini_id , (/0,ind1-1/) ) ! if west,  rhox=3 and nbghost=3: columns 2 to 4
185      CALL Agrif_Set_bc( uini_id  , (/0,ind1-1/) ) 
186      CALL Agrif_Set_bc( vini_id  , (/0,ind1-1/) )
187      CALL Agrif_Set_bc( sshini_id, (/0,ind1-1/) )
188
189      ! 4. Update type
190      !---------------
191# if defined UPD_HIGH
192      CALL Agrif_Set_Updatetype(e1u_id,update1 = Agrif_Update_Average, update2=Agrif_Update_Full_Weighting)
193      CALL Agrif_Set_Updatetype(e2v_id,update1 = Agrif_Update_Full_Weighting, update2=Agrif_Update_Average)
194#else
195      CALL Agrif_Set_Updatetype(e1u_id,update1 = Agrif_Update_Copy, update2=Agrif_Update_Average)
196      CALL Agrif_Set_Updatetype(e2v_id,update1 = Agrif_Update_Average, update2=Agrif_Update_Copy)
197#endif
198     
199      CALL Agrif_Set_ExternalMapping(nemo_mapping)
200      !
201   END SUBROUTINE agrif_declare_var_ini
202
203
204   SUBROUTINE Agrif_Init_Domain( Kbb, Kmm, Kaa ) 
205      !!----------------------------------------------------------------------
206      !!                 *** ROUTINE Agrif_InitValues_cont_dom ***
207      !!----------------------------------------------------------------------
208 
209         !!----------------------------------------------------------------------
210         !!                 *** ROUTINE Agrif_InitValues_cont ***
211         !!
212         !! ** Purpose ::   Declaration of variables to be interpolated
213         !!----------------------------------------------------------------------
214      USE agrif_oce_update
215      USE agrif_oce_interp
216      USE agrif_oce_sponge
217      USE Agrif_Util
218      USE oce 
219      USE dom_oce
220      USE zdf_oce
221      USE nemogcm
222      USE agrif_oce
223      !
224      USE lbclnk
225      USE lib_mpp
226      USE in_out_manager
227      !
228      IMPLICIT NONE
229      !
230      INTEGER, INTENT(in) ::  Kbb, Kmm, Kaa
231      !
232      LOGICAL :: check_namelist
233      CHARACTER(len=15) :: cl_check1, cl_check2, cl_check3, cl_check4 
234      REAL(wp), DIMENSION(jpi,jpj) ::   zk   ! workspace
235      INTEGER :: ji, jj, jk
236      !!----------------------------------------------------------------------
237   
238     ! CALL Agrif_Declare_Var_ini
239
240      IF( agrif_oce_alloc()  > 0 )   CALL ctl_warn('agrif agrif_oce_alloc: allocation of arrays failed')
241
242      ! Build consistent parent bathymetry and number of levels
243      ! on the child grid
244      Agrif_UseSpecialValue = .FALSE.
245      ht0_parent(:,:) = 0._wp
246      mbkt_parent(:,:) = 0
247      !
248  !    CALL Agrif_Bc_variable(ht0_id ,calledweight=1.,procname=interpht0 )
249  !    CALL Agrif_Bc_variable(mbkt_id,calledweight=1.,procname=interpmbkt)
250      CALL Agrif_Init_Variable(ht0_id , procname=interpht0 )
251      CALL Agrif_Init_Variable(mbkt_id, procname=interpmbkt)
252      !
253      ! Assume step wise change of bathymetry near interface
254      ! TODO: Switch to linear interpolation of bathymetry in the s-coordinate case
255      !       and no refinement
256      DO_2D_10_10
257         mbku_parent(ji,jj) = MIN(  mbkt_parent(ji+1,jj  ) , mbkt_parent(ji,jj)  )
258         mbkv_parent(ji,jj) = MIN(  mbkt_parent(ji  ,jj+1) , mbkt_parent(ji,jj)  )
259      END_2D
260      IF ( ln_sco.AND.Agrif_Parent(ln_sco) ) THEN
261         DO_2D_10_10
262            hu0_parent(ji,jj) = 0.5_wp * ( ht0_parent(ji,jj)+ht0_parent(ji+1,jj) )
263            hv0_parent(ji,jj) = 0.5_wp * ( ht0_parent(ji,jj)+ht0_parent(ji,jj+1) )
264         END_2D
265      ELSE
266         DO_2D_10_10
267            hu0_parent(ji,jj) = MIN( ht0_parent(ji,jj), ht0_parent(ji+1,jj))
268            hv0_parent(ji,jj) = MIN( ht0_parent(ji,jj), ht0_parent(ji,jj+1))
269         END_2D
270
271      ENDIF
272      !
273      CALL lbc_lnk( 'Agrif_Init_Domain', hu0_parent, 'U', 1. )
274      CALL lbc_lnk( 'Agrif_Init_Domain', hv0_parent, 'V', 1. )
275      zk(:,:) = REAL( mbku_parent(:,:), wp )   ;   CALL lbc_lnk( 'Agrif_InitValues_cont', zk, 'U', 1. )
276      mbku_parent(:,:) = MAX( NINT( zk(:,:) ), 1 ) ;
277      zk(:,:) = REAL( mbkv_parent(:,:), wp )   ;   CALL lbc_lnk( 'Agrif_InitValues_cont', zk, 'V', 1. )
278      mbkv_parent(:,:) = MAX( NINT( zk(:,:) ), 1 )   
279
280      IF ( ln_init_chfrpar ) THEN
281         CALL Agrif_Init_Variable(sshini_id, procname=agrif_initssh)
282         CALL lbc_lnk( 'Agrif_Init_Domain', ssh(:,:,Kbb), 'T', 1. )
283         DO jk = 1, jpk
284               e3t(:,:,jk,Kbb) =  e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kbb)  ) &
285                        &             / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk)   &
286                        &              + e3t_0(:,:,jk) * ( 1._wp - tmask(:,:,jk) )
287         END DO
288      ENDIF
289
290      ! check if masks and bathymetries match
291      IF(ln_chk_bathy) THEN
292         Agrif_UseSpecialValue = .FALSE.
293         !
294         IF(lwp) WRITE(numout,*) ' '
295         IF(lwp) WRITE(numout,*) 'AGRIF: Check Bathymetry and masks near bdys. Level: ', Agrif_Level()
296         !
297         kindic_agr = 0
298         IF( .NOT. l_vremap ) THEN
299            !
300            ! check if tmask and vertical scale factors agree with parent in sponge area:
301            CALL Agrif_Bc_variable(e3t_id,calledweight=1.,procname=interpe3t)
302            !
303         ELSE
304            !
305            ! In case of vertical interpolation, check only that total depths agree between child and parent:
306            DO ji = 1, jpi
307               DO jj = 1, jpj
308                  IF ((mbkt_parent(ji,jj)/=0).AND.(ABS(ht0_parent(ji,jj)-ht_0(ji,jj))>1.e-3)) kindic_agr = kindic_agr + 1
309                  IF ((mbku_parent(ji,jj)/=0).AND.(ABS(hu0_parent(ji,jj)-hu_0(ji,jj))>1.e-3)) kindic_agr = kindic_agr + 1
310                  IF ((mbkv_parent(ji,jj)/=0).AND.(ABS(hv0_parent(ji,jj)-hv_0(ji,jj))>1.e-3)) kindic_agr = kindic_agr + 1
311               END DO
312            END DO
313
314            CALL mpp_sum( 'agrif_user', kindic_agr )
315            IF( kindic_agr /= 0 ) THEN
316               CALL ctl_stop('==> Child Bathymetry is NOT correct near boundaries.')
317            ELSE
318               IF(lwp) WRITE(numout,*) '==> Child Bathymetry is ok near boundaries.'
319               IF(lwp) WRITE(numout,*) ' '
320            ENDIF 
321         ENDIF
322      ENDIF
323
324      IF( l_vremap ) THEN
325      ! Additional constrain that should be removed someday:
326         IF ( Agrif_Parent(jpk).GT.jpk ) THEN
327            CALL ctl_stop( ' With l_vremap, child grids must have jpk greater or equal to the parent value' )
328         ENDIF
329      ENDIF
330      !
331   END SUBROUTINE Agrif_Init_Domain
332
333
334   SUBROUTINE Agrif_InitValues_cont
335         !!----------------------------------------------------------------------
336         !!                 *** ROUTINE Agrif_InitValues_cont ***
337         !!
338         !! ** Purpose ::   Declaration of variables to be interpolated
339         !!----------------------------------------------------------------------
340      USE agrif_oce_update
341      USE agrif_oce_interp
342      USE agrif_oce_sponge
343      USE Agrif_Util
344      USE oce 
345      USE dom_oce
346      USE zdf_oce
347      USE nemogcm
348      USE agrif_oce
349      !
350      USE lbclnk
351      USE lib_mpp
352      USE in_out_manager
353      !
354      IMPLICIT NONE
355      !
356      LOGICAL :: check_namelist
357      CHARACTER(len=15) :: cl_check1, cl_check2, cl_check3, cl_check4 
358      REAL(wp), DIMENSION(jpi,jpj) ::   zk   ! workspace
359      INTEGER :: ji, jj
360
361      ! 1. Declaration of the type of variable which have to be interpolated
362      !---------------------------------------------------------------------
363      CALL agrif_declare_var
364
365      ! 2. First interpolations of potentially non zero fields
366      !-------------------------------------------------------
367      Agrif_SpecialValue    = 0._wp
368      Agrif_UseSpecialValue = .TRUE.
369      CALL Agrif_Bc_variable(tsn_id,calledweight=1.,procname=interptsn)
370      CALL Agrif_Sponge
371      tabspongedone_tsn = .FALSE.
372      CALL Agrif_Bc_variable(tsn_sponge_id,calledweight=1.,procname=interptsn_sponge)
373      ! reset tsa to zero
374      ts(:,:,:,:,Krhs_a) = 0._wp
375
376      Agrif_UseSpecialValue = ln_spc_dyn
377      use_sign_north = .TRUE.
378      sign_north = -1.
379      CALL Agrif_Bc_variable(un_interp_id,calledweight=1.,procname=interpun)
380      CALL Agrif_Bc_variable(vn_interp_id,calledweight=1.,procname=interpvn)
381      tabspongedone_u = .FALSE.
382      tabspongedone_v = .FALSE.
383      CALL Agrif_Bc_variable(un_sponge_id,calledweight=1.,procname=interpun_sponge)
384      tabspongedone_u = .FALSE.
385      tabspongedone_v = .FALSE.
386      CALL Agrif_Bc_variable(vn_sponge_id,calledweight=1.,procname=interpvn_sponge)
387      use_sign_north = .FALSE.
388      uu(:,:,:,Krhs_a) = 0._wp
389      vv(:,:,:,Krhs_a) = 0._wp
390
391      Agrif_UseSpecialValue = .TRUE.
392      CALL Agrif_Bc_variable(sshn_id,calledweight=1., procname=interpsshn )
393      hbdy(:,:) = 0._wp
394      ssh(:,:,Krhs_a) = 0._wp
395
396      IF ( ln_dynspg_ts ) THEN
397         Agrif_UseSpecialValue = ln_spc_dyn
398         use_sign_north = .TRUE.
399         sign_north = -1.
400         CALL Agrif_Bc_variable(unb_id,calledweight=1.,procname=interpunb)
401         CALL Agrif_Bc_variable(vnb_id,calledweight=1.,procname=interpvnb)
402         CALL Agrif_Bc_variable(ub2b_interp_id,calledweight=1.,procname=interpub2b)
403         CALL Agrif_Bc_variable(vb2b_interp_id,calledweight=1.,procname=interpvb2b)
404         use_sign_north = .FALSE.
405         ubdy(:,:) = 0._wp
406         vbdy(:,:) = 0._wp
407      ENDIF
408      Agrif_UseSpecialValue = .FALSE. 
409
410      !-----------------
411      check_namelist = .TRUE.
412
413      IF( check_namelist ) THEN 
414         ! Check free surface scheme
415         IF ( ( Agrif_Parent(ln_dynspg_ts ).AND.ln_dynspg_exp ).OR.&
416            & ( Agrif_Parent(ln_dynspg_exp).AND.ln_dynspg_ts ) ) THEN
417            WRITE(cl_check1,*)  Agrif_Parent( ln_dynspg_ts )
418            WRITE(cl_check2,*)  ln_dynspg_ts
419            WRITE(cl_check3,*)  Agrif_Parent( ln_dynspg_exp )
420            WRITE(cl_check4,*)  ln_dynspg_exp
421            CALL ctl_stop( 'Incompatible free surface scheme between grids' ,  &
422                  &               'parent grid ln_dynspg_ts  :'//cl_check1  ,  & 
423                  &               'child  grid ln_dynspg_ts  :'//cl_check2  ,  &
424                  &               'parent grid ln_dynspg_exp :'//cl_check3  ,  &
425                  &               'child  grid ln_dynspg_exp :'//cl_check4  ,  &
426                  &               'those logicals should be identical' )                 
427            STOP
428         ENDIF
429
430         ! Check if identical linear free surface option
431         IF ( ( Agrif_Parent(ln_linssh ).AND.(.NOT.ln_linssh )).OR.&
432            & ( (.NOT.Agrif_Parent(ln_linssh)).AND.ln_linssh ) ) THEN
433            WRITE(cl_check1,*)  Agrif_Parent(ln_linssh )
434            WRITE(cl_check2,*)  ln_linssh
435            CALL ctl_stop( 'Incompatible linearized fs option between grids',  &
436                  &               'parent grid ln_linssh  :'//cl_check1     ,  &
437                  &               'child  grid ln_linssh  :'//cl_check2     ,  &
438                  &               'those logicals should be identical' )                 
439            STOP
440         ENDIF
441      ENDIF
442
443   END SUBROUTINE Agrif_InitValues_cont
444
445   SUBROUTINE agrif_declare_var
446      !!----------------------------------------------------------------------
447      !!                 *** ROUTINE agrif_declare_var ***
448      !!----------------------------------------------------------------------
449      USE agrif_util
450      USE agrif_oce
451      USE par_oce
452      USE zdf_oce 
453      USE oce
454      !
455      IMPLICIT NONE
456      !
457      INTEGER :: ind1, ind2, ind3
458      !!----------------------------------------------------------------------
459
460      ! 1. Declaration of the type of variable which have to be interpolated
461      !---------------------------------------------------------------------
462
463      ind1 =     nbghostcells
464      ind2 = 2 + nbghostcells_x
465      ind3 = 2 + nbghostcells_y_s
466
467# if defined key_vertical
468      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jpts+1/),tsn_id)
469      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jpts+1/),tsn_sponge_id)
470      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),un_interp_id)
471      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),vn_interp_id)
472      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),un_update_id)
473      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),vn_update_id)
474      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),un_sponge_id)
475      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),vn_sponge_id)
476# else
477      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jpts/),tsn_id)
478      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jpts/),tsn_sponge_id)
479      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),un_interp_id)
480      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),vn_interp_id)
481      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),un_update_id)
482      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),vn_update_id)
483      CALL agrif_declare_variable((/1,2,0,0/),(/ind2-1,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),un_sponge_id)
484      CALL agrif_declare_variable((/2,1,0,0/),(/ind2,ind3-1,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),vn_sponge_id)
485# endif
486      CALL agrif_declare_variable((/1,2/),(/ind2-1,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),unb_id)
487      CALL agrif_declare_variable((/2,1/),(/ind2,ind3-1/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),vnb_id)
488      CALL agrif_declare_variable((/1,2/),(/ind2-1,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),ub2b_interp_id)
489      CALL agrif_declare_variable((/2,1/),(/ind2,ind3-1/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),vb2b_interp_id)
490      CALL agrif_declare_variable((/1,2/),(/ind2-1,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),ub2b_update_id)
491      CALL agrif_declare_variable((/2,1/),(/ind2,ind3-1/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),vb2b_update_id)
492
493      CALL agrif_declare_variable((/2,2/),(/ind2,ind3/),(/'x','y'/),(/1,1/),(/nlci,nlcj/),sshn_id)
494
495
496      IF( ln_zdftke.OR.ln_zdfgls ) THEN  ! logical not known at this point
497!         CALL agrif_declare_variable((/2,2,0/),(/ind3,ind3,0/),(/'x','y','N'/),(/1,1,1/),(/nlci,nlcj,jpk/), en_id)
498!         CALL agrif_declare_variable((/2,2,0/),(/ind3,ind3,0/),(/'x','y','N'/),(/1,1,1/),(/nlci,nlcj,jpk/),avt_id)
499# if defined key_vertical
500         CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,2/),avm_id)
501# else
502         CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,1/),avm_id)
503# endif
504      ENDIF
505     
506      ! 2. Type of interpolation
507      !-------------------------
508      CALL Agrif_Set_bcinterp(tsn_id,interp=AGRIF_linear)
509      CALL Agrif_Set_bcinterp(un_interp_id,interp1=Agrif_linear,interp2=AGRIF_ppm)
510      CALL Agrif_Set_bcinterp(vn_interp_id,interp1=AGRIF_ppm,interp2=Agrif_linear)
511
512      CALL Agrif_Set_bcinterp(tsn_sponge_id,interp=AGRIF_linear)
513      CALL Agrif_Set_bcinterp(un_sponge_id,interp1=Agrif_linear,interp2=AGRIF_ppm)
514      CALL Agrif_Set_bcinterp(vn_sponge_id,interp1=AGRIF_ppm,interp2=Agrif_linear)
515
516      CALL Agrif_Set_bcinterp(sshn_id,interp=AGRIF_linear)
517      CALL Agrif_Set_bcinterp(unb_id,interp1=Agrif_linear,interp2=AGRIF_ppm)
518      CALL Agrif_Set_bcinterp(vnb_id,interp1=AGRIF_ppm,interp2=Agrif_linear)
519      CALL Agrif_Set_bcinterp(ub2b_interp_id,interp1=Agrif_linear,interp2=AGRIF_ppm)
520      CALL Agrif_Set_bcinterp(vb2b_interp_id,interp1=AGRIF_ppm,interp2=Agrif_linear)
521!
522! > Divergence conserving alternative:
523!      CALL Agrif_Set_bcinterp(sshn_id,interp=AGRIF_constant)
524!      CALL Agrif_Set_bcinterp(unb_id,interp1=Agrif_linear,interp2=AGRIF_constant)
525!      CALL Agrif_Set_bcinterp(vnb_id,interp1=AGRIF_constant,interp2=Agrif_linear)
526!      CALL Agrif_Set_bcinterp(ub2b_interp_id,interp1=Agrif_linear,interp2=AGRIF_constant)
527!      CALL Agrif_Set_bcinterp(vb2b_interp_id,interp1=AGRIF_constant,interp2=Agrif_linear)
528!<
529
530      IF( ln_zdftke.OR.ln_zdfgls )  CALL Agrif_Set_bcinterp( avm_id, interp=AGRIF_linear )
531   
532
533       ! 3. Location of interpolation
534      !-----------------------------
535      CALL Agrif_Set_bc(       tsn_id, (/0,ind1-1/) ) ! if west,  rhox=3 and nbghost=3: columns 2 to 4
536      CALL Agrif_Set_bc( un_interp_id, (/0,ind1-1/) ) 
537      CALL Agrif_Set_bc( vn_interp_id, (/0,ind1-1/) )
538
539      CALL Agrif_Set_bc( tsn_sponge_id, (/-nn_sponge_len*Agrif_irhox()-1,0/) )  ! if west,  rhox=3, nn_sponge_len=2
540      CALL Agrif_Set_bc(  un_sponge_id, (/-nn_sponge_len*Agrif_irhox()-1,0/) )  ! and nbghost=3:
541      CALL Agrif_Set_bc(  vn_sponge_id, (/-nn_sponge_len*Agrif_irhox()-1,0/) )  ! columns 4 to 11
542
543      CALL Agrif_Set_bc(        sshn_id, (/0,ind1-1/) )
544      CALL Agrif_Set_bc(         unb_id, (/0,ind1-1/) )
545      CALL Agrif_Set_bc(         vnb_id, (/0,ind1-1/) )
546      CALL Agrif_Set_bc( ub2b_interp_id, (/0,ind1-1/) )
547      CALL Agrif_Set_bc( vb2b_interp_id, (/0,ind1-1/) )
548
549      IF( ln_zdftke.OR.ln_zdfgls ) CALL Agrif_Set_bc( avm_id, (/0,ind1/) )
550
551      ! 4. Update type
552      !---------------
553
554# if defined UPD_HIGH
555      CALL Agrif_Set_Updatetype(tsn_id, update = Agrif_Update_Full_Weighting)
556      CALL Agrif_Set_Updatetype(un_update_id,update1 = Agrif_Update_Average, update2 = Agrif_Update_Full_Weighting)
557      CALL Agrif_Set_Updatetype(vn_update_id,update1 = Agrif_Update_Full_Weighting, update2 = Agrif_Update_Average)
558
559      CALL Agrif_Set_Updatetype(ub2b_update_id,update1 = Agrif_Update_Average, update2 = Agrif_Update_Full_Weighting)
560      CALL Agrif_Set_Updatetype(vb2b_update_id,update1 = Agrif_Update_Full_Weighting, update2 = Agrif_Update_Average)
561      CALL Agrif_Set_Updatetype(sshn_id,update = Agrif_Update_Full_Weighting)
562      CALL Agrif_Set_Updatetype(e3t_id, update = Agrif_Update_Full_Weighting)
563
564  !    IF( ln_zdftke.OR.ln_zdfgls ) THEN
565!         CALL Agrif_Set_Updatetype( en_id, update = AGRIF_Update_Full_Weighting)
566!         CALL Agrif_Set_Updatetype(avt_id, update = AGRIF_Update_Full_Weighting)
567!         CALL Agrif_Set_Updatetype(avm_id, update = AGRIF_Update_Full_Weighting)
568   !   ENDIF
569
570#else
571      CALL Agrif_Set_Updatetype(tsn_id, update = AGRIF_Update_Average)
572      CALL Agrif_Set_Updatetype(un_update_id,update1 = Agrif_Update_Copy, update2 = Agrif_Update_Average)
573      CALL Agrif_Set_Updatetype(vn_update_id,update1 = Agrif_Update_Average, update2 = Agrif_Update_Copy)
574
575      CALL Agrif_Set_Updatetype(ub2b_update_id,update1 = Agrif_Update_Copy, update2 = Agrif_Update_Average)
576      CALL Agrif_Set_Updatetype(vb2b_update_id,update1 = Agrif_Update_Average, update2 = Agrif_Update_Copy)
577      CALL Agrif_Set_Updatetype(sshn_id,update = AGRIF_Update_Average)
578      CALL Agrif_Set_Updatetype(e3t_id, update = AGRIF_Update_Average)
579
580 !     IF( ln_zdftke.OR.ln_zdfgls ) THEN
581!         CALL Agrif_Set_Updatetype( en_id, update = AGRIF_Update_Average)
582!         CALL Agrif_Set_Updatetype(avt_id, update = AGRIF_Update_Average)
583!         CALL Agrif_Set_Updatetype(avm_id, update = AGRIF_Update_Average)
584 !     ENDIF
585
586#endif
587      !
588   END SUBROUTINE agrif_declare_var
589
590#if defined key_si3
591SUBROUTINE Agrif_InitValues_cont_ice
592      USE Agrif_Util
593      USE sbc_oce, ONLY : nn_fsbc  ! clem: necessary otherwise Agrif_Parent(nn_fsbc) = nn_fsbc
594      USE ice
595      USE agrif_ice
596      USE in_out_manager
597      USE agrif_ice_interp
598      USE lib_mpp
599      !!----------------------------------------------------------------------
600      !!                 *** ROUTINE Agrif_InitValues_cont_ice ***
601      !!----------------------------------------------------------------------
602
603      ! Controls
604
605      ! clem: For some reason, nn_fsbc(child)/=1 does not work properly (signal can be largely degraded by the agrif zoom)
606      !          the run must satisfy CFL=Uice/(dx/dt) < 0.6/nn_fsbc(child)
607      !          therefore, if nn_fsbc(child)>1 one must reduce the time-step in proportion to nn_fsbc(child), which is not acceptable
608      !       If a solution is found, the following stop could be removed because the rest of the code take nn_fsbc(child) into account     
609      IF( nn_fsbc > 1 )  CALL ctl_stop('nn_fsbc(child) must be set to 1 otherwise agrif and sea-ice may not work properly')
610
611      ! stop if rhot * nn_fsbc(parent) /= N * nn_fsbc(child) with N being integer
612      IF( MOD( Agrif_irhot() * Agrif_Parent(nn_fsbc), nn_fsbc ) /= 0 )  THEN
613         CALL ctl_stop('rhot * nn_fsbc(parent) /= N * nn_fsbc(child), therefore nn_fsbc(child) should be set to 1 or nn_fsbc(parent)')
614      ENDIF
615      ! First Interpolations (using "after" ice subtime step => nbstep_ice=1)
616      !----------------------------------------------------------------------
617      nbstep_ice = ( Agrif_irhot() * Agrif_Parent(nn_fsbc) / nn_fsbc ) ! clem: to have calledweight=1 in interp (otherwise the western border of the zoom is wrong)
618      CALL agrif_interp_ice('U') ! interpolation of ice velocities
619      CALL agrif_interp_ice('V') ! interpolation of ice velocities
620      CALL agrif_interp_ice('T') ! interpolation of ice tracers
621      nbstep_ice = 0   
622      !
623   END SUBROUTINE Agrif_InitValues_cont_ice
624
625   SUBROUTINE agrif_declare_var_ice
626      !!----------------------------------------------------------------------
627      !!                 *** ROUTINE agrif_declare_var_ice ***
628      !!----------------------------------------------------------------------
629
630      USE Agrif_Util
631      USE ice
632      USE par_oce, ONLY : nbghostcells, nbghostcells_x, nbghostcells_y_s
633      !
634      IMPLICIT NONE
635      !
636      INTEGER :: ind1, ind2, ind3
637         !!----------------------------------------------------------------------
638      !
639      ! 1. Declaration of the type of variable which have to be interpolated (parent=>child)
640      !       agrif_declare_variable(position,1st point index,--,--,dimensions,name)
641      !           ex.:  position=> 1,1 = not-centered (in i and j)
642      !                            2,2 =     centered (    -     )
643      !                 index   => 1,1 = one ghost line
644      !                            2,2 = two ghost lines
645      !-------------------------------------------------------------------------------------
646
647      ind1 =     nbghostcells
648      ind2 = 2 + nbghostcells_x
649      ind3 = 2 + nbghostcells_y_s
650      CALL agrif_declare_variable((/2,2,0/),(/ind2,ind3,0/),(/'x','y','N'/),(/1,1,1/),(/nlci,nlcj,jpl*(8+nlay_s+nlay_i)/),tra_ice_id)
651      CALL agrif_declare_variable((/1,2/)  ,(/ind2-1,ind3/)  ,(/'x','y'/)    ,(/1,1/)  ,(/nlci,nlcj/)                      ,u_ice_id  )
652      CALL agrif_declare_variable((/2,1/)  ,(/ind2,ind3-1/)  ,(/'x','y'/)    ,(/1,1/)  ,(/nlci,nlcj/)                      ,v_ice_id  )
653
654      CALL agrif_declare_variable((/2,2,0/),(/ind3,ind3,0/),(/'x','y','N'/),(/1,1,1/),(/nlci,nlcj,jpl*(8+nlay_s+nlay_i)/),tra_iceini_id)
655      CALL agrif_declare_variable((/1,2/)  ,(/ind2-1,ind3/)  ,(/'x','y'/)    ,(/1,1/)  ,(/nlci,nlcj/)                      ,u_iceini_id  )
656      CALL agrif_declare_variable((/2,1/)  ,(/ind2,ind3-1/)  ,(/'x','y'/)    ,(/1,1/)  ,(/nlci,nlcj/)                      ,v_iceini_id  )
657
658      ! 2. Set interpolations (normal & tangent to the grid cell for velocities)
659      !-----------------------------------
660      CALL Agrif_Set_bcinterp(tra_ice_id, interp  = AGRIF_linear)
661      CALL Agrif_Set_bcinterp(u_ice_id  , interp1 = Agrif_linear,interp2 = AGRIF_ppm   )
662      CALL Agrif_Set_bcinterp(v_ice_id  , interp1 = AGRIF_ppm   ,interp2 = Agrif_linear)
663
664      CALL Agrif_Set_bcinterp(tra_iceini_id, interp  = AGRIF_linear)
665      CALL Agrif_Set_interp  (tra_iceini_id, interp  = AGRIF_linear)
666      CALL Agrif_Set_bcinterp(u_iceini_id  , interp  = AGRIF_linear  )
667      CALL Agrif_Set_interp  (u_iceini_id  , interp  = AGRIF_linear   )
668      CALL Agrif_Set_bcinterp(v_iceini_id  , interp  = AGRIF_linear)
669      CALL Agrif_Set_interp  (v_iceini_id  , interp  = AGRIF_linear)
670
671      ! 3. Set location of interpolations
672      !----------------------------------
673      CALL Agrif_Set_bc(tra_ice_id,(/0,ind1/))
674      CALL Agrif_Set_bc(u_ice_id  ,(/0,ind1/))
675      CALL Agrif_Set_bc(v_ice_id  ,(/0,ind1/))
676
677      CALL Agrif_Set_bc(tra_iceini_id,(/0,ind1/))
678      CALL Agrif_Set_bc(u_iceini_id  ,(/0,ind1/))
679      CALL Agrif_Set_bc(v_iceini_id  ,(/0,ind1/))
680
681      ! 4. Set update type in case 2 ways (child=>parent) (normal & tangent to the grid cell for velocities)
682      !--------------------------------------------------
683# if defined UPD_HIGH
684      CALL Agrif_Set_Updatetype(tra_ice_id, update  = Agrif_Update_Full_Weighting)
685      CALL Agrif_Set_Updatetype(u_ice_id  , update1 = Agrif_Update_Average       , update2 = Agrif_Update_Full_Weighting)
686      CALL Agrif_Set_Updatetype(v_ice_id  , update1 = Agrif_Update_Full_Weighting, update2 = Agrif_Update_Average       )
687# else
688      CALL Agrif_Set_Updatetype(tra_ice_id, update  = AGRIF_Update_Average)
689      CALL Agrif_Set_Updatetype(u_ice_id  , update1 = Agrif_Update_Copy   , update2 = Agrif_Update_Average)
690      CALL Agrif_Set_Updatetype(v_ice_id  , update1 = Agrif_Update_Average, update2 = Agrif_Update_Copy   )
691# endif
692
693   END SUBROUTINE agrif_declare_var_ice
694#endif
695
696
697# if defined key_top
698   SUBROUTINE Agrif_InitValues_cont_top
699      !!----------------------------------------------------------------------
700      !!                 *** ROUTINE Agrif_InitValues_cont_top ***
701      !!----------------------------------------------------------------------
702      USE Agrif_Util
703      USE oce 
704      USE dom_oce
705      USE nemogcm
706      USE par_trc
707      USE lib_mpp
708      USE trc
709      USE in_out_manager
710      USE agrif_oce_sponge
711      USE agrif_top_update
712      USE agrif_top_interp
713      USE agrif_top_sponge
714      !!
715 
716   !!
717   IMPLICIT NONE
718   !
719   CHARACTER(len=10) :: cl_check1, cl_check2, cl_check3
720   LOGICAL :: check_namelist
721      !!----------------------------------------------------------------------
722
723
724   ! 1. Declaration of the type of variable which have to be interpolated
725   !---------------------------------------------------------------------
726   CALL agrif_declare_var_top
727
728   ! 2. First interpolations of potentially non zero fields
729   !-------------------------------------------------------
730   Agrif_SpecialValue=0.
731   Agrif_UseSpecialValue = .TRUE.
732   CALL Agrif_Bc_variable(trn_id,calledweight=1.,procname=interptrn)
733   Agrif_UseSpecialValue = .FALSE.
734   CALL Agrif_Sponge
735   tabspongedone_trn = .FALSE.
736   CALL Agrif_Bc_variable(trn_sponge_id,calledweight=1.,procname=interptrn_sponge)
737   ! reset tsa to zero
738   tra(:,:,:,:) = 0.
739
740   ! 3. Some controls
741   !-----------------
742   check_namelist = .TRUE.
743
744   IF( check_namelist ) THEN
745      ! Check time steps
746      IF( NINT(Agrif_Rhot()) * NINT(rdt) .NE. Agrif_Parent(rdt) ) THEN
747         WRITE(cl_check1,*)  Agrif_Parent(rdt)
748         WRITE(cl_check2,*)  rdt
749         WRITE(cl_check3,*)  rdt*Agrif_Rhot()
750         CALL ctl_stop( 'incompatible time step between grids',   &
751               &               'parent grid value : '//cl_check1    ,   & 
752               &               'child  grid value : '//cl_check2    ,   & 
753               &               'value on child grid should be changed to  &
754               &               :'//cl_check3  )
755      ENDIF
756
757      ! Check run length
758      IF( Agrif_IRhot() * (Agrif_Parent(nitend)- &
759            Agrif_Parent(nit000)+1) .NE. (nitend-nit000+1) ) THEN
760         WRITE(cl_check1,*)  (Agrif_Parent(nit000)-1)*Agrif_IRhot() + 1
761         WRITE(cl_check2,*)   Agrif_Parent(nitend)   *Agrif_IRhot()
762         CALL ctl_warn( 'incompatible run length between grids'               ,   &
763               &              ' nit000 on fine grid will be change to : '//cl_check1,   &
764               &              ' nitend on fine grid will be change to : '//cl_check2    )
765         nit000 = (Agrif_Parent(nit000)-1)*Agrif_IRhot() + 1
766         nitend =  Agrif_Parent(nitend)   *Agrif_IRhot()
767      ENDIF
768   ENDIF
769   !
770   END SUBROUTINE Agrif_InitValues_cont_top
771
772
773   SUBROUTINE agrif_declare_var_top
774      !!----------------------------------------------------------------------
775      !!                 *** ROUTINE agrif_declare_var_top ***
776      !!----------------------------------------------------------------------
777      USE agrif_util
778      USE agrif_oce
779      USE dom_oce
780      USE trc
781      !!
782      IMPLICIT NONE
783      !
784      INTEGER :: ind1, ind2, ind3
785      !!----------------------------------------------------------------------
786
787
788
789!RB_CMEMS : declare here init for top     
790      ! 1. Declaration of the type of variable which have to be interpolated
791      !---------------------------------------------------------------------
792      ind1 =     nbghostcells
793      ind2 = 2 + nbghostcells_x
794      ind3 = 2 + nbghostcells_y_s
795# if defined key_vertical
796      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jptra+1/),trn_id)
797      CALL agrif_declare_variable((/2,2,0,0/),(/ind2,ind3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jptra+1/),trn_sponge_id)
798# else
799! LAURENT: STRANGE why (3,3) here ?
800      CALL agrif_declare_variable((/2,2,0,0/),(/3,3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jptra/),trn_id)
801      CALL agrif_declare_variable((/2,2,0,0/),(/3,3,0,0/),(/'x','y','N','N'/),(/1,1,1,1/),(/nlci,nlcj,jpk,jptra/),trn_sponge_id)
802# endif
803
804      ! 2. Type of interpolation
805      !-------------------------
806      CALL Agrif_Set_bcinterp(trn_id,interp=AGRIF_linear)
807      CALL Agrif_Set_bcinterp(trn_sponge_id,interp=AGRIF_linear)
808
809      ! 3. Location of interpolation
810      !-----------------------------
811      CALL Agrif_Set_bc(trn_id,(/0,ind1-1/))
812      CALL Agrif_Set_bc(trn_sponge_id,(/-nn_sponge_len*Agrif_irhox()-1,0/))
813
814      ! 4. Update type
815      !---------------
816# if defined UPD_HIGH
817      CALL Agrif_Set_Updatetype(trn_id, update = Agrif_Update_Full_Weighting)
818#else
819      CALL Agrif_Set_Updatetype(trn_id, update = AGRIF_Update_Average)
820#endif
821   !
822   END SUBROUTINE agrif_declare_var_top
823# endif
824
825   SUBROUTINE Agrif_detect( kg, ksizex )
826      !!----------------------------------------------------------------------
827      !!                      *** ROUTINE Agrif_detect ***
828      !!----------------------------------------------------------------------
829      INTEGER, DIMENSION(2) :: ksizex
830      INTEGER, DIMENSION(ksizex(1),ksizex(2)) :: kg 
831      !!----------------------------------------------------------------------
832      !
833      RETURN
834      !
835   END SUBROUTINE Agrif_detect
836
837   SUBROUTINE agrif_nemo_init
838      !!----------------------------------------------------------------------
839      !!                     *** ROUTINE agrif_init ***
840      !!----------------------------------------------------------------------
841   USE agrif_oce 
842   USE agrif_ice
843   USE dom_oce
844   USE in_out_manager
845   USE lib_mpp
846      !!
847      IMPLICIT NONE
848      !
849      INTEGER  ::   ios                 ! Local integer output status for namelist read
850      NAMELIST/namagrif/ ln_agrif_2way, ln_init_chfrpar, rn_sponge_tra, rn_sponge_dyn, rn_trelax_tra, rn_trelax_dyn, &
851                       & ln_spc_dyn, ln_chk_bathy
852      !!--------------------------------------------------------------------------------------
853      !
854      READ  ( numnam_ref, namagrif, IOSTAT = ios, ERR = 901)
855901 IF( ios /= 0 )   CALL ctl_nam ( ios , 'namagrif in reference namelist' )
856      READ  ( numnam_cfg, namagrif, IOSTAT = ios, ERR = 902 )
857902 IF( ios >  0 )   CALL ctl_nam ( ios , 'namagrif in configuration namelist' )
858      IF(lwm) WRITE ( numond, namagrif )
859      !
860      IF(lwp) THEN                    ! control print
861         WRITE(numout,*)
862         WRITE(numout,*) 'agrif_nemo_init : AGRIF parameters'
863         WRITE(numout,*) '~~~~~~~~~~~~~~~'
864         WRITE(numout,*) '   Namelist namagrif : set AGRIF parameters'
865         WRITE(numout,*) '      Two way nesting activated ln_agrif_2way         = ', ln_agrif_2way
866         WRITE(numout,*) '      child initial state from parent ln_init_chfrpar = ', ln_init_chfrpar
867         WRITE(numout,*) '      ad. sponge coeft for tracers      rn_sponge_tra = ', rn_sponge_tra
868         WRITE(numout,*) '      ad. sponge coeft for dynamics     rn_sponge_tra = ', rn_sponge_dyn
869         WRITE(numout,*) '      ad. time relaxation for tracers   rn_trelax_tra = ', rn_trelax_tra
870         WRITE(numout,*) '      ad. time relaxation for dynamics  rn_trelax_dyn = ', rn_trelax_dyn
871         WRITE(numout,*) '      use special values for dynamics   ln_spc_dyn    = ', ln_spc_dyn
872         WRITE(numout,*) '      check bathymetry                  ln_chk_bathy  = ', ln_chk_bathy
873      ENDIF
874
875      lk_west  = .NOT. ( Agrif_Ix() == 1 )
876      lk_east  = .NOT. ( Agrif_Ix() + nbcellsx/AGRIF_Irhox() == Agrif_Parent(jpiglo) -1 )
877      lk_south = .NOT. ( Agrif_Iy() == 1 )
878      lk_north = .NOT. ( Agrif_Iy() + nbcellsy/AGRIF_Irhoy() == Agrif_Parent(jpjglo) -1 )
879
880      !
881      ! Set the number of ghost cells according to periodicity
882      nbghostcells_x = nbghostcells
883      nbghostcells_y_s = nbghostcells
884      nbghostcells_y_n = nbghostcells
885      !
886      IF ( jperio == 1 ) nbghostcells_x = 0
887      IF ( .NOT. lk_south ) nbghostcells_y_s = 0
888
889      write(*,*) lk_south, nbghostcells_y_s, nbghostcells_y_n
890
891      ! Some checks
892      IF( jpiglo /= nbcellsx + 2 + 2*nbghostcells_x )   &
893          CALL ctl_stop( 'STOP', 'agrif_nemo_init: Agrif children requires jpiglo == nbcellsx + 2 + 2*nbghostcells_x' )
894      IF( jpjglo /= nbcellsy + 2 + nbghostcells_y_s + nbghostcells_y_n )   &
895          CALL ctl_stop( 'STOP', 'agrif_nemo_init: Agrif children requires jpjglo == nbcellsy + 2 + nbghostcells_y_s + nbghostcells_y_n' )
896      IF( ln_use_jattr )   CALL ctl_stop( 'STOP', 'agrif_nemo_init:Agrif children requires ln_use_jattr = .false. ' )
897      !
898   END SUBROUTINE agrif_nemo_init
899
900# if defined key_mpp_mpi
901   SUBROUTINE Agrif_InvLoc( indloc, nprocloc, i, indglob )
902      !!----------------------------------------------------------------------
903      !!                     *** ROUTINE Agrif_InvLoc ***
904      !!----------------------------------------------------------------------
905      USE dom_oce
906      !!
907      IMPLICIT NONE
908      !
909      INTEGER :: indglob, indloc, nprocloc, i
910      !!----------------------------------------------------------------------
911      !
912      SELECT CASE( i )
913      CASE(1)   ;   indglob = indloc + nimppt(nprocloc+1) - 1
914      CASE(2)   ;   indglob = indloc + njmppt(nprocloc+1) - 1
915      CASE DEFAULT
916         indglob = indloc
917      END SELECT
918      !
919   END SUBROUTINE Agrif_InvLoc
920
921   SUBROUTINE Agrif_get_proc_info( imin, imax, jmin, jmax )
922      !!----------------------------------------------------------------------
923      !!                 *** ROUTINE Agrif_get_proc_info ***
924      !!----------------------------------------------------------------------
925      USE par_oce
926      !!
927      IMPLICIT NONE
928      !
929      INTEGER, INTENT(out) :: imin, imax
930      INTEGER, INTENT(out) :: jmin, jmax
931      !!----------------------------------------------------------------------
932      !
933      imin = nimppt(Agrif_Procrank+1)  ! ?????
934      jmin = njmppt(Agrif_Procrank+1)  ! ?????
935      imax = imin + jpi - 1
936      jmax = jmin + jpj - 1
937      !
938   END SUBROUTINE Agrif_get_proc_info
939
940   SUBROUTINE Agrif_estimate_parallel_cost(imin, imax,jmin, jmax, nbprocs, grid_cost)
941      !!----------------------------------------------------------------------
942      !!                 *** ROUTINE Agrif_estimate_parallel_cost ***
943      !!----------------------------------------------------------------------
944      USE par_oce
945      !!
946      IMPLICIT NONE
947      !
948      INTEGER,  INTENT(in)  :: imin, imax
949      INTEGER,  INTENT(in)  :: jmin, jmax
950      INTEGER,  INTENT(in)  :: nbprocs
951      REAL(wp), INTENT(out) :: grid_cost
952      !!----------------------------------------------------------------------
953      !
954      grid_cost = REAL(imax-imin+1,wp)*REAL(jmax-jmin+1,wp) / REAL(nbprocs,wp)
955      !
956   END SUBROUTINE Agrif_estimate_parallel_cost
957
958# endif
959
960   SUBROUTINE nemo_mapping(ndim,ptx,pty,bounds,bounds_chunks,correction_required,nb_chunks)
961      !!----------------------------------------------------------------------
962      !!                   *** ROUTINE Nemo_mapping ***
963      !!----------------------------------------------------------------------
964      USE dom_oce
965      !!
966      IMPLICIT NONE
967      !
968      INTEGER :: ndim
969      INTEGER :: ptx, pty
970      INTEGER, DIMENSION(ndim,2,2) :: bounds
971      INTEGER, DIMENSION(:,:,:,:), ALLOCATABLE :: bounds_chunks
972      LOGICAL, DIMENSION(:), ALLOCATABLE :: correction_required
973      INTEGER :: nb_chunks
974      !
975      INTEGER :: i
976
977      IF (agrif_debug_interp) THEN
978         DO i=1,ndim
979            WRITE(*,*) 'direction = ',i,bounds(i,1,2),bounds(i,2,2)
980         ENDDO
981      ENDIF
982
983      IF( bounds(2,2,2) > jpjglo) THEN
984         IF( bounds(2,1,2) <=jpjglo) THEN
985            nb_chunks = 2
986            ALLOCATE(bounds_chunks(nb_chunks,ndim,2,2))
987            ALLOCATE(correction_required(nb_chunks))
988            DO i = 1,nb_chunks
989               bounds_chunks(i,:,:,:) = bounds
990            END DO
991       
992      ! FIRST CHUNCK (for j<=jpjglo)   
993
994      ! Original indices
995            bounds_chunks(1,1,1,1) = bounds(1,1,2)
996            bounds_chunks(1,1,2,1) = bounds(1,2,2)
997            bounds_chunks(1,2,1,1) = bounds(2,1,2)
998            bounds_chunks(1,2,2,1) = jpjglo
999
1000            bounds_chunks(1,1,1,2) = bounds(1,1,2)
1001            bounds_chunks(1,1,2,2) = bounds(1,2,2)
1002            bounds_chunks(1,2,1,2) = bounds(2,1,2)
1003            bounds_chunks(1,2,2,2) = jpjglo
1004
1005      ! Correction required or not
1006            correction_required(1)=.FALSE.
1007       
1008      ! SECOND CHUNCK (for j>jpjglo)
1009
1010      ! Original indices
1011            bounds_chunks(2,1,1,1) = bounds(1,1,2)
1012            bounds_chunks(2,1,2,1) = bounds(1,2,2)
1013            bounds_chunks(2,2,1,1) = jpjglo-2
1014            bounds_chunks(2,2,2,1) = bounds(2,2,2)
1015
1016      ! Where to find them
1017      ! We use the relation TAB(ji,jj)=TAB(jpiglo-ji+2,jpjglo-2-(jj-jpjglo))
1018
1019            IF( ptx == 2) THEN ! T, V points
1020               bounds_chunks(2,1,1,2) = jpiglo-bounds(1,2,2)+2
1021               bounds_chunks(2,1,2,2) = jpiglo-bounds(1,1,2)+2
1022            ELSE ! U, F points
1023               bounds_chunks(2,1,1,2) = jpiglo-bounds(1,2,2)+1
1024               bounds_chunks(2,1,2,2) = jpiglo-bounds(1,1,2)+1       
1025            ENDIF
1026
1027            IF( pty == 2) THEN ! T, U points
1028               bounds_chunks(2,2,1,2) = jpjglo-2-(bounds(2,2,2) -jpjglo)
1029               bounds_chunks(2,2,2,2) = jpjglo-2-(jpjglo-2      -jpjglo)
1030            ELSE ! V, F points
1031               bounds_chunks(2,2,1,2) = jpjglo-3-(bounds(2,2,2) -jpjglo)
1032               bounds_chunks(2,2,2,2) = jpjglo-3-(jpjglo-2      -jpjglo)
1033            ENDIF
1034      ! Correction required or not
1035            correction_required(2)=.TRUE.
1036
1037         ELSE
1038            nb_chunks = 1
1039            ALLOCATE(bounds_chunks(nb_chunks,ndim,2,2))
1040            ALLOCATE(correction_required(nb_chunks))
1041            DO i=1,nb_chunks
1042               bounds_chunks(i,:,:,:) = bounds
1043            END DO
1044
1045            bounds_chunks(1,1,1,1) = bounds(1,1,2)
1046            bounds_chunks(1,1,2,1) = bounds(1,2,2)
1047            bounds_chunks(1,2,1,1) = bounds(2,1,2)
1048            bounds_chunks(1,2,2,1) = bounds(2,2,2)
1049
1050            bounds_chunks(1,1,1,2) = jpiglo-bounds(1,2,2)+2
1051            bounds_chunks(1,1,2,2) = jpiglo-bounds(1,1,2)+2
1052
1053            bounds_chunks(1,2,1,2) = jpjglo-2-(bounds(2,2,2)-jpjglo)
1054            bounds_chunks(1,2,2,2) = jpjglo-2-(bounds(2,1,2)-jpjglo)
1055
1056            IF( ptx == 2) THEN ! T, V points
1057               bounds_chunks(1,1,1,2) = jpiglo-bounds(1,2,2)+2
1058               bounds_chunks(1,1,2,2) = jpiglo-bounds(1,1,2)+2
1059            ELSE ! U, F points
1060               bounds_chunks(1,1,1,2) = jpiglo-bounds(1,2,2)+1
1061               bounds_chunks(1,1,2,2) = jpiglo-bounds(1,1,2)+1       
1062            ENDIF
1063
1064            IF (pty == 2) THEN ! T, U points
1065               bounds_chunks(1,2,1,2) = jpjglo-2-(bounds(2,2,2) -jpjglo)
1066               bounds_chunks(1,2,2,2) = jpjglo-2-(bounds(2,1,2) -jpjglo)
1067            ELSE ! V, F points
1068               bounds_chunks(1,2,1,2) = jpjglo-3-(bounds(2,2,2) -jpjglo)
1069               bounds_chunks(1,2,2,2) = jpjglo-3-(bounds(2,1,2) -jpjglo)
1070            ENDIF
1071
1072            correction_required(1)=.TRUE.         
1073         ENDIF
1074
1075      ELSE IF (bounds(1,1,2) < 1) THEN
1076         IF (bounds(1,2,2) > 0) THEN
1077            nb_chunks = 2
1078            ALLOCATE(correction_required(nb_chunks))
1079            correction_required=.FALSE.
1080            ALLOCATE(bounds_chunks(nb_chunks,ndim,2,2))
1081            DO i=1,nb_chunks
1082               bounds_chunks(i,:,:,:) = bounds
1083            END DO
1084             
1085            bounds_chunks(1,1,1,2) = bounds(1,1,2)+jpiglo-2
1086            bounds_chunks(1,1,2,2) = 1+jpiglo-2
1087         
1088            bounds_chunks(1,1,1,1) = bounds(1,1,2)
1089            bounds_chunks(1,1,2,1) = 1
1090       
1091            bounds_chunks(2,1,1,2) = 2
1092            bounds_chunks(2,1,2,2) = bounds(1,2,2)
1093         
1094            bounds_chunks(2,1,1,1) = 2
1095            bounds_chunks(2,1,2,1) = bounds(1,2,2)
1096
1097         ELSE
1098            nb_chunks = 1
1099            ALLOCATE(correction_required(nb_chunks))
1100            correction_required=.FALSE.
1101            ALLOCATE(bounds_chunks(nb_chunks,ndim,2,2))
1102            DO i=1,nb_chunks
1103               bounds_chunks(i,:,:,:) = bounds
1104            END DO   
1105            bounds_chunks(1,1,1,2) = bounds(1,1,2)+jpiglo-2
1106            bounds_chunks(1,1,2,2) = bounds(1,2,2)+jpiglo-2
1107         
1108            bounds_chunks(1,1,1,1) = bounds(1,1,2)
1109           bounds_chunks(1,1,2,1) = bounds(1,2,2)
1110         ENDIF
1111      ELSE
1112         nb_chunks=1 
1113         ALLOCATE(correction_required(nb_chunks))
1114         correction_required=.FALSE.
1115         ALLOCATE(bounds_chunks(nb_chunks,ndim,2,2))
1116         DO i=1,nb_chunks
1117            bounds_chunks(i,:,:,:) = bounds
1118         END DO
1119         bounds_chunks(1,1,1,2) = bounds(1,1,2)
1120         bounds_chunks(1,1,2,2) = bounds(1,2,2)
1121         bounds_chunks(1,2,1,2) = bounds(2,1,2)
1122         bounds_chunks(1,2,2,2) = bounds(2,2,2)
1123         
1124         bounds_chunks(1,1,1,1) = bounds(1,1,2)
1125         bounds_chunks(1,1,2,1) = bounds(1,2,2)
1126         bounds_chunks(1,2,1,1) = bounds(2,1,2)
1127         bounds_chunks(1,2,2,1) = bounds(2,2,2)             
1128      ENDIF
1129       
1130   END SUBROUTINE nemo_mapping
1131
1132   FUNCTION agrif_external_switch_index(ptx,pty,i1,isens)
1133
1134   USE dom_oce
1135
1136   INTEGER :: ptx, pty, i1, isens
1137   INTEGER :: agrif_external_switch_index
1138
1139   IF( isens == 1 ) THEN
1140      IF( ptx == 2 ) THEN ! T, V points
1141         agrif_external_switch_index = jpiglo-i1+2
1142      ELSE ! U, F points
1143         agrif_external_switch_index = jpiglo-i1+1     
1144      ENDIF
1145   ELSE IF( isens ==2 ) THEN
1146      IF ( pty == 2 ) THEN ! T, U points
1147         agrif_external_switch_index = jpjglo-2-(i1 -jpjglo)
1148      ELSE ! V, F points
1149         agrif_external_switch_index = jpjglo-3-(i1 -jpjglo)
1150      ENDIF
1151   ENDIF
1152
1153   END FUNCTION agrif_external_switch_index
1154
1155   SUBROUTINE Correct_field(tab2d,i1,i2,j1,j2)
1156      !!----------------------------------------------------------------------
1157      !!                   *** ROUTINE Correct_field ***
1158      !!----------------------------------------------------------------------
1159   
1160   USE dom_oce
1161   USE agrif_oce
1162
1163   INTEGER :: i1,i2,j1,j2
1164   REAL(wp), DIMENSION(i1:i2,j1:j2) :: tab2d
1165
1166   INTEGER :: i,j
1167   REAL(wp), DIMENSION(i1:i2,j1:j2) :: tab2dtemp
1168
1169   tab2dtemp = tab2d
1170
1171   IF( .NOT. use_sign_north ) THEN
1172      DO j=j1,j2
1173         DO i=i1,i2
1174            tab2d(i,j)=tab2dtemp(i2-(i-i1),j2-(j-j1))
1175         END DO
1176      END DO
1177   ELSE
1178      DO j=j1,j2
1179         DO i=i1,i2
1180            tab2d(i,j)=sign_north * tab2dtemp(i2-(i-i1),j2-(j-j1))
1181         END DO
1182      END DO
1183   ENDIF
1184
1185   END SUBROUTINE Correct_field
1186
1187#else
1188   SUBROUTINE Subcalledbyagrif
1189      !!----------------------------------------------------------------------
1190      !!                   *** ROUTINE Subcalledbyagrif ***
1191      !!----------------------------------------------------------------------
1192      WRITE(*,*) 'Impossible to be here'
1193   END SUBROUTINE Subcalledbyagrif
1194#endif
Note: See TracBrowser for help on using the repository browser.