New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
bdyini.F90 in branches/UKMO/r6232_HZG_WAVE/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/UKMO/r6232_HZG_WAVE/NEMOGCM/NEMO/OPA_SRC/BDY/bdyini.F90 @ 7807

Last change on this file since 7807 was 7807, checked in by jcastill, 7 years ago

Changes as in HZG wave forcing branch, but adapted to r6232

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