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

source: branches/UKMO/AMM15_v3_6_STABLE/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 7087

Last change on this file since 7087 was 7087, checked in by jgraham, 8 years ago

Bring in options for 3D U/V boundaries, following changes made for CO6.
Options added are 'zerograd' or 'neumann' boundary conditions.

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