source: branches/2012/dev_NOC_MERCATOR_2012/NEMOGCM/NEMO/OPA_SRC/BDY/bdydta.F90 @ 3651

Last change on this file since 3651 was 3651, checked in by cbricaud, 8 years ago

merge dev_MERCATOR_2012_rev3555 into dev_NOC_MERCATOR_2012 ; see ticket 1020

  • Property svn:keywords set to Id
File size: 32.2 KB
Line 
1MODULE bdydta
2   !!======================================================================
3   !!                       ***  MODULE bdydta  ***
4   !! Open boundary data : read the data for the unstructured open boundaries.
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-07  (D. Storkey) add bdy_dta_fla
9   !!            3.0  !  2008-04  (NEMO team)  add in the reference version
10   !!            3.3  !  2010-09  (E.O'Dea) modifications 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   !!----------------------------------------------------------------------
14#if defined key_bdy
15   !!----------------------------------------------------------------------
16   !!   'key_bdy'                     Open Boundary Conditions
17   !!----------------------------------------------------------------------
18   !!    bdy_dta        : read external data along open boundaries from file
19   !!    bdy_dta_init   : initialise arrays etc for reading of external data
20   !!----------------------------------------------------------------------
21   USE wrk_nemo        ! Memory Allocation
22   USE timing          ! Timing
23   USE oce             ! ocean dynamics and tracers
24   USE dom_oce         ! ocean space and time domain
25   USE phycst          ! physical constants
26   USE bdy_oce         ! ocean open boundary conditions 
27   USE bdytides        ! tidal forcing at boundaries
28   USE fldread         ! read input fields
29   USE iom             ! IOM library
30   USE in_out_manager  ! I/O logical units
31#if defined key_lim2
32   USE ice_2
33#endif
34   USE sbcapr
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC   bdy_dta          ! routine called by step.F90 and dynspg_ts.F90
40   PUBLIC   bdy_dta_init     ! routine called by nemogcm.F90
41
42   INTEGER, ALLOCATABLE, DIMENSION(:)   ::   nb_bdy_fld        ! Number of fields to update for each boundary set.
43   INTEGER                              ::   nb_bdy_fld_sum    ! Total number of fields to update for all boundary sets.
44
45   LOGICAL,           DIMENSION(jp_bdy) ::   ln_full_vel_array ! =T => full velocities in 3D boundary conditions
46                                                               ! =F => baroclinic velocities in 3D boundary conditions
47
48   TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:), TARGET ::   bf        ! structure of input fields (file informations, fields read)
49
50   TYPE(MAP_POINTER), ALLOCATABLE, DIMENSION(:) :: nbmap_ptr   ! array of pointers to nbmap
51
52#  include "domzgr_substitute.h90"
53   !!----------------------------------------------------------------------
54   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
55   !! $Id$
56   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
57   !!----------------------------------------------------------------------
58CONTAINS
59
60      SUBROUTINE bdy_dta( kt, jit, time_offset )
61      !!----------------------------------------------------------------------
62      !!                   ***  SUBROUTINE bdy_dta  ***
63      !!                   
64      !! ** Purpose :   Update external data for open boundary conditions
65      !!
66      !! ** Method  :   Use fldread.F90
67      !!               
68      !!----------------------------------------------------------------------
69      !!
70      INTEGER, INTENT( in )           ::   kt    ! ocean time-step index
71      INTEGER, INTENT( in ), OPTIONAL ::   jit   ! subcycle time-step index (for timesplitting option)
72      INTEGER, INTENT( in ), OPTIONAL ::   time_offset  ! time offset in units of timesteps. NB. if jit
73                                                        ! is present then units = subcycle timesteps.
74                                                        ! time_offset = 0 => get data at "now" time level
75                                                        ! time_offset = -1 => get data at "before" time level
76                                                        ! time_offset = +1 => get data at "after" time level
77                                                        ! etc.
78      !!
79      INTEGER     ::  ib_bdy, jfld, jstart, jend, ib, ii, ij, ik, igrd  ! local indices
80      INTEGER,          DIMENSION(jpbgrd) ::   ilen1 
81      INTEGER, POINTER, DIMENSION(:)      ::   nblen, nblenrim  ! short cuts
82      !!
83      !!---------------------------------------------------------------------------
84      !!
85      IF( nn_timing == 1 ) CALL timing_start('bdy_dta')
86
87      ! Initialise data arrays once for all from initial conditions where required
88      !---------------------------------------------------------------------------
89      IF( kt .eq. nit000 .and. .not. PRESENT(jit) ) THEN
90
91         ! Calculate depth-mean currents
92         !-----------------------------
93         CALL wrk_alloc(jpi,jpj,pu2d,pv2d) 
94
95         pu2d(:,:) = 0.e0
96         pv2d(:,:) = 0.e0
97
98         DO ik = 1, jpkm1   !! Vertically integrated momentum trends
99             pu2d(:,:) = pu2d(:,:) + fse3u(:,:,ik) * umask(:,:,ik) * un(:,:,ik)
100             pv2d(:,:) = pv2d(:,:) + fse3v(:,:,ik) * vmask(:,:,ik) * vn(:,:,ik)
101         END DO
102         pu2d(:,:) = pu2d(:,:) * hur(:,:)
103         pv2d(:,:) = pv2d(:,:) * hvr(:,:)
104         
105         DO ib_bdy = 1, nb_bdy
106
107            nblen => idx_bdy(ib_bdy)%nblen
108            nblenrim => idx_bdy(ib_bdy)%nblenrim
109
110            IF( nn_dyn2d(ib_bdy) .gt. 0 .and. nn_dyn2d_dta(ib_bdy) .eq. 0 ) THEN
111               ilen1(:) = nblen(:)
112               igrd = 1
113               DO ib = 1, ilen1(igrd)
114                  ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
115                  ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
116                  dta_bdy(ib_bdy)%ssh(ib) = sshn(ii,ij) * tmask(ii,ij,1)         
117               END DO
118               igrd = 2
119               DO ib = 1, ilen1(igrd)
120                  ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
121                  ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
122                  dta_bdy(ib_bdy)%u2d(ib) = pu2d(ii,ij) * umask(ii,ij,1)         
123               END DO
124               igrd = 3
125               DO ib = 1, ilen1(igrd)
126                  ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
127                  ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
128                  dta_bdy(ib_bdy)%v2d(ib) = pv2d(ii,ij) * vmask(ii,ij,1)         
129               END DO
130            ENDIF
131
132            IF( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 0 ) THEN
133               ilen1(:) = nblen(:)
134               igrd = 2 
135               DO ib = 1, ilen1(igrd)
136                  DO ik = 1, jpkm1
137                     ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
138                     ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
139                     dta_bdy(ib_bdy)%u3d(ib,ik) =  ( un(ii,ij,ik) - pu2d(ii,ij) ) * umask(ii,ij,ik)         
140                  END DO
141               END DO
142               igrd = 3 
143               DO ib = 1, ilen1(igrd)
144                  DO ik = 1, jpkm1
145                     ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
146                     ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
147                     dta_bdy(ib_bdy)%v3d(ib,ik) =  ( vn(ii,ij,ik) - pv2d(ii,ij) ) * vmask(ii,ij,ik)         
148                     END DO
149               END DO
150            ENDIF
151
152            IF( nn_tra(ib_bdy) .gt. 0 .and. nn_tra_dta(ib_bdy) .eq. 0 ) THEN
153               ilen1(:) = nblen(:)
154               igrd = 1                       ! Everything is at T-points here
155               DO ib = 1, ilen1(igrd)
156                  DO ik = 1, jpkm1
157                     ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
158                     ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
159                     dta_bdy(ib_bdy)%tem(ib,ik) = tsn(ii,ij,ik,jp_tem) * tmask(ii,ij,ik)         
160                     dta_bdy(ib_bdy)%sal(ib,ik) = tsn(ii,ij,ik,jp_sal) * tmask(ii,ij,ik)         
161                  END DO
162               END DO
163            ENDIF
164
165#if defined key_lim2
166            IF( nn_ice_lim2(ib_bdy) .gt. 0 .and. nn_ice_lim2_dta(ib_bdy) .eq. 0 ) THEN
167               ilen1(:) = nblen(:)
168               igrd = 1                       ! Everything is at T-points here
169               DO ib = 1, ilen1(igrd)
170                  ii = idx_bdy(ib_bdy)%nbi(ib,igrd)
171                  ij = idx_bdy(ib_bdy)%nbj(ib,igrd)
172                  dta_bdy(ib_bdy)%frld(ib) = frld(ii,ij) * tmask(ii,ij,1)         
173                  dta_bdy(ib_bdy)%hicif(ib) = hicif(ii,ij) * tmask(ii,ij,1)         
174                  dta_bdy(ib_bdy)%hsnif(ib) = hsnif(ii,ij) * tmask(ii,ij,1)         
175               END DO
176            ENDIF
177#endif
178
179         ENDDO ! ib_bdy
180
181         CALL wrk_dealloc(jpi,jpj,pu2d,pv2d) 
182
183      ENDIF ! kt .eq. nit000
184
185      ! update external data from files
186      !--------------------------------
187     
188      jstart = 1
189      DO ib_bdy = 1, nb_bdy   
190         IF( nn_dta(ib_bdy) .eq. 1 ) THEN ! skip this bit if no external data required
191     
192            IF( PRESENT(jit) ) THEN
193               ! Update barotropic boundary conditions only
194               ! jit is optional argument for fld_read and bdytide_update
195               IF( nn_dyn2d(ib_bdy) .gt. 0 ) THEN
196                  IF( nn_dyn2d_dta(ib_bdy) .eq. 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
197                     dta_bdy(ib_bdy)%ssh(:) = 0.0
198                     dta_bdy(ib_bdy)%u2d(:) = 0.0
199                     dta_bdy(ib_bdy)%v2d(:) = 0.0
200                  ENDIF
201                  IF (nn_tra(ib_bdy).ne.4) THEN
202                     IF (nn_dyn2d_dta(ib_bdy).eq.1.or.nn_dyn2d_dta(ib_bdy).eq.3.or.(ln_full_vel_array(ib_bdy).and.nn_dyn3d_dta(ib_bdy).eq.1)) THEN
203                        ! For the runoff case, no need to update the forcing (already done in the baroclinic part)
204                        jend = nb_bdy_fld(ib_bdy)
205                        IF ( nn_tra(ib_bdy) .GT. 0 .AND. nn_tra_dta(ib_bdy) .GE. 1 ) jend = jend - 2
206                        CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), map=nbmap_ptr(jstart:jend), jit=jit, time_offset=time_offset )
207                        IF ( nn_tra(ib_bdy) .GT. 0 .AND. nn_tra_dta(ib_bdy) .GE. 1 ) jend = jend + 2
208                        ! If full velocities in boundary data then split into barotropic and baroclinic data
209                        IF( ln_full_vel_array(ib_bdy) .and.                                             &
210                       &    ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 .or. nn_dyn3d_dta(ib_bdy) .eq. 1 ) ) THEN
211                           igrd = 2                      ! zonal velocity
212                           dta_bdy(ib_bdy)%u2d(:) = 0.0
213                           DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
214                              ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
215                              ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
216                              DO ik = 1, jpkm1
217                                 dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) &
218                       &                          + fse3u(ii,ij,ik) * umask(ii,ij,ik) * dta_bdy(ib_bdy)%u3d(ib,ik)
219                              END DO
220                              dta_bdy(ib_bdy)%u2d(ib) =  dta_bdy(ib_bdy)%u2d(ib) * hur(ii,ij)
221                              DO ik = 1, jpkm1
222                                 dta_bdy(ib_bdy)%u3d(ib,ik) = dta_bdy(ib_bdy)%u3d(ib,ik) - dta_bdy(ib_bdy)%u2d(ib)
223                              END DO
224                           END DO
225                           igrd = 3                      ! meridional velocity
226                           dta_bdy(ib_bdy)%v2d(:) = 0.0
227                           DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
228                              ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
229                              ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
230                              DO ik = 1, jpkm1
231                                 dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) &
232                       &                       + fse3v(ii,ij,ik) * vmask(ii,ij,ik) * dta_bdy(ib_bdy)%v3d(ib,ik)
233                              END DO
234                              dta_bdy(ib_bdy)%v2d(ib) =  dta_bdy(ib_bdy)%v2d(ib) * hvr(ii,ij)
235                              DO ik = 1, jpkm1
236                                 dta_bdy(ib_bdy)%v3d(ib,ik) = dta_bdy(ib_bdy)%v3d(ib,ik) - dta_bdy(ib_bdy)%v2d(ib)
237                              END DO
238                           END DO
239                        ENDIF                   
240                     ENDIF
241                     IF( nn_dyn2d_dta(ib_bdy) .ge. 2 ) THEN ! update tidal harmonic forcing
242                        CALL bdytide_update( kt=kt, idx=idx_bdy(ib_bdy), dta=dta_bdy(ib_bdy), td=tides(ib_bdy),   & 
243                          &                 jit=jit, time_offset=time_offset )
244                     ENDIF
245                  ENDIF
246               ENDIF
247            ELSE
248               IF (nn_tra(ib_bdy).eq.4) then      ! runoff condition
249                  jend = nb_bdy_fld(ib_bdy)
250                  CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), map=nbmap_ptr(jstart:jend), time_offset=time_offset )
251                  !
252                  igrd = 2                      ! zonal velocity
253                  DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
254                     ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
255                     ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
256                     dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) / ( e2u(ii,ij) * hu_0(ii,ij) )
257                  END DO
258                  !
259                  igrd = 3                      ! meridional velocity
260                  DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
261                     ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
262                     ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
263                     dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) / ( e1v(ii,ij) * hv_0(ii,ij) )
264                  END DO
265               ELSE
266                  IF( nn_dyn2d(ib_bdy) .gt. 0 .and. nn_dyn2d_dta(ib_bdy) .eq. 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
267                     dta_bdy(ib_bdy)%ssh(:) = 0.0
268                     dta_bdy(ib_bdy)%u2d(:) = 0.0
269                     dta_bdy(ib_bdy)%v2d(:) = 0.0
270                  ENDIF
271                  IF( nb_bdy_fld(ib_bdy) .gt. 0 ) THEN ! update external data
272                     jend = nb_bdy_fld(ib_bdy)
273                     CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), map=nbmap_ptr(jstart:jend), time_offset=time_offset )
274                  ENDIF
275                  ! If full velocities in boundary data then split into barotropic and baroclinic data
276                  IF( ln_full_vel_array(ib_bdy) .and.                                             &
277                 &    ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 .or. nn_dyn3d_dta(ib_bdy) .eq. 1 ) ) THEN
278                     igrd = 2                      ! zonal velocity
279                     dta_bdy(ib_bdy)%u2d(:) = 0.0
280                     DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
281                        ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
282                        ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
283                        DO ik = 1, jpkm1
284                           dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) &
285                 &                       + fse3u(ii,ij,ik) * umask(ii,ij,ik) * dta_bdy(ib_bdy)%u3d(ib,ik)
286                        END DO
287                        dta_bdy(ib_bdy)%u2d(ib) =  dta_bdy(ib_bdy)%u2d(ib) * hur(ii,ij)
288                        DO ik = 1, jpkm1
289                           dta_bdy(ib_bdy)%u3d(ib,ik) = dta_bdy(ib_bdy)%u3d(ib,ik) - dta_bdy(ib_bdy)%u2d(ib)
290                        END DO
291                     END DO
292                     igrd = 3                      ! meridional velocity
293                     dta_bdy(ib_bdy)%v2d(:) = 0.0
294                     DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
295                        ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
296                        ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
297                        DO ik = 1, jpkm1
298                           dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) &
299                 &                       + fse3v(ii,ij,ik) * vmask(ii,ij,ik) * dta_bdy(ib_bdy)%v3d(ib,ik)
300                        END DO
301                        dta_bdy(ib_bdy)%v2d(ib) =  dta_bdy(ib_bdy)%v2d(ib) * hvr(ii,ij)
302                        DO ik = 1, jpkm1
303                           dta_bdy(ib_bdy)%v3d(ib,ik) = dta_bdy(ib_bdy)%v3d(ib,ik) - dta_bdy(ib_bdy)%v2d(ib)
304                        END DO
305                     END DO
306                  ENDIF
307                  IF( nn_dyn2d(ib_bdy) .gt. 0 .and. nn_dyn2d_dta(ib_bdy) .ge. 2 ) THEN ! update tidal harmonic forcing
308                     CALL bdytide_update( kt=kt, idx=idx_bdy(ib_bdy), dta=dta_bdy(ib_bdy), td=tides(ib_bdy), time_offset=time_offset )
309                  ENDIF
310               ENDIF
311            ENDIF
312            jstart = jend+1
313         END IF ! nn_dta(ib_bdy) = 1
314      END DO  ! ib_bdy
315
316      IF ( ln_apr_obc ) THEN
317         DO ib_bdy = 1, nb_bdy
318            IF (nn_tra(ib_bdy).NE.4)THEN
319               igrd = 1                      ! meridional velocity
320               DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
321                  ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
322                  ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
323                  dta_bdy(ib_bdy)%ssh(ib) = dta_bdy(ib_bdy)%ssh(ib) + ssh_ib(ii,ij)
324               ENDDO
325            ENDIF
326         ENDDO
327      ENDIF
328
329      IF( nn_timing == 1 ) CALL timing_stop('bdy_dta')
330
331      END SUBROUTINE bdy_dta
332
333
334      SUBROUTINE bdy_dta_init
335      !!----------------------------------------------------------------------
336      !!                   ***  SUBROUTINE bdy_dta_init  ***
337      !!                   
338      !! ** Purpose :   Initialise arrays for reading of external data
339      !!                for open boundary conditions
340      !!
341      !! ** Method  :   Use fldread.F90
342      !!               
343      !!----------------------------------------------------------------------
344      USE dynspg_oce, ONLY: lk_dynspg_ts
345      !!
346      INTEGER     ::  ib_bdy, jfld, jstart, jend, ierror  ! local indices
347      !!
348      CHARACTER(len=100)                     ::   cn_dir        ! Root directory for location of data files
349      CHARACTER(len=100), DIMENSION(nb_bdy)  ::   cn_dir_array  ! Root directory for location of data files
350      LOGICAL                                ::   ln_full_vel   ! =T => full velocities in 3D boundary data
351                                                                ! =F => baroclinic velocities in 3D boundary data
352      INTEGER                                ::   ilen_global   ! Max length required for global bdy dta arrays
353      INTEGER,              DIMENSION(jpbgrd) ::  ilen0         ! size of local arrays
354      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ilen1, ilen3  ! size of 1st and 3rd dimensions of local arrays
355      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ibdy           ! bdy set for a particular jfld
356      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   igrid         ! index for grid type (1,2,3 = T,U,V)
357      INTEGER, POINTER, DIMENSION(:)         ::   nblen, nblenrim  ! short cuts
358      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::   blf_i         !  array of namelist information structures
359      TYPE(FLD_N) ::   bn_tem, bn_sal, bn_u3d, bn_v3d   !
360      TYPE(FLD_N) ::   bn_ssh, bn_u2d, bn_v2d           ! informations about the fields to be read
361#if defined key_lim2
362      TYPE(FLD_N) ::   bn_frld, bn_hicif, bn_hsnif      !
363#endif
364      NAMELIST/nambdy_dta/ cn_dir, bn_tem, bn_sal, bn_u3d, bn_v3d, bn_ssh, bn_u2d, bn_v2d 
365#if defined key_lim2
366      NAMELIST/nambdy_dta/ bn_frld, bn_hicif, bn_hsnif
367#endif
368      NAMELIST/nambdy_dta/ ln_full_vel
369      !!---------------------------------------------------------------------------
370
371      IF( nn_timing == 1 ) CALL timing_start('bdy_dta_init')
372
373      IF(lwp) WRITE(numout,*)
374      IF(lwp) WRITE(numout,*) 'bdy_dta_ini : initialization of data at the open boundaries'
375      IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
376      IF(lwp) WRITE(numout,*) ''
377
378      ! Set nn_dta
379      DO ib_bdy = 1, nb_bdy
380         nn_dta(ib_bdy) = MAX(  nn_dyn2d_dta(ib_bdy)       &
381                               ,nn_dyn3d_dta(ib_bdy)       &
382                               ,nn_tra_dta(ib_bdy)         &
383#if defined key_lim2
384                               ,nn_ice_lim2_dta(ib_bdy)    &
385#endif
386                              )
387         IF(nn_dta(ib_bdy) .gt. 1) nn_dta(ib_bdy) = 1
388      END DO
389
390      ! Work out upper bound of how many fields there are to read in and allocate arrays
391      ! ---------------------------------------------------------------------------
392      ALLOCATE( nb_bdy_fld(nb_bdy) )
393      nb_bdy_fld(:) = 0
394      DO ib_bdy = 1, nb_bdy         
395         IF( nn_dyn2d(ib_bdy) .gt. 0 .and. ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) THEN
396            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 3
397         ENDIF
398         IF( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ) THEN
399            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 2
400         ENDIF
401         IF( nn_tra(ib_bdy) .gt. 0 .and. nn_tra_dta(ib_bdy) .eq. 1  ) THEN
402            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 2
403         ENDIF
404#if defined key_lim2
405         IF( nn_ice_lim2(ib_bdy) .gt. 0 .and. nn_ice_lim2_dta(ib_bdy) .eq. 1  ) THEN
406            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 3
407         ENDIF
408#endif               
409         IF(lwp) WRITE(numout,*) 'Maximum number of files to open =',nb_bdy_fld(ib_bdy)
410      ENDDO           
411
412      nb_bdy_fld_sum = SUM( nb_bdy_fld )
413
414      ALLOCATE( bf(nb_bdy_fld_sum), STAT=ierror )
415      IF( ierror > 0 ) THEN   
416         CALL ctl_stop( 'bdy_dta: unable to allocate bf structure' )   ;   RETURN 
417      ENDIF
418      ALLOCATE( blf_i(nb_bdy_fld_sum), STAT=ierror )
419      IF( ierror > 0 ) THEN   
420         CALL ctl_stop( 'bdy_dta: unable to allocate blf_i structure' )   ;   RETURN 
421      ENDIF
422      ALLOCATE( nbmap_ptr(nb_bdy_fld_sum), STAT=ierror )
423      IF( ierror > 0 ) THEN   
424         CALL ctl_stop( 'bdy_dta: unable to allocate nbmap_ptr structure' )   ;   RETURN 
425      ENDIF
426      ALLOCATE( ilen1(nb_bdy_fld_sum), ilen3(nb_bdy_fld_sum) ) 
427      ALLOCATE( ibdy(nb_bdy_fld_sum) ) 
428      ALLOCATE( igrid(nb_bdy_fld_sum) ) 
429
430      ! Read namelists
431      ! --------------
432      REWIND(numnam)
433      jfld = 0 
434      DO ib_bdy = 1, nb_bdy         
435         IF( nn_dta(ib_bdy) .eq. 1 ) THEN
436            ! set file information
437            cn_dir = './'        ! directory in which the model is executed
438            ln_full_vel = .false.
439            ! ... default values (NB: frequency positive => hours, negative => months)
440            !                    !  file       ! frequency !  variable   ! time intep !  clim   ! 'yearly' or ! weights  ! rotation  !
441            !                    !  name       ! hours !   name     !  (T/F)  !  (T/F)  !  'monthly'  ! filename ! pairs     !
442            bn_ssh     = FLD_N(  'bdy_ssh'     ,  24   , 'sossheig' , .false. , .false. ,   'yearly'  , ''       , ''        )
443            bn_u2d     = FLD_N(  'bdy_vel2d_u' ,  24   , 'vobtcrtx' , .false. , .false. ,   'yearly'  , ''       , ''        )
444            bn_v2d     = FLD_N(  'bdy_vel2d_v' ,  24   , 'vobtcrty' , .false. , .false. ,   'yearly'  , ''       , ''        )
445            bn_u3d     = FLD_N(  'bdy_vel3d_u' ,  24   , 'vozocrtx' , .false. , .false. ,   'yearly'  , ''       , ''        )
446            bn_v3d     = FLD_N(  'bdy_vel3d_v' ,  24   , 'vomecrty' , .false. , .false. ,   'yearly'  , ''       , ''        )
447            bn_tem     = FLD_N(  'bdy_tem'     ,  24   , 'votemper' , .false. , .false. ,   'yearly'  , ''       , ''        )
448            bn_sal     = FLD_N(  'bdy_sal'     ,  24   , 'vosaline' , .false. , .false. ,   'yearly'  , ''       , ''        )
449#if defined key_lim2
450            bn_frld    = FLD_N(  'bdy_frld'    ,  24   , 'ildsconc' , .false. , .false. ,   'yearly'  , ''       , ''        )
451            bn_hicif   = FLD_N(  'bdy_hicif'   ,  24   , 'iicethic' , .false. , .false. ,   'yearly'  , ''       , ''        )
452            bn_hsnif   = FLD_N(  'bdy_hsnif'   ,  24   , 'isnothic' , .false. , .false. ,   'yearly'  , ''       , ''        )
453#endif
454
455            ! Important NOT to rewind here.
456            READ( numnam, nambdy_dta )
457
458            cn_dir_array(ib_bdy) = cn_dir
459            ln_full_vel_array(ib_bdy) = ln_full_vel
460
461            nblen => idx_bdy(ib_bdy)%nblen
462            nblenrim => idx_bdy(ib_bdy)%nblenrim
463
464            ! Only read in necessary fields for this set.
465            ! Important that barotropic variables come first.
466            IF( nn_dyn2d(ib_bdy) .gt. 0 .and. ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) THEN
467
468               IF( nn_tra(ib_bdy) .ne. 4 ) THEN ! runoff condition : no ssh reading
469                  jfld = jfld + 1
470                  blf_i(jfld) = bn_ssh
471                  ibdy(jfld) = ib_bdy
472                  igrid(jfld) = 1
473                  ilen1(jfld) = nblen(igrid(jfld))
474                  ilen3(jfld) = 1
475               ENDIF
476
477               IF( .not. ln_full_vel_array(ib_bdy) ) THEN
478                  jfld = jfld + 1
479                  blf_i(jfld) = bn_u2d
480                  ibdy(jfld) = ib_bdy
481                  igrid(jfld) = 2
482                  ilen1(jfld) = nblen(igrid(jfld))
483                  ilen3(jfld) = 1
484
485                  jfld = jfld + 1
486                  blf_i(jfld) = bn_v2d
487                  ibdy(jfld) = ib_bdy
488                  igrid(jfld) = 3
489                  ilen1(jfld) = nblen(igrid(jfld))
490                  ilen3(jfld) = 1
491               ENDIF
492
493            ENDIF
494
495            ! baroclinic velocities
496            IF( ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ) .or. &
497           &      ( ln_full_vel_array(ib_bdy) .and. nn_dyn2d(ib_bdy) .gt. 0 .and.  &
498           &        ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) ) THEN
499
500               jfld = jfld + 1
501               blf_i(jfld) = bn_u3d
502               ibdy(jfld) = ib_bdy
503               igrid(jfld) = 2
504               ilen1(jfld) = nblen(igrid(jfld))
505               ilen3(jfld) = jpk
506
507               jfld = jfld + 1
508               blf_i(jfld) = bn_v3d
509               ibdy(jfld) = ib_bdy
510               igrid(jfld) = 3
511               ilen1(jfld) = nblen(igrid(jfld))
512               ilen3(jfld) = jpk
513
514            ENDIF
515
516            ! temperature and salinity
517            IF( nn_tra(ib_bdy) .gt. 0 .and. nn_tra_dta(ib_bdy) .eq. 1 ) THEN
518
519               jfld = jfld + 1
520               blf_i(jfld) = bn_tem
521               ibdy(jfld) = ib_bdy
522               igrid(jfld) = 1
523               ilen1(jfld) = nblen(igrid(jfld))
524               ilen3(jfld) = jpk
525
526               jfld = jfld + 1
527               blf_i(jfld) = bn_sal
528               ibdy(jfld) = ib_bdy
529               igrid(jfld) = 1
530               ilen1(jfld) = nblen(igrid(jfld))
531               ilen3(jfld) = jpk
532
533            ENDIF
534
535#if defined key_lim2
536            ! sea ice
537            IF( nn_ice_lim2(ib_bdy) .gt. 0 .and. nn_ice_lim2_dta(ib_bdy) .eq. 1 ) THEN
538
539               jfld = jfld + 1
540               blf_i(jfld) = bn_frld
541               ibdy(jfld) = ib_bdy
542               igrid(jfld) = 1
543               ilen1(jfld) = nblen(igrid(jfld))
544               ilen3(jfld) = 1
545
546               jfld = jfld + 1
547               blf_i(jfld) = bn_hicif
548               ibdy(jfld) = ib_bdy
549               igrid(jfld) = 1
550               ilen1(jfld) = nblen(igrid(jfld))
551               ilen3(jfld) = 1
552
553               jfld = jfld + 1
554               blf_i(jfld) = bn_hsnif
555               ibdy(jfld) = ib_bdy
556               igrid(jfld) = 1
557               ilen1(jfld) = nblen(igrid(jfld))
558               ilen3(jfld) = 1
559
560            ENDIF
561#endif
562            ! Recalculate field counts
563            !-------------------------
564            nb_bdy_fld_sum = 0
565            IF( ib_bdy .eq. 1 ) THEN
566               nb_bdy_fld(ib_bdy) = jfld
567               nb_bdy_fld_sum     = jfld             
568            ELSE
569               nb_bdy_fld(ib_bdy) = jfld - nb_bdy_fld_sum
570               nb_bdy_fld_sum = nb_bdy_fld_sum + nb_bdy_fld(ib_bdy)
571            ENDIF
572
573         ENDIF ! nn_dta .eq. 1
574      ENDDO ! ib_bdy
575
576      DO jfld = 1, nb_bdy_fld_sum
577         ALLOCATE( bf(jfld)%fnow(ilen1(jfld),1,ilen3(jfld)) )
578         IF( blf_i(jfld)%ln_tint ) ALLOCATE( bf(jfld)%fdta(ilen1(jfld),1,ilen3(jfld),2) )
579         nbmap_ptr(jfld)%ptr => idx_bdy(ibdy(jfld))%nbmap(:,igrid(jfld))
580      ENDDO
581
582      ! fill bf with blf_i and control print
583      !-------------------------------------
584      jstart = 1
585      DO ib_bdy = 1, nb_bdy
586         jend = nb_bdy_fld(ib_bdy) 
587         CALL fld_fill( bf(jstart:jend), blf_i(jstart:jend), cn_dir_array(ib_bdy), 'bdy_dta',   &
588         &              'open boundary conditions', 'nambdy_dta' )
589         jstart = jend + 1
590      ENDDO
591
592      ! Initialise local boundary data arrays
593      ! nn_xxx_dta=0 : allocate space - will be filled from initial conditions later
594      ! nn_xxx_dta=1 : point to "fnow" arrays
595      !-------------------------------------
596
597      jfld = 0
598      DO ib_bdy=1, nb_bdy
599
600         nblen => idx_bdy(ib_bdy)%nblen
601         nblenrim => idx_bdy(ib_bdy)%nblenrim
602
603         IF (nn_dyn2d(ib_bdy) .gt. 0) THEN
604            IF( nn_dyn2d_dta(ib_bdy) .eq. 0 .or. nn_dyn2d_dta(ib_bdy) .eq. 2 .or. ln_full_vel_array(ib_bdy) ) THEN
605               ilen0(1:3) = nblen(1:3)
606               ALLOCATE( dta_bdy(ib_bdy)%u2d(ilen0(2)) )
607               ALLOCATE( dta_bdy(ib_bdy)%v2d(ilen0(3)) )
608               IF (nn_dyn2d_dta(ib_bdy).eq.1.or.nn_dyn2d_dta(ib_bdy).eq.3) THEN
609                  jfld = jfld + 1
610                  dta_bdy(ib_bdy)%ssh => bf(jfld)%fnow(:,1,1)
611               ELSE
612                  ALLOCATE( dta_bdy(ib_bdy)%ssh(nblen(1)) )
613               ENDIF
614            ELSE
615               IF( nn_dyn2d(ib_bdy) .ne. jp_frs ) THEN
616                  jfld = jfld + 1
617                  dta_bdy(ib_bdy)%ssh => bf(jfld)%fnow(:,1,1)
618               ENDIF
619               jfld = jfld + 1
620               dta_bdy(ib_bdy)%u2d => bf(jfld)%fnow(:,1,1)
621               jfld = jfld + 1
622               dta_bdy(ib_bdy)%v2d => bf(jfld)%fnow(:,1,1)
623            ENDIF
624         ENDIF
625
626         IF ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 0 ) THEN
627            ilen0(1:3) = nblen(1:3)
628            ALLOCATE( dta_bdy(ib_bdy)%u3d(ilen0(2),jpk) )
629            ALLOCATE( dta_bdy(ib_bdy)%v3d(ilen0(3),jpk) )
630         ENDIF
631         IF ( ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ).or. &
632           &  ( ln_full_vel_array(ib_bdy) .and. nn_dyn2d(ib_bdy) .gt. 0 .and.   &
633           &    ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) ) THEN
634            jfld = jfld + 1
635            dta_bdy(ib_bdy)%u3d => bf(jfld)%fnow(:,1,:)
636            jfld = jfld + 1
637            dta_bdy(ib_bdy)%v3d => bf(jfld)%fnow(:,1,:)
638         ENDIF
639
640         IF (nn_tra(ib_bdy) .gt. 0) THEN
641            IF( nn_tra_dta(ib_bdy) .eq. 0 ) THEN
642               ilen0(1:3) = nblen(1:3)
643               ALLOCATE( dta_bdy(ib_bdy)%tem(ilen0(1),jpk) )
644               ALLOCATE( dta_bdy(ib_bdy)%sal(ilen0(1),jpk) )
645            ELSE
646               jfld = jfld + 1
647               dta_bdy(ib_bdy)%tem => bf(jfld)%fnow(:,1,:)
648               jfld = jfld + 1
649               dta_bdy(ib_bdy)%sal => bf(jfld)%fnow(:,1,:)
650            ENDIF
651         ENDIF
652
653#if defined key_lim2
654         IF (nn_ice_lim2(ib_bdy) .gt. 0) THEN
655            IF( nn_ice_lim2_dta(ib_bdy) .eq. 0 ) THEN
656               ilen0(1:3) = nblen(1:3)
657               ALLOCATE( dta_bdy(ib_bdy)%frld(ilen0(1)) )
658               ALLOCATE( dta_bdy(ib_bdy)%hicif(ilen0(1)) )
659               ALLOCATE( dta_bdy(ib_bdy)%hsnif(ilen0(1)) )
660            ELSE
661               jfld = jfld + 1
662               dta_bdy(ib_bdy)%frld  => bf(jfld)%fnow(:,1,1)
663               jfld = jfld + 1
664               dta_bdy(ib_bdy)%hicif => bf(jfld)%fnow(:,1,1)
665               jfld = jfld + 1
666               dta_bdy(ib_bdy)%hsnif => bf(jfld)%fnow(:,1,1)
667            ENDIF
668         ENDIF
669#endif
670
671      ENDDO ! ib_bdy
672
673      IF( nn_timing == 1 ) CALL timing_stop('bdy_dta_init')
674
675      END SUBROUTINE bdy_dta_init
676
677#else
678   !!----------------------------------------------------------------------
679   !!   Dummy module                   NO Open Boundary Conditions
680   !!----------------------------------------------------------------------
681CONTAINS
682   SUBROUTINE bdy_dta( kt, jit, time_offset ) ! Empty routine
683      INTEGER, INTENT( in )           ::   kt   
684      INTEGER, INTENT( in ), OPTIONAL ::   jit   
685      INTEGER, INTENT( in ), OPTIONAL ::   time_offset
686      WRITE(*,*) 'bdy_dta: You should not have seen this print! error?', kt
687   END SUBROUTINE bdy_dta
688   SUBROUTINE bdy_dta_init()                  ! Empty routine
689      WRITE(*,*) 'bdy_dta_init: You should not have seen this print! error?'
690   END SUBROUTINE bdy_dta_init
691#endif
692
693   !!==============================================================================
694END MODULE bdydta
Note: See TracBrowser for help on using the repository browser.