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 NEMO/trunk/src/OCE/BDY – NEMO

source: NEMO/trunk/src/OCE/BDY/bdydta.F90 @ 10529

Last change on this file since 10529 was 10529, checked in by smasson, 5 years ago

trunk: bugfix in BDY routines for non-MPP compilation, see #2211
  • Property svn:keywords set to Id
File size: 37.9 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   !!            3.6  !  2012-01  (C. Rousset) add ice boundary conditions for sea ice
14   !!            4.0  !  2018     (C. Rousset) SI3 compatibility
15   !!----------------------------------------------------------------------
16
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 oce            ! ocean dynamics and tracers
22   USE dom_oce        ! ocean space and time domain
23   USE phycst         ! physical constants
24   USE sbcapr         ! atmospheric pressure forcing
25   USE sbctide        ! Tidal forcing or not
26   USE bdy_oce        ! ocean open boundary conditions 
27   USE bdytides       ! tidal forcing at boundaries
28#if defined key_si3
29   USE ice            ! sea-ice variables
30   USE icevar         ! redistribute ice input into categories
31#endif
32   !
33   USE lib_mpp, ONLY: ctl_stop, ctl_nam
34   USE fldread        ! read input fields
35   USE iom            ! IOM library
36   USE in_out_manager ! I/O logical units
37   USE timing         ! Timing
38
39   IMPLICIT NONE
40   PRIVATE
41
42   PUBLIC   bdy_dta          ! routine called by step.F90 and dynspg_ts.F90
43   PUBLIC   bdy_dta_init     ! routine called by nemogcm.F90
44
45   INTEGER, ALLOCATABLE, DIMENSION(:)   ::   nb_bdy_fld        ! Number of fields to update for each boundary set.
46   INTEGER                              ::   nb_bdy_fld_sum    ! Total number of fields to update for all boundary sets.
47   LOGICAL,           DIMENSION(jp_bdy) ::   ln_full_vel_array ! =T => full velocities in 3D boundary conditions
48                                                               ! =F => baroclinic velocities in 3D boundary conditions
49!$AGRIF_DO_NOT_TREAT
50   TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:), TARGET ::   bf        ! structure of input fields (file informations, fields read)
51!$AGRIF_END_DO_NOT_TREAT
52   TYPE(MAP_POINTER), ALLOCATABLE, DIMENSION(:) :: nbmap_ptr   ! array of pointers to nbmap
53
54#if defined key_si3
55   INTEGER ::   nice_cat                      ! number of categories in the input file
56   INTEGER ::   jfld_hti, jfld_hts, jfld_ai   ! indices of ice thickness, snow thickness and concentration in bf structure
57   INTEGER, DIMENSION(jp_bdy) :: jfld_htit, jfld_htst, jfld_ait
58#endif
59
60   !!----------------------------------------------------------------------
61   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
62   !! $Id$
63   !! Software governed by the CeCILL license (see ./LICENSE)
64   !!----------------------------------------------------------------------
65CONTAINS
66
67      SUBROUTINE bdy_dta( kt, jit, time_offset )
68      !!----------------------------------------------------------------------
69      !!                   ***  SUBROUTINE bdy_dta  ***
70      !!                   
71      !! ** Purpose :   Update external data for open boundary conditions
72      !!
73      !! ** Method  :   Use fldread.F90
74      !!               
75      !!----------------------------------------------------------------------
76      INTEGER, INTENT(in)           ::   kt           ! ocean time-step index
77      INTEGER, INTENT(in), OPTIONAL ::   jit          ! subcycle time-step index (for timesplitting option)
78      INTEGER, INTENT(in), OPTIONAL ::   time_offset  ! time offset in units of timesteps. NB. if jit
79      !                                               ! is present then units = subcycle timesteps.
80      !                                               ! time_offset = 0 => get data at "now" time level
81      !                                               ! time_offset = -1 => get data at "before" time level
82      !                                               ! time_offset = +1 => get data at "after" time level
83      !                                               ! etc.
84      !
85      INTEGER ::  jbdy, jfld, jstart, jend, ib, jl  ! dummy loop indices
86      INTEGER ::  ii, ij, ik, igrd                  ! local integers
87      INTEGER,          DIMENSION(jpbgrd) ::   ilen1 
88      INTEGER, POINTER, DIMENSION(:)      ::   nblen, nblenrim  ! short cuts
89      TYPE(OBC_DATA), POINTER             ::   dta              ! short cut
90      !!---------------------------------------------------------------------------
91      !
92      IF( ln_timing )   CALL timing_start('bdy_dta')
93      !
94      ! Initialise data arrays once for all from initial conditions where required
95      !---------------------------------------------------------------------------
96      IF( kt == nit000 .AND. .NOT.PRESENT(jit) ) THEN
97
98         ! Calculate depth-mean currents
99         !-----------------------------
100         
101         DO jbdy = 1, nb_bdy
102            !
103            nblen    => idx_bdy(jbdy)%nblen
104            nblenrim => idx_bdy(jbdy)%nblenrim
105            dta      => dta_bdy(jbdy)
106            !
107            IF( nn_dyn2d_dta(jbdy) == 0 ) THEN
108               ilen1(:) = nblen(:)
109               IF( dta%ll_ssh ) THEN
110                  igrd = 1
111                  DO ib = 1, ilen1(igrd)
112                     ii = idx_bdy(jbdy)%nbi(ib,igrd)
113                     ij = idx_bdy(jbdy)%nbj(ib,igrd)
114                     dta_bdy(jbdy)%ssh(ib) = sshn(ii,ij) * tmask(ii,ij,1)         
115                  END DO
116               ENDIF
117               IF( dta%ll_u2d ) THEN
118                  igrd = 2
119                  DO ib = 1, ilen1(igrd)
120                     ii = idx_bdy(jbdy)%nbi(ib,igrd)
121                     ij = idx_bdy(jbdy)%nbj(ib,igrd)
122                     dta_bdy(jbdy)%u2d(ib) = un_b(ii,ij) * umask(ii,ij,1)         
123                  END DO
124               ENDIF
125               IF( dta%ll_v2d ) THEN
126                  igrd = 3
127                  DO ib = 1, ilen1(igrd)
128                     ii = idx_bdy(jbdy)%nbi(ib,igrd)
129                     ij = idx_bdy(jbdy)%nbj(ib,igrd)
130                     dta_bdy(jbdy)%v2d(ib) = vn_b(ii,ij) * vmask(ii,ij,1)         
131                  END DO
132               ENDIF
133            ENDIF
134            !
135            IF( nn_dyn3d_dta(jbdy) == 0 ) THEN
136               ilen1(:) = nblen(:)
137               IF( dta%ll_u3d ) THEN
138                  igrd = 2 
139                  DO ib = 1, ilen1(igrd)
140                     DO ik = 1, jpkm1
141                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
142                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
143                        dta_bdy(jbdy)%u3d(ib,ik) =  ( un(ii,ij,ik) - un_b(ii,ij) ) * umask(ii,ij,ik)         
144                     END DO
145                  END DO
146               ENDIF
147               IF( dta%ll_v3d ) THEN
148                  igrd = 3 
149                  DO ib = 1, ilen1(igrd)
150                     DO ik = 1, jpkm1
151                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
152                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
153                        dta_bdy(jbdy)%v3d(ib,ik) =  ( vn(ii,ij,ik) - vn_b(ii,ij) ) * vmask(ii,ij,ik)         
154                        END DO
155                  END DO
156               ENDIF
157            ENDIF
158
159            IF( nn_tra_dta(jbdy) == 0 ) THEN
160               ilen1(:) = nblen(:)
161               IF( dta%ll_tem ) THEN
162                  igrd = 1 
163                  DO ib = 1, ilen1(igrd)
164                     DO ik = 1, jpkm1
165                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
166                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
167                        dta_bdy(jbdy)%tem(ib,ik) = tsn(ii,ij,ik,jp_tem) * tmask(ii,ij,ik)         
168                     END DO
169                  END DO
170               ENDIF
171               IF( dta%ll_sal ) THEN
172                  igrd = 1 
173                  DO ib = 1, ilen1(igrd)
174                     DO ik = 1, jpkm1
175                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
176                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
177                        dta_bdy(jbdy)%sal(ib,ik) = tsn(ii,ij,ik,jp_sal) * tmask(ii,ij,ik)         
178                     END DO
179                  END DO
180               ENDIF
181            ENDIF
182
183#if defined key_si3
184            IF( nn_ice_dta(jbdy) == 0 ) THEN    ! set ice to initial values
185               ilen1(:) = nblen(:)
186               IF( dta%ll_a_i ) THEN
187                  igrd = 1   
188                  DO jl = 1, jpl
189                     DO ib = 1, ilen1(igrd)
190                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
191                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
192                        dta_bdy(jbdy)%a_i (ib,jl) =  a_i(ii,ij,jl) * tmask(ii,ij,1) 
193                     END DO
194                  END DO
195               ENDIF
196               IF( dta%ll_h_i ) THEN
197                  igrd = 1   
198                  DO jl = 1, jpl
199                     DO ib = 1, ilen1(igrd)
200                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
201                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
202                        dta_bdy(jbdy)%h_i (ib,jl) =  h_i(ii,ij,jl) * tmask(ii,ij,1) 
203                     END DO
204                  END DO
205               ENDIF
206               IF( dta%ll_h_s ) THEN
207                  igrd = 1   
208                  DO jl = 1, jpl
209                     DO ib = 1, ilen1(igrd)
210                        ii = idx_bdy(jbdy)%nbi(ib,igrd)
211                        ij = idx_bdy(jbdy)%nbj(ib,igrd)
212                        dta_bdy(jbdy)%h_s (ib,jl) =  h_s(ii,ij,jl) * tmask(ii,ij,1) 
213                     END DO
214                  END DO
215               ENDIF
216            ENDIF
217#endif
218         END DO ! jbdy
219         !
220      ENDIF ! kt == nit000
221
222      ! update external data from files
223      !--------------------------------
224     
225      jstart = 1
226      DO jbdy = 1, nb_bdy   
227         dta => dta_bdy(jbdy)
228         IF( nn_dta(jbdy) == 1 ) THEN ! skip this bit if no external data required
229     
230            IF( PRESENT(jit) ) THEN
231               ! Update barotropic boundary conditions only
232               ! jit is optional argument for fld_read and bdytide_update
233               IF( cn_dyn2d(jbdy) /= 'none' ) THEN
234                  IF( nn_dyn2d_dta(jbdy) == 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
235                     IF( dta%ll_ssh ) dta%ssh(:) = 0._wp
236                     IF( dta%ll_u2d ) dta%u2d(:) = 0._wp
237                     IF( dta%ll_u3d ) dta%v2d(:) = 0._wp
238                  ENDIF
239                  IF (cn_tra(jbdy) /= 'runoff') THEN
240                     IF( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 ) THEN
241
242                        jend = jstart + dta%nread(2) - 1
243                        IF( ln_full_vel_array(jbdy) ) THEN
244                           CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), map=nbmap_ptr(jstart:jend),  &
245                                     & kit=jit, kt_offset=time_offset , jpk_bdy=nb_jpk_bdy,   &
246                                     & fvl=ln_full_vel_array(jbdy)  )
247                        ELSE
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                        ENDIF
251
252                        ! If full velocities in boundary data then extract barotropic velocities from 3D fields
253                        IF( ln_full_vel_array(jbdy) .AND.                                             &
254                          &    ( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 .OR.  &
255                          &      nn_dyn3d_dta(jbdy) == 1 ) )THEN
256
257                           igrd = 2                      ! zonal velocity
258                           dta%u2d(:) = 0._wp
259                           DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
260                              ii   = idx_bdy(jbdy)%nbi(ib,igrd)
261                              ij   = idx_bdy(jbdy)%nbj(ib,igrd)
262                              DO ik = 1, jpkm1
263                                 dta%u2d(ib) = dta%u2d(ib) &
264                       &                          + e3u_n(ii,ij,ik) * umask(ii,ij,ik) * dta%u3d(ib,ik)
265                              END DO
266                              dta%u2d(ib) =  dta%u2d(ib) * r1_hu_n(ii,ij)
267                           END DO
268                           igrd = 3                      ! meridional velocity
269                           dta%v2d(:) = 0._wp
270                           DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
271                              ii   = idx_bdy(jbdy)%nbi(ib,igrd)
272                              ij   = idx_bdy(jbdy)%nbj(ib,igrd)
273                              DO ik = 1, jpkm1
274                                 dta%v2d(ib) = dta%v2d(ib) &
275                       &                       + e3v_n(ii,ij,ik) * vmask(ii,ij,ik) * dta%v3d(ib,ik)
276                              END DO
277                              dta%v2d(ib) =  dta%v2d(ib) * r1_hv_n(ii,ij)
278                           END DO
279                        ENDIF                   
280                     ENDIF
281                     IF( nn_dyn2d_dta(jbdy) .ge. 2 ) THEN ! update tidal harmonic forcing
282                        CALL bdytide_update( kt=kt, idx=idx_bdy(jbdy), dta=dta, td=tides(jbdy),   & 
283                          &                 jit=jit, time_offset=time_offset )
284                     ENDIF
285                  ENDIF
286               ENDIF
287            ELSE
288               IF (cn_tra(jbdy) == 'runoff') then      ! runoff condition
289                  jend = nb_bdy_fld(jbdy)
290                  CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend),  &
291                               & map=nbmap_ptr(jstart:jend), kt_offset=time_offset )
292                  !
293                  igrd = 2                      ! zonal velocity
294                  DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
295                     ii   = idx_bdy(jbdy)%nbi(ib,igrd)
296                     ij   = idx_bdy(jbdy)%nbj(ib,igrd)
297                     dta%u2d(ib) = dta%u2d(ib) / ( e2u(ii,ij) * hu_0(ii,ij) )
298                  END DO
299                  !
300                  igrd = 3                      ! meridional velocity
301                  DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
302                     ii   = idx_bdy(jbdy)%nbi(ib,igrd)
303                     ij   = idx_bdy(jbdy)%nbj(ib,igrd)
304                     dta%v2d(ib) = dta%v2d(ib) / ( e1v(ii,ij) * hv_0(ii,ij) )
305                  END DO
306               ELSE
307                  IF( nn_dyn2d_dta(jbdy) == 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
308                     IF( dta%ll_ssh ) dta%ssh(:) = 0._wp
309                     IF( dta%ll_u2d ) dta%u2d(:) = 0._wp
310                     IF( dta%ll_v2d ) dta%v2d(:) = 0._wp
311                  ENDIF
312                  IF( dta%nread(1) .gt. 0 ) THEN ! update external data
313                     jend = jstart + dta%nread(1) - 1
314                     CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), &
315                                  & map=nbmap_ptr(jstart:jend), kt_offset=time_offset, jpk_bdy=nb_jpk_bdy,   &
316                                  & fvl=ln_full_vel_array(jbdy) )
317                  ENDIF
318                  ! If full velocities in boundary data then split into barotropic and baroclinic data
319                  IF( ln_full_vel_array(jbdy) .and.                                             &
320                    & ( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 .OR. &
321                    &   nn_dyn3d_dta(jbdy) == 1 ) ) THEN
322                     igrd = 2                      ! zonal velocity
323                     dta%u2d(:) = 0._wp
324                     DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
325                        ii   = idx_bdy(jbdy)%nbi(ib,igrd)
326                        ij   = idx_bdy(jbdy)%nbj(ib,igrd)
327                        DO ik = 1, jpkm1
328                           dta%u2d(ib) = dta%u2d(ib) &
329                 &                       + e3u_n(ii,ij,ik) * umask(ii,ij,ik) * dta%u3d(ib,ik)
330                        END DO
331                        dta%u2d(ib) =  dta%u2d(ib) * r1_hu_n(ii,ij)
332                        DO ik = 1, jpkm1
333                           dta%u3d(ib,ik) = dta%u3d(ib,ik) - dta%u2d(ib)
334                        END DO
335                     END DO
336                     igrd = 3                      ! meridional velocity
337                     dta%v2d(:) = 0._wp
338                     DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
339                        ii   = idx_bdy(jbdy)%nbi(ib,igrd)
340                        ij   = idx_bdy(jbdy)%nbj(ib,igrd)
341                        DO ik = 1, jpkm1
342                           dta%v2d(ib) = dta%v2d(ib) &
343                 &                       + e3v_n(ii,ij,ik) * vmask(ii,ij,ik) * dta%v3d(ib,ik)
344                        END DO
345                        dta%v2d(ib) =  dta%v2d(ib) * r1_hv_n(ii,ij)
346                        DO ik = 1, jpkm1
347                           dta%v3d(ib,ik) = dta%v3d(ib,ik) - dta%v2d(ib)
348                        END DO
349                     END DO
350                  ENDIF
351
352               ENDIF
353#if defined key_si3
354               ! convert N-cat fields (input) into jpl-cat (output)
355               IF( cn_ice(jbdy) /= 'none' .AND. nn_ice_dta(jbdy) == 1 ) THEN
356                  jfld_hti = jfld_htit(jbdy)
357                  jfld_hts = jfld_htst(jbdy)
358                  jfld_ai  = jfld_ait(jbdy)
359                  IF    ( jpl /= 1 .AND. nice_cat == 1 ) THEN                       ! case input cat = 1
360                     CALL ice_var_itd ( bf(jfld_hti)%fnow(:,1,1), bf(jfld_hts)%fnow(:,1,1), bf(jfld_ai)%fnow(:,1,1), &
361                        &               dta_bdy(jbdy)%h_i     , dta_bdy(jbdy)%h_s     , dta_bdy(jbdy)%a_i    )
362                  ELSEIF( jpl /= 1 .AND. nice_cat /= 1 .AND. nice_cat /= jpl ) THEN ! case input cat /=1 and /=jpl
363                     CALL ice_var_itd2( bf(jfld_hti)%fnow(:,1,:), bf(jfld_hts)%fnow(:,1,:), bf(jfld_ai)%fnow(:,1,:), &
364                        &               dta_bdy(jbdy)%h_i     , dta_bdy(jbdy)%h_s     , dta_bdy(jbdy)%a_i    )
365                  ENDIF
366               ENDIF
367#endif
368            ENDIF
369            jstart = jstart + dta%nread(1)
370         ENDIF    ! nn_dta(jbdy) = 1
371      END DO  ! jbdy
372
373      IF ( ln_tide ) THEN
374         IF (ln_dynspg_ts) THEN      ! Fill temporary arrays with slow-varying bdy data                           
375            DO jbdy = 1, nb_bdy    ! Tidal component added in ts loop
376               IF ( nn_dyn2d_dta(jbdy) .ge. 2 ) THEN
377                  nblen => idx_bdy(jbdy)%nblen
378                  nblenrim => idx_bdy(jbdy)%nblenrim
379                  IF( cn_dyn2d(jbdy) == 'frs' ) THEN; ilen1(:)=nblen(:) ; ELSE ; ilen1(:)=nblenrim(:) ; ENDIF
380                  IF ( dta_bdy(jbdy)%ll_ssh ) dta_bdy_s(jbdy)%ssh(1:ilen1(1)) = dta_bdy(jbdy)%ssh(1:ilen1(1))
381                  IF ( dta_bdy(jbdy)%ll_u2d ) dta_bdy_s(jbdy)%u2d(1:ilen1(2)) = dta_bdy(jbdy)%u2d(1:ilen1(2))
382                  IF ( dta_bdy(jbdy)%ll_v2d ) dta_bdy_s(jbdy)%v2d(1:ilen1(3)) = dta_bdy(jbdy)%v2d(1:ilen1(3))
383               ENDIF
384            END DO
385         ELSE ! Add tides if not split-explicit free surface else this is done in ts loop
386            !
387            CALL bdy_dta_tides( kt=kt, time_offset=time_offset )
388         ENDIF
389      ENDIF
390
391      IF ( ln_apr_obc ) THEN
392         DO jbdy = 1, nb_bdy
393            IF (cn_tra(jbdy) /= 'runoff')THEN
394               igrd = 1                      ! meridional velocity
395               DO ib = 1, idx_bdy(jbdy)%nblenrim(igrd)
396                  ii   = idx_bdy(jbdy)%nbi(ib,igrd)
397                  ij   = idx_bdy(jbdy)%nbj(ib,igrd)
398                  dta_bdy(jbdy)%ssh(ib) = dta_bdy(jbdy)%ssh(ib) + ssh_ib(ii,ij)
399               END DO
400            ENDIF
401         END DO
402      ENDIF
403      !
404      IF( ln_timing )   CALL timing_stop('bdy_dta')
405      !
406   END SUBROUTINE bdy_dta
407
408
409   SUBROUTINE bdy_dta_init
410      !!----------------------------------------------------------------------
411      !!                   ***  SUBROUTINE bdy_dta_init  ***
412      !!                   
413      !! ** Purpose :   Initialise arrays for reading of external data
414      !!                for open boundary conditions
415      !!
416      !! ** Method  :   
417      !!               
418      !!----------------------------------------------------------------------
419      INTEGER ::   jbdy, jfld, jstart, jend, ierror, ios     ! Local integers
420      !
421      CHARACTER(len=100)                     ::   cn_dir        ! Root directory for location of data files
422      CHARACTER(len=100), DIMENSION(nb_bdy)  ::   cn_dir_array  ! Root directory for location of data files
423      CHARACTER(len = 256)::   clname                           ! temporary file name
424      LOGICAL                                ::   ln_full_vel   ! =T => full velocities in 3D boundary data
425      !                                                         ! =F => baroclinic velocities in 3D boundary data
426      INTEGER                                ::   ilen_global   ! Max length required for global bdy dta arrays
427      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ilen1, ilen3  ! size of 1st and 3rd dimensions of local arrays
428      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   ibdy           ! bdy set for a particular jfld
429      INTEGER, ALLOCATABLE, DIMENSION(:)     ::   igrid         ! index for grid type (1,2,3 = T,U,V)
430      INTEGER, POINTER, DIMENSION(:)         ::   nblen, nblenrim  ! short cuts
431      TYPE(OBC_DATA), POINTER                ::   dta           ! short cut
432#if defined key_si3
433      INTEGER               ::   kndims   ! number of dimensions in an array (i.e. 3 = wo ice cat; 4 = w ice cat)
434      INTEGER, DIMENSION(4) ::   kdimsz   ! size   of dimensions
435      INTEGER               ::   inum,id1 ! local integer
436#endif
437      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::   blf_i         !  array of namelist information structures
438      TYPE(FLD_N) ::   bn_tem, bn_sal, bn_u3d, bn_v3d   !
439      TYPE(FLD_N) ::   bn_ssh, bn_u2d, bn_v2d           ! informations about the fields to be read
440#if defined key_si3
441      TYPE(FLD_N) ::   bn_a_i, bn_h_i, bn_h_s     
442#endif
443      NAMELIST/nambdy_dta/ cn_dir, bn_tem, bn_sal, bn_u3d, bn_v3d, bn_ssh, bn_u2d, bn_v2d 
444#if defined key_si3
445      NAMELIST/nambdy_dta/ bn_a_i, bn_h_i, bn_h_s
446#endif
447      NAMELIST/nambdy_dta/ ln_full_vel, nb_jpk_bdy
448      !!---------------------------------------------------------------------------
449      !
450      IF(lwp) WRITE(numout,*)
451      IF(lwp) WRITE(numout,*) 'bdy_dta_ini : initialization of data at the open boundaries'
452      IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
453      IF(lwp) WRITE(numout,*) ''
454
455      ! Set nn_dta
456      DO jbdy = 1, nb_bdy
457         nn_dta(jbdy) = MAX(   nn_dyn2d_dta  (jbdy)    &
458            &                , nn_dyn3d_dta  (jbdy)    &
459            &                , nn_tra_dta    (jbdy)    &
460#if defined key_si3
461            &                , nn_ice_dta    (jbdy)    &
462#endif
463                              )
464         IF(nn_dta(jbdy) > 1)   nn_dta(jbdy) = 1
465      END DO
466
467      ! Work out upper bound of how many fields there are to read in and allocate arrays
468      ! ---------------------------------------------------------------------------
469      ALLOCATE( nb_bdy_fld(nb_bdy) )
470      nb_bdy_fld(:) = 0
471      DO jbdy = 1, nb_bdy         
472         IF( cn_dyn2d(jbdy) /= 'none' .AND. ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) ) THEN
473            nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 3
474         ENDIF
475         IF( cn_dyn3d(jbdy) /= 'none' .AND. nn_dyn3d_dta(jbdy) == 1 ) THEN
476            nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 2
477         ENDIF
478         IF( cn_tra(jbdy) /= 'none' .AND. nn_tra_dta(jbdy) == 1  ) THEN
479            nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 2
480         ENDIF
481#if defined key_si3
482         IF( cn_ice(jbdy) /= 'none' .AND. nn_ice_dta(jbdy) == 1  ) THEN
483            nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 3
484         ENDIF
485#endif               
486         IF(lwp) WRITE(numout,*) 'Maximum number of files to open =', nb_bdy_fld(jbdy)
487      END DO           
488
489      nb_bdy_fld_sum = SUM( nb_bdy_fld )
490
491      ALLOCATE( bf(nb_bdy_fld_sum), STAT=ierror )
492      IF( ierror > 0 ) THEN   
493         CALL ctl_stop( 'bdy_dta: unable to allocate bf structure' )   ;   RETURN 
494      ENDIF
495      ALLOCATE( blf_i(nb_bdy_fld_sum), STAT=ierror )
496      IF( ierror > 0 ) THEN   
497         CALL ctl_stop( 'bdy_dta: unable to allocate blf_i structure' )   ;   RETURN 
498      ENDIF
499      ALLOCATE( nbmap_ptr(nb_bdy_fld_sum), STAT=ierror )
500      IF( ierror > 0 ) THEN   
501         CALL ctl_stop( 'bdy_dta: unable to allocate nbmap_ptr structure' )   ;   RETURN 
502      ENDIF
503      ALLOCATE( ilen1(nb_bdy_fld_sum), ilen3(nb_bdy_fld_sum) ) 
504      ALLOCATE( ibdy(nb_bdy_fld_sum) ) 
505      ALLOCATE( igrid(nb_bdy_fld_sum) ) 
506
507      ! Read namelists
508      ! --------------
509      REWIND(numnam_ref)
510      REWIND(numnam_cfg)
511      jfld = 0 
512      DO jbdy = 1, nb_bdy         
513         IF( nn_dta(jbdy) == 1 ) THEN
514            READ  ( numnam_ref, nambdy_dta, IOSTAT = ios, ERR = 901)
515901         IF( ios /= 0 )   CALL ctl_nam ( ios , 'nambdy_dta in reference namelist', lwp )
516            READ  ( numnam_cfg, nambdy_dta, IOSTAT = ios, ERR = 902 )
517902         IF( ios >  0 )   CALL ctl_nam ( ios , 'nambdy_dta in configuration namelist', lwp )
518            IF(lwm) WRITE( numond, nambdy_dta )
519
520            cn_dir_array(jbdy) = cn_dir
521            ln_full_vel_array(jbdy) = ln_full_vel
522
523            nblen => idx_bdy(jbdy)%nblen
524            nblenrim => idx_bdy(jbdy)%nblenrim
525            dta => dta_bdy(jbdy)
526            dta%nread(2) = 0
527
528            ! Only read in necessary fields for this set.
529            ! Important that barotropic variables come first.
530            IF( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) THEN
531
532               IF( dta%ll_ssh ) THEN
533                  if(lwp) write(numout,*) '++++++ reading in ssh field'
534                  jfld = jfld + 1
535                  blf_i(jfld) = bn_ssh
536                  ibdy(jfld) = jbdy
537                  igrid(jfld) = 1
538                  ilen1(jfld) = nblen(igrid(jfld))
539                  ilen3(jfld) = 1
540                  dta%nread(2) = dta%nread(2) + 1
541               ENDIF
542
543               IF( dta%ll_u2d .and. .not. ln_full_vel_array(jbdy) ) THEN
544                  if(lwp) write(numout,*) '++++++ reading in u2d field'
545                  jfld = jfld + 1
546                  blf_i(jfld) = bn_u2d
547                  ibdy(jfld) = jbdy
548                  igrid(jfld) = 2
549                  ilen1(jfld) = nblen(igrid(jfld))
550                  ilen3(jfld) = 1
551                  dta%nread(2) = dta%nread(2) + 1
552               ENDIF
553
554               IF( dta%ll_v2d .and. .not. ln_full_vel_array(jbdy) ) THEN
555                  if(lwp) write(numout,*) '++++++ reading in v2d field'
556                  jfld = jfld + 1
557                  blf_i(jfld) = bn_v2d
558                  ibdy(jfld) = jbdy
559                  igrid(jfld) = 3
560                  ilen1(jfld) = nblen(igrid(jfld))
561                  ilen3(jfld) = 1
562                  dta%nread(2) = dta%nread(2) + 1
563               ENDIF
564
565            ENDIF
566
567            ! read 3D velocities if baroclinic velocities require OR if
568            ! barotropic velocities required and ln_full_vel set to .true.
569            IF( nn_dyn3d_dta(jbdy) == 1 .OR. &
570           &  ( ln_full_vel_array(jbdy) .AND. ( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 ) ) ) THEN
571
572               IF( dta%ll_u3d .OR. ( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) ) THEN
573                  if(lwp) write(numout,*) '++++++ reading in u3d field'
574                  jfld = jfld + 1
575                  blf_i(jfld) = bn_u3d
576                  ibdy(jfld) = jbdy
577                  igrid(jfld) = 2
578                  ilen1(jfld) = nblen(igrid(jfld))
579                  ilen3(jfld) = jpk
580                  IF( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) dta%nread(2) = dta%nread(2) + 1
581               ENDIF
582
583               IF( dta%ll_v3d .OR. ( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) ) THEN
584                  if(lwp) write(numout,*) '++++++ reading in v3d field'
585                  jfld = jfld + 1
586                  blf_i(jfld) = bn_v3d
587                  ibdy(jfld) = jbdy
588                  igrid(jfld) = 3
589                  ilen1(jfld) = nblen(igrid(jfld))
590                  ilen3(jfld) = jpk
591                  IF( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) dta%nread(2) = dta%nread(2) + 1
592               ENDIF
593
594            ENDIF
595
596            ! temperature and salinity
597            IF( nn_tra_dta(jbdy) == 1 ) THEN
598
599               IF( dta%ll_tem ) THEN
600                  if(lwp) write(numout,*) '++++++ reading in tem field'
601                  jfld = jfld + 1
602                  blf_i(jfld) = bn_tem
603                  ibdy(jfld) = jbdy
604                  igrid(jfld) = 1
605                  ilen1(jfld) = nblen(igrid(jfld))
606                  ilen3(jfld) = jpk
607               ENDIF
608
609               IF( dta%ll_sal ) THEN
610                  if(lwp) write(numout,*) '++++++ reading in sal field'
611                  jfld = jfld + 1
612                  blf_i(jfld) = bn_sal
613                  ibdy(jfld) = jbdy
614                  igrid(jfld) = 1
615                  ilen1(jfld) = nblen(igrid(jfld))
616                  ilen3(jfld) = jpk
617               ENDIF
618
619            ENDIF
620
621#if defined key_si3
622            ! sea ice
623            IF( nn_ice_dta(jbdy) == 1 ) THEN
624               ! Test for types of ice input (1cat or Xcat)
625               ! Build file name to find dimensions
626               clname=TRIM( cn_dir )//TRIM(bn_a_i%clname)
627               IF( .NOT. bn_a_i%ln_clim ) THEN   
628                                                  WRITE(clname, '(a,"_y",i4.4)' ) TRIM( clname ), nyear    ! add year
629                  IF( bn_a_i%cltype /= 'yearly' ) WRITE(clname, '(a,"m" ,i2.2)' ) TRIM( clname ), nmonth   ! add month
630               ELSE
631                  IF( bn_a_i%cltype /= 'yearly' ) WRITE(clname, '(a,"_m",i2.2)' ) TRIM( clname ), nmonth   ! add month
632               ENDIF
633               IF( bn_a_i%cltype == 'daily' .OR. bn_a_i%cltype(1:4) == 'week' ) &
634               &                                  WRITE(clname, '(a,"d" ,i2.2)' ) TRIM( clname ), nday     ! add day
635               !
636               CALL iom_open  ( clname, inum )
637               id1 = iom_varid( inum, bn_a_i%clvar, kdimsz=kdimsz, kndims=kndims, ldstop = .FALSE. )
638               CALL iom_close ( inum )
639
640                IF ( kndims == 4 ) THEN
641                 nice_cat = kdimsz(4)   ! Xcat input
642               ELSE
643                 nice_cat = 1           ! 1cat input     
644               ENDIF
645               ! End test
646
647               IF( dta%ll_a_i ) THEN
648                  jfld = jfld + 1
649                  blf_i(jfld) = bn_a_i
650                  ibdy(jfld)  = jbdy
651                  igrid(jfld) = 1
652                  ilen1(jfld) = nblen(igrid(jfld))
653                  ilen3(jfld) = nice_cat
654               ENDIF
655
656               IF( dta%ll_h_i ) THEN
657                  jfld = jfld + 1
658                  blf_i(jfld) = bn_h_i
659                  ibdy(jfld)  = jbdy
660                  igrid(jfld) = 1
661                  ilen1(jfld) = nblen(igrid(jfld))
662                  ilen3(jfld) = nice_cat
663               ENDIF
664
665               IF( dta%ll_h_s ) THEN
666                  jfld = jfld + 1
667                  blf_i(jfld) = bn_h_s
668                  ibdy(jfld)  = jbdy
669                  igrid(jfld) = 1
670                  ilen1(jfld) = nblen(igrid(jfld))
671                  ilen3(jfld) = nice_cat
672               ENDIF
673
674            ENDIF
675#endif
676            ! Recalculate field counts
677            !-------------------------
678            IF( jbdy == 1 ) THEN
679               nb_bdy_fld_sum = 0
680               nb_bdy_fld(jbdy) = jfld
681               nb_bdy_fld_sum     = jfld             
682            ELSE
683               nb_bdy_fld(jbdy) = jfld - nb_bdy_fld_sum
684               nb_bdy_fld_sum = nb_bdy_fld_sum + nb_bdy_fld(jbdy)
685            ENDIF
686
687            dta%nread(1) = nb_bdy_fld(jbdy)
688
689         ENDIF ! nn_dta == 1
690      ENDDO ! jbdy
691
692      DO jfld = 1, nb_bdy_fld_sum
693         ALLOCATE( bf(jfld)%fnow(ilen1(jfld),1,ilen3(jfld)) )
694         IF( blf_i(jfld)%ln_tint ) ALLOCATE( bf(jfld)%fdta(ilen1(jfld),1,ilen3(jfld),2) )
695         nbmap_ptr(jfld)%ptr => idx_bdy(ibdy(jfld))%nbmap(:,igrid(jfld))
696         nbmap_ptr(jfld)%ll_unstruc = ln_coords_file(ibdy(jfld))
697      ENDDO
698
699      ! fill bf with blf_i and control print
700      !-------------------------------------
701      jstart = 1
702      DO jbdy = 1, nb_bdy
703         jend = jstart - 1 + nb_bdy_fld(jbdy) 
704         CALL fld_fill( bf(jstart:jend), blf_i(jstart:jend), cn_dir_array(jbdy), 'bdy_dta',   &
705         &              'open boundary conditions', 'nambdy_dta' )
706         jstart = jend + 1
707      ENDDO
708
709      DO jfld = 1, nb_bdy_fld_sum
710         bf(jfld)%igrd = igrid(jfld)
711         bf(jfld)%ibdy = ibdy(jfld)
712      ENDDO
713
714      ! Initialise local boundary data arrays
715      ! nn_xxx_dta=0 : allocate space - will be filled from initial conditions later
716      ! nn_xxx_dta=1 : point to "fnow" arrays
717      !-------------------------------------
718
719      jfld = 0
720      DO jbdy=1, nb_bdy
721
722         nblen => idx_bdy(jbdy)%nblen
723         dta => dta_bdy(jbdy)
724
725         if(lwp) then
726            write(numout,*) '++++++ dta%ll_ssh = ',dta%ll_ssh
727            write(numout,*) '++++++ dta%ll_u2d = ',dta%ll_u2d
728            write(numout,*) '++++++ dta%ll_v2d = ',dta%ll_v2d
729            write(numout,*) '++++++ dta%ll_u3d = ',dta%ll_u3d
730            write(numout,*) '++++++ dta%ll_v3d = ',dta%ll_v3d
731            write(numout,*) '++++++ dta%ll_tem = ',dta%ll_tem
732            write(numout,*) '++++++ dta%ll_sal = ',dta%ll_sal
733         endif
734
735         IF ( nn_dyn2d_dta(jbdy) == 0 .or. nn_dyn2d_dta(jbdy) == 2 ) THEN
736            if(lwp) write(numout,*) '++++++ dta%ssh/u2d/u3d allocated space'
737            IF( dta%ll_ssh ) ALLOCATE( dta%ssh(nblen(1)) )
738            IF( dta%ll_u2d ) ALLOCATE( dta%u2d(nblen(2)) )
739            IF( dta%ll_v2d ) ALLOCATE( dta%v2d(nblen(3)) )
740         ENDIF
741         IF ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) THEN
742            IF( dta%ll_ssh ) THEN
743               if(lwp) write(numout,*) '++++++ dta%ssh pointing to fnow'
744               jfld = jfld + 1
745               dta%ssh => bf(jfld)%fnow(:,1,1)
746            ENDIF
747            IF ( dta%ll_u2d ) THEN
748               IF ( ln_full_vel_array(jbdy) ) THEN
749                  if(lwp) write(numout,*) '++++++ dta%u2d allocated space'
750                  ALLOCATE( dta%u2d(nblen(2)) )
751               ELSE
752                  if(lwp) write(numout,*) '++++++ dta%u2d pointing to fnow'
753                  jfld = jfld + 1
754                  dta%u2d => bf(jfld)%fnow(:,1,1)
755               ENDIF
756            ENDIF
757            IF ( dta%ll_v2d ) THEN
758               IF ( ln_full_vel_array(jbdy) ) THEN
759                  if(lwp) write(numout,*) '++++++ dta%v2d allocated space'
760                  ALLOCATE( dta%v2d(nblen(3)) )
761               ELSE
762                  if(lwp) write(numout,*) '++++++ dta%v2d pointing to fnow'
763                  jfld = jfld + 1
764                  dta%v2d => bf(jfld)%fnow(:,1,1)
765               ENDIF
766            ENDIF
767         ENDIF
768
769         IF ( nn_dyn3d_dta(jbdy) == 0 ) THEN
770            if(lwp) write(numout,*) '++++++ dta%u3d/v3d allocated space'
771            IF( dta%ll_u3d ) ALLOCATE( dta_bdy(jbdy)%u3d(nblen(2),jpk) )
772            IF( dta%ll_v3d ) ALLOCATE( dta_bdy(jbdy)%v3d(nblen(3),jpk) )
773         ENDIF
774         IF ( nn_dyn3d_dta(jbdy) == 1 .or. &
775           &  ( ln_full_vel_array(jbdy) .and. ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) ) ) THEN
776            IF ( dta%ll_u3d .or. ( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) ) THEN
777               if(lwp) write(numout,*) '++++++ dta%u3d pointing to fnow'
778               jfld = jfld + 1
779               dta_bdy(jbdy)%u3d => bf(jfld)%fnow(:,1,:)
780            ENDIF
781            IF ( dta%ll_v3d .or. ( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) ) THEN
782               if(lwp) write(numout,*) '++++++ dta%v3d pointing to fnow'
783               jfld = jfld + 1
784               dta_bdy(jbdy)%v3d => bf(jfld)%fnow(:,1,:)
785            ENDIF
786         ENDIF
787
788         IF( nn_tra_dta(jbdy) == 0 ) THEN
789            if(lwp) write(numout,*) '++++++ dta%tem/sal allocated space'
790            IF( dta%ll_tem ) ALLOCATE( dta_bdy(jbdy)%tem(nblen(1),jpk) )
791            IF( dta%ll_sal ) ALLOCATE( dta_bdy(jbdy)%sal(nblen(1),jpk) )
792         ELSE
793            IF( dta%ll_tem ) THEN
794               if(lwp) write(numout,*) '++++++ dta%tem pointing to fnow'
795               jfld = jfld + 1
796               dta_bdy(jbdy)%tem => bf(jfld)%fnow(:,1,:)
797            ENDIF
798            IF( dta%ll_sal ) THEN
799               if(lwp) write(numout,*) '++++++ dta%sal pointing to fnow'
800               jfld = jfld + 1
801               dta_bdy(jbdy)%sal => bf(jfld)%fnow(:,1,:)
802            ENDIF
803         ENDIF
804
805#if defined key_si3
806         IF (cn_ice(jbdy) /= 'none') THEN
807            IF( nn_ice_dta(jbdy) == 0 ) THEN
808               ALLOCATE( dta_bdy(jbdy)%a_i(nblen(1),jpl) )
809               ALLOCATE( dta_bdy(jbdy)%h_i(nblen(1),jpl) )
810               ALLOCATE( dta_bdy(jbdy)%h_s(nblen(1),jpl) )
811            ELSE
812               IF ( nice_cat == jpl ) THEN ! case input cat = jpl
813                  jfld = jfld + 1
814                  dta_bdy(jbdy)%a_i => bf(jfld)%fnow(:,1,:)
815                  jfld = jfld + 1
816                  dta_bdy(jbdy)%h_i => bf(jfld)%fnow(:,1,:)
817                  jfld = jfld + 1
818                  dta_bdy(jbdy)%h_s => bf(jfld)%fnow(:,1,:)
819               ELSE                        ! case input cat = 1 OR (/=1 and /=jpl)
820                  jfld_ait(jbdy)  = jfld + 1
821                  jfld_htit(jbdy) = jfld + 2
822                  jfld_htst(jbdy) = jfld + 3
823                  jfld     = jfld + 3
824                  ALLOCATE( dta_bdy(jbdy)%a_i(nblen(1),jpl) )
825                  ALLOCATE( dta_bdy(jbdy)%h_i(nblen(1),jpl) )
826                  ALLOCATE( dta_bdy(jbdy)%h_s(nblen(1),jpl) )
827                  dta_bdy(jbdy)%a_i(:,:) = 0._wp
828                  dta_bdy(jbdy)%h_i(:,:) = 0._wp
829                  dta_bdy(jbdy)%h_s(:,:) = 0._wp
830               ENDIF
831
832            ENDIF
833         ENDIF
834#endif
835         !
836      END DO ! jbdy
837      !
838   END SUBROUTINE bdy_dta_init
839
840   !!==============================================================================
841END MODULE bdydta
Note: See TracBrowser for help on using the repository browser.