source: branches/2012/dev_MERGE_2012/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 3680

Last change on this file since 3680 was 3680, checked in by rblod, 8 years ago

First commit of the final branch for 2012 (future nemo_3_5), see ticket #1028

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