source: branches/2013/dev_r3858_NOC_ZTC/NEMOGCM/NEMO/OPA_SRC/BDY/bdydta.F90 @ 4105

Last change on this file since 4105 was 4105, checked in by acc, 8 years ago

Branch 2013/dev_r3858_NOC_ZTC, #863. Port across time-stepping changes from dev_r3867_MERCATOR1_DYN branch. Part 1: modules totally independent of ztilde changes (chiefly BDY stuff).

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