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.
bdydta.F90 in branches/2013/dev_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/2013/dev_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/BDY/bdydta.F90 @ 6763

Last change on this file since 6763 was 4223, checked in by cbricaud, 11 years ago

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