source: trunk/NEMOGCM/NEMO/OPA_SRC/BDY/bdydta.F90 @ 3851

Last change on this file since 3851 was 3851, checked in by smasson, 8 years ago

trunk: bugfix in fldread when nn_fsbc * rn_rdt > frcing file period, see #958

  • Property svn:keywords set to Id
File size: 32.5 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.  &
203                       & (ln_full_vel_array(ib_bdy) .AND. nn_dyn3d_dta(ib_bdy).eq.1) )THEN
204
205                        ! For the runoff case, no need to update the forcing (already done in the baroclinic part)
206                        jend = nb_bdy_fld(ib_bdy)
207                        IF ( nn_tra(ib_bdy) .GT. 0 .AND. nn_tra_dta(ib_bdy) .GE. 1 ) jend = jend - 2
208                        CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), map=nbmap_ptr(jstart:jend),  &
209                                     & kit=jit, kt_offset=time_offset )
210                        IF ( nn_tra(ib_bdy) .GT. 0 .AND. nn_tra_dta(ib_bdy) .GE. 1 ) jend = jend + 2
211
212                        ! If full velocities in boundary data then split into barotropic and baroclinic data
213                        IF( ln_full_vel_array(ib_bdy) .AND.                                             &
214                          &    ( nn_dyn2d_dta(ib_bdy) .EQ. 1 .OR. nn_dyn2d_dta(ib_bdy) .EQ. 3 .OR.  &
215                          &      nn_dyn3d_dta(ib_bdy) .EQ. 1 ) )THEN
216
217                           igrd = 2                      ! zonal velocity
218                           dta_bdy(ib_bdy)%u2d(:) = 0.0
219                           DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
220                              ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
221                              ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
222                              DO ik = 1, jpkm1
223                                 dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) &
224                       &                          + fse3u(ii,ij,ik) * umask(ii,ij,ik) * dta_bdy(ib_bdy)%u3d(ib,ik)
225                              END DO
226                              dta_bdy(ib_bdy)%u2d(ib) =  dta_bdy(ib_bdy)%u2d(ib) * hur(ii,ij)
227                              DO ik = 1, jpkm1
228                                 dta_bdy(ib_bdy)%u3d(ib,ik) = dta_bdy(ib_bdy)%u3d(ib,ik) - dta_bdy(ib_bdy)%u2d(ib)
229                              END DO
230                           END DO
231                           igrd = 3                      ! meridional velocity
232                           dta_bdy(ib_bdy)%v2d(:) = 0.0
233                           DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
234                              ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
235                              ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
236                              DO ik = 1, jpkm1
237                                 dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) &
238                       &                       + fse3v(ii,ij,ik) * vmask(ii,ij,ik) * dta_bdy(ib_bdy)%v3d(ib,ik)
239                              END DO
240                              dta_bdy(ib_bdy)%v2d(ib) =  dta_bdy(ib_bdy)%v2d(ib) * hvr(ii,ij)
241                              DO ik = 1, jpkm1
242                                 dta_bdy(ib_bdy)%v3d(ib,ik) = dta_bdy(ib_bdy)%v3d(ib,ik) - dta_bdy(ib_bdy)%v2d(ib)
243                              END DO
244                           END DO
245                        ENDIF                   
246                     ENDIF
247                     IF( nn_dyn2d_dta(ib_bdy) .ge. 2 ) THEN ! update tidal harmonic forcing
248                        CALL bdytide_update( kt=kt, idx=idx_bdy(ib_bdy), dta=dta_bdy(ib_bdy), td=tides(ib_bdy),   & 
249                          &                 jit=jit, time_offset=time_offset )
250                     ENDIF
251                  ENDIF
252               ENDIF
253            ELSE
254               IF (nn_tra(ib_bdy).eq.4) then      ! runoff condition
255                  jend = nb_bdy_fld(ib_bdy)
256                  CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend),  &
257                               & map=nbmap_ptr(jstart:jend), kt_offset=time_offset )
258                  !
259                  igrd = 2                      ! zonal 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)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) / ( e2u(ii,ij) * hu_0(ii,ij) )
264                  END DO
265                  !
266                  igrd = 3                      ! meridional velocity
267                  DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
268                     ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
269                     ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
270                     dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) / ( e1v(ii,ij) * hv_0(ii,ij) )
271                  END DO
272               ELSE
273                  IF( nn_dyn2d(ib_bdy) .gt. 0 .and. nn_dyn2d_dta(ib_bdy) .eq. 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
274                     dta_bdy(ib_bdy)%ssh(:) = 0.0
275                     dta_bdy(ib_bdy)%u2d(:) = 0.0
276                     dta_bdy(ib_bdy)%v2d(:) = 0.0
277                  ENDIF
278                  IF( nb_bdy_fld(ib_bdy) .gt. 0 ) THEN ! update external data
279                     jend = nb_bdy_fld(ib_bdy)
280                     CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), &
281                                  & map=nbmap_ptr(jstart:jend), kt_offset=time_offset )
282                  ENDIF
283                  ! If full velocities in boundary data then split into barotropic and baroclinic data
284                  IF( ln_full_vel_array(ib_bdy) .and.                                             &
285                    & ( nn_dyn2d_dta(ib_bdy) .EQ. 1 .OR. nn_dyn2d_dta(ib_bdy) .EQ. 3 .OR. &
286                    &   nn_dyn3d_dta(ib_bdy) .EQ. 1 ) ) THEN
287                     igrd = 2                      ! zonal velocity
288                     dta_bdy(ib_bdy)%u2d(:) = 0.0
289                     DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
290                        ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
291                        ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
292                        DO ik = 1, jpkm1
293                           dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) &
294                 &                       + fse3u(ii,ij,ik) * umask(ii,ij,ik) * dta_bdy(ib_bdy)%u3d(ib,ik)
295                        END DO
296                        dta_bdy(ib_bdy)%u2d(ib) =  dta_bdy(ib_bdy)%u2d(ib) * hur(ii,ij)
297                        DO ik = 1, jpkm1
298                           dta_bdy(ib_bdy)%u3d(ib,ik) = dta_bdy(ib_bdy)%u3d(ib,ik) - dta_bdy(ib_bdy)%u2d(ib)
299                        END DO
300                     END DO
301                     igrd = 3                      ! meridional velocity
302                     dta_bdy(ib_bdy)%v2d(:) = 0.0
303                     DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd)
304                        ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
305                        ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
306                        DO ik = 1, jpkm1
307                           dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) &
308                 &                       + fse3v(ii,ij,ik) * vmask(ii,ij,ik) * dta_bdy(ib_bdy)%v3d(ib,ik)
309                        END DO
310                        dta_bdy(ib_bdy)%v2d(ib) =  dta_bdy(ib_bdy)%v2d(ib) * hvr(ii,ij)
311                        DO ik = 1, jpkm1
312                           dta_bdy(ib_bdy)%v3d(ib,ik) = dta_bdy(ib_bdy)%v3d(ib,ik) - dta_bdy(ib_bdy)%v2d(ib)
313                        END DO
314                     END DO
315                  ENDIF
316                  IF( nn_dyn2d(ib_bdy) .gt. 0 .and. nn_dyn2d_dta(ib_bdy) .ge. 2 ) THEN ! update tidal harmonic forcing
317                     CALL bdytide_update( kt=kt, idx=idx_bdy(ib_bdy), dta=dta_bdy(ib_bdy),  &
318                                        & td=tides(ib_bdy), time_offset=time_offset )
319                  ENDIF
320               ENDIF
321            ENDIF
322            jstart = jend+1
323         END IF ! nn_dta(ib_bdy) = 1
324      END DO  ! ib_bdy
325
326      IF ( ln_apr_obc ) THEN
327         DO ib_bdy = 1, nb_bdy
328            IF (nn_tra(ib_bdy).NE.4)THEN
329               igrd = 1                      ! meridional velocity
330               DO ib = 1, idx_bdy(ib_bdy)%nblenrim(igrd)
331                  ii   = idx_bdy(ib_bdy)%nbi(ib,igrd)
332                  ij   = idx_bdy(ib_bdy)%nbj(ib,igrd)
333                  dta_bdy(ib_bdy)%ssh(ib) = dta_bdy(ib_bdy)%ssh(ib) + ssh_ib(ii,ij)
334               ENDDO
335            ENDIF
336         ENDDO
337      ENDIF
338
339      IF( nn_timing == 1 ) CALL timing_stop('bdy_dta')
340
341      END SUBROUTINE bdy_dta
342
343
344      SUBROUTINE bdy_dta_init
345      !!----------------------------------------------------------------------
346      !!                   ***  SUBROUTINE bdy_dta_init  ***
347      !!                   
348      !! ** Purpose :   Initialise arrays for reading of external data
349      !!                for open boundary conditions
350      !!
351      !! ** Method  :   Use fldread.F90
352      !!               
353      !!----------------------------------------------------------------------
354      USE dynspg_oce, ONLY: lk_dynspg_ts
355      !!
356      INTEGER     ::  ib_bdy, jfld, jstart, jend, ierror  ! local indices
357      !!
358      CHARACTER(len=100)                     ::   cn_dir        ! Root directory for location of data files
359      CHARACTER(len=100), DIMENSION(nb_bdy)  ::   cn_dir_array  ! Root directory for location of data files
360      LOGICAL                                ::   ln_full_vel   ! =T => full velocities in 3D boundary data
361                                                                ! =F => baroclinic velocities in 3D boundary data
362      INTEGER                                ::   ilen_global   ! Max length required for global bdy dta arrays
363      INTEGER,              DIMENSION(jpbgrd) ::  ilen0         ! size of local arrays
364      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ilen1, ilen3  ! size of 1st and 3rd dimensions of local arrays
365      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ibdy           ! bdy set for a particular jfld
366      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   igrid         ! index for grid type (1,2,3 = T,U,V)
367      INTEGER, POINTER, DIMENSION(:)         ::   nblen, nblenrim  ! short cuts
368      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::   blf_i         !  array of namelist information structures
369      TYPE(FLD_N) ::   bn_tem, bn_sal, bn_u3d, bn_v3d   !
370      TYPE(FLD_N) ::   bn_ssh, bn_u2d, bn_v2d           ! informations about the fields to be read
371#if defined key_lim2
372      TYPE(FLD_N) ::   bn_frld, bn_hicif, bn_hsnif      !
373#endif
374      NAMELIST/nambdy_dta/ cn_dir, bn_tem, bn_sal, bn_u3d, bn_v3d, bn_ssh, bn_u2d, bn_v2d 
375#if defined key_lim2
376      NAMELIST/nambdy_dta/ bn_frld, bn_hicif, bn_hsnif
377#endif
378      NAMELIST/nambdy_dta/ ln_full_vel
379      !!---------------------------------------------------------------------------
380
381      IF( nn_timing == 1 ) CALL timing_start('bdy_dta_init')
382
383      IF(lwp) WRITE(numout,*)
384      IF(lwp) WRITE(numout,*) 'bdy_dta_ini : initialization of data at the open boundaries'
385      IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
386      IF(lwp) WRITE(numout,*) ''
387
388      ! Set nn_dta
389      DO ib_bdy = 1, nb_bdy
390         nn_dta(ib_bdy) = MAX(  nn_dyn2d_dta(ib_bdy)       &
391                               ,nn_dyn3d_dta(ib_bdy)       &
392                               ,nn_tra_dta(ib_bdy)         &
393#if defined key_lim2
394                               ,nn_ice_lim2_dta(ib_bdy)    &
395#endif
396                              )
397         IF(nn_dta(ib_bdy) .gt. 1) nn_dta(ib_bdy) = 1
398      END DO
399
400      ! Work out upper bound of how many fields there are to read in and allocate arrays
401      ! ---------------------------------------------------------------------------
402      ALLOCATE( nb_bdy_fld(nb_bdy) )
403      nb_bdy_fld(:) = 0
404      DO ib_bdy = 1, nb_bdy         
405         IF( nn_dyn2d(ib_bdy) .gt. 0 .and. ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) THEN
406            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 3
407         ENDIF
408         IF( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ) THEN
409            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 2
410         ENDIF
411         IF( nn_tra(ib_bdy) .gt. 0 .and. nn_tra_dta(ib_bdy) .eq. 1  ) THEN
412            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 2
413         ENDIF
414#if defined key_lim2
415         IF( nn_ice_lim2(ib_bdy) .gt. 0 .and. nn_ice_lim2_dta(ib_bdy) .eq. 1  ) THEN
416            nb_bdy_fld(ib_bdy) = nb_bdy_fld(ib_bdy) + 3
417         ENDIF
418#endif               
419         IF(lwp) WRITE(numout,*) 'Maximum number of files to open =',nb_bdy_fld(ib_bdy)
420      ENDDO           
421
422      nb_bdy_fld_sum = SUM( nb_bdy_fld )
423
424      ALLOCATE( bf(nb_bdy_fld_sum), STAT=ierror )
425      IF( ierror > 0 ) THEN   
426         CALL ctl_stop( 'bdy_dta: unable to allocate bf structure' )   ;   RETURN 
427      ENDIF
428      ALLOCATE( blf_i(nb_bdy_fld_sum), STAT=ierror )
429      IF( ierror > 0 ) THEN   
430         CALL ctl_stop( 'bdy_dta: unable to allocate blf_i structure' )   ;   RETURN 
431      ENDIF
432      ALLOCATE( nbmap_ptr(nb_bdy_fld_sum), STAT=ierror )
433      IF( ierror > 0 ) THEN   
434         CALL ctl_stop( 'bdy_dta: unable to allocate nbmap_ptr structure' )   ;   RETURN 
435      ENDIF
436      ALLOCATE( ilen1(nb_bdy_fld_sum), ilen3(nb_bdy_fld_sum) ) 
437      ALLOCATE( ibdy(nb_bdy_fld_sum) ) 
438      ALLOCATE( igrid(nb_bdy_fld_sum) ) 
439
440      ! Read namelists
441      ! --------------
442      REWIND(numnam)
443      jfld = 0 
444      DO ib_bdy = 1, nb_bdy         
445         IF( nn_dta(ib_bdy) .eq. 1 ) THEN
446            ! set file information
447            cn_dir = './'        ! directory in which the model is executed
448            ln_full_vel = .false.
449            ! ... default values (NB: frequency positive => hours, negative => months)
450            !                    !  file       ! frequency !  variable   ! time intep !  clim   ! 'yearly' or ! weights  ! rotation  !
451            !                    !  name       ! hours !   name     !  (T/F)  !  (T/F)  !  'monthly'  ! filename ! pairs     !
452            bn_ssh     = FLD_N(  'bdy_ssh'     ,  24   , 'sossheig' , .false. , .false. ,   'yearly'  , ''       , ''        )
453            bn_u2d     = FLD_N(  'bdy_vel2d_u' ,  24   , 'vobtcrtx' , .false. , .false. ,   'yearly'  , ''       , ''        )
454            bn_v2d     = FLD_N(  'bdy_vel2d_v' ,  24   , 'vobtcrty' , .false. , .false. ,   'yearly'  , ''       , ''        )
455            bn_u3d     = FLD_N(  'bdy_vel3d_u' ,  24   , 'vozocrtx' , .false. , .false. ,   'yearly'  , ''       , ''        )
456            bn_v3d     = FLD_N(  'bdy_vel3d_v' ,  24   , 'vomecrty' , .false. , .false. ,   'yearly'  , ''       , ''        )
457            bn_tem     = FLD_N(  'bdy_tem'     ,  24   , 'votemper' , .false. , .false. ,   'yearly'  , ''       , ''        )
458            bn_sal     = FLD_N(  'bdy_sal'     ,  24   , 'vosaline' , .false. , .false. ,   'yearly'  , ''       , ''        )
459#if defined key_lim2
460            bn_frld    = FLD_N(  'bdy_frld'    ,  24   , 'ildsconc' , .false. , .false. ,   'yearly'  , ''       , ''        )
461            bn_hicif   = FLD_N(  'bdy_hicif'   ,  24   , 'iicethic' , .false. , .false. ,   'yearly'  , ''       , ''        )
462            bn_hsnif   = FLD_N(  'bdy_hsnif'   ,  24   , 'isnothic' , .false. , .false. ,   'yearly'  , ''       , ''        )
463#endif
464
465            ! Important NOT to rewind here.
466            READ( numnam, nambdy_dta )
467
468            cn_dir_array(ib_bdy) = cn_dir
469            ln_full_vel_array(ib_bdy) = ln_full_vel
470
471            nblen => idx_bdy(ib_bdy)%nblen
472            nblenrim => idx_bdy(ib_bdy)%nblenrim
473
474            ! Only read in necessary fields for this set.
475            ! Important that barotropic variables come first.
476            IF( nn_dyn2d(ib_bdy) .gt. 0 .and. ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) THEN
477
478               IF( nn_tra(ib_bdy) .ne. 4 ) THEN ! runoff condition : no ssh reading
479                  jfld = jfld + 1
480                  blf_i(jfld) = bn_ssh
481                  ibdy(jfld) = ib_bdy
482                  igrid(jfld) = 1
483                  ilen1(jfld) = nblen(igrid(jfld))
484                  ilen3(jfld) = 1
485               ENDIF
486
487               IF( .not. ln_full_vel_array(ib_bdy) ) THEN
488                  jfld = jfld + 1
489                  blf_i(jfld) = bn_u2d
490                  ibdy(jfld) = ib_bdy
491                  igrid(jfld) = 2
492                  ilen1(jfld) = nblen(igrid(jfld))
493                  ilen3(jfld) = 1
494
495                  jfld = jfld + 1
496                  blf_i(jfld) = bn_v2d
497                  ibdy(jfld) = ib_bdy
498                  igrid(jfld) = 3
499                  ilen1(jfld) = nblen(igrid(jfld))
500                  ilen3(jfld) = 1
501               ENDIF
502
503            ENDIF
504
505            ! baroclinic velocities
506            IF( ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ) .or. &
507           &      ( ln_full_vel_array(ib_bdy) .and. nn_dyn2d(ib_bdy) .gt. 0 .and.  &
508           &        ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) ) THEN
509
510               jfld = jfld + 1
511               blf_i(jfld) = bn_u3d
512               ibdy(jfld) = ib_bdy
513               igrid(jfld) = 2
514               ilen1(jfld) = nblen(igrid(jfld))
515               ilen3(jfld) = jpk
516
517               jfld = jfld + 1
518               blf_i(jfld) = bn_v3d
519               ibdy(jfld) = ib_bdy
520               igrid(jfld) = 3
521               ilen1(jfld) = nblen(igrid(jfld))
522               ilen3(jfld) = jpk
523
524            ENDIF
525
526            ! temperature and salinity
527            IF( nn_tra(ib_bdy) .gt. 0 .and. nn_tra_dta(ib_bdy) .eq. 1 ) THEN
528
529               jfld = jfld + 1
530               blf_i(jfld) = bn_tem
531               ibdy(jfld) = ib_bdy
532               igrid(jfld) = 1
533               ilen1(jfld) = nblen(igrid(jfld))
534               ilen3(jfld) = jpk
535
536               jfld = jfld + 1
537               blf_i(jfld) = bn_sal
538               ibdy(jfld) = ib_bdy
539               igrid(jfld) = 1
540               ilen1(jfld) = nblen(igrid(jfld))
541               ilen3(jfld) = jpk
542
543            ENDIF
544
545#if defined key_lim2
546            ! sea ice
547            IF( nn_ice_lim2(ib_bdy) .gt. 0 .and. nn_ice_lim2_dta(ib_bdy) .eq. 1 ) THEN
548
549               jfld = jfld + 1
550               blf_i(jfld) = bn_frld
551               ibdy(jfld) = ib_bdy
552               igrid(jfld) = 1
553               ilen1(jfld) = nblen(igrid(jfld))
554               ilen3(jfld) = 1
555
556               jfld = jfld + 1
557               blf_i(jfld) = bn_hicif
558               ibdy(jfld) = ib_bdy
559               igrid(jfld) = 1
560               ilen1(jfld) = nblen(igrid(jfld))
561               ilen3(jfld) = 1
562
563               jfld = jfld + 1
564               blf_i(jfld) = bn_hsnif
565               ibdy(jfld) = ib_bdy
566               igrid(jfld) = 1
567               ilen1(jfld) = nblen(igrid(jfld))
568               ilen3(jfld) = 1
569
570            ENDIF
571#endif
572            ! Recalculate field counts
573            !-------------------------
574            nb_bdy_fld_sum = 0
575            IF( ib_bdy .eq. 1 ) THEN
576               nb_bdy_fld(ib_bdy) = jfld
577               nb_bdy_fld_sum     = jfld             
578            ELSE
579               nb_bdy_fld(ib_bdy) = jfld - nb_bdy_fld_sum
580               nb_bdy_fld_sum = nb_bdy_fld_sum + nb_bdy_fld(ib_bdy)
581            ENDIF
582
583         ENDIF ! nn_dta .eq. 1
584      ENDDO ! ib_bdy
585
586      DO jfld = 1, nb_bdy_fld_sum
587         ALLOCATE( bf(jfld)%fnow(ilen1(jfld),1,ilen3(jfld)) )
588         IF( blf_i(jfld)%ln_tint ) ALLOCATE( bf(jfld)%fdta(ilen1(jfld),1,ilen3(jfld),2) )
589         nbmap_ptr(jfld)%ptr => idx_bdy(ibdy(jfld))%nbmap(:,igrid(jfld))
590      ENDDO
591
592      ! fill bf with blf_i and control print
593      !-------------------------------------
594      jstart = 1
595      DO ib_bdy = 1, nb_bdy
596         jend = nb_bdy_fld(ib_bdy) 
597         CALL fld_fill( bf(jstart:jend), blf_i(jstart:jend), cn_dir_array(ib_bdy), 'bdy_dta',   &
598         &              'open boundary conditions', 'nambdy_dta' )
599         jstart = jend + 1
600      ENDDO
601
602      ! Initialise local boundary data arrays
603      ! nn_xxx_dta=0 : allocate space - will be filled from initial conditions later
604      ! nn_xxx_dta=1 : point to "fnow" arrays
605      !-------------------------------------
606
607      jfld = 0
608      DO ib_bdy=1, nb_bdy
609
610         nblen => idx_bdy(ib_bdy)%nblen
611         nblenrim => idx_bdy(ib_bdy)%nblenrim
612
613         IF (nn_dyn2d(ib_bdy) .gt. 0) THEN
614            IF( nn_dyn2d_dta(ib_bdy) .eq. 0 .or. nn_dyn2d_dta(ib_bdy) .eq. 2 .or. ln_full_vel_array(ib_bdy) ) THEN
615               ilen0(1:3) = nblen(1:3)
616               ALLOCATE( dta_bdy(ib_bdy)%u2d(ilen0(2)) )
617               ALLOCATE( dta_bdy(ib_bdy)%v2d(ilen0(3)) )
618               IF (nn_dyn2d_dta(ib_bdy).eq.1.or.nn_dyn2d_dta(ib_bdy).eq.3) THEN
619                  jfld = jfld + 1
620                  dta_bdy(ib_bdy)%ssh => bf(jfld)%fnow(:,1,1)
621               ELSE
622                  ALLOCATE( dta_bdy(ib_bdy)%ssh(nblen(1)) )
623               ENDIF
624            ELSE
625               IF( nn_dyn2d(ib_bdy) .ne. jp_frs ) THEN
626                  jfld = jfld + 1
627                  dta_bdy(ib_bdy)%ssh => bf(jfld)%fnow(:,1,1)
628               ENDIF
629               jfld = jfld + 1
630               dta_bdy(ib_bdy)%u2d => bf(jfld)%fnow(:,1,1)
631               jfld = jfld + 1
632               dta_bdy(ib_bdy)%v2d => bf(jfld)%fnow(:,1,1)
633            ENDIF
634         ENDIF
635
636         IF ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 0 ) THEN
637            ilen0(1:3) = nblen(1:3)
638            ALLOCATE( dta_bdy(ib_bdy)%u3d(ilen0(2),jpk) )
639            ALLOCATE( dta_bdy(ib_bdy)%v3d(ilen0(3),jpk) )
640         ENDIF
641         IF ( ( nn_dyn3d(ib_bdy) .gt. 0 .and. nn_dyn3d_dta(ib_bdy) .eq. 1 ).or. &
642           &  ( ln_full_vel_array(ib_bdy) .and. nn_dyn2d(ib_bdy) .gt. 0 .and.   &
643           &    ( nn_dyn2d_dta(ib_bdy) .eq. 1 .or. nn_dyn2d_dta(ib_bdy) .eq. 3 ) ) ) THEN
644            jfld = jfld + 1
645            dta_bdy(ib_bdy)%u3d => bf(jfld)%fnow(:,1,:)
646            jfld = jfld + 1
647            dta_bdy(ib_bdy)%v3d => bf(jfld)%fnow(:,1,:)
648         ENDIF
649
650         IF (nn_tra(ib_bdy) .gt. 0) THEN
651            IF( nn_tra_dta(ib_bdy) .eq. 0 ) THEN
652               ilen0(1:3) = nblen(1:3)
653               ALLOCATE( dta_bdy(ib_bdy)%tem(ilen0(1),jpk) )
654               ALLOCATE( dta_bdy(ib_bdy)%sal(ilen0(1),jpk) )
655            ELSE
656               jfld = jfld + 1
657               dta_bdy(ib_bdy)%tem => bf(jfld)%fnow(:,1,:)
658               jfld = jfld + 1
659               dta_bdy(ib_bdy)%sal => bf(jfld)%fnow(:,1,:)
660            ENDIF
661         ENDIF
662
663#if defined key_lim2
664         IF (nn_ice_lim2(ib_bdy) .gt. 0) THEN
665            IF( nn_ice_lim2_dta(ib_bdy) .eq. 0 ) THEN
666               ilen0(1:3) = nblen(1:3)
667               ALLOCATE( dta_bdy(ib_bdy)%frld(ilen0(1)) )
668               ALLOCATE( dta_bdy(ib_bdy)%hicif(ilen0(1)) )
669               ALLOCATE( dta_bdy(ib_bdy)%hsnif(ilen0(1)) )
670            ELSE
671               jfld = jfld + 1
672               dta_bdy(ib_bdy)%frld  => bf(jfld)%fnow(:,1,1)
673               jfld = jfld + 1
674               dta_bdy(ib_bdy)%hicif => bf(jfld)%fnow(:,1,1)
675               jfld = jfld + 1
676               dta_bdy(ib_bdy)%hsnif => bf(jfld)%fnow(:,1,1)
677            ENDIF
678         ENDIF
679#endif
680
681      ENDDO ! ib_bdy
682
683      IF( nn_timing == 1 ) CALL timing_stop('bdy_dta_init')
684
685      END SUBROUTINE bdy_dta_init
686
687#else
688   !!----------------------------------------------------------------------
689   !!   Dummy module                   NO Open Boundary Conditions
690   !!----------------------------------------------------------------------
691CONTAINS
692   SUBROUTINE bdy_dta( kt, jit, time_offset ) ! Empty routine
693      INTEGER, INTENT( in )           ::   kt   
694      INTEGER, INTENT( in ), OPTIONAL ::   jit   
695      INTEGER, INTENT( in ), OPTIONAL ::   time_offset
696      WRITE(*,*) 'bdy_dta: You should not have seen this print! error?', kt
697   END SUBROUTINE bdy_dta
698   SUBROUTINE bdy_dta_init()                  ! Empty routine
699      WRITE(*,*) 'bdy_dta_init: You should not have seen this print! error?'
700   END SUBROUTINE bdy_dta_init
701#endif
702
703   !!==============================================================================
704END MODULE bdydta
Note: See TracBrowser for help on using the repository browser.