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.
obcdta.F90 in trunk/NEMO/OPA_SRC/OBC – NEMO

source: trunk/NEMO/OPA_SRC/OBC/obcdta.F90 @ 1876

Last change on this file since 1876 was 1876, checked in by rblod, 14 years ago

Corrections for AGRIF inside OBC see ticket #673

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 57.8 KB
Line 
1MODULE obcdta
2  !!==============================================================================
3  !!                            ***  MODULE obcdta  ***
4  !! Open boundary data : read the data for the open boundaries.
5  !!==============================================================================
6#if defined key_obc
7  !!------------------------------------------------------------------------------
8  !!   'key_obc'         :                                Open Boundary Conditions
9  !!------------------------------------------------------------------------------
10  !!   obc_dta           : read u, v, t, s data along each open boundary
11  !!------------------------------------------------------------------------------
12  !! * Modules used
13  USE oce             ! ocean dynamics and tracers
14  USE dom_oce         ! ocean space and time domain
15  USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
16  USE phycst          ! physical constants
17  USE obc_oce         ! ocean open boundary conditions
18  USE in_out_manager  ! I/O logical units
19  USE lib_mpp         ! distributed memory computing
20  USE dynspg_oce
21  USE ioipsl          ! now only for  ymds2ju function
22  USE iom             !
23
24  IMPLICIT NONE
25  PRIVATE
26
27  !! * Accessibility
28  PUBLIC obc_dta      ! routines called by step.F90
29  PUBLIC obc_dta_bt   ! routines called by dynspg_ts.F90
30
31  !! * Shared module variables
32  REAL(wp),  DIMENSION(2)              ::  zjcnes_obc   !
33  REAL(wp),  DIMENSION(:), ALLOCATABLE :: ztcobc
34  REAL(wp) :: rdt_obc
35  REAL(wp) :: zjcnes
36  INTEGER :: imm0, iyy0, idd0, iyy, imm, idd
37  INTEGER :: nt_a=2, nt_b=1, itobc, ndate0_cnes, nday_year0
38  INTEGER ::  itobce, itobcw, itobcs, itobcn, itobc_b  ! number of time steps in OBC files
39
40  INTEGER ::   &
41       ntobc      , &     !:  where we are in the obc file
42       ntobc_b    , &     !:  first record used
43       ntobc_a            !:  second record used
44
45  CHARACTER (len=40) :: &    ! name of data files
46       cl_obc_eTS   , cl_obc_eU,  &
47       cl_obc_wTS   , cl_obc_wU,  &
48       cl_obc_nTS   , cl_obc_nV,  &
49       cl_obc_sTS   , cl_obc_sV
50
51  ! arrays used for interpolating time dependent data on the boundaries
52  REAL(wp), DIMENSION(jpj,jpk,jptobc) :: uedta, vedta, tedta, sedta    ! East
53  REAL(wp), DIMENSION(jpj,jpk,jptobc) :: uwdta, vwdta, twdta, swdta    ! West
54  REAL(wp), DIMENSION(jpi,jpk,jptobc) :: undta, vndta, tndta, sndta    ! North
55  REAL(wp), DIMENSION(jpi,jpk,jptobc) :: usdta, vsdta, tsdta, ssdta    ! South
56
57  LOGICAL, DIMENSION (jpj,jpk ) :: ltemsk=.TRUE., luemsk=.TRUE., lvemsk=.TRUE.  ! boolean msks
58  LOGICAL, DIMENSION (jpj,jpk ) :: ltwmsk=.TRUE., luwmsk=.TRUE., lvwmsk=.TRUE.  ! used for outliers
59  LOGICAL, DIMENSION (jpi,jpk ) :: ltnmsk=.TRUE., lunmsk=.TRUE., lvnmsk=.TRUE.  ! checks
60  LOGICAL, DIMENSION (jpi,jpk ) :: ltsmsk=.TRUE., lusmsk=.TRUE., lvsmsk=.TRUE.
61
62  !! * Substitutions
63#  include "obc_vectopt_loop_substitute.h90"
64   !!----------------------------------------------------------------------
65   !!   OPA 9.0 , LOCEAN-IPSL (2006)
66   !! $Id$
67   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
68   !!----------------------------------------------------------------------
69
70CONTAINS
71
72  SUBROUTINE obc_dta( kt )
73    !!---------------------------------------------------------------------------
74    !!                      ***  SUBROUTINE obc_dta  ***
75    !!                   
76    !! ** Purpose :   Find the climatological  boundary arrays for the specified date,
77    !!                The boundary arrays are netcdf files. Three possible cases:
78    !!                - one time frame only in the file (time dimension = 1).
79    !!                in that case the boundary data does not change in time.
80    !!                - many time frames. In that case,  if we have 12 frames
81    !!                we assume monthly fields.
82    !!                Else, we assume that time_counter is in seconds
83    !!                since the beginning of either the current year or a reference
84    !!                year given in the namelist.
85    !!                (no check is done so far but one would have to check the "unit"
86    !!                 attribute of variable time_counter).
87    !!
88    !!
89    !! History :
90    !!        !  98-05 (J.M. Molines) Original code
91    !!   8.5  !  02-10 (C. Talandier, A-M. Treguier) Free surface, F90
92    !!
93    !!   9.0  !  04-06 (F. Durand, A-M. Treguier) Netcdf BC files on input
94    !!        !  2007-2008 (C. Langlais, P. Mathiot, J.M. Molines) high frequency boundaries data
95    !!---------------------------------------------------------------------------
96    !! * Arguments
97    INTEGER, INTENT( in ) ::   kt          ! ocean time-step index
98
99    !! * Local declarations
100    INTEGER ::   ji, jj, jk, ii, ij ,it  ! dummy loop indices
101    INTEGER ::  ikprint                                ! frequency for printouts.
102    INTEGER, SAVE :: immfile, iyyfile                     !
103    INTEGER :: nt              !  record indices (incrementation)
104    INTEGER :: istop           ! local error check
105
106    REAL(wp) ::   zxy, znum, zden ! time interpolation weight
107
108    ! variables for the julian day calculation
109    INTEGER :: iyear, imonth, iday
110    REAL(wp) :: zsec , zjulian, zjuliancnes   
111
112    ! IOM STUFF
113    INTEGER ::  idvar, id_e, id_w, id_n, id_s, id_x       ! file identifiers
114    INTEGER, DIMENSION(1)  :: itmp
115    CHARACTER(LEN=25) :: cl_vname
116
117    !!---------------------------------------------------------------------------
118
119    ! 0.  initialisation :
120    ! --------------------
121    IF ( kt == nit000  )  CALL obc_dta_ini ( kt )
122    IF ( nobc_dta == 0 )  RETURN   ! already done in obc_dta_ini
123    IF ( itobc == 1    )  RETURN   ! case of only one time frame in file done in obc_dta_ini
124
125    ! in the following code, we assume that obc data are read from files, with more than 1 time frame in it
126
127    iyyfile=iyy ; immfile = 00  ! set component of the current file name
128    IF ( cffile /= 'annual') immfile = imm   !
129    IF ( ln_obc_clim       ) iyyfile = 0000  ! assume that climatological files are labeled y0000
130
131    ! 1. Synchronize time of run with time of data files
132    !---------------------------------------------------
133    ! nday_year is the day number in the current year ( 1 for 01/01 )
134    zsec=MOD( (kt-nit000)*rdt - (nday_year - nday_year0 )*rday, rday ) ! number of seconds in the current day
135    IF (ln_obc_clim)  THEN
136      zjcnes = nday_year - 1  + zsec/rday
137    ELSE
138      zjcnes = zjcnes + rdt/rday
139    ENDIF
140
141    ! look for 'before' record number in the current file
142    ntobc = nrecbef ()  ! this function return the record number for 'before', relative to zjcnes
143
144    IF (MOD(kt-1,10)==0) THEN
145       IF (lwp) WRITE(numout,*) 'kt= ',kt,' zjcnes =', zjcnes,' ndastp =',ndastp, 'mm =',imm 
146    END IF
147
148    ! 2. read a new data if necessary
149    !--------------------------------
150    IF ( ntobc /= ntobc_b ) THEN
151    ! we need to read the 'after' record
152    ! swap working index:
153    nt=nt_b ; nt_b=nt_a ; nt_a=nt
154    ntobc_b = ntobc
155
156    ! new record number :
157    ntobc_a = ntobc_a + 1 
158
159    ! all tricky things related to record number, changing files etc... are managed by obc_read
160     
161    CALL obc_read (kt, nt_a, ntobc_a, iyyfile, immfile )
162
163    ! update zjcnes_obc
164    zjcnes_obc(nt_b)= ztcobc(ntobc_b)
165    zjcnes_obc(nt_a)= ztcobc(ntobc_a)
166    ENDIF
167
168    ! 3.   interpolation at each time step
169    ! ------------------------------------
170    IF ( ln_obc_clim) THEN
171      znum= MOD(zjcnes           - zjcnes_obc(nt_b), REAL(nyear_len(1),wp) ) ; IF ( znum < 0 ) znum = znum + REAL(nyear_len(1),wp)
172      zden= MOD(zjcnes_obc(nt_a) - zjcnes_obc(nt_b), REAL(nyear_len(1),wp) ) ; IF ( zden < 0 ) zden = zden + REAL(nyear_len(1),wp)
173    ELSE
174      znum= zjcnes           - zjcnes_obc(nt_b)
175      zden= zjcnes_obc(nt_a) - zjcnes_obc(nt_b)
176    ENDIF
177    zxy = znum / zden
178
179    IF( lp_obc_east ) THEN
180       !  fills sfoe, tfoe, ufoe ,vfoe
181       sfoe(:,:) = zxy * sedta (:,:,nt_a) + (1. - zxy)*sedta(:,:,nt_b)
182       tfoe(:,:) = zxy * tedta (:,:,nt_a) + (1. - zxy)*tedta(:,:,nt_b)
183       ufoe(:,:) = zxy * uedta (:,:,nt_a) + (1. - zxy)*uedta(:,:,nt_b)
184       vfoe(:,:) = zxy * vedta (:,:,nt_a) + (1. - zxy)*vedta(:,:,nt_b)
185    ENDIF
186
187    IF( lp_obc_west) THEN
188       !  fills sfow, tfow, ufow ,vfow
189       sfow(:,:) = zxy * swdta (:,:,nt_a) + (1. - zxy)*swdta(:,:,nt_b)
190       tfow(:,:) = zxy * twdta (:,:,nt_a) + (1. - zxy)*twdta(:,:,nt_b)
191       ufow(:,:) = zxy * uwdta (:,:,nt_a) + (1. - zxy)*uwdta(:,:,nt_b)
192       vfow(:,:) = zxy * vwdta (:,:,nt_a) + (1. - zxy)*vwdta(:,:,nt_b)
193    ENDIF
194
195    IF( lp_obc_north) THEN
196       !  fills sfon, tfon, ufon ,vfon
197       sfon(:,:) = zxy * sndta (:,:,nt_a) + (1. - zxy)*sndta(:,:,nt_b)
198       tfon(:,:) = zxy * tndta (:,:,nt_a) + (1. - zxy)*tndta(:,:,nt_b)
199       ufon(:,:) = zxy * undta (:,:,nt_a) + (1. - zxy)*undta(:,:,nt_b)
200       vfon(:,:) = zxy * vndta (:,:,nt_a) + (1. - zxy)*vndta(:,:,nt_b)
201    ENDIF
202
203    IF( lp_obc_south) THEN
204       !  fills sfos, tfos, ufos ,vfos
205       sfos(:,:) = zxy * ssdta (:,:,nt_a) + (1. - zxy)*ssdta(:,:,nt_b)
206       tfos(:,:) = zxy * tsdta (:,:,nt_a) + (1. - zxy)*tsdta(:,:,nt_b)
207       ufos(:,:) = zxy * usdta (:,:,nt_a) + (1. - zxy)*usdta(:,:,nt_b)
208       vfos(:,:) = zxy * vsdta (:,:,nt_a) + (1. - zxy)*vsdta(:,:,nt_b)
209    ENDIF
210  END SUBROUTINE obc_dta
211
212
213  SUBROUTINE obc_dta_ini (kt)
214    !!-----------------------------------------------------------------------------
215    !!                       ***  SUBROUTINE obc_dta_ini  ***
216    !!
217    !! ** Purpose :
218    !!      When obc_dta first call, realize some data initialization
219    !!
220    !! ** Method :
221    !!
222    !! History :
223    !!   9.0  ! 07-10 (J.M. Molines )
224    !!----------------------------------------------------------------------------
225    !! * Argument
226    INTEGER, INTENT(in)  :: kt      ! ocean time-step index
227
228    !! * Local declarations
229    INTEGER ::   ji,jj, it   ! dummy loop indices
230
231    REAL(wp) ::   zxy                                    ! time interpolation weight
232
233    INTEGER ::  ikprint                                ! frequency for printouts.
234
235    INTEGER, SAVE :: immfile, iyyfile                     !
236    INTEGER :: nt              !  record indices (incrementation)
237    INTEGER :: istop           ! local error check
238
239    ! variables for the julian day calculation
240    INTEGER :: iyear, imonth, iday
241    REAL(wp) :: zsec , zjulian, zjuliancnes   
242
243    ! IOM STUFF
244    INTEGER ::  idvar, id_e, id_w, id_n, id_s, id_x       ! file identifiers
245    INTEGER, DIMENSION(1)  :: itmp
246    CHARACTER(LEN=25) :: cl_vname
247
248    IF(lwp) WRITE(numout,*)
249    IF(lwp) WRITE(numout,*)  'obc_dta : find boundary data'
250    IF(lwp) WRITE(numout,*)  '~~~~~~~'
251    IF (lwp) THEN
252       IF ( nobc_dta == 0 ) THEN
253          WRITE(numout,*)  '          OBC data taken from initial conditions.'
254       ELSE     
255          WRITE(numout,*)  '          OBC data taken from netcdf files.'
256       ENDIF
257    ENDIF
258    nday_year0 = nday_year  ! to remember the day when kt=nit000
259
260    sedta(:,:,:) = 0.e0 ; tedta(:,:,:) = 0.e0 ; uedta(:,:,:) = 0.e0 ; vedta(:,:,:) = 0.e0 ! East
261    swdta(:,:,:) = 0.e0 ; twdta(:,:,:) = 0.e0 ; uwdta(:,:,:) = 0.e0 ; vwdta(:,:,:) = 0.e0 ! West
262    sndta(:,:,:) = 0.e0 ; tndta(:,:,:) = 0.e0 ; undta(:,:,:) = 0.e0 ; vndta(:,:,:) = 0.e0 ! North
263    ssdta(:,:,:) = 0.e0 ; tsdta(:,:,:) = 0.e0 ; usdta(:,:,:) = 0.e0 ; vsdta(:,:,:) = 0.e0 ! South
264
265    sfoe(:,:) = 0.e0  ; tfoe(:,:) = 0.e0 ; ufoe(:,:) = 0.e0 ; vfoe(:,:) = 0.e0   ! East
266    sfow(:,:) = 0.e0  ; tfow(:,:) = 0.e0 ; ufow(:,:) = 0.e0 ; vfow(:,:) = 0.e0   ! West
267    sfon(:,:) = 0.e0  ; tfon(:,:) = 0.e0 ; ufon(:,:) = 0.e0 ; vfon(:,:) = 0.e0   ! North
268    sfos(:,:) = 0.e0  ; tfos(:,:) = 0.e0 ; ufos(:,:) = 0.e0 ; vfos(:,:) = 0.e0   ! South
269
270    IF (nobc_dta == 0 ) THEN   ! boundary data are the initial data of this run (set only at nit000)
271       IF (lp_obc_east) THEN  ! East
272          DO ji = nie0 , nie1   
273             sfoe(nje0p1:nje1m1,:) = temsk(nje0p1:nje1m1,:) * sn (ji+1 , nje0p1:nje1m1 , :)
274             tfoe(nje0p1:nje1m1,:) = temsk(nje0p1:nje1m1,:) * tn (ji+1 , nje0p1:nje1m1 , :)
275             ufoe(nje0p1:nje1m1,:) = uemsk(nje0p1:nje1m1,:) * un (ji   , nje0p1:nje1m1 , :)
276             vfoe(nje0p1:nje1m1,:) = vemsk(nje0p1:nje1m1,:) * vn (ji+1 , nje0p1:nje1m1 , :)
277          END DO
278       ENDIF
279
280       IF (lp_obc_west) THEN  ! West
281          DO ji = niw0 , niw1   
282             sfow(njw0p1:njw1m1,:) = twmsk(njw0p1:njw1m1,:) * sn (ji , njw0p1:njw1m1 , :)
283             tfow(njw0p1:njw1m1,:) = twmsk(njw0p1:njw1m1,:) * tn (ji , njw0p1:njw1m1 , :)
284             ufow(njw0p1:njw1m1,:) = uwmsk(njw0p1:njw1m1,:) * un (ji , njw0p1:njw1m1 , :)
285             vfow(njw0p1:njw1m1,:) = vwmsk(njw0p1:njw1m1,:) * vn (ji , njw0p1:njw1m1 , :)
286          END DO
287       ENDIF
288
289       IF (lp_obc_north) THEN ! North
290          DO jj = njn0 , njn1
291             sfon(nin0p1:nin1m1,:) = tnmsk(nin0p1:nin1m1,:) * sn (nin0p1:nin1m1 , jj+1 , :)
292             tfon(nin0p1:nin1m1,:) = tnmsk(nin0p1:nin1m1,:) * tn (nin0p1:nin1m1 , jj+1 , :)
293             ufon(nin0p1:nin1m1,:) = unmsk(nin0p1:nin1m1,:) * un (nin0p1:nin1m1 , jj+1 , :)
294             vfon(nin0p1:nin1m1,:) = vnmsk(nin0p1:nin1m1,:) * vn (nin0p1:nin1m1 , jj   , :)
295          END DO
296       ENDIF
297
298       IF (lp_obc_south) THEN ! South
299          DO jj = njs0 , njs1
300             sfos(nis0p1:nis1m1,:) = tsmsk(nis0p1:nis1m1,:) * sn (nis0p1:nis1m1 , jj , :)
301             tfos(nis0p1:nis1m1,:) = tsmsk(nis0p1:nis1m1,:) * tn (nis0p1:nis1m1 , jj , :)
302             ufos(nis0p1:nis1m1,:) = usmsk(nis0p1:nis1m1,:) * un (nis0p1:nis1m1 , jj , :)
303             vfos(nis0p1:nis1m1,:) = vsmsk(nis0p1:nis1m1,:) * vn (nis0p1:nis1m1 , jj , :)
304          END DO
305       ENDIF
306       RETURN  ! exit the routine all is done
307    ENDIF  ! nobc_dta = 0
308
309!!!! In the following OBC data are read from files.
310    ! all logical-mask are initialzed to true when declared
311    WHERE ( temsk == 0 ) ltemsk=.FALSE. 
312    WHERE ( uemsk == 0 ) luemsk=.FALSE. 
313    WHERE ( vemsk == 0 ) lvemsk=.FALSE. 
314
315    WHERE ( twmsk == 0 ) ltwmsk=.FALSE. 
316    WHERE ( uwmsk == 0 ) luwmsk=.FALSE. 
317    WHERE ( vwmsk == 0 ) lvwmsk=.FALSE. 
318
319    WHERE ( tnmsk == 0 ) ltnmsk=.FALSE. 
320    WHERE ( unmsk == 0 ) lunmsk=.FALSE. 
321    WHERE ( vnmsk == 0 ) lvnmsk=.FALSE. 
322
323    WHERE ( tsmsk == 0 ) ltsmsk=.FALSE. 
324    WHERE ( usmsk == 0 ) lusmsk=.FALSE. 
325    WHERE ( vsmsk == 0 ) lvsmsk=.FALSE. 
326
327    iyear=1950;  imonth=01; iday=01;  zsec=0. 
328    ! zjuliancnes : julian day corresonding  to  01/01/1950
329    CALL ymds2ju(iyear, imonth, iday,zsec , zjuliancnes)
330
331    !current year and curent month
332    iyy=INT(ndastp/10000) ; imm=INT((ndastp -iyy*10000)/100) ; idd=(ndastp-iyy*10000-imm*100)
333    IF (iyy <  1900)  iyy = iyy+1900  ! always assume that years are on 4 digits.
334    CALL ymds2ju(iyy, imm, idd ,zsec , zjulian)
335    ndate0_cnes = zjulian - zjuliancnes   ! jcnes day when call to obc_dta_ini
336
337    iyyfile=iyy ; immfile=0  ! set component of the current file name
338    IF ( cffile /= 'annual') immfile=imm
339    IF ( ln_obc_clim) iyyfile = 0  ! assume that climatological files are labeled y0000
340
341    CALL obc_dta_chktime ( iyyfile, immfile )
342
343    IF ( itobc == 1 ) THEN 
344       ! in this case we will provide boundary data only once.
345       nt_a=1 ; ntobc_a=1
346       CALL obc_read (nit000, nt_a, ntobc_a, iyyfile, immfile) 
347       IF( lp_obc_east ) THEN
348          !  fills sfoe, tfoe, ufoe ,vfoe
349          sfoe(:,:) =  sedta (:,:,1) ; tfoe(:,:) =  tedta (:,:,1)
350          ufoe(:,:) =  uedta (:,:,1) ; vfoe(:,:) =  vedta (:,:,1)
351       ENDIF
352
353       IF( lp_obc_west) THEN
354          !  fills sfow, tfow, ufow ,vfow
355          sfow(:,:) =  swdta (:,:,1) ; tfow(:,:) =  twdta (:,:,1)
356          ufow(:,:) =  uwdta (:,:,1) ; vfow(:,:) =  vwdta (:,:,1)
357       ENDIF
358
359       IF( lp_obc_north) THEN
360          !  fills sfon, tfon, ufon ,vfon
361          sfon(:,:) =  sndta (:,:,1) ; tfon(:,:) =  tndta (:,:,1)
362          ufon(:,:) =  undta (:,:,1) ; vfon(:,:) =  vndta (:,:,1)
363       ENDIF
364
365       IF( lp_obc_south) THEN
366          !  fills sfos, tfos, ufos ,vfos
367          sfos(:,:) =  ssdta (:,:,1) ; tfos(:,:) =  tsdta (:,:,1)
368          ufos(:,:) =  usdta (:,:,1) ; vfos(:,:) =  vsdta (:,:,1)
369       ENDIF
370       RETURN  ! we go out of obc_dta_ini -------------------------------------->>>>>
371    ENDIF
372
373    ! nday_year is the day number in the current year ( 1 for 01/01 )
374    ! we suppose that we always start from the begining of a day
375    !    zsec=MOD( (kt-nit000)*rdt - (nday_year - nday_year0 )*rday, rday ) ! number of seconds in the current day
376    zsec=0.e0  ! here, kt=nit000, nday_year = ndat_year0
377
378    IF (ln_obc_clim)  THEN
379      zjcnes = nday_year - 1  + zsec/rday  ! for clim file time is in days in a year
380    ELSE
381      zjcnes = ndate0_cnes + (nday_year - nday_year0 ) + zsec/rday
382    ENDIF
383
384    ! look for 'before' record number in the current file
385    ntobc = nrecbef ()
386
387    IF (lwp) WRITE(numout,*) 'obc files frequency :',cffile
388    IF (lwp) WRITE(numout,*) ' zjcnes0 =',zjcnes,' ndastp0 =',ndastp
389    IF (lwp) WRITE(numout,*) ' annee0 ',iyy,' month0 ', imm,' day0 ', idd
390    IF (lwp) WRITE(numout,*) 'first file open :',cl_obc_nTS
391
392    ! record initialisation
393    !--------------------
394    nt_b = 1 ; nt_a = 2
395
396    ntobc_a = ntobc + 1
397    ntobc_b = ntobc
398
399    CALL obc_read (kt, nt_b, ntobc_b, iyyfile, immfile)  ! read 'before' fields
400    CALL obc_read (kt, nt_a, ntobc_a, iyyfile, immfile)  ! read 'after' fields
401
402    zjcnes_obc(nt_b)= ztcobc(ntobc_b)
403    zjcnes_obc(nt_a)= ztcobc(ntobc_a)
404    !
405  END SUBROUTINE obc_dta_ini
406
407
408  SUBROUTINE obc_dta_chktime (kyyfile, kmmfile)
409   !
410   ! check the number of time steps in the files and read ztcobc
411   !
412   ! * Arguments
413   INTEGER, INTENT(in) :: kyyfile, kmmfile
414   ! * local variables
415   INTEGER :: istop       ! error control
416   INTEGER :: ji          ! dummy loop index
417
418    INTEGER ::  idvar, id_e, id_w, id_n, id_s, id_x       ! file identifiers
419    INTEGER, DIMENSION(1)  :: itmp
420    CHARACTER(LEN=25) :: cl_vname
421
422    ntobc_a = 0; itobce =0 ; itobcw = 0; itobcn = 0; itobcs = 0
423    ! build file name
424    WRITE(cl_obc_eTS ,'("obc_east_TS_y",i4.4,"m",i2.2,".nc")'  ) kyyfile,kmmfile
425    WRITE(cl_obc_wTS ,'("obc_west_TS_y",i4.4,"m",i2.2,".nc")'  ) kyyfile,kmmfile
426    WRITE(cl_obc_nTS ,'("obc_north_TS_y",i4.4,"m",i2.2,".nc")' ) kyyfile,kmmfile
427    WRITE(cl_obc_sTS ,'("obc_south_TS_y",i4.4,"m",i2.2,".nc")' ) kyyfile,kmmfile
428
429    cl_vname = 'time_counter'
430    IF ( lp_obc_east ) THEN
431       CALL iom_open ( cl_obc_eTS , id_e )
432       idvar = iom_varid( id_e, cl_vname, kdimsz = itmp ); itobce=itmp(1)
433    ENDIF
434    IF ( lp_obc_west ) THEN
435       CALL iom_open ( cl_obc_wTS , id_w )
436       idvar = iom_varid( id_w, cl_vname, kdimsz = itmp ) ; itobcw=itmp(1)
437    ENDIF
438    IF ( lp_obc_north ) THEN
439       CALL iom_open ( cl_obc_nTS , id_n )
440       idvar = iom_varid( id_n, cl_vname, kdimsz = itmp ) ; itobcn=itmp(1)
441    ENDIF
442    IF ( lp_obc_south ) THEN
443       CALL iom_open ( cl_obc_sTS , id_s )
444       idvar = iom_varid( id_s, cl_vname, kdimsz = itmp ) ; itobcs=itmp(1)
445    ENDIF
446
447    itobc = MAX( itobce, itobcw, itobcn, itobcs )
448    istop = 0
449    IF ( lp_obc_east  .AND. itobce /= itobc ) istop = istop+1 
450    IF ( lp_obc_west  .AND. itobcw /= itobc ) istop = istop+1     
451    IF ( lp_obc_north .AND. itobcn /= itobc ) istop = istop+1
452    IF ( lp_obc_south .AND. itobcs /= itobc ) istop = istop+1 
453    nstop = nstop + istop
454
455    IF ( istop /=  0 )  THEN
456       WRITE(ctmp1,*) ' east, west, north, south: ', itobce, itobcw, itobcn, itobcs
457       CALL ctl_stop( 'obcdta : all files must have the same number of time steps', ctmp1 )
458    ENDIF
459
460    IF ( itobc == 1 ) THEN
461       IF (lwp) THEN
462          WRITE(numout,*) ' obcdta found one time step only in the OBC files'
463          IF (ln_obc_clim) THEN
464             ! OK no problem
465          ELSE
466             ln_obc_clim=.true.
467             WRITE(numout,*) ' we force ln_obc_clim to T'
468          ENDIF
469       ENDIF
470    ELSE
471#if defined key_agrif
472       IF ( ASSOCIATED(ztcobc) ) DEALLOCATE ( ztcobc )
473#else
474       IF ( ALLOCATED(ztcobc) ) DEALLOCATE ( ztcobc )
475#endif
476       ALLOCATE (ztcobc(itobc))
477       DO ji=1,1   ! use a dummy loop to read ztcobc only once
478          IF ( lp_obc_east ) THEN
479             CALL iom_gettime ( id_e, ztcobc, cl_vname ) ; CALL iom_close (id_e) ; EXIT
480          ENDIF
481          IF ( lp_obc_west ) THEN
482             CALL iom_gettime ( id_w, ztcobc, cl_vname ) ; CALL iom_close (id_w) ; EXIT
483          ENDIF
484          IF ( lp_obc_north ) THEN
485             CALL iom_gettime ( id_n, ztcobc, cl_vname ) ; CALL iom_close (id_n) ; EXIT
486          ENDIF
487          IF ( lp_obc_south ) THEN
488             CALL iom_gettime ( id_s, ztcobc, cl_vname ) ; CALL iom_close (id_s) ; EXIT
489          ENDIF
490       END DO
491       rdt_obc = ztcobc(2)-ztcobc(1)  !  just an information, not used for any computation
492       IF (lwp) WRITE(numout,*) ' obcdta found', itobc,' time steps in the OBC files'
493       IF (lwp) WRITE(numout,*) ' time step of obc data :', rdt_obc,' days'           
494     ENDIF
495     zjcnes = zjcnes - rdt/rday  ! trick : zcnes is always incremented by rdt/rday in obc_dta!
496  END SUBROUTINE obc_dta_chktime
497
498
499#if defined key_dynspg_ts || defined key_dynspg_exp
500  SUBROUTINE obc_dta_bt( kt, kbt )
501    !!---------------------------------------------------------------------------
502    !!                      ***  SUBROUTINE obc_dta  ***
503    !!
504    !! ** Purpose :   time interpolation of barotropic data for time-splitting scheme
505    !!                Data at the boundary must be in m2/s
506    !!
507    !! History :
508    !!   9.0  !  05-11 (V. garnier) Original code
509    !!---------------------------------------------------------------------------
510    !! * Arguments
511    INTEGER, INTENT( in ) ::   kt          ! ocean time-step index
512    INTEGER, INTENT( in ) ::   kbt         ! barotropic ocean time-step index
513
514    !! * Local declarations
515    INTEGER ::   ji, jj, jk, ii, ij   ! dummy loop indices
516    INTEGER ::   id_e, id_w, id_n, id_s, fid  ! file identifiers
517    INTEGER ::   itimo, iman, imois, i15
518    INTEGER ::   itobcm, itobcp, itimom, itimop
519    REAL(wp) ::  zxy
520    INTEGER ::   isrel, ikt           ! number of seconds since 1/1/1992
521    INTEGER ::   iprint              ! frequency for printouts.
522
523    !!---------------------------------------------------------------------------
524
525    ! 1.   First call: check time frames available in files.
526    ! -------------------------------------------------------
527
528    IF( kt == nit000 ) THEN
529
530       ! 1.1  Barotropic tangential velocities set to zero
531       ! -------------------------------------------------
532       IF( lp_obc_east  ) vbtfoe(:) = 0.e0
533       IF( lp_obc_west  ) vbtfow(:) = 0.e0
534       IF( lp_obc_south ) ubtfos(:) = 0.e0
535       IF( lp_obc_north ) ubtfon(:) = 0.e0
536
537       ! 1.2  Sea surface height and normal barotropic velocities set to zero
538       !                               or initial conditions if nobc_dta == 0
539       ! --------------------------------------------------------------------
540
541       IF( lp_obc_east ) THEN
542          ! initialisation to zero
543          sshedta(:,:) = 0.e0
544          ubtedta(:,:) = 0.e0
545          !                                        ! ================== !
546          IF( nobc_dta == 0 )   THEN               ! initial state used !
547             !                                     ! ================== !
548             !  Fills sedta, tedta, uedta (global arrays)
549             !  Remark: this works for njzoom = 1. Should the definition of ij include njzoom?
550             DO ji = nie0, nie1
551                DO jj = nje0p1, nje1m1
552                   ij = jj -1 + njmpp
553                   sshedta(ij,1) = sshn(ji+1,jj) * tmask(ji+1,jj,1)
554                END DO
555             END DO
556          ENDIF
557       ENDIF
558
559       IF( lp_obc_west) THEN
560          ! initialisation to zero
561          sshwdta(:,:) = 0.e0
562          ubtwdta(:,:) = 0.e0
563          !                                        ! ================== !
564          IF( nobc_dta == 0 )   THEN               ! initial state used !
565             !                                     ! ================== !
566             !  Fills swdta, twdta, uwdta (global arrays)
567             !  Remark: this works for njzoom = 1. Should the definition of ij include njzoom?
568             DO ji = niw0, niw1
569                DO jj = njw0p1, njw1m1
570                   ij = jj -1 + njmpp
571                   sshwdta(ij,1) = sshn(ji,jj) * tmask(ji,jj,1)
572                END DO
573             END DO
574          ENDIF
575       ENDIF
576
577       IF( lp_obc_north) THEN
578          ! initialisation to zero
579          sshndta(:,:) = 0.e0
580          vbtndta(:,:) = 0.e0
581          !                                        ! ================== !
582          IF( nobc_dta == 0 )   THEN               ! initial state used !
583             !                                     ! ================== !
584             !  Fills sndta, tndta, vndta (global arrays)
585             !  Remark: this works for njzoom = 1. Should the definition of ij include njzoom?
586             DO jj = njn0, njn1
587                DO ji = nin0p1, nin1m1
588                   DO jk = 1, jpkm1
589                      ii = ji -1 + nimpp
590                      vbtndta(ii,1) = vbtndta(ii,1) + vndta(ii,jk,1)*fse3v(ji,jj,jk)
591                   END DO
592                   sshndta(ii,1) = sshn(ii,jj+1) * tmask(ji,jj+1,1)
593                END DO
594             END DO
595          ENDIF
596       ENDIF
597
598       IF( lp_obc_south) THEN
599          ! initialisation to zero
600          ssdta(:,:,:) = 0.e0
601          tsdta(:,:,:) = 0.e0
602          vsdta(:,:,:) = 0.e0
603          sshsdta(:,:) = 0.e0
604          vbtsdta(:,:) = 0.e0
605          !                                        ! ================== !
606          IF( nobc_dta == 0 )   THEN               ! initial state used !
607             !                                     ! ================== !
608             !  Fills ssdta, tsdta, vsdta (global arrays)
609             !  Remark: this works for njzoom = 1. Should the definition of ij include njzoom?
610             DO jj = njs0, njs1
611                DO ji = nis0p1, nis1m1
612                   DO jk = 1, jpkm1
613                      ii = ji -1 + nimpp
614                      vbtsdta(ii,1) = vbtsdta(ii,1) + vsdta(ii,jk,1)*fse3v(ji,jj,jk)
615                   END DO
616                   sshsdta(ii,1) = sshn(ji,jj) * tmask(ii,jj,1)
617                END DO
618             END DO
619          ENDIF
620       ENDIF
621
622    ENDIF        !       END IF kt == nit000
623
624    !!------------------------------------------------------------------------------------
625    ! 2.      Initialize the time we are at. Does this every time the routine is called,
626    !         excepted when nobc_dta = 0
627    !
628    IF( nobc_dta == 0) THEN
629       itimo = 1
630       zxy   = 0
631    ELSE
632       IF(ntobc == 1) THEN
633          itimo = 1
634       ELSE IF (ntobc == 12) THEN      !   BC are monthly
635          ! we assume we have climatology in that case
636          iman  = 12
637          i15   = nday / 16
638          imois = nmonth + i15 - 1
639          IF( imois == 0 )   imois = iman
640          itimo = imois
641       ELSE
642          IF(lwp) WRITE(numout,*) 'data other than constant or monthly',kt
643          iman  = ntobc
644          itimo = FLOOR( kt*rdt / tcobc(1))
645          isrel=kt*rdt
646       ENDIF
647    ENDIF
648
649    ! 2. Read two records in the file if necessary
650    ! ---------------------------------------------
651
652    IF( nobc_dta == 1 .AND. nlecto == 1 ) THEN
653
654       IF( lp_obc_east ) THEN
655          ! ... Read datafile and set sea surface height and barotropic velocity
656          ! ... initialise the sshedta, ubtedta arrays
657          sshedta(:,0) = sshedta(:,1)
658          ubtedta(:,0) = ubtedta(:,1)
659          CALL iom_open ( 'obceast_TS.nc', id_e )
660          CALL iom_get ( id_e, jpdom_unknown, 'vossurfh', sshedta(:,1), ktime=ntobc1 )
661          CALL iom_get ( id_e, jpdom_unknown, 'vossurfh', sshedta(:,2), ktime=ntobc2 )
662          IF( lk_dynspg_ts ) THEN
663             CALL iom_get (id_e, jpdom_unknown, 'vossurfh', sshedta(:,3), ktime=ntobc2+1 )
664          ENDIF
665          CALL iom_close ( id_e )
666          !
667          CALL iom_open ( 'obceast_U.nc', id_e )
668          CALL iom_get ( id_e, jpdom_unknown, 'vozoubt', ubtedta(:,1), ktime=ntobc1 )
669          CALL iom_get ( id_e, jpdom_unknown, 'vozoubt', ubtedta(:,2), ktime=ntobc2 )
670          IF( lk_dynspg_ts ) THEN
671             CALL iom_get ( id_e, jpdom_unknown, 'vozoubt', ubtedta(:,3), ktime=ntobc2+1 )
672          ENDIF
673          CALL iom_close ( id_e )
674          ! ... Usually printout is done only once at kt = nit000, unless nprint (namelist) > 1
675          IF( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
676             WRITE(numout,*)
677             WRITE(numout,*) ' Read East OBC barotropic data records ', ntobc1, ntobc2
678             iprint = (jpjef-jpjed+1)/20 +1
679             WRITE(numout,*)
680             WRITE(numout,*) ' Sea surface height record 1'
681             CALL prihre( sshedta(:,1), jpjef-jpjed+1, 1, 1, jpjef-jpjed+1, iprint, 1, 1, -3, 1., numout )
682             WRITE(numout,*)
683             WRITE(numout,*) ' Normal transport (m2/s) record 1',iprint
684             CALL prihre( ubtedta(:,1), jpjef-jpjed+1, 1, 1, jpjef-jpjed+1, iprint, 1, 1, -3, 1., numout )
685          ENDIF
686       ENDIF
687
688       IF( lp_obc_west ) THEN
689          ! ... Read datafile and set temperature, salinity and normal velocity
690          ! ... initialise the swdta, twdta, uwdta arrays
691          sshwdta(:,0) = sshwdta(:,1)
692          ubtwdta(:,0) = ubtwdta(:,1)
693          CALL iom_open ( 'obcwest_TS.nc', id_w )
694          CALL iom_get ( id_w, jpdom_unknown, 'vossurfh', sshwdta(:,1), ktime=ntobc1 )
695          CALL iom_get ( id_w, jpdom_unknown, 'vossurfh', sshwdta(:,2), ktime=ntobc2 )
696          IF( lk_dynspg_ts ) THEN
697             CALL  ( id_w, jpdom_unknown, 'vossurfh', sshwdta(:,3), ktime=ntobc2+1 )
698          ENDIF
699          CALL iom_close ( id_w )
700          !
701          CALL iom_open ( 'obcwest_U.nc', id_w )
702          CALL iom_get ( id_w, jpdom_unknown, 'vozoubt', ubtwdta(:,1), ktime=ntobc1 )
703          CALL iom_get ( id_w, jpdom_unknown, 'vozoubt', ubtwdta(:,2), ktime=ntobc2 )
704          IF( lk_dynspg_ts ) THEN
705             CALL iom_get ( id_w, jpdom_unknown, 'vozoubt', ubtwdta(:,3), ktime=ntobc2+1 )
706          ENDIF
707          CALL iom_close ( id_w )
708          ! ... Usually printout is done only once at kt = nit000, unless nprint (namelist) > 1
709          IF( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
710             WRITE(numout,*)
711             WRITE(numout,*) ' Read West OBC barotropic data records ', ntobc1, ntobc2
712             iprint = (jpjwf-jpjwd+1)/20 +1
713             WRITE(numout,*)
714             WRITE(numout,*) ' Sea surface height record 1  - printout surface level'
715             CALL prihre( sshwdta(:,1), jpjwf-jpjwd+1, 1, 1, jpjwf-jpjwd+1, iprint, 1, 1, -3, 1., numout )
716             WRITE(numout,*)
717             WRITE(numout,*) ' Normal transport (m2/s) record 1'
718             CALL prihre( ubtwdta(:,1), jpjwf-jpjwd+1, 1, 1, jpjwf-jpjwd+1, iprint, 1, 1, -3, 1., numout )
719          ENDIF
720       ENDIF
721
722       IF( lp_obc_north) THEN
723          ! ... Read datafile and set sea surface height and barotropic velocity
724          ! ... initialise the sshndta, ubtndta arrays
725          sshndta(:,0) = sshndta(:,1)
726          vbtndta(:,0) = vbtndta(:,1)
727          CALL iom_open ( 'obcnorth_TS.nc', id_n )
728          CALL iom_get (id_n, jpdom_unknown, 'vossurfh', sshndta(:,1), ktime=ntobc1 )
729          CALL iom_get (id_n, jpdom_unknown, 'vossurfh', sshndta(:,2), ktime=ntobc2 )
730          IF( lk_dynspg_ts ) THEN
731             CALL iom_get (id_n, jpdom_unknown, 'vossurfh', sshndta(:,3), ktime=ntobc2+1 )
732          ENDIF
733          CALL iom_close ( id_n )
734
735          CALL iom_open ( 'obcnorth_V.nc', id_n )
736          CALL iom_get (id_n, jpdom_unknown, 'vomevbt', vbtndta(:,1), ktime=ntobc1 )
737          CALL iom_get (id_n, jpdom_unknown, 'vomevbt', vbtndta(:,2), ktime=ntobc2 )
738          IF( lk_dynspg_ts ) THEN
739             CALL iom_get (id_n, jpdom_unknown, 'vomevbt', vbtndta(:,3), ktime=ntobc2+1 )
740          ENDIF
741          CALL iom_close ( id_n )
742
743          ! ... Usually printout is done only once at kt = nit000, unless nprint (namelist) > 1
744          IF( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
745             WRITE(numout,*)
746             WRITE(numout,*) ' Read North OBC barotropic data records ', ntobc1, ntobc2
747             iprint = (jpinf-jpind+1)/20 +1
748             WRITE(numout,*)
749             WRITE(numout,*) ' Sea surface height record 1  - printout surface level'
750             CALL prihre( sshndta(:,1), jpinf-jpind+1, 1, 1, jpinf-jpind+1, iprint, 1, 1, -3, 1., numout )
751             WRITE(numout,*)
752             WRITE(numout,*) ' Normal transport (m2/s) record 1'
753             CALL prihre( vbtndta(:,1), jpinf-jpind+1, 1, 1, jpinf-jpind+1, iprint, 1, 1, -3, 1., numout )
754          ENDIF
755       ENDIF
756
757       IF( lp_obc_south) THEN
758          ! ... Read datafile and set sea surface height and barotropic velocity
759          ! ... initialise the sshsdta, ubtsdta arrays
760          sshsdta(:,0) = sshsdta(:,1)
761          vbtsdta(:,0) = vbtsdta(:,1)
762          CALL iom_open ( 'obcsouth_TS.nc', id_s )
763          CALL iom_get ( id_s, jpdom_unknown, 'vossurfh', sshsdta(:,1), ktime=ntobc1 )
764          CALL iom_get ( id_s, jpdom_unknown, 'vossurfh', sshsdta(:,2), ktime=ntobc2 )
765          IF( lk_dynspg_ts ) THEN
766             CALL iom_get ( id_s, jpdom_unknown, 'vossurfh', sshsdta(:,3), ktime=ntobc2+1 )
767          ENDIF
768          CALL iom_close ( id_s )
769
770          CALL iom_open ( 'obcsouth_V.nc', id_s )
771          CALL iom_get ( id_s, jpdom_unknown, 'vomevbt', vbtsdta(:,1), ktime=ntobc1 )
772          CALL iom_get ( id_s, jpdom_unknown, 'vomevbt', vbtsdta(:,2), ktime=ntobc2 )
773          IF( lk_dynspg_ts ) THEN
774             CALL iom_get ( id_s, jpdom_unknown, 'vomevbt', vbtsdta(:,3), ktime=ntobc2+1 )
775          ENDIF
776          CALL iom_close ( id_s )
777
778          ! ... Usually printout is done only once at kt = nit000, unless nprint (namelist) > 1
779          IF( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
780             WRITE(numout,*)
781             WRITE(numout,*) ' Read South OBC barotropic data records ', ntobc1, ntobc2
782             iprint = (jpisf-jpisd+1)/20 +1
783             WRITE(numout,*)
784             WRITE(numout,*) ' Sea surface height record 1  - printout surface level'
785             CALL prihre( sshsdta(:,1), jpisf-jpisd+1, 1, 1, jpisf-jpisd+1, iprint, 1, 1, -3, 1., numout )
786             WRITE(numout,*)
787             WRITE(numout,*) ' Normal transport (m2/s) record 1'
788             CALL prihre( vbtsdta(:,1), jpisf-jpisd+1, 1, 1, jpisf-jpisd+1, iprint, 1, 1, -3, 1., numout )
789          ENDIF
790       ENDIF
791
792    ENDIF        !      end of the test on the condition to read or not the files
793
794    ! 3.  Call at every time step : Linear interpolation of BCs to current time step
795    ! ----------------------------------------------------------------------
796
797    IF( lk_dynspg_ts ) THEN
798       isrel = (kt-1)*rdt + kbt*(rdt/REAL(nn_baro,wp))
799
800       IF( nobc_dta == 1 ) THEN
801          isrel = (kt-1)*rdt + kbt*(rdt/REAL(nn_baro,wp))
802          itimo  = FLOOR(  kt*rdt    / (tcobc(2)-tcobc(1)) )
803          itimom = FLOOR( (kt-1)*rdt / (tcobc(2)-tcobc(1)) )
804          itimop = FLOOR( (kt+1)*rdt / (tcobc(2)-tcobc(1)) )
805          IF( itimom == itimo .AND. itimop == itimo ) THEN
806             itobcm = ntobc1
807             itobcp = ntobc2
808
809          ELSEIF ( itimom <= itimo .AND. itimop == itimo ) THEN
810             IF(  FLOOR( isrel / (tcobc(2)-tcobc(1)) ) < itimo ) THEN
811                itobcm = ntobc1-1
812                itobcp = ntobc2-1
813             ELSE
814                itobcm = ntobc1
815                itobcp = ntobc2
816             ENDIF
817
818          ELSEIF ( itimom == itimo .AND. itimop >= itimo ) THEN
819             IF(  FLOOR( isrel / (tcobc(2)-tcobc(1)) ) < itimop ) THEN
820                itobcm = ntobc1
821                itobcp = ntobc2
822             ELSE
823                itobcm = ntobc1+1
824                itobcp = ntobc2+1
825             ENDIF
826
827          ELSEIF ( itimom == itimo-1 .AND. itimop == itimo+1 ) THEN
828             IF(  FLOOR( isrel / (tcobc(2)-tcobc(1)) ) < itimo ) THEN
829                itobcm = ntobc1-1
830                itobcp = ntobc2-1
831             ELSEIF (  FLOOR( isrel / (tcobc(2)-tcobc(1)) ) < itimop ) THEN
832                itobcm = ntobc1
833                itobcp = ntobc2
834             ELSEIF (  FLOOR( isrel / (tcobc(2)-tcobc(1)) ) == itimop ) THEN
835                itobcm = ntobc1+1
836                itobcp = ntobc2+2
837             ELSE
838                IF(lwp) WRITE(numout, *) 'obc_dta_bt: You should not have seen this print! error 1?'
839             ENDIF
840          ELSE
841             IF(lwp) WRITE(numout, *) 'obc_dta_bt: You should not have seen this print! error 2?'
842          ENDIF
843
844       ENDIF
845
846    ELSE IF( lk_dynspg_exp ) THEN
847       isrel=kt*rdt
848       itobcm = ntobc1
849       itobcp = ntobc2
850    ENDIF
851
852    IF( ntobc == 1 .OR. nobc_dta == 0 ) THEN
853       zxy = 0.e0
854    ELSE IF( ntobc == 12 ) THEN
855       zxy = FLOAT( nday + 15 - 30 * i15 ) / 30.
856    ELSE
857       zxy = (tcobc(itobcm)-FLOAT(isrel)) / (tcobc(itobcm)-tcobc(itobcp))
858    ENDIF
859
860    IF( lp_obc_east ) THEN           !  fills sshfoe, ubtfoe (local to each processor)
861       DO jj = nje0p1, nje1m1
862          ij = jj -1 + njmpp
863          sshfoe(jj) = ( zxy * sshedta(ij,2) + (1.-zxy) * sshedta(ij,1) ) * temsk(jj,1)
864          ubtfoe(jj) = ( zxy * ubtedta(ij,2) + (1.-zxy) * ubtedta(ij,1) ) * uemsk(jj,1)
865       END DO
866    ENDIF
867
868    IF( lp_obc_west) THEN            !  fills sshfow, ubtfow (local to each processor)
869       DO jj = njw0p1, njw1m1
870          ij = jj -1 + njmpp
871          sshfow(jj) = ( zxy * sshwdta(ij,2) + (1.-zxy) * sshwdta(ij,1) ) * twmsk(jj,1)
872          ubtfow(jj) = ( zxy * ubtwdta(ij,2) + (1.-zxy) * ubtwdta(ij,1) ) * uwmsk(jj,1)
873       END DO
874    ENDIF
875
876    IF( lp_obc_north) THEN           !  fills sshfon, vbtfon (local to each processor)
877       DO ji = nin0p1, nin1m1
878          ii = ji -1 + nimpp
879          sshfon(ji) = ( zxy * sshndta(ii,2) + (1.-zxy) * sshndta(ii,1) ) * tnmsk(ji,1)
880          vbtfon(ji) = ( zxy * vbtndta(ii,2) + (1.-zxy) * vbtndta(ii,1) ) * vnmsk(ji,1)
881       END DO
882    ENDIF
883
884    IF( lp_obc_south) THEN           !  fills sshfos, vbtfos (local to each processor)
885       DO ji = nis0p1, nis1m1
886          ii = ji -1 + nimpp
887          sshfos(ji) = ( zxy * sshsdta(ii,2) + (1.-zxy) * sshsdta(ii,1) ) * tsmsk(ji,1)
888          vbtfos(ji) = ( zxy * vbtsdta(ii,2) + (1.-zxy) * vbtsdta(ii,1) ) * vsmsk(ji,1)
889       END DO
890    ENDIF
891
892  END SUBROUTINE obc_dta_bt
893
894#else
895  !!-----------------------------------------------------------------------------
896  !!   Default option
897  !!-----------------------------------------------------------------------------
898  SUBROUTINE obc_dta_bt ( kt, kbt )       ! Empty routine
899    !! * Arguments
900    INTEGER,INTENT(in) :: kt
901    INTEGER, INTENT( in ) ::   kbt         ! barotropic ocean time-step index
902    WRITE(*,*) 'obc_dta_bt: You should not have seen this print! error?', kt
903    WRITE(*,*) 'obc_dta_bt: You should not have seen this print! error?', kbt
904  END SUBROUTINE obc_dta_bt
905#endif
906
907
908  !!==============================================================================
909  SUBROUTINE obc_read (kt, nt_x, ntobc_x, iyy, imm)
910     !!-------------------------------------------------------------------------
911     !!                      ***  ROUTINE obc_read  ***
912     !!
913     !! ** Purpose :  Read the boundary data in files identified by iyy and imm
914     !!               According to the validated open boundaries, return the
915     !!               following arrays :
916     !!                sedta, tedta : East OBC salinity and temperature
917     !!                uedta, vedta :   "   "  u and v velocity component     
918     !!
919     !!                swdta, twdta : West OBC salinity and temperature
920     !!                uwdta, vwdta :   "   "  u and v velocity component     
921     !!
922     !!                sndta, tndta : North OBC salinity and temperature
923     !!                undta, vndta :   "   "  u and v velocity component     
924     !!
925     !!                ssdta, tsdta : South OBC salinity and temperature
926     !!                usdta, vsdta :   "   "  u and v velocity component     
927     !!
928     !! ** Method  :  These fields are read in the record ntobc_x of the files.
929     !!               The number of records is already known. If  ntobc_x is greater
930     !!               than the number of record, this routine will look for next file,
931     !!               updating the indices (case of inter-annual obcs) or loop at the
932     !!               begining in case of climatological file (ln_obc_clim = true ).
933     !! -------------------------------------------------------------------------
934     !! History:     !  2005  ( P. Mathiot, C. Langlais ) Original code
935     !!              !  2008  ( J,M, Molines ) Use IOM and cleaning
936     !!--------------------------------------------------------------------------
937
938    ! * Arguments
939    INTEGER, INTENT( in ) :: kt, nt_x
940    INTEGER, INTENT( inout ) :: ntobc_x , iyy, imm      ! yes ! inout !
941
942    ! * Local variables
943    CHARACTER (len=40) :: &    ! file names
944         cl_obc_eTS   , cl_obc_eU,  cl_obc_eV,&
945         cl_obc_wTS   , cl_obc_wU,  cl_obc_wV,&
946         cl_obc_nTS   , cl_obc_nU,  cl_obc_nV,&
947         cl_obc_sTS   , cl_obc_sU,  cl_obc_sV
948
949    INTEGER :: ikprint
950    REAL(wp) :: zmin, zmax   ! control of boundary values
951
952    !IOM stuff
953    INTEGER :: id_e, id_w, id_n, id_s, ji, jj
954    INTEGER, DIMENSION(2) :: istart, icount
955   
956    !--------------------------------------------------------------------------
957    IF ( ntobc_x > itobc ) THEN
958      IF (ln_obc_clim) THEN  ! just loop on the same file
959        ntobc_x = 1 
960      ELSE
961        ! need to change file : it is always for an 'after' data
962        IF ( cffile == 'annual' ) THEN ! go to next year file
963          iyy = iyy + 1
964        ELSE IF ( cffile =='monthly' ) THEN  ! go to next month file
965          imm = imm + 1 
966          IF ( imm == 13 ) THEN
967            imm = 1 ; iyy = iyy + 1
968          ENDIF
969        ELSE
970         ctmp1='obcread : this type of obc file is not supported :( '
971         ctmp2=TRIM(cffile)
972         CALL ctl_stop (ctmp1, ctmp2)
973         ! cffile should be either annual or monthly ...
974        ENDIF
975       ! as the file is changed, need to update itobc etc ...
976        CALL obc_dta_chktime (iyy,imm)
977        ntobc_x = nrecbef() + 1 ! remember : this case occur for an after data
978      ENDIF
979    ENDIF
980
981    IF ( lp_obc_east ) THEN 
982       ! ... Read datafile and set temperature, salinity and normal velocity
983       ! ... initialise the sedta, tedta, uedta arrays
984       WRITE(cl_obc_eTS ,'("obc_east_TS_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
985       WRITE(cl_obc_eU  ,'("obc_east_U_y"   ,i4.4,"m",i2.2,".nc")' ) iyy,imm
986       WRITE(cl_obc_eV  ,'("obc_east_V_y"   ,i4.4,"m",i2.2,".nc")' ) iyy,imm
987       ! JMM this may change depending on the obc data format ...
988       istart(:)=(/nje0+njmpp-1,1/) ; icount(:)=(/nje1-nje0 +1,jpk/)
989       IF (lwp) WRITE(numout,*) 'read data in :', TRIM(cl_obc_eTS)
990       IF (nje1 >= nje0 ) THEN
991          CALL iom_open ( cl_obc_eTS , id_e )
992          CALL iom_get ( id_e, jpdom_unknown, 'votemper', tedta(nje0:nje1,:,nt_x), &
993               &               ktime=ntobc_x , kstart=istart, kcount= icount )
994          CALL iom_get ( id_e, jpdom_unknown, 'vosaline', sedta(nje0:nje1,:,nt_x), &
995               &               ktime=ntobc_x , kstart=istart, kcount= icount )
996          CALL iom_close (id_e)
997          !
998          CALL iom_open ( cl_obc_eU , id_e )
999          CALL iom_get  ( id_e, jpdom_unknown, 'vozocrtx', uedta(nje0:nje1,:,nt_x), &
1000               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1001          CALL iom_close ( id_e )
1002          !
1003          CALL iom_open ( cl_obc_eV , id_e )
1004          CALL iom_get ( id_e, jpdom_unknown, 'vomecrty', vedta(nje0:nje1,:,nt_x), &
1005               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1006          CALL iom_close ( id_e )
1007
1008          ! mask the boundary values
1009          tedta(:,:,nt_x) = tedta(:,:,nt_x)*temsk(:,:) ;  sedta(:,:,nt_x) = sedta(:,:,nt_x)*temsk(:,:)
1010          uedta(:,:,nt_x) = uedta(:,:,nt_x)*uemsk(:,:) ;  vedta(:,:,nt_x) = vedta(:,:,nt_x)*vemsk(:,:)
1011
1012          ! check any outliers
1013          zmin=MINVAL( sedta(:,:,nt_x), mask=ltemsk ) ; zmax=MAXVAL(sedta(:,:,nt_x), mask=ltemsk)
1014          IF (  zmin < 5 .OR. zmax > 50)   THEN
1015             CALL ctl_stop('Error in sedta',' routine obcdta')
1016          ENDIF
1017          zmin=MINVAL( tedta(:,:,nt_x), mask=ltemsk ) ; zmax=MAXVAL(tedta(:,:,nt_x), mask=ltemsk)
1018          IF (  zmin < -10. .OR. zmax > 40)   THEN
1019             CALL ctl_stop('Error in tedta',' routine obcdta')
1020          ENDIF
1021          zmin=MINVAL( uedta(:,:,nt_x), mask=luemsk ) ; zmax=MAXVAL(uedta(:,:,nt_x), mask=luemsk)
1022          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1023             CALL ctl_stop('Error in uedta',' routine obcdta')
1024          ENDIF
1025          zmin=MINVAL( vedta(:,:,nt_x), mask=lvemsk ) ; zmax=MAXVAL(vedta(:,:,nt_x), mask=lvemsk)
1026          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1027             CALL ctl_stop('Error in vedta',' routine obcdta')
1028          ENDIF
1029
1030          !               Usually printout is done only once at kt = nit000, unless nprint (namelist) > 1     
1031          IF ( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
1032             WRITE(numout,*)
1033             WRITE(numout,*) ' Read East OBC data records ', ntobc_x
1034             ikprint = jpj/20 +1
1035             WRITE(numout,*) ' Temperature  record 1 - printout every 3 level'
1036             CALL prihre( tedta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1037             WRITE(numout,*)
1038             WRITE(numout,*) ' Salinity  record 1 - printout every 3 level'
1039             CALL prihre( sedta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1040             WRITE(numout,*)
1041             WRITE(numout,*) ' Normal velocity U  record 1  - printout every 3 level'
1042             CALL prihre( uedta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1043             WRITE(numout,*)
1044             WRITE(numout,*) ' Tangential velocity V  record 1  - printout every 3 level'
1045             CALL prihre( vedta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1046          ENDIF
1047       ENDIF
1048    ENDIF
1049!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1050    IF ( lp_obc_west ) THEN
1051       ! ... Read datafile and set temperature, salinity and normal velocity
1052       ! ... initialise the swdta, twdta, uwdta arrays
1053       WRITE(cl_obc_wTS ,'("obc_west_TS_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1054       WRITE(cl_obc_wU  ,'("obc_west_U_y"   ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1055       WRITE(cl_obc_wV  ,'("obc_west_V_y"   ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1056       istart(:)=(/njw0+njmpp-1,1/) ; icount(:)=(/njw1-njw0 +1,jpk/)
1057       IF (lwp) WRITE(numout,*) 'read data in :', TRIM(cl_obc_wTS)
1058
1059       IF ( njw1 >= njw0 ) THEN
1060          CALL iom_open ( cl_obc_wTS , id_w )
1061          CALL iom_get ( id_w, jpdom_unknown, 'votemper', twdta(njw0:njw1,:,nt_x), & 
1062               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1063
1064          CALL iom_get ( id_w, jpdom_unknown, 'vosaline', swdta(njw0:njw1,:,nt_x), &
1065               &               ktime=ntobc_x , kstart=istart, kcount= icount)
1066          CALL iom_close (id_w)
1067          !
1068          CALL iom_open ( cl_obc_wU , id_w )
1069          CALL iom_get  ( id_w, jpdom_unknown, 'vozocrtx', uwdta(njw0:njw1,:,nt_x),&
1070               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1071          CALL iom_close ( id_w )
1072          !
1073          CALL iom_open ( cl_obc_wV , id_w )
1074          CALL iom_get ( id_w, jpdom_unknown, 'vomecrty', vwdta(njw0:njw1,:,nt_x), &
1075               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1076          CALL iom_close ( id_w )
1077
1078          ! mask the boundary values
1079          twdta(:,:,nt_x) = twdta(:,:,nt_x)*twmsk(:,:) ;  swdta(:,:,nt_x) = swdta(:,:,nt_x)*twmsk(:,:)
1080          uwdta(:,:,nt_x) = uwdta(:,:,nt_x)*uwmsk(:,:) ;  vwdta(:,:,nt_x) = vwdta(:,:,nt_x)*vwmsk(:,:)
1081
1082          ! check any outliers
1083          zmin=MINVAL( swdta(:,:,nt_x), mask=ltwmsk ) ; zmax=MAXVAL(swdta(:,:,nt_x), mask=ltwmsk)
1084          IF (  zmin < 5 .OR. zmax > 50)   THEN
1085             CALL ctl_stop('Error in swdta',' routine obcdta')
1086          ENDIF
1087          zmin=MINVAL( twdta(:,:,nt_x), mask=ltwmsk ) ; zmax=MAXVAL(twdta(:,:,nt_x), mask=ltwmsk)
1088          IF (  zmin < -10. .OR. zmax > 40)   THEN
1089             CALL ctl_stop('Error in twdta',' routine obcdta')
1090          ENDIF
1091          zmin=MINVAL( uwdta(:,:,nt_x), mask=luwmsk ) ; zmax=MAXVAL(uwdta(:,:,nt_x), mask=luwmsk)
1092          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1093             CALL ctl_stop('Error in uwdta',' routine obcdta')
1094          ENDIF
1095          zmin=MINVAL( vwdta(:,:,nt_x), mask=lvwmsk ) ; zmax=MAXVAL(vwdta(:,:,nt_x), mask=lvwmsk)
1096          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1097             CALL ctl_stop('Error in vwdta',' routine obcdta')
1098          ENDIF
1099
1100
1101          IF ( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
1102             WRITE(numout,*)
1103             WRITE(numout,*) ' Read West OBC data records ', ntobc_x
1104             ikprint = jpj/20 +1
1105             WRITE(numout,*) ' Temperature  record 1 - printout every 3 level'
1106             CALL prihre( twdta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1107             WRITE(numout,*)
1108             WRITE(numout,*) ' Salinity  record 1 - printout every 3 level'
1109             CALL prihre( swdta(:,:,nt_x),jpj,jpk, 1, jpj, ikprint,   jpk, 1, -3, 1., numout )
1110             WRITE(numout,*)
1111             WRITE(numout,*) ' Normal velocity U  record 1  - printout every 3 level'
1112             CALL prihre( uwdta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1113             WRITE(numout,*)
1114             WRITE(numout,*) ' Tangential velocity V  record 1  - printout every 3 level'
1115             CALL prihre( vwdta(:,:,nt_x), jpj, jpk, 1, jpj, ikprint, jpk, 1, -3, 1., numout )
1116          ENDIF
1117       END IF
1118    ENDIF
1119!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1120    IF( lp_obc_north) THEN
1121       WRITE(cl_obc_nTS ,'("obc_north_TS_y" ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1122       WRITE(cl_obc_nV  ,'("obc_north_V_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1123       WRITE(cl_obc_nU  ,'("obc_north_U_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1124       istart(:)=(/nin0+nimpp-1,1/) ; icount(:)=(/nin1-nin0 +1,jpk/)
1125       IF (lwp) WRITE(numout,*) 'read data in :', TRIM(cl_obc_nTS)
1126       IF ( nin1 >= nin0 ) THEN
1127          CALL iom_open ( cl_obc_nTS , id_n )
1128          CALL iom_get ( id_n, jpdom_unknown, 'votemper', tndta(nin0:nin1,:,nt_x), &
1129               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1130          CALL iom_get ( id_n, jpdom_unknown, 'vosaline', sndta(nin0:nin1,:,nt_x), &
1131               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1132          CALL iom_close (id_n)
1133          !
1134          CALL iom_open ( cl_obc_nU , id_n )
1135          CALL iom_get  ( id_n, jpdom_unknown, 'vozocrtx', undta(nin0:nin1,:,nt_x), &
1136               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1137          CALL iom_close ( id_n )
1138          !
1139          CALL iom_open ( cl_obc_nV , id_n )
1140          CALL iom_get  ( id_n, jpdom_unknown, 'vomecrty', vndta(nin0:nin1,:,nt_x), &
1141               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1142          CALL iom_close ( id_n )
1143
1144          ! mask the boundary values
1145          tndta(:,:,nt_x) = tndta(:,:,nt_x)*tnmsk(:,:) ;  sndta(:,:,nt_x) = sndta(:,:,nt_x)*tnmsk(:,:)
1146          undta(:,:,nt_x) = undta(:,:,nt_x)*unmsk(:,:) ;  vndta(:,:,nt_x) = vndta(:,:,nt_x)*vnmsk(:,:)
1147
1148          ! check any outliers
1149          zmin=MINVAL( sndta(:,:,nt_x), mask=ltnmsk ) ; zmax=MAXVAL(sndta(:,:,nt_x), mask=ltnmsk)
1150          IF (  zmin < 5 .OR. zmax > 50)   THEN
1151             CALL ctl_stop('Error in sndta',' routine obcdta')
1152          ENDIF
1153          zmin=MINVAL( tndta(:,:,nt_x), mask=ltnmsk ) ; zmax=MAXVAL(tndta(:,:,nt_x), mask=ltnmsk)
1154          IF (  zmin < -10. .OR. zmax > 40)   THEN
1155             CALL ctl_stop('Error in tndta',' routine obcdta')
1156          ENDIF
1157          zmin=MINVAL( undta(:,:,nt_x), mask=lunmsk ) ; zmax=MAXVAL(undta(:,:,nt_x), mask=lunmsk)
1158          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1159             CALL ctl_stop('Error in undta',' routine obcdta')
1160          ENDIF
1161          zmin=MINVAL( vndta(:,:,nt_x), mask=lvnmsk ) ; zmax=MAXVAL(vndta(:,:,nt_x), mask=lvnmsk)
1162          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1163             CALL ctl_stop('Error in vndta',' routine obcdta')
1164          ENDIF
1165
1166          IF ( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
1167             WRITE(numout,*)
1168             WRITE(numout,*) ' Read North OBC data records ', ntobc_x
1169             ikprint = jpi/20 +1
1170             WRITE(numout,*) ' Temperature  record 1 - printout every 3 level'
1171             CALL prihre( tndta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1172             WRITE(numout,*)
1173             WRITE(numout,*) ' Salinity  record 1 - printout every 3 level'
1174             CALL prihre( sndta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1175             WRITE(numout,*)
1176             WRITE(numout,*) ' Normal velocity V  record 1  - printout every 3 level'
1177             CALL prihre( vndta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1178             WRITE(numout,*)
1179             WRITE(numout,*) ' Tangential  velocity U  record 1  - printout every 3 level'
1180             CALL prihre( undta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1181          ENDIF
1182       ENDIF
1183    ENDIF
1184!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1185    IF( lp_obc_south) THEN
1186       WRITE(cl_obc_sTS ,'("obc_south_TS_y" ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1187       WRITE(cl_obc_sV  ,'("obc_south_V_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1188       WRITE(cl_obc_sU  ,'("obc_south_U_y"  ,i4.4,"m",i2.2,".nc")' ) iyy,imm
1189       istart(:)=(/nis0+nimpp-1,1/) ; icount(:)=(/nis1-nis0 +1,jpk/)
1190       IF (lwp) WRITE(numout,*) 'read data in :', TRIM(cl_obc_sTS)
1191       IF ( nis1 >= nis0 ) THEN
1192          CALL iom_open ( cl_obc_sTS , id_s )
1193          CALL iom_get ( id_s, jpdom_unknown, 'votemper', tsdta(nis0:nis1,:,nt_x), &
1194               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1195          CALL iom_get ( id_s, jpdom_unknown, 'vosaline', ssdta(nis0:nis1,:,nt_x), &
1196               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1197          CALL iom_close (id_s)
1198          !
1199          CALL iom_open ( cl_obc_sU , id_s )
1200          CALL iom_get  ( id_s, jpdom_unknown, 'vozocrtx', usdta(nis0:nis1,:,nt_x), &
1201               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1202          CALL iom_close ( id_s )
1203          !
1204          CALL iom_open ( cl_obc_sV , id_s )
1205          CALL iom_get  ( id_s, jpdom_unknown, 'vomecrty', vsdta(nis0:nis1,:,nt_x), &
1206               &               ktime=ntobc_x , kstart=istart, kcount= icount )
1207          CALL iom_close ( id_s )
1208
1209          ! mask the boundary values
1210          tsdta(:,:,nt_x) = tsdta(:,:,nt_x)*tsmsk(:,:) ;  ssdta(:,:,nt_x) = ssdta(:,:,nt_x)*tsmsk(:,:)
1211          usdta(:,:,nt_x) = usdta(:,:,nt_x)*usmsk(:,:) ;  vsdta(:,:,nt_x) = vsdta(:,:,nt_x)*vsmsk(:,:)
1212
1213          ! check any outliers
1214          zmin=MINVAL( ssdta(:,:,nt_x), mask=ltsmsk ) ; zmax=MAXVAL(ssdta(:,:,nt_x), mask=ltsmsk)
1215          IF (  zmin < 5 .OR. zmax > 50)   THEN
1216             CALL ctl_stop('Error in ssdta',' routine obcdta')
1217          ENDIF
1218          zmin=MINVAL( tsdta(:,:,nt_x), mask=ltsmsk ) ; zmax=MAXVAL(tsdta(:,:,nt_x), mask=ltsmsk)
1219          IF (  zmin < -10. .OR. zmax > 40)   THEN
1220             CALL ctl_stop('Error in tsdta',' routine obcdta')
1221          ENDIF
1222          zmin=MINVAL( usdta(:,:,nt_x), mask=lusmsk ) ; zmax=MAXVAL(usdta(:,:,nt_x), mask=lusmsk)
1223          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1224             CALL ctl_stop('Error in usdta',' routine obcdta')
1225          ENDIF
1226          zmin=MINVAL( vsdta(:,:,nt_x), mask=lvsmsk ) ; zmax=MAXVAL(vsdta(:,:,nt_x), mask=lvsmsk)
1227          IF (  zmin < -5. .OR. zmax > 5.)   THEN
1228             CALL ctl_stop('Error in vsdta',' routine obcdta')
1229          ENDIF
1230
1231          IF ( lwp .AND.  ( kt == nit000 .OR. nprint /= 0 )  ) THEN
1232             WRITE(numout,*)
1233             WRITE(numout,*) ' Read South OBC data records ', ntobc_x
1234             ikprint = jpi/20 +1
1235             WRITE(numout,*) ' Temperature  record 1 - printout every 3 level'
1236             CALL prihre( tsdta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1237             WRITE(numout,*)
1238             WRITE(numout,*) ' Salinity  record 1 - printout every 3 level'
1239             CALL prihre( ssdta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1240             WRITE(numout,*)
1241             WRITE(numout,*) ' Normal velocity V  record 1  - printout every 3 level'
1242             CALL prihre( vsdta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1243             WRITE(numout,*)
1244             WRITE(numout,*) ' Tangential velocity U  record 1  - printout every 3 level'
1245             CALL prihre( usdta(:,:,nt_x), jpi, jpk, 1, jpi, ikprint, jpk, 1, -3, 1., numout )
1246          ENDIF
1247       ENDIF
1248    ENDIF
1249!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1250  END SUBROUTINE obc_read 
1251
1252  INTEGER FUNCTION nrecbef()
1253      !!-----------------------------------------------------------------------
1254      !!                     ***    FUNCTION nrecbef   ***
1255      !!
1256      !!  Purpose : - provide the before record number in files, with respect to zjcnes
1257      !!
1258      !!    History : 2008-04 : ( J.M. Molines ) Original code
1259      !!-----------------------------------------------------------------------
1260
1261      INTEGER :: it , idum
1262
1263    idum = itobc
1264    DO it =1, itobc
1265       IF ( ztcobc(it) > zjcnes ) THEN ;  idum = it - 1 ; EXIT ;  ENDIF
1266    ENDDO
1267    ! idum can be 0 (climato, before first record)
1268    IF ( idum == 0 ) THEN
1269       IF ( ln_obc_clim ) THEN
1270         idum = itobc
1271       ELSE
1272         ctmp1='obc_dta: find ntobc == 0 for  non climatological file '
1273         ctmp2='consider adding a first record in your data file '
1274         CALL ctl_stop(ctmp1, ctmp2)
1275       ENDIF
1276    ENDIF
1277    ! idum can be itobc ( zjcnes > ztcobc (itobc) )
1278    !  This is not a problem ...
1279    nrecbef = idum
1280
1281  END FUNCTION nrecbef
1282
1283#else
1284  !!------------------------------------------------------------------------------
1285  !!   default option:           Dummy module          NO Open Boundary Conditions
1286  !!------------------------------------------------------------------------------
1287CONTAINS
1288  SUBROUTINE obc_dta( kt )             ! Dummy routine
1289    INTEGER, INTENT (in) :: kt
1290    WRITE(*,*) 'obc_dta: You should not have seen this print! error?', kt
1291  END SUBROUTINE obc_dta
1292#endif
1293END MODULE obcdta
Note: See TracBrowser for help on using the repository browser.