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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
bdyini.F90 in branches/2013/dev_r3853_CNRS9_ConfSetting/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/2013/dev_r3853_CNRS9_ConfSetting/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 3875

Last change on this file since 3875 was 3875, checked in by clevy, 11 years ago

Configuration Setting/Step? 1, see ticket:#1074

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