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

Last change on this file since 9657 was 9657, checked in by clem, 2 years ago

change nn_ice_lim and cn_ice_lim to nn_ice and cn_ice for BDY

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