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

source: trunk/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 4689

Last change on this file since 4689 was 4689, checked in by clem, 10 years ago

new version of LIM3 with perfect conservation of heat, see ticket #1352

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