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 branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/OBC – NEMO

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/OBC/obcdta.F90 @ 2647

Last change on this file since 2647 was 2647, checked in by gm, 11 years ago

dynamic mem: #785 ; OPA_SRC/OBC: move dyn allocation from nemogcm to obcini... (hopefully end)

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