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/NERC/dev_r3874_FASTNEt/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/NERC/dev_r3874_FASTNEt/NEMOGCM/NEMO/OPA_SRC/BDY/bdydta.F90 @ 6736

Last change on this file since 6736 was 6736, checked in by jamesharle, 8 years ago

FASTNEt code modifications

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