source: branches/2013/dev_r3891_METO1_MERCATOR6_OBC_BDY_merge/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 3902

Last change on this file since 3902 was 3902, checked in by davestorkey, 9 years ago

bug fixes

  • Property svn:keywords set to Id
File size: 75.5 KB
Line 
1MODULE bdyini
2   !!======================================================================
3   !!                       ***  MODULE  bdyini  ***
4   !! Unstructured open boundaries : initialisation
5   !!======================================================================
6   !! History :  1.0  !  2005-01  (J. Chanut, A. Sellar)  Original code
7   !!             -   !  2007-01  (D. Storkey) Update to use IOM module
8   !!             -   !  2007-01  (D. Storkey) Tidal forcing
9   !!            3.0  !  2008-04  (NEMO team)  add in the reference version
10   !!            3.3  !  2010-09  (E.O'Dea) updates for Shelf configurations
11   !!            3.3  !  2010-09  (D.Storkey) add ice boundary conditions
12   !!            3.4  !  2011     (D. Storkey) rewrite in preparation for OBC-BDY merge
13   !!            3.4  !  2012     (J. Chanut) straight open boundary case update
14   !!            3.5  !  2012     (S. Mocavero, I. Epicoco) Updates for the
15   !!                             optimization of BDY communications
16   !!----------------------------------------------------------------------
17#if defined key_bdy
18   !!----------------------------------------------------------------------
19   !!   'key_bdy'                     Unstructured Open Boundary Conditions
20   !!----------------------------------------------------------------------
21   !!   bdy_init       : Initialization of unstructured open boundaries
22   !!----------------------------------------------------------------------
23   USE timing          ! Timing
24   USE oce             ! ocean dynamics and tracers variables
25   USE dom_oce         ! ocean space and time domain
26   USE bdy_oce         ! unstructured open boundary conditions
27   USE in_out_manager  ! I/O units
28   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
29   USE lib_mpp         ! for mpp_sum 
30   USE iom             ! I/O
31   USE sbctide, ONLY: lk_tide ! Tidal forcing or not
32   USE phycst, ONLY: rday
33
34   IMPLICIT NONE
35   PRIVATE
36
37   PUBLIC   bdy_init   ! routine called in nemo_init
38
39   INTEGER, PARAMETER          :: jp_nseg = 100
40   INTEGER, PARAMETER          :: nrimmax = 20 ! maximum rimwidth in structured
41                                               ! open boundary data files
42   ! Straight open boundary segment parameters:
43   INTEGER  :: nbdysege, nbdysegw, nbdysegn, nbdysegs 
44   INTEGER, DIMENSION(jp_nseg) :: jpieob, jpjedt, jpjeft, npckge
45   INTEGER, DIMENSION(jp_nseg) :: jpiwob, jpjwdt, jpjwft, npckgw
46   INTEGER, DIMENSION(jp_nseg) :: jpjnob, jpindt, jpinft, npckgn
47   INTEGER, DIMENSION(jp_nseg) :: jpjsob, jpisdt, jpisft, npckgs
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54   
55   SUBROUTINE bdy_init
56      !!----------------------------------------------------------------------
57      !!                 ***  ROUTINE bdy_init  ***
58      !!         
59      !! ** Purpose :   Initialization of the dynamics and tracer fields with
60      !!              unstructured open boundaries.
61      !!
62      !! ** Method  :   Read initialization arrays (mask, indices) to identify
63      !!              an unstructured open boundary
64      !!
65      !! ** Input   :  bdy_init.nc, input file for unstructured open boundaries
66      !!----------------------------------------------------------------------     
67      ! namelist variables
68      !-------------------
69      CHARACTER(LEN=80),DIMENSION(jpbgrd)  ::   clfile
70      CHARACTER(LEN=1)   ::   ctypebdy
71      INTEGER :: nbdyind, nbdybeg, nbdyend
72
73      ! local variables
74      !-------------------
75      INTEGER  ::   ib_bdy, ii, ij, ik, igrd, ib, ir, iseg ! dummy loop indices
76      INTEGER  ::   icount, icountr, ibr_max, ilen1, ibm1  ! local integers
77      INTEGER  ::   iw, ie, is, in, inum, id_dummy         !   -       -
78      INTEGER  ::   igrd_start, igrd_end, jpbdta           !   -       -
79      INTEGER  ::   jpbdtau, jpbdtas                       !   -       -
80      INTEGER  ::   ib_bdy1, ib_bdy2, ib1, ib2             !   -       -
81      INTEGER, POINTER  ::  nbi, nbj, nbr                  ! short cuts
82      REAL(wp), POINTER  ::  flagu, flagv                  !    -   -
83      REAL(wp), POINTER, DIMENSION(:,:)       ::   mask    ! pointer to 2D mask fields
84      REAL(wp) ::   zefl, zwfl, znfl, zsfl                 ! local scalars
85      INTEGER, DIMENSION (2)                  ::   kdimsz
86      INTEGER, DIMENSION(jpbgrd,jp_bdy)       ::   nblendta         ! Length of index arrays
87      INTEGER, ALLOCATABLE, DIMENSION(:,:,:)  ::   nbidta, nbjdta   ! Index arrays: i and j indices of bdy dta
88      INTEGER, ALLOCATABLE, DIMENSION(:,:,:)  ::   nbrdta           ! Discrete distance from rim points
89      CHARACTER(LEN=1),DIMENSION(jpbgrd)      ::   cgrid
90      INTEGER :: com_east, com_west, com_south, com_north          ! Flags for boundaries sending
91      INTEGER :: com_east_b, com_west_b, com_south_b, com_north_b  ! Flags for boundaries receiving
92      INTEGER :: iw_b(4), ie_b(4), is_b(4), in_b(4)                ! Arrays for neighbours coordinates
93
94      !!
95      NAMELIST/nambdy/ nb_bdy, ln_coords_file, cn_coords_file,             &
96         &             ln_mask_file, cn_mask_file, cn_dyn2d, nn_dyn2d_dta, &
97         &             cn_dyn3d, nn_dyn3d_dta, cn_tra, nn_tra_dta,         & 
98         &             ln_tra_dmp, ln_dyn3d_dmp, rn_time_dmp,              &
99#if defined key_lim2
100         &             cn_ice_lim2, nn_ice_lim2_dta,                       &
101#endif
102         &             ln_vol, nn_volctl, nn_rimwidth
103      !!
104      NAMELIST/nambdy_index/ ctypebdy, nbdyind, nbdybeg, nbdyend
105
106      !!----------------------------------------------------------------------
107
108      IF( nn_timing == 1 ) CALL timing_start('bdy_init')
109
110      IF( bdy_oce_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'bdy_init : unable to allocate oce arrays' )
111
112      IF(lwp) WRITE(numout,*)
113      IF(lwp) WRITE(numout,*) 'bdy_init : initialization of open boundaries'
114      IF(lwp) WRITE(numout,*) '~~~~~~~~'
115      !
116
117      IF( jperio /= 0 )   CALL ctl_stop( 'Cyclic or symmetric,',   &
118         &                               ' and general open boundary condition are not compatible' )
119
120      cgrid= (/'t','u','v'/)
121     
122      ! -----------------------------------------
123      ! Initialise and read namelist parameters
124      ! -----------------------------------------
125
126      nb_bdy            = 0
127      ln_coords_file(:) = .false.
128      cn_coords_file(:) = ''
129      ln_mask_file      = .false.
130      cn_mask_file(:)   = ''
131      cn_dyn2d(:)       = ''
132      nn_dyn2d_dta(:)   = -1  ! uninitialised flag
133      cn_dyn3d(:)       = ''
134      nn_dyn3d_dta(:)   = -1  ! uninitialised flag
135      cn_tra(:)         = ''
136      nn_tra_dta(:)     = -1  ! uninitialised flag
137      ln_tra_dmp(:)     = .false.
138      ln_dyn3d_dmp(:)   = .false.
139      rn_time_dmp(:)    = 1.
140#if defined key_lim2
141      cn_ice_lim2(:)    = ''
142      nn_ice_lim2_dta(:)= -1  ! uninitialised flag
143#endif
144      ln_vol            = .false.
145      nn_volctl         = -1  ! uninitialised flag
146      nn_rimwidth(:)    = -1  ! uninitialised flag
147
148      REWIND( numnam )                   
149      READ  ( numnam, nambdy )
150
151      ! -----------------------------------------
152      ! Check and write out namelist parameters
153      ! -----------------------------------------
154      !                                   ! control prints
155      IF(lwp) WRITE(numout,*) '         nambdy'
156
157      IF( nb_bdy .eq. 0 ) THEN
158        IF(lwp) WRITE(numout,*) 'nb_bdy = 0, NO OPEN BOUNDARIES APPLIED.'
159      ELSE
160        IF(lwp) WRITE(numout,*) 'Number of open boundary sets : ',nb_bdy
161      ENDIF
162
163      DO ib_bdy = 1,nb_bdy
164        IF(lwp) WRITE(numout,*) ' ' 
165        IF(lwp) WRITE(numout,*) '------ Open boundary data set ',ib_bdy,'------' 
166
167        IF( ln_coords_file(ib_bdy) ) THEN
168           IF(lwp) WRITE(numout,*) 'Boundary definition read from file '//TRIM(cn_coords_file(ib_bdy))
169        ELSE
170           IF(lwp) WRITE(numout,*) 'Boundary defined in namelist.'
171        ENDIF
172        IF(lwp) WRITE(numout,*)
173
174        IF(lwp) WRITE(numout,*) 'Boundary conditions for barotropic solution:  '
175        SELECT CASE( cn_dyn2d(ib_bdy) )                 
176          CASE('none')         ;   IF(lwp) WRITE(numout,*) '      no open boundary condition'       
177          CASE('frs')          ;   IF(lwp) WRITE(numout,*) '      Flow Relaxation Scheme'
178          CASE('flather')      ;   IF(lwp) WRITE(numout,*) '      Flather radiation condition'
179          CASE('orlanski')     ;   IF(lwp) WRITE(numout,*) '      NPO Orlanski radiation condition with adaptive nudging'
180          CASE DEFAULT   ;   CALL ctl_stop( 'unrecognised value for cn_dyn2d' )
181        END SELECT
182        IF( cn_dyn2d(ib_bdy) /= 'none' ) THEN
183           SELECT CASE( nn_dyn2d_dta(ib_bdy) )                   !
184              CASE( 0 )      ;   IF(lwp) WRITE(numout,*) '      initial state used for bdy data'       
185              CASE( 1 )      ;   IF(lwp) WRITE(numout,*) '      boundary data taken from file'
186              CASE( 2 )      ;   IF(lwp) WRITE(numout,*) '      tidal harmonic forcing taken from file'
187              CASE( 3 )      ;   IF(lwp) WRITE(numout,*) '      boundary data AND tidal harmonic forcing taken from files'
188              CASE DEFAULT   ;   CALL ctl_stop( 'nn_dyn2d_dta must be between 0 and 3' )
189           END SELECT
190           IF (( nn_dyn2d_dta(ib_bdy) .ge. 2 ).AND.(.NOT.lk_tide)) THEN
191             CALL ctl_stop( 'You must activate key_tide to add tidal forcing at open boundaries' )
192           ENDIF
193        ENDIF
194        IF(lwp) WRITE(numout,*)
195
196        IF(lwp) WRITE(numout,*) 'Boundary conditions for baroclinic velocities:  '
197        SELECT CASE( cn_dyn3d(ib_bdy) )                 
198          CASE('none')      ;   IF(lwp) WRITE(numout,*) '      no open boundary condition'       
199          CASE('frs')       ;   IF(lwp) WRITE(numout,*) '      Flow Relaxation Scheme'
200          CASE('specified') ;   IF(lwp) WRITE(numout,*) '      Specified value'
201          CASE('zero')      ;   IF(lwp) WRITE(numout,*) '      Zero baroclinic velocities (runoff case)'
202          CASE('orlanski')  ;   IF(lwp) WRITE(numout,*) '      NPO Orlanski radiation condition with adaptive nudging'
203          CASE DEFAULT   ;   CALL ctl_stop( 'unrecognised value for cn_dyn3d' )
204        END SELECT
205        IF( cn_dyn3d(ib_bdy) /= 'none' ) THEN
206           SELECT CASE( nn_dyn3d_dta(ib_bdy) )                   !
207              CASE( 0 )      ;   IF(lwp) WRITE(numout,*) '      initial state used for bdy data'       
208              CASE( 1 )      ;   IF(lwp) WRITE(numout,*) '      boundary data taken from file'
209              CASE DEFAULT   ;   CALL ctl_stop( 'nn_dyn3d_dta must be 0 or 1' )
210           END SELECT
211        ENDIF
212
213        IF ( ln_dyn3d_dmp(ib_bdy) ) THEN
214           IF ( cn_dyn3d(ib_bdy) == 'none' ) THEN
215              IF(lwp) WRITE(numout,*) 'No open boundary condition for baroclinic velocities: ln_dyn3d_dmp is set to .false.'
216              ln_dyn3d_dmp(ib_bdy)=.false.
217           ELSEIF ( cn_dyn3d(ib_bdy) == 'frs' ) THEN
218              CALL ctl_stop( 'Use FRS OR relaxation' )
219           ELSE
220              IF(lwp) WRITE(numout,*) '      + baroclinic velocities relaxation zone'
221              IF(lwp) WRITE(numout,*) '      Damping time scale: ',rn_time_dmp(ib_bdy),' days'
222              IF((lwp).AND.rn_time_dmp(ib_bdy)<0) CALL ctl_stop( 'Time scale must be positive' )
223           ENDIF
224        ELSE
225           IF(lwp) WRITE(numout,*) '      NO relaxation on baroclinic velocities'
226        ENDIF
227        IF(lwp) WRITE(numout,*)
228
229        IF(lwp) WRITE(numout,*) 'Boundary conditions for temperature and salinity:  '
230        SELECT CASE( cn_tra(ib_bdy) )                 
231          CASE('none')      ;   IF(lwp) WRITE(numout,*) '      no open boundary condition'       
232          CASE('frs')       ;   IF(lwp) WRITE(numout,*) '      Flow Relaxation Scheme'
233          CASE('specified') ;   IF(lwp) WRITE(numout,*) '      Specified value'
234          CASE('neumann')   ;   IF(lwp) WRITE(numout,*) '      Neumann conditions'
235          CASE('runoff')    ;   IF(lwp) WRITE(numout,*) '      Runoff conditions : Neumann for T and specified to 0.1 for salinity'
236          CASE('orlanski')  ;   IF(lwp) WRITE(numout,*) '      NPO Orlanski radiation condition with adaptive nudging'
237          CASE DEFAULT   ;   CALL ctl_stop( 'unrecognised value for cn_tra' )
238        END SELECT
239        IF( cn_tra(ib_bdy) /= 'none' ) THEN
240           SELECT CASE( nn_tra_dta(ib_bdy) )                   !
241              CASE( 0 )      ;   IF(lwp) WRITE(numout,*) '      initial state used for bdy data'       
242              CASE( 1 )      ;   IF(lwp) WRITE(numout,*) '      boundary data taken from file'
243              CASE DEFAULT   ;   CALL ctl_stop( 'nn_tra_dta must be 0 or 1' )
244           END SELECT
245        ENDIF
246
247        IF ( ln_tra_dmp(ib_bdy) ) THEN
248           IF ( cn_tra(ib_bdy) == 'none' ) THEN
249              IF(lwp) WRITE(numout,*) 'No open boundary condition for tracers: ln_tra_dmp is set to .false.'
250              ln_tra_dmp(ib_bdy)=.false.
251           ELSEIF ( cn_tra(ib_bdy) == 'frs' ) THEN
252              CALL ctl_stop( 'Use FRS OR relaxation' )
253           ELSE
254              IF(lwp) WRITE(numout,*) '      + T/S relaxation zone'
255              IF(lwp) WRITE(numout,*) '      Damping time scale: ',rn_time_dmp(ib_bdy),' days'
256              IF((lwp).AND.rn_time_dmp(ib_bdy)<0) CALL ctl_stop( 'Time scale must be positive' )
257           ENDIF
258        ELSE
259           IF(lwp) WRITE(numout,*) '      NO T/S relaxation'
260        ENDIF
261        IF(lwp) WRITE(numout,*)
262
263#if defined key_lim2
264        IF(lwp) WRITE(numout,*) 'Boundary conditions for sea ice:  '
265        SELECT CASE( cn_ice_lim2(ib_bdy) )                 
266          CASE('none')   ;   IF(lwp) WRITE(numout,*) '      no open boundary condition'       
267          CASE('frs')    ;   IF(lwp) WRITE(numout,*) '      Flow Relaxation Scheme'
268          CASE DEFAULT   ;   CALL ctl_stop( 'unrecognised value for cn_ice_lim2' )
269        END SELECT
270        IF( cn_ice_lim2(ib_bdy) /= 'none' ) THEN
271           SELECT CASE( nn_ice_lim2_dta(ib_bdy) )                   !
272              CASE( 0 )      ;   IF(lwp) WRITE(numout,*) '      initial state used for bdy data'       
273              CASE( 1 )      ;   IF(lwp) WRITE(numout,*) '      boundary data taken from file'
274              CASE DEFAULT   ;   CALL ctl_stop( 'nn_ice_lim2_dta must be 0 or 1' )
275           END SELECT
276        ENDIF
277        IF(lwp) WRITE(numout,*)
278#endif
279
280        IF(lwp) WRITE(numout,*) '      Width of relaxation zone = ', nn_rimwidth(ib_bdy)
281        IF(lwp) WRITE(numout,*)
282
283      ENDDO
284
285     IF (nb_bdy .gt. 0) THEN
286        IF( ln_vol ) THEN                     ! check volume conservation (nn_volctl value)
287          IF(lwp) WRITE(numout,*) 'Volume correction applied at open boundaries'
288          IF(lwp) WRITE(numout,*)
289          SELECT CASE ( nn_volctl )
290            CASE( 1 )      ;   IF(lwp) WRITE(numout,*) '      The total volume will be constant'
291            CASE( 0 )      ;   IF(lwp) WRITE(numout,*) '      The total volume will vary according to the surface E-P flux'
292            CASE DEFAULT   ;   CALL ctl_stop( 'nn_volctl must be 0 or 1' )
293          END SELECT
294          IF(lwp) WRITE(numout,*)
295        ELSE
296          IF(lwp) WRITE(numout,*) 'No volume correction applied at open boundaries'
297          IF(lwp) WRITE(numout,*)
298        ENDIF
299     ENDIF
300
301      ! -------------------------------------------------
302      ! Initialise indices arrays for open boundaries
303      ! -------------------------------------------------
304
305      ! Work out global dimensions of boundary data
306      ! ---------------------------------------------
307      REWIND( numnam )                   
308               
309      nblendta(:,:) = 0
310      nbdysege = 0
311      nbdysegw = 0
312      nbdysegn = 0
313      nbdysegs = 0
314      icount   = 0 ! count user defined segments
315      ! Dimensions below are used to allocate arrays to read external data
316      jpbdtas = 1 ! Maximum size of boundary data (structured case)
317      jpbdtau = 1 ! Maximum size of boundary data (unstructured case)
318
319      DO ib_bdy = 1, nb_bdy
320
321         IF( .NOT. ln_coords_file(ib_bdy) ) THEN ! Work out size of global arrays from namelist parameters
322 
323            icount = icount + 1
324            ! No REWIND here because may need to read more than one nambdy_index namelist.
325            READ  ( numnam, nambdy_index )
326
327            SELECT CASE ( TRIM(ctypebdy) )
328              CASE( 'N' )
329                 IF( nbdyind == -1 ) THEN  ! Automatic boundary definition: if nbdysegX = -1
330                    nbdyind  = jpjglo - 2  ! set boundary to whole side of model domain.
331                    nbdybeg  = 2
332                    nbdyend  = jpiglo - 1
333                 ENDIF
334                 nbdysegn = nbdysegn + 1
335                 npckgn(nbdysegn) = ib_bdy ! Save bdy package number
336                 jpjnob(nbdysegn) = nbdyind
337                 jpindt(nbdysegn) = nbdybeg
338                 jpinft(nbdysegn) = nbdyend
339                 !
340              CASE( 'S' )
341                 IF( nbdyind == -1 ) THEN  ! Automatic boundary definition: if nbdysegX = -1
342                    nbdyind  = 2           ! set boundary to whole side of model domain.
343                    nbdybeg  = 2
344                    nbdyend  = jpiglo - 1
345                 ENDIF
346                 nbdysegs = nbdysegs + 1
347                 npckgs(nbdysegs) = ib_bdy ! Save bdy package number
348                 jpjsob(nbdysegs) = nbdyind
349                 jpisdt(nbdysegs) = nbdybeg
350                 jpisft(nbdysegs) = nbdyend
351                 !
352              CASE( 'E' )
353                 IF( nbdyind == -1 ) THEN  ! Automatic boundary definition: if nbdysegX = -1
354                    nbdyind  = jpiglo - 2  ! set boundary to whole side of model domain.
355                    nbdybeg  = 2
356                    nbdyend  = jpjglo - 1
357                 ENDIF
358                 nbdysege = nbdysege + 1 
359                 npckge(nbdysege) = ib_bdy ! Save bdy package number
360                 jpieob(nbdysege) = nbdyind
361                 jpjedt(nbdysege) = nbdybeg
362                 jpjeft(nbdysege) = nbdyend
363                 !
364              CASE( 'W' )
365                 IF( nbdyind == -1 ) THEN  ! Automatic boundary definition: if nbdysegX = -1
366                    nbdyind  = 2           ! set boundary to whole side of model domain.
367                    nbdybeg  = 2
368                    nbdyend  = jpjglo - 1
369                 ENDIF
370                 nbdysegw = nbdysegw + 1
371                 npckgw(nbdysegw) = ib_bdy ! Save bdy package number
372                 jpiwob(nbdysegw) = nbdyind
373                 jpjwdt(nbdysegw) = nbdybeg
374                 jpjwft(nbdysegw) = nbdyend
375                 !
376              CASE DEFAULT   ;   CALL ctl_stop( 'ctypebdy must be N, S, E or W' )
377            END SELECT
378
379            ! For simplicity we assume that in case of straight bdy, arrays have the same length
380            ! (even if it is true that last tangential velocity points
381            ! are useless). This simplifies a little bit boundary data format (and agrees with format
382            ! used so far in obc package)
383
384            nblendta(1:jpbgrd,ib_bdy) =  (nbdyend - nbdybeg + 1) * nn_rimwidth(ib_bdy)
385            jpbdtas = MAX(jpbdtas, (nbdyend - nbdybeg + 1))
386            IF (lwp.and.(nn_rimwidth(ib_bdy)>nrimmax)) &
387            & CALL ctl_stop( 'rimwidth must be lower than nrimmax' )
388
389         ELSE            ! Read size of arrays in boundary coordinates file.
390            CALL iom_open( cn_coords_file(ib_bdy), inum )
391            DO igrd = 1, jpbgrd
392               id_dummy = iom_varid( inum, 'nbi'//cgrid(igrd), kdimsz=kdimsz ) 
393               nblendta(igrd,ib_bdy) = kdimsz(1)
394               jpbdtau = MAX(jpbdtau, kdimsz(1))
395            ENDDO
396            CALL iom_close( inum )
397
398         ENDIF
399
400      ENDDO ! ib_bdy
401
402      IF (nb_bdy>0) THEN
403         jpbdta = MAXVAL(nblendta(1:jpbgrd,1:nb_bdy))
404
405         ! Allocate arrays
406         !---------------
407         ALLOCATE( nbidta(jpbdta, jpbgrd, nb_bdy), nbjdta(jpbdta, jpbgrd, nb_bdy),    &
408            &      nbrdta(jpbdta, jpbgrd, nb_bdy) )
409
410         ALLOCATE( dta_global(jpbdtau, 1, jpk) )
411         IF ( icount>0 ) ALLOCATE( dta_global2(jpbdtas, nrimmax, jpk) )
412         !
413      ENDIF
414
415      ! Now look for crossings in user (namelist) defined open boundary segments:
416      !--------------------------------------------------------------------------
417      IF ( icount>0 ) CALL bdy_ctl_seg
418
419      ! Calculate global boundary index arrays or read in from file
420      !------------------------------------------------------------               
421      ! 1. Read global index arrays from boundary coordinates file.
422      DO ib_bdy = 1, nb_bdy
423
424         IF( ln_coords_file(ib_bdy) ) THEN
425
426            CALL iom_open( cn_coords_file(ib_bdy), inum )
427            DO igrd = 1, jpbgrd
428               CALL iom_get( inum, jpdom_unknown, 'nbi'//cgrid(igrd), dta_global(1:nblendta(igrd,ib_bdy),:,1) )
429               DO ii = 1,nblendta(igrd,ib_bdy)
430                  nbidta(ii,igrd,ib_bdy) = INT( dta_global(ii,1,1) )
431               END DO
432               CALL iom_get( inum, jpdom_unknown, 'nbj'//cgrid(igrd), dta_global(1:nblendta(igrd,ib_bdy),:,1) )
433               DO ii = 1,nblendta(igrd,ib_bdy)
434                  nbjdta(ii,igrd,ib_bdy) = INT( dta_global(ii,1,1) )
435               END DO
436               CALL iom_get( inum, jpdom_unknown, 'nbr'//cgrid(igrd), dta_global(1:nblendta(igrd,ib_bdy),:,1) )
437               DO ii = 1,nblendta(igrd,ib_bdy)
438                  nbrdta(ii,igrd,ib_bdy) = INT( dta_global(ii,1,1) )
439               END DO
440
441               ibr_max = MAXVAL( nbrdta(:,igrd,ib_bdy) )
442               IF(lwp) WRITE(numout,*)
443               IF(lwp) WRITE(numout,*) ' Maximum rimwidth in file is ', ibr_max
444               IF(lwp) WRITE(numout,*) ' nn_rimwidth from namelist is ', nn_rimwidth(ib_bdy)
445               IF (ibr_max < nn_rimwidth(ib_bdy))   &
446                     CALL ctl_stop( 'nn_rimwidth is larger than maximum rimwidth in file',cn_coords_file(ib_bdy) )
447            END DO
448            CALL iom_close( inum )
449
450         ENDIF
451
452      ENDDO     
453   
454      ! 2. Now fill indices corresponding to straight open boundary arrays:
455      ! East
456      !-----
457      DO iseg = 1, nbdysege
458         ib_bdy = npckge(iseg)
459         !
460         ! ------------ T points -------------
461         igrd=1
462         icount=0
463         DO ir = 1, nn_rimwidth(ib_bdy)
464            DO ij = jpjedt(iseg), jpjeft(iseg)
465               icount = icount + 1
466               nbidta(icount, igrd, ib_bdy) = jpieob(iseg) + 2 - ir
467               nbjdta(icount, igrd, ib_bdy) = ij
468               nbrdta(icount, igrd, ib_bdy) = ir
469            ENDDO
470         ENDDO
471         !
472         ! ------------ U points -------------
473         igrd=2
474         icount=0
475         DO ir = 1, nn_rimwidth(ib_bdy)
476            DO ij = jpjedt(iseg), jpjeft(iseg)
477               icount = icount + 1
478               nbidta(icount, igrd, ib_bdy) = jpieob(iseg) + 1 - ir
479               nbjdta(icount, igrd, ib_bdy) = ij
480               nbrdta(icount, igrd, ib_bdy) = ir
481            ENDDO
482         ENDDO
483         !
484         ! ------------ V points -------------
485         igrd=3
486         icount=0
487         DO ir = 1, nn_rimwidth(ib_bdy)
488!            DO ij = jpjedt(iseg), jpjeft(iseg) - 1
489            DO ij = jpjedt(iseg), jpjeft(iseg)
490               icount = icount + 1
491               nbidta(icount, igrd, ib_bdy) = jpieob(iseg) + 2 - ir
492               nbjdta(icount, igrd, ib_bdy) = ij
493               nbrdta(icount, igrd, ib_bdy) = ir
494            ENDDO
495            nbidta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
496            nbjdta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
497         ENDDO
498      ENDDO
499      !
500      ! West
501      !-----
502      DO iseg = 1, nbdysegw
503         ib_bdy = npckgw(iseg)
504         !
505         ! ------------ T points -------------
506         igrd=1
507         icount=0
508         DO ir = 1, nn_rimwidth(ib_bdy)
509            DO ij = jpjwdt(iseg), jpjwft(iseg)
510               icount = icount + 1
511               nbidta(icount, igrd, ib_bdy) = jpiwob(iseg) + ir - 1
512               nbjdta(icount, igrd, ib_bdy) = ij
513               nbrdta(icount, igrd, ib_bdy) = ir
514            ENDDO
515         ENDDO
516         !
517         ! ------------ U points -------------
518         igrd=2
519         icount=0
520         DO ir = 1, nn_rimwidth(ib_bdy)
521            DO ij = jpjwdt(iseg), jpjwft(iseg)
522               icount = icount + 1
523               nbidta(icount, igrd, ib_bdy) = jpiwob(iseg) + ir - 1
524               nbjdta(icount, igrd, ib_bdy) = ij
525               nbrdta(icount, igrd, ib_bdy) = ir
526            ENDDO
527         ENDDO
528         !
529         ! ------------ V points -------------
530         igrd=3
531         icount=0
532         DO ir = 1, nn_rimwidth(ib_bdy)
533!            DO ij = jpjwdt(iseg), jpjwft(iseg) - 1
534            DO ij = jpjwdt(iseg), jpjwft(iseg)
535               icount = icount + 1
536               nbidta(icount, igrd, ib_bdy) = jpiwob(iseg) + ir - 1
537               nbjdta(icount, igrd, ib_bdy) = ij
538               nbrdta(icount, igrd, ib_bdy) = ir
539            ENDDO
540            nbidta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
541            nbjdta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
542         ENDDO
543      ENDDO
544      !
545      ! North
546      !-----
547      DO iseg = 1, nbdysegn
548         ib_bdy = npckgn(iseg)
549         !
550         ! ------------ T points -------------
551         igrd=1
552         icount=0
553         DO ir = 1, nn_rimwidth(ib_bdy)
554            DO ii = jpindt(iseg), jpinft(iseg)
555               icount = icount + 1
556               nbidta(icount, igrd, ib_bdy) = ii
557               nbjdta(icount, igrd, ib_bdy) = jpjnob(iseg) + 2 - ir 
558               nbrdta(icount, igrd, ib_bdy) = ir
559            ENDDO
560         ENDDO
561         !
562         ! ------------ U points -------------
563         igrd=2
564         icount=0
565         DO ir = 1, nn_rimwidth(ib_bdy)
566!            DO ii = jpindt(iseg), jpinft(iseg) - 1
567            DO ii = jpindt(iseg), jpinft(iseg)
568               icount = icount + 1
569               nbidta(icount, igrd, ib_bdy) = ii
570               nbjdta(icount, igrd, ib_bdy) = jpjnob(iseg) + 2 - ir
571               nbrdta(icount, igrd, ib_bdy) = ir
572            ENDDO
573            nbidta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
574            nbjdta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
575         ENDDO
576         !
577         ! ------------ V points -------------
578         igrd=3
579         icount=0
580         DO ir = 1, nn_rimwidth(ib_bdy)
581            DO ii = jpindt(iseg), jpinft(iseg)
582               icount = icount + 1
583               nbidta(icount, igrd, ib_bdy) = ii
584               nbjdta(icount, igrd, ib_bdy) = jpjnob(iseg) + 1 - ir
585               nbrdta(icount, igrd, ib_bdy) = ir
586            ENDDO
587         ENDDO
588      ENDDO
589      !
590      ! South
591      !-----
592      DO iseg = 1, nbdysegs
593         ib_bdy = npckgs(iseg)
594         !
595         ! ------------ T points -------------
596         igrd=1
597         icount=0
598         DO ir = 1, nn_rimwidth(ib_bdy)
599            DO ii = jpisdt(iseg), jpisft(iseg)
600               icount = icount + 1
601               nbidta(icount, igrd, ib_bdy) = ii
602               nbjdta(icount, igrd, ib_bdy) = jpjsob(iseg) + ir - 1
603               nbrdta(icount, igrd, ib_bdy) = ir
604            ENDDO
605         ENDDO
606         !
607         ! ------------ U points -------------
608         igrd=2
609         icount=0
610         DO ir = 1, nn_rimwidth(ib_bdy)
611!            DO ii = jpisdt(iseg), jpisft(iseg) - 1
612            DO ii = jpisdt(iseg), jpisft(iseg)
613               icount = icount + 1
614               nbidta(icount, igrd, ib_bdy) = ii
615               nbjdta(icount, igrd, ib_bdy) = jpjsob(iseg) + ir - 1
616               nbrdta(icount, igrd, ib_bdy) = ir
617            ENDDO
618            nbidta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
619            nbjdta(icount, igrd, ib_bdy) = -ib_bdy ! Discount this point
620         ENDDO
621         !
622         ! ------------ V points -------------
623         igrd=3
624         icount=0
625         DO ir = 1, nn_rimwidth(ib_bdy)
626            DO ii = jpisdt(iseg), jpisft(iseg)
627               icount = icount + 1
628               nbidta(icount, igrd, ib_bdy) = ii
629               nbjdta(icount, igrd, ib_bdy) = jpjsob(iseg) + ir - 1
630               nbrdta(icount, igrd, ib_bdy) = ir
631            ENDDO
632         ENDDO
633      ENDDO
634
635      !  Deal with duplicated points
636      !-----------------------------
637      ! We assign negative indices to duplicated points (to remove them from bdy points to be updated)
638      ! if their distance to the bdy is greater than the other
639      ! If their distance are the same, just keep only one to avoid updating a point twice
640      DO igrd = 1, jpbgrd
641         DO ib_bdy1 = 1, nb_bdy
642            DO ib_bdy2 = 1, nb_bdy
643               IF (ib_bdy1/=ib_bdy2) THEN
644                  DO ib1 = 1, nblendta(igrd,ib_bdy1)
645                     DO ib2 = 1, nblendta(igrd,ib_bdy2)
646                        IF ((nbidta(ib1, igrd, ib_bdy1)==nbidta(ib2, igrd, ib_bdy2)).AND. &
647                        &   (nbjdta(ib1, igrd, ib_bdy1)==nbjdta(ib2, igrd, ib_bdy2))) THEN
648!                           IF ((lwp).AND.(igrd==1)) WRITE(numout,*) ' found coincident point ji, jj:', &
649!                                                       &              nbidta(ib1, igrd, ib_bdy1),      &
650!                                                       &              nbjdta(ib2, igrd, ib_bdy2)
651                           ! keep only points with the lowest distance to boundary:
652                           IF (nbrdta(ib1, igrd, ib_bdy1)<nbrdta(ib2, igrd, ib_bdy2)) THEN
653                             nbidta(ib2, igrd, ib_bdy2) =-ib_bdy2
654                             nbjdta(ib2, igrd, ib_bdy2) =-ib_bdy2
655                           ELSEIF (nbrdta(ib1, igrd, ib_bdy1)>nbrdta(ib2, igrd, ib_bdy2)) THEN
656                             nbidta(ib1, igrd, ib_bdy1) =-ib_bdy1
657                             nbjdta(ib1, igrd, ib_bdy1) =-ib_bdy1
658                           ! Arbitrary choice if distances are the same:
659                           ELSE
660                             nbidta(ib1, igrd, ib_bdy1) =-ib_bdy1
661                             nbjdta(ib1, igrd, ib_bdy1) =-ib_bdy1
662                           ENDIF
663                        END IF
664                     END DO
665                  END DO
666               ENDIF
667            END DO
668         END DO
669      END DO
670
671      ! Work out dimensions of boundary data on each processor
672      ! ------------------------------------------------------
673
674      ! Rather assume that boundary data indices are given on global domain
675      ! TO BE DISCUSSED ?
676!      iw = mig(1) + 1            ! if monotasking and no zoom, iw=2
677!      ie = mig(1) + nlci-1 - 1   ! if monotasking and no zoom, ie=jpim1
678!      is = mjg(1) + 1            ! if monotasking and no zoom, is=2
679!      in = mjg(1) + nlcj-1 - 1   ! if monotasking and no zoom, in=jpjm1     
680      iw = mig(1) - jpizoom + 2         ! if monotasking and no zoom, iw=2
681      ie = mig(1) + nlci - jpizoom - 1  ! if monotasking and no zoom, ie=jpim1
682      is = mjg(1) - jpjzoom + 2         ! if monotasking and no zoom, is=2
683      in = mjg(1) + nlcj - jpjzoom - 1  ! if monotasking and no zoom, in=jpjm1
684
685      ALLOCATE( nbondi_bdy(nb_bdy))
686      ALLOCATE( nbondj_bdy(nb_bdy))
687      nbondi_bdy(:)=2
688      nbondj_bdy(:)=2
689      ALLOCATE( nbondi_bdy_b(nb_bdy))
690      ALLOCATE( nbondj_bdy_b(nb_bdy))
691      nbondi_bdy_b(:)=2
692      nbondj_bdy_b(:)=2
693
694      ! Work out dimensions of boundary data on each neighbour process
695      IF(nbondi .eq. 0) THEN
696         iw_b(1) = jpizoom + nimppt(nowe+1)
697         ie_b(1) = jpizoom + nimppt(nowe+1)+nlcit(nowe+1)-3
698         is_b(1) = jpjzoom + njmppt(nowe+1)
699         in_b(1) = jpjzoom + njmppt(nowe+1)+nlcjt(nowe+1)-3
700
701         iw_b(2) = jpizoom + nimppt(noea+1)
702         ie_b(2) = jpizoom + nimppt(noea+1)+nlcit(noea+1)-3
703         is_b(2) = jpjzoom + njmppt(noea+1)
704         in_b(2) = jpjzoom + njmppt(noea+1)+nlcjt(noea+1)-3
705      ELSEIF(nbondi .eq. 1) THEN
706         iw_b(1) = jpizoom + nimppt(nowe+1)
707         ie_b(1) = jpizoom + nimppt(nowe+1)+nlcit(nowe+1)-3
708         is_b(1) = jpjzoom + njmppt(nowe+1)
709         in_b(1) = jpjzoom + njmppt(nowe+1)+nlcjt(nowe+1)-3
710      ELSEIF(nbondi .eq. -1) THEN
711         iw_b(2) = jpizoom + nimppt(noea+1)
712         ie_b(2) = jpizoom + nimppt(noea+1)+nlcit(noea+1)-3
713         is_b(2) = jpjzoom + njmppt(noea+1)
714         in_b(2) = jpjzoom + njmppt(noea+1)+nlcjt(noea+1)-3
715      ENDIF
716
717      IF(nbondj .eq. 0) THEN
718         iw_b(3) = jpizoom + nimppt(noso+1)
719         ie_b(3) = jpizoom + nimppt(noso+1)+nlcit(noso+1)-3
720         is_b(3) = jpjzoom + njmppt(noso+1)
721         in_b(3) = jpjzoom + njmppt(noso+1)+nlcjt(noso+1)-3
722
723         iw_b(4) = jpizoom + nimppt(nono+1)
724         ie_b(4) = jpizoom + nimppt(nono+1)+nlcit(nono+1)-3
725         is_b(4) = jpjzoom + njmppt(nono+1)
726         in_b(4) = jpjzoom + njmppt(nono+1)+nlcjt(nono+1)-3
727      ELSEIF(nbondj .eq. 1) THEN
728         iw_b(3) = jpizoom + nimppt(noso+1)
729         ie_b(3) = jpizoom + nimppt(noso+1)+nlcit(noso+1)-3
730         is_b(3) = jpjzoom + njmppt(noso+1)
731         in_b(3) = jpjzoom + njmppt(noso+1)+nlcjt(noso+1)-3
732      ELSEIF(nbondj .eq. -1) THEN
733         iw_b(4) = jpizoom + nimppt(nono+1)
734         ie_b(4) = jpizoom + nimppt(nono+1)+nlcit(nono+1)-3
735         is_b(4) = jpjzoom + njmppt(nono+1)
736         in_b(4) = jpjzoom + njmppt(nono+1)+nlcjt(nono+1)-3
737      ENDIF
738
739      DO ib_bdy = 1, nb_bdy
740         DO igrd = 1, jpbgrd
741            icount  = 0
742            icountr = 0
743            idx_bdy(ib_bdy)%nblen(igrd)    = 0
744            idx_bdy(ib_bdy)%nblenrim(igrd) = 0
745            DO ib = 1, nblendta(igrd,ib_bdy)
746               ! check that data is in correct order in file
747               ibm1 = MAX(1,ib-1)
748               IF(lwp) THEN         ! Since all procs read global data only need to do this check on one proc...
749                  IF( nbrdta(ib,igrd,ib_bdy) < nbrdta(ibm1,igrd,ib_bdy) ) THEN
750                     CALL ctl_stop('bdy_init : ERROR : boundary data in file  &
751                                    must be defined in order of distance from edge nbr.', &
752                                   'A utility for re-ordering boundary coordinates and data &
753                                    files exists in the TOOLS/OBC directory')
754                  ENDIF   
755               ENDIF
756               ! check if point is in local domain
757               IF(  nbidta(ib,igrd,ib_bdy) >= iw .AND. nbidta(ib,igrd,ib_bdy) <= ie .AND.   &
758                  & nbjdta(ib,igrd,ib_bdy) >= is .AND. nbjdta(ib,igrd,ib_bdy) <= in       ) THEN
759                  !
760                  icount = icount  + 1
761                  !
762                  IF( nbrdta(ib,igrd,ib_bdy) == 1 )   icountr = icountr+1
763               ENDIF
764            ENDDO
765            idx_bdy(ib_bdy)%nblenrim(igrd) = icountr !: length of rim boundary data on each proc
766            idx_bdy(ib_bdy)%nblen   (igrd) = icount  !: length of boundary data on each proc       
767         ENDDO  ! igrd
768
769         ! Allocate index arrays for this boundary set
770         !--------------------------------------------
771         ilen1 = MAXVAL(idx_bdy(ib_bdy)%nblen(:))
772         ALLOCATE( idx_bdy(ib_bdy)%nbi(ilen1,jpbgrd) )
773         ALLOCATE( idx_bdy(ib_bdy)%nbj(ilen1,jpbgrd) )
774         ALLOCATE( idx_bdy(ib_bdy)%nbr(ilen1,jpbgrd) )
775         ALLOCATE( idx_bdy(ib_bdy)%nbd(ilen1,jpbgrd) )
776         ALLOCATE( idx_bdy(ib_bdy)%nbmap(ilen1,jpbgrd) )
777         ALLOCATE( idx_bdy(ib_bdy)%nbw(ilen1,jpbgrd) )
778         ALLOCATE( idx_bdy(ib_bdy)%flagu(ilen1,jpbgrd) )
779         ALLOCATE( idx_bdy(ib_bdy)%flagv(ilen1,jpbgrd) )
780
781         ! Dispatch mapping indices and discrete distances on each processor
782         ! -----------------------------------------------------------------
783
784         com_east = 0
785         com_west = 0
786         com_south = 0
787         com_north = 0
788
789         com_east_b = 0
790         com_west_b = 0
791         com_south_b = 0
792         com_north_b = 0
793         DO igrd = 1, jpbgrd
794            icount  = 0
795            ! Loop on rimwidth to ensure outermost points come first in the local arrays.
796            DO ir=1, nn_rimwidth(ib_bdy)
797               DO ib = 1, nblendta(igrd,ib_bdy)
798                  ! check if point is in local domain and equals ir
799                  IF(  nbidta(ib,igrd,ib_bdy) >= iw .AND. nbidta(ib,igrd,ib_bdy) <= ie .AND.   &
800                     & nbjdta(ib,igrd,ib_bdy) >= is .AND. nbjdta(ib,igrd,ib_bdy) <= in .AND.   &
801                     & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
802                     !
803                     icount = icount  + 1
804
805                     ! Rather assume that boundary data indices are given on global domain
806                     ! TO BE DISCUSSED ?
807!                     idx_bdy(ib_bdy)%nbi(icount,igrd)   = nbidta(ib,igrd,ib_bdy)- mig(1)+1
808!                     idx_bdy(ib_bdy)%nbj(icount,igrd)   = nbjdta(ib,igrd,ib_bdy)- mjg(1)+1
809                     idx_bdy(ib_bdy)%nbi(icount,igrd)   = nbidta(ib,igrd,ib_bdy)- mig(1)+jpizoom
810                     idx_bdy(ib_bdy)%nbj(icount,igrd)   = nbjdta(ib,igrd,ib_bdy)- mjg(1)+jpjzoom
811                     ! check if point has to be sent
812                     ii = idx_bdy(ib_bdy)%nbi(icount,igrd)
813                     ij = idx_bdy(ib_bdy)%nbj(icount,igrd)
814                     if((com_east .ne. 1) .and. (ii .eq. (nlci-1)) .and. (nbondi .le. 0)) then
815                        com_east = 1
816                     elseif((com_west .ne. 1) .and. (ii .eq. 2) .and. (nbondi .ge. 0) .and. (nbondi .ne. 2)) then
817                        com_west = 1
818                     endif
819                     if((com_south .ne. 1) .and. (ij .eq. 2) .and. (nbondj .ge. 0) .and. (nbondj .ne. 2)) then
820                        com_south = 1
821                     elseif((com_north .ne. 1) .and. (ij .eq. (nlcj-1)) .and. (nbondj .le. 0)) then
822                        com_north = 1
823                     endif
824                     idx_bdy(ib_bdy)%nbr(icount,igrd)   = nbrdta(ib,igrd,ib_bdy)
825                     idx_bdy(ib_bdy)%nbmap(icount,igrd) = ib
826                  ENDIF
827                  ! check if point has to be received from a neighbour
828                  IF(nbondi .eq. 0) THEN
829                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(1) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(1) .AND.   &
830                       & nbjdta(ib,igrd,ib_bdy) >= is_b(1) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(1) .AND.   &
831                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
832                       ii = nbidta(ib,igrd,ib_bdy)- iw_b(1)+2
833                       if((com_west_b .ne. 1) .and. (ii .eq. (nlcit(nowe+1)-1))) then
834                          ij = nbjdta(ib,igrd,ib_bdy) - is_b(1)+2
835                          if((ij .eq. 2) .and. (nbondj .eq. 0 .or. nbondj .eq. 1)) then
836                            com_south = 1
837                          elseif((ij .eq. nlcjt(nowe+1)-1) .and. (nbondj .eq. 0 .or. nbondj .eq. -1)) then
838                            com_north = 1
839                          endif
840                          com_west_b = 1
841                       endif
842                     ENDIF
843                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(2) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(2) .AND.   &
844                       & nbjdta(ib,igrd,ib_bdy) >= is_b(2) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(2) .AND.   &
845                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
846                       ii = nbidta(ib,igrd,ib_bdy)- iw_b(2)+2
847                       if((com_east_b .ne. 1) .and. (ii .eq. 2)) then
848                          ij = nbjdta(ib,igrd,ib_bdy) - is_b(2)+2
849                          if((ij .eq. 2) .and. (nbondj .eq. 0 .or. nbondj .eq. 1)) then
850                            com_south = 1
851                          elseif((ij .eq. nlcjt(noea+1)-1) .and. (nbondj .eq. 0 .or. nbondj .eq. -1)) then
852                            com_north = 1
853                          endif
854                          com_east_b = 1
855                       endif
856                     ENDIF
857                  ELSEIF(nbondi .eq. 1) THEN
858                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(1) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(1) .AND.   &
859                       & nbjdta(ib,igrd,ib_bdy) >= is_b(1) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(1) .AND.   &
860                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
861                       ii = nbidta(ib,igrd,ib_bdy)- iw_b(1)+2
862                       if((com_west_b .ne. 1) .and. (ii .eq. (nlcit(nowe+1)-1))) then
863                          ij = nbjdta(ib,igrd,ib_bdy) - is_b(1)+2
864                          if((ij .eq. 2) .and. (nbondj .eq. 0 .or. nbondj .eq. 1)) then
865                            com_south = 1
866                          elseif((ij .eq. nlcjt(nowe+1)-1) .and. (nbondj .eq. 0 .or. nbondj .eq. -1)) then
867                            com_north = 1
868                          endif
869                          com_west_b = 1
870                       endif
871                     ENDIF
872                  ELSEIF(nbondi .eq. -1) THEN
873                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(2) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(2) .AND.   &
874                       & nbjdta(ib,igrd,ib_bdy) >= is_b(2) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(2) .AND.   &
875                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
876                       ii = nbidta(ib,igrd,ib_bdy)- iw_b(2)+2
877                       if((com_east_b .ne. 1) .and. (ii .eq. 2)) then
878                          ij = nbjdta(ib,igrd,ib_bdy) - is_b(2)+2
879                          if((ij .eq. 2) .and. (nbondj .eq. 0 .or. nbondj .eq. 1)) then
880                            com_south = 1
881                          elseif((ij .eq. nlcjt(noea+1)-1) .and. (nbondj .eq. 0 .or. nbondj .eq. -1)) then
882                            com_north = 1
883                          endif
884                          com_east_b = 1
885                       endif
886                     ENDIF
887                  ENDIF
888                  IF(nbondj .eq. 0) THEN
889                     IF(com_north_b .ne. 1 .AND. (nbidta(ib,igrd,ib_bdy) == iw_b(4)-1  &
890                       & .OR. nbidta(ib,igrd,ib_bdy) == ie_b(4)+1) .AND. &
891                       & nbjdta(ib,igrd,ib_bdy) == is_b(4) .AND. nbrdta(ib,igrd,ib_bdy) == ir) THEN
892                       com_north_b = 1 
893                     ENDIF
894                     IF(com_south_b .ne. 1 .AND. (nbidta(ib,igrd,ib_bdy) == iw_b(3)-1  &
895                       &.OR. nbidta(ib,igrd,ib_bdy) == ie_b(3)+1) .AND. &
896                       & nbjdta(ib,igrd,ib_bdy) == in_b(3) .AND. nbrdta(ib,igrd,ib_bdy) == ir) THEN
897                       com_south_b = 1 
898                     ENDIF
899                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(3) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(3) .AND.   &
900                       & nbjdta(ib,igrd,ib_bdy) >= is_b(3) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(3) .AND.   &
901                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
902                       ij = nbjdta(ib,igrd,ib_bdy)- is_b(3)+2
903                       if((com_south_b .ne. 1) .and. (ij .eq. (nlcjt(noso+1)-1))) then
904                          com_south_b = 1
905                       endif
906                     ENDIF
907                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(4) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(4) .AND.   &
908                       & nbjdta(ib,igrd,ib_bdy) >= is_b(4) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(4) .AND.   &
909                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
910                       ij = nbjdta(ib,igrd,ib_bdy)- is_b(4)+2
911                       if((com_north_b .ne. 1) .and. (ij .eq. 2)) then
912                          com_north_b = 1
913                       endif
914                     ENDIF
915                  ELSEIF(nbondj .eq. 1) THEN
916                     IF( com_south_b .ne. 1 .AND. (nbidta(ib,igrd,ib_bdy) == iw_b(3)-1 .OR. &
917                       & nbidta(ib,igrd,ib_bdy) == ie_b(3)+1) .AND. &
918                       & nbjdta(ib,igrd,ib_bdy) == in_b(3) .AND. nbrdta(ib,igrd,ib_bdy) == ir) THEN
919                       com_south_b = 1 
920                     ENDIF
921                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(3) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(3) .AND.   &
922                       & nbjdta(ib,igrd,ib_bdy) >= is_b(3) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(3) .AND.   &
923                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
924                       ij = nbjdta(ib,igrd,ib_bdy)- is_b(3)+2
925                       if((com_south_b .ne. 1) .and. (ij .eq. (nlcjt(noso+1)-1))) then
926                          com_south_b = 1
927                       endif
928                     ENDIF
929                  ELSEIF(nbondj .eq. -1) THEN
930                     IF(com_north_b .ne. 1 .AND. (nbidta(ib,igrd,ib_bdy) == iw_b(4)-1  &
931                       & .OR. nbidta(ib,igrd,ib_bdy) == ie_b(4)+1) .AND. &
932                       & nbjdta(ib,igrd,ib_bdy) == is_b(4) .AND. nbrdta(ib,igrd,ib_bdy) == ir) THEN
933                       com_north_b = 1 
934                     ENDIF
935                     IF( nbidta(ib,igrd,ib_bdy) >= iw_b(4) .AND. nbidta(ib,igrd,ib_bdy) <= ie_b(4) .AND.   &
936                       & nbjdta(ib,igrd,ib_bdy) >= is_b(4) .AND. nbjdta(ib,igrd,ib_bdy) <= in_b(4) .AND.   &
937                       & nbrdta(ib,igrd,ib_bdy) == ir  ) THEN
938                       ij = nbjdta(ib,igrd,ib_bdy)- is_b(4)+2
939                       if((com_north_b .ne. 1) .and. (ij .eq. 2)) then
940                          com_north_b = 1
941                       endif
942                     ENDIF
943                  ENDIF
944               ENDDO
945            ENDDO
946         ENDDO 
947         ! definition of the i- and j- direction local boundaries arrays
948         ! used for sending the boudaries
949         IF((com_east .eq. 1) .and. (com_west .eq. 1)) THEN
950            nbondi_bdy(ib_bdy) = 0
951         ELSEIF ((com_east .eq. 1) .and. (com_west .eq. 0)) THEN
952            nbondi_bdy(ib_bdy) = -1
953         ELSEIF ((com_east .eq. 0) .and. (com_west .eq. 1)) THEN
954            nbondi_bdy(ib_bdy) = 1
955         ENDIF
956
957         IF((com_north .eq. 1) .and. (com_south .eq. 1)) THEN
958            nbondj_bdy(ib_bdy) = 0
959         ELSEIF ((com_north .eq. 1) .and. (com_south .eq. 0)) THEN
960            nbondj_bdy(ib_bdy) = -1
961         ELSEIF ((com_north .eq. 0) .and. (com_south .eq. 1)) THEN
962            nbondj_bdy(ib_bdy) = 1
963         ENDIF
964
965         ! definition of the i- and j- direction local boundaries arrays
966         ! used for receiving the boudaries
967         IF((com_east_b .eq. 1) .and. (com_west_b .eq. 1)) THEN
968            nbondi_bdy_b(ib_bdy) = 0
969         ELSEIF ((com_east_b .eq. 1) .and. (com_west_b .eq. 0)) THEN
970            nbondi_bdy_b(ib_bdy) = -1
971         ELSEIF ((com_east_b .eq. 0) .and. (com_west_b .eq. 1)) THEN
972            nbondi_bdy_b(ib_bdy) = 1
973         ENDIF
974
975         IF((com_north_b .eq. 1) .and. (com_south_b .eq. 1)) THEN
976            nbondj_bdy_b(ib_bdy) = 0
977         ELSEIF ((com_north_b .eq. 1) .and. (com_south_b .eq. 0)) THEN
978            nbondj_bdy_b(ib_bdy) = -1
979         ELSEIF ((com_north_b .eq. 0) .and. (com_south_b .eq. 1)) THEN
980            nbondj_bdy_b(ib_bdy) = 1
981         ENDIF
982
983         ! Compute rim weights for FRS scheme
984         ! ----------------------------------
985         DO igrd = 1, jpbgrd
986            DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
987               nbr => idx_bdy(ib_bdy)%nbr(ib,igrd)
988               idx_bdy(ib_bdy)%nbw(ib,igrd) = 1.- TANH( FLOAT( nbr - 1 ) *0.5 )      ! tanh formulation
989!               idx_bdy(ib_bdy)%nbw(ib,igrd) = (FLOAT(nn_rimwidth(ib_bdy)+1-nbr)/FLOAT(nn_rimwidth(ib_bdy)))**2.  ! quadratic
990!               idx_bdy(ib_bdy)%nbw(ib,igrd) =  FLOAT(nn_rimwidth(ib_bdy)+1-nbr)/FLOAT(nn_rimwidth(ib_bdy))       ! linear
991            END DO
992         END DO 
993
994         ! Compute damping coefficients
995         ! ----------------------------
996         DO igrd = 1, jpbgrd
997            DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
998               nbr => idx_bdy(ib_bdy)%nbr(ib,igrd)
999               idx_bdy(ib_bdy)%nbd(ib,igrd) = 1. / ( rn_time_dmp(ib_bdy) * rday ) & 
1000               & *(FLOAT(nn_rimwidth(ib_bdy)+1-nbr)/FLOAT(nn_rimwidth(ib_bdy)))**2.   ! quadratic
1001               idx_bdy(ib_bdy)%nbdout(ib,igrd) = 1. / ( rn_time_dmp_out(ib_bdy) * rday ) & 
1002               & *(FLOAT(nn_rimwidth(ib_bdy)+1-nbr)/FLOAT(nn_rimwidth(ib_bdy)))**2.   ! quadratic
1003            END DO
1004         END DO
1005
1006      ENDDO
1007
1008      ! ------------------------------------------------------
1009      ! Initialise masks and find normal/tangential directions
1010      ! ------------------------------------------------------
1011
1012      ! Read global 2D mask at T-points: bdytmask
1013      ! -----------------------------------------
1014      ! bdytmask = 1  on the computational domain AND on open boundaries
1015      !          = 0  elsewhere   
1016 
1017      IF( ln_mask_file ) THEN
1018         CALL iom_open( cn_mask_file, inum )
1019         CALL iom_get ( inum, jpdom_data, 'bdy_msk', bdytmask(:,:) )
1020         CALL iom_close( inum )
1021
1022         ! Derive mask on U and V grid from mask on T grid
1023         bdyumask(:,:) = 0.e0
1024         bdyvmask(:,:) = 0.e0
1025         DO ij=1, jpjm1
1026            DO ii=1, jpim1
1027               bdyumask(ii,ij)=bdytmask(ii,ij)*bdytmask(ii+1, ij )
1028               bdyvmask(ii,ij)=bdytmask(ii,ij)*bdytmask(ii  ,ij+1) 
1029            END DO
1030         END DO
1031         CALL lbc_lnk( bdyumask(:,:), 'U', 1. )   ;   CALL lbc_lnk( bdyvmask(:,:), 'V', 1. )      ! Lateral boundary cond.
1032
1033
1034         ! Mask corrections
1035         ! ----------------
1036         DO ik = 1, jpkm1
1037            DO ij = 1, jpj
1038               DO ii = 1, jpi
1039                  tmask(ii,ij,ik) = tmask(ii,ij,ik) * bdytmask(ii,ij)
1040                  umask(ii,ij,ik) = umask(ii,ij,ik) * bdyumask(ii,ij)
1041                  vmask(ii,ij,ik) = vmask(ii,ij,ik) * bdyvmask(ii,ij)
1042                  bmask(ii,ij)    = bmask(ii,ij)    * bdytmask(ii,ij)
1043               END DO     
1044            END DO
1045         END DO
1046
1047         DO ik = 1, jpkm1
1048            DO ij = 2, jpjm1
1049               DO ii = 2, jpim1
1050                  fmask(ii,ij,ik) = fmask(ii,ij,ik) * bdytmask(ii,ij  ) * bdytmask(ii+1,ij  )   &
1051                     &                              * bdytmask(ii,ij+1) * bdytmask(ii+1,ij+1)
1052               END DO     
1053            END DO
1054         END DO
1055
1056         tmask_i (:,:) = tmask(:,:,1) * tmask_i(:,:)
1057
1058      ENDIF ! ln_mask_file=.TRUE.
1059     
1060      bdytmask(:,:) = tmask(:,:,1)
1061      bdyumask(:,:) = umask(:,:,1)
1062      bdyvmask(:,:) = vmask(:,:,1)
1063
1064      ! bdy masks and bmask are now set to zero on boundary points:
1065      igrd = 1       ! In the free surface case, bmask is at T-points
1066      DO ib_bdy = 1, nb_bdy
1067        DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)     
1068          bmask(idx_bdy(ib_bdy)%nbi(ib,igrd), idx_bdy(ib_bdy)%nbj(ib,igrd)) = 0.e0
1069        ENDDO
1070      ENDDO
1071      !
1072      igrd = 1
1073      DO ib_bdy = 1, nb_bdy
1074        DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)     
1075          bdytmask(idx_bdy(ib_bdy)%nbi(ib,igrd), idx_bdy(ib_bdy)%nbj(ib,igrd)) = 0.e0
1076        ENDDO
1077      ENDDO
1078      !
1079      igrd = 2
1080      DO ib_bdy = 1, nb_bdy
1081        DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
1082          bdyumask(idx_bdy(ib_bdy)%nbi(ib,igrd), idx_bdy(ib_bdy)%nbj(ib,igrd)) = 0.e0
1083        ENDDO
1084      ENDDO
1085      !
1086      igrd = 3
1087      DO ib_bdy = 1, nb_bdy
1088        DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
1089          bdyvmask(idx_bdy(ib_bdy)%nbi(ib,igrd), idx_bdy(ib_bdy)%nbj(ib,igrd)) = 0.e0
1090        ENDDO
1091      ENDDO
1092
1093      ! Lateral boundary conditions
1094      CALL lbc_lnk( fmask        , 'F', 1. )   ;   CALL lbc_lnk( bdytmask(:,:), 'T', 1. )
1095      CALL lbc_lnk( bdyumask(:,:), 'U', 1. )   ;   CALL lbc_lnk( bdyvmask(:,:), 'V', 1. )
1096
1097      DO ib_bdy = 1, nb_bdy       ! Indices and directions of rim velocity components
1098
1099         idx_bdy(ib_bdy)%flagu(:,:) = 0.e0
1100         idx_bdy(ib_bdy)%flagv(:,:) = 0.e0
1101         icount = 0 
1102
1103         ! Calculate relationship of U direction to the local orientation of the boundary
1104         ! flagu = -1 : u component is normal to the dynamical boundary but its direction is outward
1105         ! flagu =  0 : u is tangential
1106         ! flagu =  1 : u is normal to the boundary and is direction is inward
1107 
1108         DO igrd = 1,jpbgrd 
1109            SELECT CASE( igrd )
1110               CASE( 1 ) ; mask => umask
1111               CASE( 2 ) ; mask => bdytmask 
1112               CASE( 3 ) ; mask => fmask
1113            END SELECT
1114            DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd) 
1115               nbi => idx_bdy(ib_bdy)%nbi(ib,igrd)
1116               nbj => idx_bdy(ib_bdy)%nbj(ib,igrd)
1117               zefl = mask(nbi  ,nbj)
1118               zwfl = mask(nbi+1,nbj)
1119               IF( zefl + zwfl == 2 ) THEN
1120                  icount = icount + 1
1121               ELSE
1122                  idx_bdy(ib_bdy)%flagu(ib,igrd)=-zefl+zwfl
1123               ENDIF
1124            END DO
1125         END DO
1126
1127         ! Calculate relationship of V direction to the local orientation of the boundary
1128         ! flagv = -1 : u component is normal to the dynamical boundary but its direction is outward
1129         ! flagv =  0 : u is tangential
1130         ! flagv =  1 : u is normal to the boundary and is direction is inward
1131
1132         DO igrd = 1,jpbgrd 
1133            SELECT CASE( igrd )
1134               CASE( 1 ) ; mask => vmask 
1135               CASE( 2 ) ; mask => bdytmask 
1136               CASE( 3 ) ; mask => fmask
1137            END SELECT
1138            DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd) 
1139               nbi => idx_bdy(ib_bdy)%nbi(ib,igrd)
1140               nbj => idx_bdy(ib_bdy)%nbj(ib,igrd)
1141               znfl = mask(nbi,nbj  )
1142               zsfl = mask(nbi,nbj+1)
1143               IF( znfl + zsfl == 2 ) THEN
1144                  icount = icount + 1
1145               ELSE
1146                  idx_bdy(ib_bdy)%flagv(ib) = -znfl + zsfl
1147               END IF
1148            END DO
1149         END DO
1150
1151         IF( icount /= 0 ) THEN
1152            IF(lwp) WRITE(numout,*)
1153            IF(lwp) WRITE(numout,*) ' E R R O R : Some data velocity points,',   &
1154               ' are not boundary points. Check nbi, nbj, indices for boundary set ',ib_bdy
1155            IF(lwp) WRITE(numout,*) ' ========== '
1156            IF(lwp) WRITE(numout,*)
1157            nstop = nstop + 1
1158         ENDIF
1159   
1160      ENDDO
1161
1162      ! Compute total lateral surface for volume correction:
1163      ! ----------------------------------------------------
1164      ! JC: this must be done at each time step with key_vvl
1165      bdysurftot = 0.e0 
1166      IF( ln_vol ) THEN 
1167         igrd = 2      ! Lateral surface at U-points
1168         DO ib_bdy = 1, nb_bdy
1169            DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
1170               nbi => idx_bdy(ib_bdy)%nbi(ib,igrd)
1171               nbj => idx_bdy(ib_bdy)%nbj(ib,igrd)
1172               flagu => idx_bdy(ib_bdy)%flagu(ib)
1173               bdysurftot = bdysurftot + hu     (nbi  , nbj)                           &
1174                  &                    * e2u    (nbi  , nbj) * ABS( flagu ) &
1175                  &                    * tmask_i(nbi  , nbj)                           &
1176                  &                    * tmask_i(nbi+1, nbj)                   
1177            ENDDO
1178         ENDDO
1179
1180         igrd=3 ! Add lateral surface at V-points
1181         DO ib_bdy = 1, nb_bdy
1182            DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
1183               nbi => idx_bdy(ib_bdy)%nbi(ib,igrd)
1184               nbj => idx_bdy(ib_bdy)%nbj(ib,igrd)
1185               flagv => idx_bdy(ib_bdy)%flagv(ib)
1186               bdysurftot = bdysurftot + hv     (nbi, nbj  )                           &
1187                  &                    * e1v    (nbi, nbj  ) * ABS( flagv ) &
1188                  &                    * tmask_i(nbi, nbj  )                           &
1189                  &                    * tmask_i(nbi, nbj+1)
1190            ENDDO
1191         ENDDO
1192         !
1193         IF( lk_mpp )   CALL mpp_sum( bdysurftot )      ! sum over the global domain
1194      END IF   
1195      !
1196      ! Tidy up
1197      !--------
1198      IF (nb_bdy>0) THEN
1199         DEALLOCATE(nbidta, nbjdta, nbrdta)
1200      ENDIF
1201
1202      IF( nn_timing == 1 ) CALL timing_stop('bdy_init')
1203
1204   END SUBROUTINE bdy_init
1205
1206   SUBROUTINE bdy_ctl_seg
1207      !!----------------------------------------------------------------------
1208      !!                 ***  ROUTINE bdy_ctl_seg  ***
1209      !!
1210      !! ** Purpose :   Check straight open boundary segments location
1211      !!
1212      !! ** Method  :   - Look for open boundary corners
1213      !!                - Check that segments start or end on land
1214      !!----------------------------------------------------------------------
1215      INTEGER  ::   ib, ib1, ib2, ji ,jj, itest 
1216      INTEGER, DIMENSION(jp_nseg,2) :: icorne, icornw, icornn, icorns 
1217      REAL(wp), DIMENSION(2) ::   ztestmask
1218      !!----------------------------------------------------------------------
1219      !
1220      IF (lwp) WRITE(numout,*) ' '
1221      IF (lwp) WRITE(numout,*) 'bdy_ctl_seg: Check analytical segments'
1222      IF (lwp) WRITE(numout,*) '~~~~~~~~~~~~'
1223      !
1224      IF(lwp) WRITE(numout,*) 'Number of east  segments     : ', nbdysege
1225      IF(lwp) WRITE(numout,*) 'Number of west  segments     : ', nbdysegw
1226      IF(lwp) WRITE(numout,*) 'Number of north segments     : ', nbdysegn
1227      IF(lwp) WRITE(numout,*) 'Number of south segments     : ', nbdysegs
1228      ! 1. Check bounds
1229      !----------------
1230      DO ib = 1, nbdysegn
1231         IF (lwp) WRITE(numout,*) '**check north seg bounds pckg: ', npckgn(ib)
1232         IF ((jpjnob(ib).ge.jpjglo-1).or.& 
1233            &(jpjnob(ib).le.1))        CALL ctl_stop( 'nbdyind out of domain' )
1234         IF (jpindt(ib).ge.jpinft(ib)) CALL ctl_stop( 'Bdy start index is greater than end index' )
1235         IF (jpindt(ib).le.1     )     CALL ctl_stop( 'Start index out of domain' )
1236         IF (jpinft(ib).ge.jpiglo)     CALL ctl_stop( 'End index out of domain' )
1237      END DO
1238      !
1239      DO ib = 1, nbdysegs
1240         IF (lwp) WRITE(numout,*) '**check south seg bounds pckg: ', npckgs(ib)
1241         IF ((jpjsob(ib).ge.jpjglo-1).or.& 
1242            &(jpjsob(ib).le.1))        CALL ctl_stop( 'nbdyind out of domain' )
1243         IF (jpisdt(ib).ge.jpisft(ib)) CALL ctl_stop( 'Bdy start index is greater than end index' )
1244         IF (jpisdt(ib).le.1     )     CALL ctl_stop( 'Start index out of domain' )
1245         IF (jpisft(ib).ge.jpiglo)     CALL ctl_stop( 'End index out of domain' )
1246      END DO
1247      !
1248      DO ib = 1, nbdysege
1249         IF (lwp) WRITE(numout,*) '**check east  seg bounds pckg: ', npckge(ib)
1250         IF ((jpieob(ib).ge.jpiglo-1).or.& 
1251            &(jpieob(ib).le.1))        CALL ctl_stop( 'nbdyind out of domain' )
1252         IF (jpjedt(ib).ge.jpjeft(ib)) CALL ctl_stop( 'Bdy start index is greater than end index' )
1253         IF (jpjedt(ib).le.1     )     CALL ctl_stop( 'Start index out of domain' )
1254         IF (jpjeft(ib).ge.jpjglo)     CALL ctl_stop( 'End index out of domain' )
1255      END DO
1256      !
1257      DO ib = 1, nbdysegw
1258         IF (lwp) WRITE(numout,*) '**check west  seg bounds pckg: ', npckgw(ib)
1259         IF ((jpiwob(ib).ge.jpiglo-1).or.& 
1260            &(jpiwob(ib).le.1))        CALL ctl_stop( 'nbdyind out of domain' )
1261         IF (jpjwdt(ib).ge.jpjwft(ib)) CALL ctl_stop( 'Bdy start index is greater than end index' )
1262         IF (jpjwdt(ib).le.1     )     CALL ctl_stop( 'Start index out of domain' )
1263         IF (jpjwft(ib).ge.jpjglo)     CALL ctl_stop( 'End index out of domain' )
1264      ENDDO
1265      !
1266      !     
1267      ! 2. Look for segment crossings
1268      !------------------------------
1269      IF (lwp) WRITE(numout,*) '**Look for segments corners  :'
1270      !
1271      itest = 0 ! corner number
1272      !
1273      ! flag to detect if start or end of open boundary belongs to a corner
1274      ! if not (=0), it must be on land.
1275      ! if a corner is detected, save bdy package number for further tests
1276      icorne(:,:)=0. ; icornw(:,:)=0. ; icornn(:,:)=0. ; icorns(:,:)=0.
1277      ! South/West crossings
1278      IF ((nbdysegw > 0).AND.(nbdysegs > 0)) THEN
1279         DO ib1 = 1, nbdysegw       
1280            DO ib2 = 1, nbdysegs
1281               IF (( jpisdt(ib2)<=jpiwob(ib1)).AND. &
1282                &  ( jpisft(ib2)>=jpiwob(ib1)).AND. &
1283                &  ( jpjwdt(ib1)<=jpjsob(ib2)).AND. &
1284                &  ( jpjwft(ib1)>=jpjsob(ib2))) THEN
1285                  IF ((jpjwdt(ib1)==jpjsob(ib2)).AND.(jpisdt(ib2)==jpiwob(ib1))) THEN 
1286                     ! We have a possible South-West corner                     
1287!                     WRITE(numout,*) ' Found a South-West corner at (i,j): ', jpisdt(ib2), jpjwdt(ib1)
1288!                     WRITE(numout,*) ' between segments: ', npckgw(ib1), npckgs(ib2)
1289                     icornw(ib1,1) = npckgs(ib2)
1290                     icorns(ib2,1) = npckgw(ib1)
1291                  ELSEIF ((jpisft(ib2)==jpiwob(ib1)).AND.(jpjwft(ib1)==jpjsob(ib2))) THEN
1292                     IF(lwp) WRITE(numout,*)
1293                     IF(lwp) WRITE(numout,*) ' E R R O R : Found an acute open boundary corner at point (i,j)= ', &
1294                     &                                     jpisft(ib2), jpjwft(ib1)
1295                     IF(lwp) WRITE(numout,*) ' ==========  Not allowed yet'
1296                     IF(lwp) WRITE(numout,*) '             Crossing problem with West segment: ',npckgw(ib1), & 
1297                     &                                                    ' and South segment: ',npckgs(ib2)
1298                     IF(lwp) WRITE(numout,*)
1299                     nstop = nstop + 1
1300                  ELSE
1301                     IF(lwp) WRITE(numout,*)
1302                     IF(lwp) WRITE(numout,*) ' E R R O R : Check South and West Open boundary indices'
1303                     IF(lwp) WRITE(numout,*) ' ==========  Crossing problem with West segment: ',npckgw(ib1) , &
1304                     &                                                    ' and South segment: ',npckgs(ib2)
1305                     IF(lwp) WRITE(numout,*)
1306                     nstop = nstop+1
1307                  END IF
1308               END IF
1309            END DO
1310         END DO
1311      END IF
1312      !
1313      ! South/East crossings
1314      IF ((nbdysege > 0).AND.(nbdysegs > 0)) THEN
1315         DO ib1 = 1, nbdysege
1316            DO ib2 = 1, nbdysegs
1317               IF (( jpisdt(ib2)<=jpieob(ib1)+1).AND. &
1318                &  ( jpisft(ib2)>=jpieob(ib1)+1).AND. &
1319                &  ( jpjedt(ib1)<=jpjsob(ib2)  ).AND. &
1320                &  ( jpjeft(ib1)>=jpjsob(ib2)  )) THEN
1321                  IF ((jpjedt(ib1)==jpjsob(ib2)).AND.(jpisft(ib2)==jpieob(ib1)+1)) THEN
1322                     ! We have a possible South-East corner
1323!                     WRITE(numout,*) ' Found a South-East corner at (i,j): ', jpisft(ib2), jpjedt(ib1)
1324!                     WRITE(numout,*) ' between segments: ', npckge(ib1), npckgs(ib2)
1325                     icorne(ib1,1) = npckgs(ib2)
1326                     icorns(ib2,2) = npckge(ib1)
1327                  ELSEIF ((jpjeft(ib1)==jpjsob(ib2)).AND.(jpisdt(ib2)==jpieob(ib1)+1)) THEN
1328                     IF(lwp) WRITE(numout,*)
1329                     IF(lwp) WRITE(numout,*) ' E R R O R : Found an acute open boundary corner at point (i,j)= ', &
1330                     &                                     jpisdt(ib2), jpjeft(ib1)
1331                     IF(lwp) WRITE(numout,*) ' ==========  Not allowed yet'
1332                     IF(lwp) WRITE(numout,*) '             Crossing problem with East segment: ',npckge(ib1), &
1333                     &                                                    ' and South segment: ',npckgs(ib2)
1334                     IF(lwp) WRITE(numout,*)
1335                     nstop = nstop + 1
1336                  ELSE
1337                     IF(lwp) WRITE(numout,*)
1338                     IF(lwp) WRITE(numout,*) ' E R R O R : Check South and East Open boundary indices'
1339                     IF(lwp) WRITE(numout,*) ' ==========  Crossing problem with East segment: ',npckge(ib1), &
1340                     &                                                    ' and South segment: ',npckgs(ib2)
1341                     IF(lwp) WRITE(numout,*)
1342                     nstop = nstop + 1
1343                  END IF
1344               END IF
1345            END DO
1346         END DO
1347      END IF
1348      !
1349      ! North/West crossings
1350      IF ((nbdysegn > 0).AND.(nbdysegw > 0)) THEN
1351         DO ib1 = 1, nbdysegw       
1352            DO ib2 = 1, nbdysegn
1353               IF (( jpindt(ib2)<=jpiwob(ib1)  ).AND. &
1354                &  ( jpinft(ib2)>=jpiwob(ib1)  ).AND. &
1355                &  ( jpjwdt(ib1)<=jpjnob(ib2)+1).AND. &
1356                &  ( jpjwft(ib1)>=jpjnob(ib2)+1)) THEN
1357                  IF ((jpjwft(ib1)==jpjnob(ib2)+1).AND.(jpindt(ib2)==jpiwob(ib1))) THEN
1358                     ! We have a possible North-West corner
1359!                     WRITE(numout,*) ' Found a North-West corner at (i,j): ', jpindt(ib2), jpjwft(ib1)
1360!                     WRITE(numout,*) ' between segments: ', npckgw(ib1), npckgn(ib2)
1361                     icornw(ib1,2) = npckgn(ib2)
1362                     icornn(ib2,1) = npckgw(ib1)
1363                  ELSEIF ((jpjwdt(ib1)==jpjnob(ib2)+1).AND.(jpinft(ib2)==jpiwob(ib1))) THEN
1364                     IF(lwp) WRITE(numout,*)
1365                     IF(lwp) WRITE(numout,*) ' E R R O R : Found an acute open boundary corner at point (i,j)= ', &
1366                     &                                     jpinft(ib2), jpjwdt(ib1)
1367                     IF(lwp) WRITE(numout,*) ' ==========  Not allowed yet'
1368                     IF(lwp) WRITE(numout,*) '             Crossing problem with West segment: ',npckgw(ib1), &
1369                     &                                                    ' and North segment: ',npckgn(ib2)
1370                     IF(lwp) WRITE(numout,*)
1371                     nstop = nstop + 1
1372                  ELSE
1373                     IF(lwp) WRITE(numout,*)
1374                     IF(lwp) WRITE(numout,*) ' E R R O R : Check North and West Open boundary indices'
1375                     IF(lwp) WRITE(numout,*) ' ==========  Crossing problem with West segment: ',npckgw(ib1), &
1376                     &                                                    ' and North segment: ',npckgn(ib2)
1377                     IF(lwp) WRITE(numout,*)
1378                     nstop = nstop + 1
1379                  END IF
1380               END IF
1381            END DO
1382         END DO
1383      END IF
1384      !
1385      ! North/East crossings
1386      IF ((nbdysegn > 0).AND.(nbdysege > 0)) THEN
1387         DO ib1 = 1, nbdysege       
1388            DO ib2 = 1, nbdysegn
1389               IF (( jpindt(ib2)<=jpieob(ib1)+1).AND. &
1390                &  ( jpinft(ib2)>=jpieob(ib1)+1).AND. &
1391                &  ( jpjedt(ib1)<=jpjnob(ib2)+1).AND. &
1392                &  ( jpjeft(ib1)>=jpjnob(ib2)+1)) THEN
1393                  IF ((jpjeft(ib1)==jpjnob(ib2)+1).AND.(jpinft(ib2)==jpieob(ib1)+1)) THEN
1394                     ! We have a possible North-East corner
1395!                     WRITE(numout,*) ' Found a North-East corner at (i,j): ', jpinft(ib2), jpjeft(ib1)
1396!                     WRITE(numout,*) ' between segments: ', npckge(ib1), npckgn(ib2)
1397                     icorne(ib1,2) = npckgn(ib2)
1398                     icornn(ib2,2) = npckge(ib1)
1399                  ELSEIF ((jpjedt(ib1)==jpjnob(ib2)+1).AND.(jpindt(ib2)==jpieob(ib1)+1)) THEN
1400                     IF(lwp) WRITE(numout,*)
1401                     IF(lwp) WRITE(numout,*) ' E R R O R : Found an acute open boundary corner at point (i,j)= ', &
1402                     &                                     jpindt(ib2), jpjedt(ib1)
1403                     IF(lwp) WRITE(numout,*) ' ==========  Not allowed yet'
1404                     IF(lwp) WRITE(numout,*) '             Crossing problem with East segment: ',npckge(ib1), &
1405                     &                                                    ' and North segment: ',npckgn(ib2)
1406                     IF(lwp) WRITE(numout,*)
1407                     nstop = nstop + 1
1408                  ELSE
1409                     IF(lwp) WRITE(numout,*)
1410                     IF(lwp) WRITE(numout,*) ' E R R O R : Check North and East Open boundary indices'
1411                     IF(lwp) WRITE(numout,*) ' ==========  Crossing problem with East segment: ',npckge(ib1), &
1412                     &                                                    ' and North segment: ',npckgn(ib2)
1413                     IF(lwp) WRITE(numout,*)
1414                     nstop = nstop + 1
1415                  END IF
1416               END IF
1417            END DO
1418         END DO
1419      END IF
1420      !
1421      ! 3. Check if segment extremities are on land
1422      !--------------------------------------------
1423      !
1424      ! West segments
1425      DO ib = 1, nbdysegw
1426         ! get mask at boundary extremities:
1427         ztestmask(1:2)=0.
1428         DO ji = 1, jpi
1429            DO jj = 1, jpj             
1430              IF (((ji + nimpp - 1) == jpiwob(ib)).AND. & 
1431               &  ((jj + njmpp - 1) == jpjwdt(ib))) ztestmask(1)=tmask(ji,jj,1)
1432              IF (((ji + nimpp - 1) == jpiwob(ib)).AND. & 
1433               &  ((jj + njmpp - 1) == jpjwft(ib))) ztestmask(2)=tmask(ji,jj,1) 
1434            END DO
1435         END DO
1436         IF( lk_mpp )   CALL mpp_sum( ztestmask, 2 )   ! sum over the global domain
1437
1438         IF (ztestmask(1)==1) THEN
1439            IF (icornw(ib,1)==0) THEN
1440               IF(lwp) WRITE(numout,*)
1441               IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgw(ib)
1442               IF(lwp) WRITE(numout,*) ' ==========  does not start on land or on a corner'                                                 
1443               IF(lwp) WRITE(numout,*)
1444               nstop = nstop + 1
1445            ELSE
1446               ! This is a corner
1447               WRITE(numout,*) 'Found a South-West corner at (i,j): ', jpiwob(ib), jpjwdt(ib)
1448               CALL bdy_ctl_corn(npckgw(ib), icornw(ib,1))
1449               itest=itest+1
1450            ENDIF
1451         ENDIF
1452         IF (ztestmask(2)==1) THEN
1453            IF (icornw(ib,2)==0) THEN
1454               IF(lwp) WRITE(numout,*)
1455               IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgw(ib)
1456               IF(lwp) WRITE(numout,*) ' ==========  does not end on land or on a corner'                                                 
1457               IF(lwp) WRITE(numout,*)
1458               nstop = nstop + 1
1459            ELSE
1460               ! This is a corner
1461               WRITE(numout,*) 'Found a North-West corner at (i,j): ', jpiwob(ib), jpjwft(ib)
1462               CALL bdy_ctl_corn(npckgw(ib), icornw(ib,2))
1463               itest=itest+1
1464            ENDIF
1465         ENDIF
1466      END DO
1467      !
1468      ! East segments
1469      DO ib = 1, nbdysege
1470         ! get mask at boundary extremities:
1471         ztestmask(1:2)=0.
1472         DO ji = 1, jpi
1473            DO jj = 1, jpj             
1474              IF (((ji + nimpp - 1) == jpieob(ib)+1).AND. & 
1475               &  ((jj + njmpp - 1) == jpjedt(ib))) ztestmask(1)=tmask(ji,jj,1)
1476              IF (((ji + nimpp - 1) == jpieob(ib)+1).AND. & 
1477               &  ((jj + njmpp - 1) == jpjeft(ib))) ztestmask(2)=tmask(ji,jj,1) 
1478            END DO
1479         END DO
1480         IF( lk_mpp )   CALL mpp_sum( ztestmask, 2 )   ! sum over the global domain
1481
1482         IF (ztestmask(1)==1) THEN
1483            IF (icorne(ib,1)==0) THEN
1484               IF(lwp) WRITE(numout,*)
1485               IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckge(ib)
1486               IF(lwp) WRITE(numout,*) ' ==========  does not start on land or on a corner'                                                 
1487               IF(lwp) WRITE(numout,*)
1488               nstop = nstop + 1 
1489            ELSE
1490               ! This is a corner
1491               WRITE(numout,*) 'Found a South-East corner at (i,j): ', jpieob(ib)+1, jpjedt(ib)
1492               CALL bdy_ctl_corn(npckge(ib), icorne(ib,1))
1493               itest=itest+1
1494            ENDIF
1495         ENDIF
1496         IF (ztestmask(2)==1) THEN
1497            IF (icorne(ib,2)==0) THEN
1498               IF(lwp) WRITE(numout,*)
1499               IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckge(ib)
1500               IF(lwp) WRITE(numout,*) ' ==========  does not end on land or on a corner'                                                 
1501               IF(lwp) WRITE(numout,*)
1502               nstop = nstop + 1
1503            ELSE
1504               ! This is a corner
1505               WRITE(numout,*) 'Found a North-East corner at (i,j): ', jpieob(ib)+1, jpjeft(ib)
1506               CALL bdy_ctl_corn(npckge(ib), icorne(ib,2))
1507               itest=itest+1
1508            ENDIF
1509         ENDIF
1510      END DO
1511      !
1512      ! South segments
1513      DO ib = 1, nbdysegs
1514         ! get mask at boundary extremities:
1515         ztestmask(1:2)=0.
1516         DO ji = 1, jpi
1517            DO jj = 1, jpj             
1518              IF (((jj + njmpp - 1) == jpjsob(ib)).AND. & 
1519               &  ((ji + nimpp - 1) == jpisdt(ib))) ztestmask(1)=tmask(ji,jj,1)
1520              IF (((jj + njmpp - 1) == jpjsob(ib)).AND. & 
1521               &  ((ji + nimpp - 1) == jpisft(ib))) ztestmask(2)=tmask(ji,jj,1) 
1522            END DO
1523         END DO
1524         IF( lk_mpp )   CALL mpp_sum( ztestmask, 2 )   ! sum over the global domain
1525
1526         IF ((ztestmask(1)==1).AND.(icorns(ib,1)==0)) THEN
1527            IF(lwp) WRITE(numout,*)
1528            IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgs(ib)
1529            IF(lwp) WRITE(numout,*) ' ==========  does not start on land or on a corner'                                                 
1530            IF(lwp) WRITE(numout,*)
1531            nstop = nstop + 1
1532         ENDIF
1533         IF ((ztestmask(2)==1).AND.(icorns(ib,2)==0)) THEN
1534            IF(lwp) WRITE(numout,*)
1535            IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgs(ib)
1536            IF(lwp) WRITE(numout,*) ' ==========  does not end on land or on a corner'                                                 
1537            IF(lwp) WRITE(numout,*)
1538            nstop = nstop + 1
1539         ENDIF
1540      END DO
1541      !
1542      ! North segments
1543      DO ib = 1, nbdysegn
1544         ! get mask at boundary extremities:
1545         ztestmask(1:2)=0.
1546         DO ji = 1, jpi
1547            DO jj = 1, jpj             
1548              IF (((jj + njmpp - 1) == jpjnob(ib)+1).AND. & 
1549               &  ((ji + nimpp - 1) == jpindt(ib))) ztestmask(1)=tmask(ji,jj,1)
1550              IF (((jj + njmpp - 1) == jpjnob(ib)+1).AND. & 
1551               &  ((ji + nimpp - 1) == jpinft(ib))) ztestmask(2)=tmask(ji,jj,1) 
1552            END DO
1553         END DO
1554         IF( lk_mpp )   CALL mpp_sum( ztestmask, 2 )   ! sum over the global domain
1555
1556         IF ((ztestmask(1)==1).AND.(icornn(ib,1)==0)) THEN
1557            IF(lwp) WRITE(numout,*)
1558            IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgn(ib)
1559            IF(lwp) WRITE(numout,*) ' ==========  does not start on land'                                                 
1560            IF(lwp) WRITE(numout,*)
1561            nstop = nstop + 1
1562         ENDIF
1563         IF ((ztestmask(2)==1).AND.(icornn(ib,2)==0)) THEN
1564            IF(lwp) WRITE(numout,*)
1565            IF(lwp) WRITE(numout,*) ' E R R O R : Open boundary segment ', npckgn(ib)
1566            IF(lwp) WRITE(numout,*) ' ==========  does not end on land'                                                 
1567            IF(lwp) WRITE(numout,*)
1568            nstop = nstop + 1
1569         ENDIF
1570      END DO
1571      !
1572      IF ((itest==0).AND.(lwp)) WRITE(numout,*) 'NO open boundary corner found'
1573      !
1574      ! Other tests TBD:
1575      ! segments completly on land
1576      ! optimized open boundary array length according to landmask
1577      ! Nudging layers that overlap with interior domain
1578      !
1579   END SUBROUTINE bdy_ctl_seg
1580
1581   SUBROUTINE bdy_ctl_corn( ib1, ib2 )
1582      !!----------------------------------------------------------------------
1583      !!                 ***  ROUTINE bdy_ctl_corn  ***
1584      !!
1585      !! ** Purpose :   Check numerical schemes consistency between
1586      !!                segments having a common corner
1587      !!
1588      !! ** Method  :   
1589      !!----------------------------------------------------------------------
1590      INTEGER, INTENT(in)  ::   ib1, ib2
1591      INTEGER :: itest
1592      !!----------------------------------------------------------------------
1593      itest = 0
1594
1595      IF (cn_dyn2d(ib1)/=cn_dyn2d(ib2)) itest = itest + 1
1596      IF (cn_dyn3d(ib1)/=cn_dyn3d(ib2)) itest = itest + 1
1597      IF (cn_tra(ib1)/=cn_tra(ib2)) itest = itest + 1
1598      !
1599      IF (nn_dyn2d_dta(ib1)/=nn_dyn2d_dta(ib2)) itest = itest + 1
1600      IF (nn_dyn3d_dta(ib1)/=nn_dyn3d_dta(ib2)) itest = itest + 1
1601      IF (nn_tra_dta(ib1)/=nn_tra_dta(ib2)) itest = itest + 1
1602      !
1603      IF (nn_rimwidth(ib1)/=nn_rimwidth(ib2)) itest = itest + 1   
1604      !
1605      IF ( itest>0 ) THEN
1606         IF(lwp) WRITE(numout,*) ' E R R O R : Segments ', ib1, 'and ', ib2
1607         IF(lwp) WRITE(numout,*) ' ==========  have different open bdy schemes'                                                 
1608         IF(lwp) WRITE(numout,*)
1609         nstop = nstop + 1
1610      ENDIF
1611      !
1612   END SUBROUTINE bdy_ctl_corn
1613
1614#else
1615   !!---------------------------------------------------------------------------------
1616   !!   Dummy module                                   NO open boundaries
1617   !!---------------------------------------------------------------------------------
1618CONTAINS
1619   SUBROUTINE bdy_init      ! Dummy routine
1620   END SUBROUTINE bdy_init
1621#endif
1622
1623   !!=================================================================================
1624END MODULE bdyini
Note: See TracBrowser for help on using the repository browser.