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_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/2013/dev_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 4193

Last change on this file since 4193 was 4193, checked in by cbricaud, 11 years ago

Merge branch with revision 4119

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