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

source: branches/2016/dev_r6522_SIMPLIF_3/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 6862

Last change on this file since 6862 was 6862, checked in by lovato, 8 years ago

#1729 - trunk: removed key_bdy from the code and set usage of ln_bdy. Tested with SETTE.

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