New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
bdydta.F90 in branches/2013/dev_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

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

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

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