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.

fldread.F90 in branches/2012/dev_CMCC_INGV_2012/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

Context Navigation

source: branches/2012/dev_CMCC_INGV_2012/NEMOGCM/NEMO/OPA_SRC/SBC/fldread.F90 @ 3646

Last change on this file since 3646 was 3646, checked in by vichi, 11 years ago
Add the resulting merged branch from CMCC and INGV 2012 developments
Property svn:keywords set to `Id`
File size: 67.5 KB

Line
1	MODULE fldread
2	!!======================================================================
3	!! * MODULE fldread *
4	!! Ocean forcing: read input field for surface boundary condition
5	!!=====================================================================
6	!! History : 2.0 ! 06-2006 (S. Masson, G. Madec) Original code
7	!! ! 05-2008 (S. Alderson) Modified for Interpolation in memory
8	!! ! from input grid to model grid
9	!!----------------------------------------------------------------------
10
11	!!----------------------------------------------------------------------
12	!! fld_read : read input fields used for the computation of the
13	!! surface boundary condition
14	!!----------------------------------------------------------------------
15	USE oce ! ocean dynamics and tracers
16	USE dom_oce ! ocean space and time domain
17	USE phycst ! ???
18	USE in_out_manager ! I/O manager
19	USE iom ! I/O manager library
20	USE geo2ocean ! for vector rotation on to model grid
21	USE lib_mpp ! MPP library
22	USE wrk_nemo ! work arrays
23	USE ioipsl, ONLY : ymds2ju, ju2ymds ! for calendar
24
25	IMPLICIT NONE
26	PRIVATE
27
28	PUBLIC fld_map ! routine called by tides_init
29
30	TYPE, PUBLIC :: FLD_N !: Namelist field informations
31	CHARACTER(len = 256) :: clname ! generic name of the NetCDF flux file
32	INTEGER :: nfreqh ! frequency of each flux file
33	CHARACTER(len = 34) :: clvar ! generic name of the variable in the NetCDF flux file
34	LOGICAL :: ln_tint ! time interpolation or not (T/F)
35	LOGICAL :: ln_clim ! climatology or not (T/F)
36	CHARACTER(len = 8) :: cltype ! type of data file 'daily', 'monthly' or yearly'
37	CHARACTER(len = 34) :: wname ! generic name of a NetCDF weights file to be used, blank if not
38	CHARACTER(len = 34) :: vcomp ! symbolic component name if a vector that needs rotation
39	! ! a string starting with "U" or "V" for each component
40	! ! chars 2 onwards identify which components go together
41	END TYPE FLD_N
42
43	TYPE, PUBLIC :: FLD !: Input field related variables
44	CHARACTER(len = 256) :: clrootname ! generic name of the NetCDF file
45	CHARACTER(len = 256) :: clname ! current name of the NetCDF file
46	INTEGER :: nfreqh ! frequency of each flux file
47	CHARACTER(len = 34) :: clvar ! generic name of the variable in the NetCDF flux file
48	LOGICAL :: ln_tint ! time interpolation or not (T/F)
49	LOGICAL :: ln_clim ! climatology or not (T/F)
50	CHARACTER(len = 8) :: cltype ! type of data file 'daily', 'monthly' or yearly'
51	INTEGER :: num ! iom id of the jpfld files to be read
52	INTEGER , DIMENSION(2) :: nrec_b ! before record (1: index, 2: second since Jan. 1st 00h of nit000 year)
53	INTEGER , DIMENSION(2) :: nrec_a ! after record (1: index, 2: second since Jan. 1st 00h of nit000 year)
54	REAL(wp) , ALLOCATABLE, DIMENSION(:,:,: ) :: fnow ! input fields interpolated to now time step
55	REAL(wp) , ALLOCATABLE, DIMENSION(:,:,:,:) :: fdta ! 2 consecutive record of input fields
56	CHARACTER(len = 256) :: wgtname ! current name of the NetCDF weight file acting as a key
57	! ! into the WGTLIST structure
58	CHARACTER(len = 34) :: vcomp ! symbolic name for a vector component that needs rotation
59	LOGICAL :: rotn ! flag to indicate whether field has been rotated
60	END TYPE FLD
61
62	TYPE, PUBLIC :: MAP_POINTER !: Array of integer pointers to 1D arrays
63	INTEGER, POINTER :: ptr(:)
64	END TYPE MAP_POINTER
65
66	!$AGRIF_DO_NOT_TREAT
67
68	!! keep list of all weights variables so they're only read in once
69	!! need to add AGRIF directives not to process this structure
70	!! also need to force wgtname to include AGRIF nest number
71	TYPE :: WGT !: Input weights related variables
72	CHARACTER(len = 256) :: wgtname ! current name of the NetCDF weight file
73	INTEGER , DIMENSION(2) :: ddims ! shape of input grid
74	INTEGER , DIMENSION(2) :: botleft ! top left corner of box in input grid containing
75	! ! current processor grid
76	INTEGER , DIMENSION(2) :: topright ! top right corner of box
77	INTEGER :: jpiwgt ! width of box on input grid
78	INTEGER :: jpjwgt ! height of box on input grid
79	INTEGER :: numwgt ! number of weights (4=bilinear, 16=bicubic)
80	INTEGER :: nestid ! for agrif, keep track of nest we're in
81	INTEGER :: overlap ! =0 when cyclic grid has no overlapping EW columns
82	! ! =>1 when they have one or more overlapping columns
83	! ! =-1 not cyclic
84	LOGICAL :: cyclic ! east-west cyclic or not
85	INTEGER, DIMENSION(:,:,:), POINTER :: data_jpi ! array of source integers
86	INTEGER, DIMENSION(:,:,:), POINTER :: data_jpj ! array of source integers
87	REAL(wp), DIMENSION(:,:,:), POINTER :: data_wgt ! array of weights on model grid
88	REAL(wp), DIMENSION(:,:,:), POINTER :: fly_dta ! array of values on input grid
89	REAL(wp), DIMENSION(:,:,:), POINTER :: col ! temporary array for reading in columns
90	END TYPE WGT
91
92	INTEGER, PARAMETER :: tot_wgts = 10
93	TYPE( WGT ), DIMENSION(tot_wgts) :: ref_wgts ! array of wgts
94	INTEGER :: nxt_wgt = 1 ! point to next available space in ref_wgts array
95
96	!$AGRIF_END_DO_NOT_TREAT
97
98	PUBLIC fld_read, fld_fill ! called by sbc... modules
99
100	!!----------------------------------------------------------------------
101	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
102	!! $Id$
103	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
104	!!----------------------------------------------------------------------
105	CONTAINS
106
107	SUBROUTINE fld_read( kt, kn_fsbc, sd, map, jit, time_offset )
108	!!---------------------------------------------------------------------
109	!! * ROUTINE fld_read *
110	!!
111	!! ** Purpose : provide at each time step the surface ocean fluxes
112	!! (momentum, heat, freshwater and runoff)
113	!!
114	!! ** Method : READ each input fields in NetCDF files using IOM
115	!! and intepolate it to the model time-step.
116	!! Several assumptions are made on the input file:
117	!! blahblahblah....
118	!!----------------------------------------------------------------------
119	INTEGER , INTENT(in ) :: kt ! ocean time step
120	INTEGER , INTENT(in ) :: kn_fsbc ! sbc computation period (in time step)
121	TYPE(FLD), INTENT(inout), DIMENSION(:) :: sd ! input field related variables
122	TYPE(MAP_POINTER),INTENT(in), OPTIONAL, DIMENSION(:) :: map ! global-to-local mapping index
123	INTEGER , INTENT(in ), OPTIONAL :: jit ! subcycle timestep for timesplitting option
124	INTEGER , INTENT(in ), OPTIONAL :: time_offset ! provide fields at time other than "now"
125	! time_offset = -1 => fields at "before" time level
126	! time_offset = +1 => fields at "after" time levels
127	! etc.
128	!!
129	INTEGER :: imf ! size of the structure sd
130	INTEGER :: jf ! dummy indices
131	INTEGER :: ireclast ! last record to be read in the current year file
132	INTEGER :: isecend ! number of second since Jan. 1st 00h of nit000 year at nitend
133	INTEGER :: isecsbc ! number of seconds between Jan. 1st 00h of nit000 year and the middle of sbc time step
134	INTEGER :: itime_add ! local time offset variable
135	LOGICAL :: llnxtyr ! open next year file?
136	LOGICAL :: llnxtmth ! open next month file?
137	LOGICAL :: llstop ! stop is the file does not exist
138	LOGICAL :: ll_firstcall ! true if this is the first call to fld_read for this set of fields
139	REAL(wp) :: ztinta ! ratio applied to after records when doing time interpolation
140	REAL(wp) :: ztintb ! ratio applied to before records when doing time interpolation
141	CHARACTER(LEN=1000) :: clfmt ! write format
142	!!---------------------------------------------------------------------
143	ll_firstcall = .false.
144	IF( PRESENT(jit) ) THEN
145	IF(kt == nit000 .and. jit == 1) ll_firstcall = .true.
146	ELSE
147	IF(kt == nit000) ll_firstcall = .true.
148	ENDIF
149
150	itime_add = 0
151	IF( PRESENT(time_offset) ) itime_add = time_offset
152
153	! Note that shifting time to be centrered in the middle of sbc time step impacts only nsec_* variables of the calendar
154	IF( present(jit) ) THEN
155	! ignore kn_fsbc in this case
156	isecsbc = nsec_year + nsec1jan000 + (jit+itime_add)*rdt/REAL(nn_baro,wp)
157	ELSE
158	isecsbc = nsec_year + nsec1jan000 + NINT(0.5 * REAL(kn_fsbc - 1,wp) * rdttra(1)) + itime_add * rdttra(1) ! middle of sbc time step
159	ENDIF
160	imf = SIZE( sd )
161	!
162	IF( ll_firstcall ) THEN ! initialization
163	IF( PRESENT(map) ) THEN
164	DO jf = 1, imf
165	CALL fld_init( kn_fsbc, sd(jf), map(jf)%ptr ) ! read each before field (put them in after as they will be swapped)
166	END DO
167	ELSE
168	DO jf = 1, imf
169	CALL fld_init( kn_fsbc, sd(jf) ) ! read each before field (put them in after as they will be swapped)
170	END DO
171	ENDIF
172	IF( lwp ) CALL wgt_print() ! control print
173	CALL fld_rot( kt, sd ) ! rotate vector fiels if needed
174	ENDIF
175	! ! ====================================== !
176	IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN ! update field at each kn_fsbc time-step !
177	! ! ====================================== !
178	!
179	DO jf = 1, imf ! --- loop over field --- !
180
181	IF( isecsbc > sd(jf)%nrec_a(2) .OR. ll_firstcall ) THEN ! read/update the after data?
182
183	IF( sd(jf)%ln_tint ) THEN ! swap before record field and informations
184	sd(jf)%nrec_b(:) = sd(jf)%nrec_a(:)
185	!CDIR COLLAPSE
186	sd(jf)%fdta(:,:,:,1) = sd(jf)%fdta(:,:,:,2)
187	ENDIF
188
189	IF( PRESENT(jit) ) THEN
190	CALL fld_rec( kn_fsbc, sd(jf), time_offset=itime_add, jit=jit ) ! update record informations
191	ELSE
192	CALL fld_rec( kn_fsbc, sd(jf), time_offset=itime_add ) ! update record informations
193	ENDIF
194
195	! do we have to change the year/month/week/day of the forcing field??
196	IF( sd(jf)%ln_tint ) THEN
197	! if we do time interpolation we will need to open next year/month/week/day file before the end of the current
198	! one. If so, we are still before the end of the year/month/week/day when calling fld_rec so sd(jf)%nrec_a(1)
199	! will be larger than the record number that should be read for current year/month/week/day
200
201	! last record to be read in the current file
202	IF ( sd(jf)%nfreqh == -12 ) THEN ; ireclast = 1 ! yearly mean
203	ELSEIF( sd(jf)%nfreqh == -1 ) THEN ! monthly mean
204	IF( sd(jf)%cltype == 'monthly' ) THEN ; ireclast = 1
205	ELSE ; ireclast = 12
206	ENDIF
207	ELSE ! higher frequency mean (in hours)
208	IF( sd(jf)%cltype == 'monthly' ) THEN ; ireclast = 24 * nmonth_len(nmonth) / sd(jf)%nfreqh
209	ELSEIF( sd(jf)%cltype(1:4) == 'week' ) THEN ; ireclast = 24 * 7 / sd(jf)%nfreqh
210	ELSEIF( sd(jf)%cltype == 'daily' ) THEN ; ireclast = 24 / sd(jf)%nfreqh
211	ELSE ; ireclast = 24 * nyear_len( 1 ) / sd(jf)%nfreqh
212	ENDIF
213	ENDIF
214
215	! do we need next file data?
216	IF( sd(jf)%nrec_a(1) > ireclast ) THEN
217
218	sd(jf)%nrec_a(1) = 1 ! force to read the first record of the next file
219
220	IF( .NOT. sd(jf)%ln_clim ) THEN ! close the current file and open a new one.
221
222	llnxtmth = sd(jf)%cltype == 'monthly' .OR. nday == nmonth_len(nmonth) ! open next month file?
223	llnxtyr = sd(jf)%cltype == 'yearly' .OR. (nmonth == 12 .AND. llnxtmth) ! open next year file?
224
225	! if the run finishes at the end of the current year/month/week/day, we will allow next
226	! year/month/week/day file to be not present. If the run continue further than the current
227	! year/month/week/day, next year/month/week/day file must exist
228	isecend = nsec_year + nsec1jan000 + (nitend - kt) * NINT(rdttra(1)) ! second at the end of the run
229	llstop = isecend > sd(jf)%nrec_a(2) ! read more than 1 record of next year
230
231	CALL fld_clopn( sd(jf), nyear + COUNT((/llnxtyr /)) , &
232	& nmonth + COUNT((/llnxtmth/)) - 12 * COUNT((/llnxtyr /)), &
233	& nday + 1 - nmonth_len(nmonth) * COUNT((/llnxtmth/)), llstop )
234
235	IF( sd(jf)%num <= 0 .AND. .NOT. llstop ) THEN ! next year file does not exist
236	CALL ctl_warn('next year/month/week/day file: '//TRIM(sd(jf)%clname)// &
237	& ' not present -> back to current year/month/day')
238	CALL fld_clopn( sd(jf), nyear, nmonth, nday ) ! back to the current year/month/day
239	sd(jf)%nrec_a(1) = ireclast ! force to read the last record to be read in the current year file
240	ENDIF
241
242	ENDIF
243	ENDIF
244
245	ELSE
246	! if we are not doing time interpolation, we must change the year/month/week/day of the file just after
247	! switching to the NEW year/month/week/day. If it is the case, we are at the beginning of the
248	! year/month/week/day when calling fld_rec so sd(jf)%nrec_a(1) = 1
249	IF( sd(jf)%nrec_a(1) == 1 .AND. .NOT. ( sd(jf)%ln_clim .AND. sd(jf)%cltype == 'yearly' ) ) &
250	& CALL fld_clopn( sd(jf), nyear, nmonth, nday )
251	ENDIF
252
253	! read after data
254	IF( PRESENT(map) ) THEN
255	CALL fld_get( sd(jf), map(jf)%ptr )
256	ELSE
257	CALL fld_get( sd(jf) )
258	ENDIF
259
260	ENDIF
261	END DO ! --- end loop over field --- !
262
263	CALL fld_rot( kt, sd ) ! rotate vector fiels if needed
264
265	DO jf = 1, imf ! --- loop over field --- !
266	!
267	IF( sd(jf)%ln_tint ) THEN ! temporal interpolation
268	IF(lwp .AND. kt - nit000 <= 100 ) THEN
269	clfmt = "('fld_read: var ', a, ' kt = ', i8, ' (', f7.2,' days), Y/M/D = ', i4.4,'/', i2.2,'/', i2.2," // &
270	& "', records b/a: ', i4.4, '/', i4.4, ' (days ', f7.2,'/', f7.2, ')')"
271	WRITE(numout, clfmt) TRIM( sd(jf)%clvar ), kt, REAL(isecsbc,wp)/rday, nyear, nmonth, nday, &
272	& sd(jf)%nrec_b(1), sd(jf)%nrec_a(1), REAL(sd(jf)%nrec_b(2),wp)/rday, REAL(sd(jf)%nrec_a(2),wp)/rday
273	WRITE(numout, *) 'itime_add is : ',itime_add
274	ENDIF
275	! temporal interpolation weights
276	ztinta = REAL( isecsbc - sd(jf)%nrec_b(2), wp ) / REAL( sd(jf)%nrec_a(2) - sd(jf)%nrec_b(2), wp )
277	ztintb = 1. - ztinta
278	!CDIR COLLAPSE
279	sd(jf)%fnow(:,:,:) = ztintb * sd(jf)%fdta(:,:,:,1) + ztinta * sd(jf)%fdta(:,:,:,2)
280	ELSE ! nothing to do...
281	IF(lwp .AND. kt - nit000 <= 100 ) THEN
282	clfmt = "('fld_read: var ', a, ' kt = ', i8,' (', f7.2,' days), Y/M/D = ', i4.4,'/', i2.2,'/', i2.2," // &
283	& "', record: ', i4.4, ' (days ', f7.2, ' <-> ', f7.2, ')')"
284	WRITE(numout, clfmt) TRIM(sd(jf)%clvar), kt, REAL(isecsbc,wp)/rday, nyear, nmonth, nday, &
285	& sd(jf)%nrec_a(1), REAL(sd(jf)%nrec_b(2),wp)/rday, REAL(sd(jf)%nrec_a(2),wp)/rday
286	ENDIF
287	ENDIF
288	!
289	IF( kt == nitend - kn_fsbc + 1 ) CALL iom_close( sd(jf)%num ) ! Close the input files
290
291	END DO ! --- end loop over field --- !
292	!
293	! ! ====================================== !
294	ENDIF ! update field at each kn_fsbc time-step !
295	! ! ====================================== !
296	!
297	END SUBROUTINE fld_read
298
299
300	SUBROUTINE fld_init( kn_fsbc, sdjf, map )
301	!!---------------------------------------------------------------------
302	!! * ROUTINE fld_init *
303	!!
304	!! ** Purpose : - if time interpolation, read before data
305	!! - open current year file
306	!!----------------------------------------------------------------------
307	INTEGER , INTENT(in ) :: kn_fsbc ! sbc computation period (in time step)
308	TYPE(FLD), INTENT(inout) :: sdjf ! input field related variables
309	INTEGER , INTENT(in), OPTIONAL, DIMENSION(:) :: map ! global-to-local mapping indices
310	!!
311	LOGICAL :: llprevyr ! are we reading previous year file?
312	LOGICAL :: llprevmth ! are we reading previous month file?
313	LOGICAL :: llprevweek ! are we reading previous week file?
314	LOGICAL :: llprevday ! are we reading previous day file?
315	LOGICAL :: llprev ! llprevyr .OR. llprevmth .OR. llprevweek .OR. llprevday
316	INTEGER :: idvar ! variable id
317	INTEGER :: inrec ! number of record existing for this variable
318	INTEGER :: iyear, imonth, iday ! first day of the current file in yyyy mm dd
319	INTEGER :: isec_week ! number of seconds since start of the weekly file
320	CHARACTER(LEN=1000) :: clfmt ! write format
321	!!---------------------------------------------------------------------
322
323	! some default definitions...
324	sdjf%num = 0 ! default definition for non-opened file
325	IF( sdjf%ln_clim ) sdjf%clname = TRIM( sdjf%clrootname ) ! file name defaut definition, never change in this case
326	llprevyr = .FALSE.
327	llprevmth = .FALSE.
328	llprevweek = .FALSE.
329	llprevday = .FALSE.
330	isec_week = 0
331
332	IF( sdjf%cltype(1:4) == 'week' .AND. nn_leapy == 0 ) &
333	& CALL ctl_stop('fld_clopn: weekly file ('//TRIM(sdjf%clrootname)//') needs nn_leapy = 1')
334	IF( sdjf%cltype(1:4) == 'week' .AND. sdjf%ln_clim ) &
335	& CALL ctl_stop('fld_clopn: weekly file ('//TRIM(sdjf%clrootname)//') needs ln_clim = .FALSE.')
336
337	! define record informations
338	CALL fld_rec( kn_fsbc, sdjf, ldbefore = .TRUE. ) ! return before values in sdjf%nrec_a (as we will swap it later)
339
340	! Note that shifting time to be centrered in the middle of sbc time step impacts only nsec_* variables of the calendar
341
342	IF( sdjf%ln_tint ) THEN ! we need to read the previous record and we will put it in the current record structure
343
344	IF( sdjf%nrec_a(1) == 0 ) THEN ! we redefine record sdjf%nrec_a(1) with the last record of previous year file
345	IF ( sdjf%nfreqh == -12 ) THEN ! yearly mean
346	IF( sdjf%cltype == 'yearly' ) THEN ! yearly file
347	sdjf%nrec_a(1) = 1 ! force to read the unique record
348	llprevyr = .NOT. sdjf%ln_clim ! use previous year file?
349	ELSE
350	CALL ctl_stop( "fld_init: yearly mean file must be in a yearly type of file: "//TRIM(sdjf%clname) )
351	ENDIF
352	ELSEIF( sdjf%nfreqh == -1 ) THEN ! monthly mean
353	IF( sdjf%cltype == 'monthly' ) THEN ! monthly file
354	sdjf%nrec_a(1) = 1 ! force to read the unique record
355	llprevmth = .TRUE. ! use previous month file?
356	llprevyr = llprevmth .AND. nmonth == 1 ! use previous year file?
357	ELSE ! yearly file
358	sdjf%nrec_a(1) = 12 ! force to read december mean
359	llprevyr = .NOT. sdjf%ln_clim ! use previous year file?
360	ENDIF
361	ELSE ! higher frequency mean (in hours)
362	IF ( sdjf%cltype == 'monthly' ) THEN ! monthly file
363	sdjf%nrec_a(1) = 24 * nmonth_len(nmonth-1) / sdjf%nfreqh ! last record of previous month
364	llprevmth = .TRUE. ! use previous month file?
365	llprevyr = llprevmth .AND. nmonth == 1 ! use previous year file?
366	ELSEIF( sdjf%cltype(1:4) == 'week' ) THEN ! weekly file
367	llprevweek = .TRUE. ! use previous week file?
368	sdjf%nrec_a(1) = 24 * 7 / sdjf%nfreqh ! last record of previous week
369	isec_week = NINT(rday) * 7 ! add a shift toward previous week
370	ELSEIF( sdjf%cltype == 'daily' ) THEN ! daily file
371	sdjf%nrec_a(1) = 24 / sdjf%nfreqh ! last record of previous day
372	llprevday = .TRUE. ! use previous day file?
373	llprevmth = llprevday .AND. nday == 1 ! use previous month file?
374	llprevyr = llprevmth .AND. nmonth == 1 ! use previous year file?
375	ELSE ! yearly file
376	sdjf%nrec_a(1) = 24 * nyear_len(0) / sdjf%nfreqh ! last record of previous year
377	llprevyr = .NOT. sdjf%ln_clim ! use previous year file?
378	ENDIF
379	ENDIF
380	ENDIF
381	IF ( sdjf%cltype(1:4) == 'week' ) THEN
382	isec_week = isec_week + ksec_week( sdjf%cltype(6:8) ) ! second since the beginning of the week
383	llprevmth = isec_week > nsec_month ! longer time since the beginning of the week than the month
384	llprevyr = llprevmth .AND. nmonth == 1
385	ENDIF
386	llprev = llprevyr .OR. llprevmth .OR. llprevweek .OR. llprevday
387	!
388	iyear = nyear - COUNT((/llprevyr /))
389	imonth = nmonth - COUNT((/llprevmth/)) + 12 * COUNT((/llprevyr /))
390	iday = nday - COUNT((/llprevday/)) + nmonth_len(nmonth-1) * COUNT((/llprevmth/)) - isec_week / NINT(rday)
391	!
392	CALL fld_clopn( sdjf, iyear, imonth, iday, .NOT. llprev )
393
394	! if previous year/month/day file does not exist, we switch to the current year/month/day
395	IF( llprev .AND. sdjf%num <= 0 ) THEN
396	CALL ctl_warn( 'previous year/month/week/day file: '//TRIM(sdjf%clname)// &
397	& ' not present -> back to current year/month/week/day' )
398	! we force to read the first record of the current year/month/day instead of last record of previous year/month/day
399	llprev = .FALSE.
400	sdjf%nrec_a(1) = 1
401	CALL fld_clopn( sdjf, nyear, nmonth, nday )
402	ENDIF
403
404	IF( llprev ) THEN ! check if the last record sdjf%nrec_n(1) exists in the file
405	idvar = iom_varid( sdjf%num, sdjf%clvar ) ! id of the variable sdjf%clvar
406	IF( idvar <= 0 ) RETURN
407	inrec = iom_file( sdjf%num )%dimsz( iom_file( sdjf%num )%ndims(idvar), idvar ) ! size of the last dim of idvar
408	sdjf%nrec_a(1) = MIN( sdjf%nrec_a(1), inrec ) ! make sure we select an existing record
409	ENDIF
410
411	! read before data
412	IF( PRESENT(map) ) THEN
413	CALL fld_get( sdjf, map ) ! read before values in after arrays(as we will swap it later)
414	ELSE
415	CALL fld_get( sdjf ) ! read before values in after arrays(as we will swap it later)
416	ENDIF
417
418	clfmt = "('fld_init : time-interpolation for ', a, ' read previous record = ', i4, ' at time = ', f7.2, ' days')"
419	IF(lwp) WRITE(numout, clfmt) TRIM(sdjf%clvar), sdjf%nrec_a(1), REAL(sdjf%nrec_a(2),wp)/rday
420
421	IF( llprev ) CALL iom_close( sdjf%num ) ! force to close previous year file (-> redefine sdjf%num to 0)
422
423	ENDIF
424
425	! make sure current year/month/day file is opened
426	IF( sdjf%num <= 0 ) THEN
427	!
428	IF ( sdjf%cltype(1:4) == 'week' ) THEN
429	isec_week = ksec_week( sdjf%cltype(6:8) ) ! second since the beginning of the week
430	llprevmth = isec_week > nsec_month ! longer time since beginning of the week than the month
431	llprevyr = llprevmth .AND. nmonth == 1
432	ELSE
433	isec_week = 0
434	llprevmth = .FALSE.
435	llprevyr = .FALSE.
436	ENDIF
437	!
438	iyear = nyear - COUNT((/llprevyr /))
439	imonth = nmonth - COUNT((/llprevmth/)) + 12 * COUNT((/llprevyr /))
440	iday = nday + nmonth_len(nmonth-1) * COUNT((/llprevmth/)) - isec_week / NINT(rday)
441	!
442	CALL fld_clopn( sdjf, iyear, imonth, iday )
443	ENDIF
444	!
445	END SUBROUTINE fld_init
446
447
448	SUBROUTINE fld_rec( kn_fsbc, sdjf, ldbefore, jit, time_offset )
449	!!---------------------------------------------------------------------
450	!! * ROUTINE fld_rec *
451	!!
452	!! ** Purpose : Compute
453	!! if sdjf%ln_tint = .TRUE.
454	!! nrec_a: record number and its time (nrec_b is obtained from nrec_a when swapping)
455	!! if sdjf%ln_tint = .FALSE.
456	!! nrec_a(1): record number
457	!! nrec_b(2) and nrec_a(2): time of the beginning and end of the record (for print only)
458	!!----------------------------------------------------------------------
459	INTEGER , INTENT(in ) :: kn_fsbc ! sbc computation period (in time step)
460	TYPE(FLD), INTENT(inout) :: sdjf ! input field related variables
461	LOGICAL , INTENT(in ), OPTIONAL :: ldbefore ! sent back before record values (default = .FALSE.)
462	INTEGER , INTENT(in ), OPTIONAL :: jit ! index of barotropic subcycle
463	! used only if sdjf%ln_tint = .TRUE.
464	INTEGER , INTENT(in ), OPTIONAL :: time_offset ! Offset of required time level compared to "now"
465	! time level in units of time steps.
466	!!
467	LOGICAL :: llbefore ! local definition of ldbefore
468	INTEGER :: iendrec ! end of this record (in seconds)
469	INTEGER :: imth ! month number
470	INTEGER :: ifreq_sec ! frequency mean (in seconds)
471	INTEGER :: isec_week ! number of seconds since the start of the weekly file
472	INTEGER :: itime_add ! local time offset variable
473	REAL(wp) :: ztmp ! temporary variable
474	!!----------------------------------------------------------------------
475	!
476	! Note that shifting time to be centrered in the middle of sbc time step impacts only nsec_* variables of the calendar
477	!
478	IF( PRESENT(ldbefore) ) THEN ; llbefore = ldbefore .AND. sdjf%ln_tint ! needed only if sdjf%ln_tint = .TRUE.
479	ELSE ; llbefore = .FALSE.
480	ENDIF
481	!
482	itime_add = 0
483	IF( PRESENT(time_offset) ) itime_add = time_offset
484	!
485	! ! =========== !
486	IF ( sdjf%nfreqh == -12 ) THEN ! yearly mean
487	! ! =========== !
488	!
489	IF( sdjf%ln_tint ) THEN ! time interpolation, shift by 1/2 record
490	!
491	! INT( ztmp )
492	! /\|\
493	! 1 \| *----
494	! 0 \|----(
495	! \|----+----\|--> time
496	! 0 /\|\ 1 (nday/nyear_len(1))
497	! \|
498	! \|
499	! forcing record : 1
500	!
501	ztmp = REAL( nday, wp ) / REAL( nyear_len(1), wp ) + 0.5
502	IF( PRESENT(jit) ) THEN
503	ztmp = ztmp + (jit+itime_add)*rdt/REAL(nn_baro,wp)
504	ELSE
505	ztmp = ztmp + itime_add*rdttra(1)
506	ENDIF
507	sdjf%nrec_a(1) = 1 + INT( ztmp ) - COUNT((/llbefore/))
508	! swap at the middle of the year
509	IF( llbefore ) THEN ; sdjf%nrec_a(2) = nsec1jan000 - NINT(0.5 * rday) * nyear_len(0)
510	ELSE ; sdjf%nrec_a(2) = nsec1jan000 + NINT(0.5 * rday) * nyear_len(1)
511	ENDIF
512	ELSE ! no time interpolation
513	sdjf%nrec_a(1) = 1
514	sdjf%nrec_a(2) = NINT(rday) * nyear_len(1) + nsec1jan000 ! swap at the end of the year
515	sdjf%nrec_b(2) = nsec1jan000 ! beginning of the year (only for print)
516	ENDIF
517	!
518	! ! ============ !
519	ELSEIF( sdjf%nfreqh == -1 ) THEN ! monthly mean !
520	! ! ============ !
521	!
522	IF( sdjf%ln_tint ) THEN ! time interpolation, shift by 1/2 record
523	!
524	! INT( ztmp )
525	! /\|\
526	! 1 \| *----
527	! 0 \|----(
528	! \|----+----\|--> time
529	! 0 /\|\ 1 (nday/nmonth_len(nmonth))
530	! \|
531	! \|
532	! forcing record : nmonth
533	!
534	ztmp = REAL( nday, wp ) / REAL( nmonth_len(nmonth), wp ) + 0.5
535	IF( PRESENT(jit) ) THEN
536	ztmp = ztmp + (jit+itime_add)*rdt/REAL(nn_baro,wp)
537	ELSE
538	ztmp = ztmp + itime_add*rdttra(1)
539	ENDIF
540	imth = nmonth + INT( ztmp ) - COUNT((/llbefore/))
541	IF( sdjf%cltype == 'monthly' ) THEN ; sdjf%nrec_a(1) = 1 + INT( ztmp ) - COUNT((/llbefore/))
542	ELSE ; sdjf%nrec_a(1) = imth
543	ENDIF
544	sdjf%nrec_a(2) = nmonth_half( imth ) + nsec1jan000 ! swap at the middle of the month
545	ELSE ! no time interpolation
546	IF( sdjf%cltype == 'monthly' ) THEN ; sdjf%nrec_a(1) = 1
547	ELSE ; sdjf%nrec_a(1) = nmonth
548	ENDIF
549	sdjf%nrec_a(2) = nmonth_end(nmonth ) + nsec1jan000 ! swap at the end of the month
550	sdjf%nrec_b(2) = nmonth_end(nmonth-1) + nsec1jan000 ! beginning of the month (only for print)
551	ENDIF
552	!
553	! ! ================================ !
554	ELSE ! higher frequency mean (in hours)
555	! ! ================================ !
556	!
557	ifreq_sec = sdjf%nfreqh * 3600 ! frequency mean (in seconds)
558	IF( sdjf%cltype(1:4) == 'week' ) isec_week = ksec_week( sdjf%cltype(6:8) ) ! since the first day of the current week
559	! number of second since the beginning of the file
560	IF( sdjf%cltype == 'monthly' ) THEN ; ztmp = REAL(nsec_month,wp) ! since the first day of the current month
561	ELSEIF( sdjf%cltype(1:4) == 'week' ) THEN ; ztmp = REAL(isec_week ,wp) ! since the first day of the current week
562	ELSEIF( sdjf%cltype == 'daily' ) THEN ; ztmp = REAL(nsec_day ,wp) ! since 00h of the current day
563	ELSE ; ztmp = REAL(nsec_year ,wp) ! since 00h on Jan 1 of the current year
564	ENDIF
565	ztmp = ztmp + 0.5 * REAL(kn_fsbc - 1, wp) * rdttra(1) ! shift time to be centrered in the middle of sbc time step
566	ztmp = ztmp + 0.01 * rdttra(1) ! add 0.01 time step to avoid truncation error
567	IF( PRESENT(jit) ) THEN
568	ztmp = ztmp + (jit+itime_add)*rdt/REAL(nn_baro,wp)
569	ELSE
570	ztmp = ztmp + itime_add*rdttra(1)
571	ENDIF
572	IF( sdjf%ln_tint ) THEN ! time interpolation, shift by 1/2 record
573	!
574	! INT( ztmp )
575	! /\|\
576	! 2 \| *-----(
577	! 1 \| *-----(
578	! 0 \|--(
579	! \|--+--\|--+--\|--+--\|--> time
580	! 0 /\|\ 1 /\|\ 2 /\|\ 3 (nsec_year/ifreq_sec) or (nsec_month/ifreq_sec)
581	! \| \| \|
582	! \| \| \|
583	! forcing record : 1 2 3
584	!
585	ztmp= ztmp / REAL(ifreq_sec, wp) + 0.5
586	ELSE ! no time interpolation
587	!
588	! INT( ztmp )
589	! /\|\
590	! 2 \| *-----(
591	! 1 \| *-----(
592	! 0 \|-----(
593	! \|--+--\|--+--\|--+--\|--> time
594	! 0 /\|\ 1 /\|\ 2 /\|\ 3 (nsec_year/ifreq_sec) or (nsec_month/ifreq_sec)
595	! \| \| \|
596	! \| \| \|
597	! forcing record : 1 2 3
598	!
599	ztmp= ztmp / REAL(ifreq_sec, wp)
600	ENDIF
601	sdjf%nrec_a(1) = 1 + INT( ztmp ) - COUNT((/llbefore/)) ! record nomber to be read
602
603	iendrec = ifreq_sec * sdjf%nrec_a(1) + nsec1jan000 ! end of this record (in second)
604	! add the number of seconds between 00h Jan 1 and the end of previous month/week/day (ok if nmonth=1)
605	IF( sdjf%cltype == 'monthly' ) iendrec = iendrec + NINT(rday) * SUM(nmonth_len(1:nmonth -1))
606	IF( sdjf%cltype(1:4) == 'week' ) iendrec = iendrec + ( nsec_year - isec_week )
607	IF( sdjf%cltype == 'daily' ) iendrec = iendrec + NINT(rday) * ( nday_year - 1 )
608	IF( sdjf%ln_tint ) THEN
609	sdjf%nrec_a(2) = iendrec - ifreq_sec / 2 ! swap at the middle of the record
610	ELSE
611	sdjf%nrec_a(2) = iendrec ! swap at the end of the record
612	sdjf%nrec_b(2) = iendrec - ifreq_sec ! beginning of the record (only for print)
613	ENDIF
614	!
615	ENDIF
616	!
617	END SUBROUTINE fld_rec
618
619
620	SUBROUTINE fld_get( sdjf, map )
621	!!---------------------------------------------------------------------
622	!! * ROUTINE fld_get *
623	!!
624	!! ** Purpose : read the data
625	!!----------------------------------------------------------------------
626	TYPE(FLD), INTENT(inout) :: sdjf ! input field related variables
627	INTEGER , INTENT(in), OPTIONAL, DIMENSION(:) :: map ! global-to-local mapping indices
628	!!
629	INTEGER :: ipk ! number of vertical levels of sdjf%fdta ( 2D: ipk=1 ; 3D: ipk=jpk )
630	INTEGER :: iw ! index into wgts array
631	!!---------------------------------------------------------------------
632
633	ipk = SIZE( sdjf%fnow, 3 )
634
635	IF( PRESENT(map) ) THEN
636	IF( sdjf%ln_tint ) THEN ; CALL fld_map( sdjf%num, sdjf%clvar, sdjf%fdta(:,:,:,2), sdjf%nrec_a(1), map )
637	ELSE ; CALL fld_map( sdjf%num, sdjf%clvar, sdjf%fnow(:,:,: ), sdjf%nrec_a(1), map )
638	ENDIF
639	ELSE IF( LEN(TRIM(sdjf%wgtname)) > 0 ) THEN
640	CALL wgt_list( sdjf, iw )
641	IF( sdjf%ln_tint ) THEN ; CALL fld_interp( sdjf%num, sdjf%clvar, iw , ipk , sdjf%fdta(:,:,:,2), sdjf%nrec_a(1) )
642	ELSE ; CALL fld_interp( sdjf%num, sdjf%clvar, iw , ipk , sdjf%fnow(:,:,: ), sdjf%nrec_a(1) )
643	ENDIF
644	ELSE
645	SELECT CASE( ipk )
646	CASE(1)
647	IF( sdjf%ln_tint ) THEN ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fdta(:,:,1,2), sdjf%nrec_a(1) )
648	ELSE ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fnow(:,:,1 ), sdjf%nrec_a(1) )
649	ENDIF
650	CASE DEFAULT
651	IF( sdjf%ln_tint ) THEN ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fdta(:,:,:,2), sdjf%nrec_a(1) )
652	ELSE ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fnow(:,:,: ), sdjf%nrec_a(1) )
653	ENDIF
654	END SELECT
655	ENDIF
656	!
657	sdjf%rotn = .false. ! vector not yet rotated
658
659	END SUBROUTINE fld_get
660
661	SUBROUTINE fld_map( num, clvar, dta, nrec, map )
662	!!---------------------------------------------------------------------
663	!! * ROUTINE fld_get *
664	!!
665	!! ** Purpose : read global data from file and map onto local data
666	!! using a general mapping (for open boundaries)
667	!!----------------------------------------------------------------------
668	#if defined key_bdy
669	USE bdy_oce, ONLY: dta_global ! workspace to read in global data arrays
670	#endif
671
672	INTEGER , INTENT(in ) :: num ! stream number
673	CHARACTER(LEN=*) , INTENT(in ) :: clvar ! variable name
674	REAL(wp), DIMENSION(:,:,:), INTENT(out) :: dta ! output field on model grid (2 dimensional)
675	INTEGER , INTENT(in ) :: nrec ! record number to read (ie time slice)
676	INTEGER, DIMENSION(:) , INTENT(in ) :: map ! global-to-local mapping indices
677	!!
678	INTEGER :: ipi ! length of boundary data on local process
679	INTEGER :: ipj ! length of dummy dimension ( = 1 )
680	INTEGER :: ipk ! number of vertical levels of dta ( 2D: ipk=1 ; 3D: ipk=jpk )
681	INTEGER :: ilendta ! length of data in file
682	INTEGER :: idvar ! variable ID
683	INTEGER :: ib, ik ! loop counters
684	INTEGER :: ierr
685	REAL(wp), POINTER, DIMENSION(:,:,:) :: dta_read ! work space for global data
686	!!---------------------------------------------------------------------
687
688	#if defined key_bdy
689	dta_read => dta_global
690	#endif
691
692	ipi = SIZE( dta, 1 )
693	ipj = 1
694	ipk = SIZE( dta, 3 )
695
696	idvar = iom_varid( num, clvar )
697	ilendta = iom_file(num)%dimsz(1,idvar)
698	IF(lwp) WRITE(numout,*) 'Dim size for ',TRIM(clvar),' is ', ilendta
699	IF(lwp) WRITE(numout,*) 'Number of levels for ',TRIM(clvar),' is ', ipk
700
701	SELECT CASE( ipk )
702	CASE(1)
703	CALL iom_get ( num, jpdom_unknown, clvar, dta_read(1:ilendta,1:ipj,1 ), nrec )
704	CASE DEFAULT
705	CALL iom_get ( num, jpdom_unknown, clvar, dta_read(1:ilendta,1:ipj,1:ipk), nrec )
706	END SELECT
707	!
708	DO ib = 1, ipi
709	DO ik = 1, ipk
710	dta(ib,1,ik) = dta_read(map(ib),1,ik)
711	END DO
712	END DO
713
714	END SUBROUTINE fld_map
715
716
717	SUBROUTINE fld_rot( kt, sd )
718	!!---------------------------------------------------------------------
719	!! * ROUTINE fld_rot *
720	!!
721	!! ** Purpose : Vector fields may need to be rotated onto the local grid direction
722	!!----------------------------------------------------------------------
723	INTEGER , INTENT(in ) :: kt ! ocean time step
724	TYPE(FLD), INTENT(inout), DIMENSION(:) :: sd ! input field related variables
725	!!
726	INTEGER :: ju, jv, jk ! loop indices
727	INTEGER :: imf ! size of the structure sd
728	INTEGER :: ill ! character length
729	INTEGER :: iv ! indice of V component
730	REAL(wp), POINTER, DIMENSION(:,:) :: utmp, vtmp ! temporary arrays for vector rotation
731	CHARACTER (LEN=100) :: clcomp ! dummy weight name
732	!!---------------------------------------------------------------------
733
734	CALL wrk_alloc( jpi,jpj, utmp, vtmp )
735
736	!! (sga: following code should be modified so that pairs arent searched for each time
737	!
738	imf = SIZE( sd )
739	DO ju = 1, imf
740	ill = LEN_TRIM( sd(ju)%vcomp )
741	IF( ill > 0 .AND. .NOT. sd(ju)%rotn ) THEN ! find vector rotations required
742	IF( sd(ju)%vcomp(1:1) == 'U' ) THEN ! east-west component has symbolic name starting with 'U'
743	! look for the north-south component which has same symbolic name but with 'U' replaced with 'V'
744	clcomp = 'V' // sd(ju)%vcomp(2:ill) ! works even if ill == 1
745	iv = -1
746	DO jv = 1, imf
747	IF( TRIM(sd(jv)%vcomp) == TRIM(clcomp) ) iv = jv
748	END DO
749	IF( iv > 0 ) THEN ! fields ju and iv are two components which need to be rotated together
750	DO jk = 1, SIZE( sd(ju)%fnow, 3 )
751	IF( sd(ju)%ln_tint )THEN
752	CALL rot_rep( sd(ju)%fdta(:,:,jk,2), sd(iv)%fdta(:,:,jk,2), 'T', 'en->i', utmp(:,:) )
753	CALL rot_rep( sd(ju)%fdta(:,:,jk,2), sd(iv)%fdta(:,:,jk,2), 'T', 'en->j', vtmp(:,:) )
754	sd(ju)%fdta(:,:,jk,2) = utmp(:,:) ; sd(iv)%fdta(:,:,jk,2) = vtmp(:,:)
755	ELSE
756	CALL rot_rep( sd(ju)%fnow(:,:,jk ), sd(iv)%fnow(:,:,jk ), 'T', 'en->i', utmp(:,:) )
757	CALL rot_rep( sd(ju)%fnow(:,:,jk ), sd(iv)%fnow(:,:,jk ), 'T', 'en->j', vtmp(:,:) )
758	sd(ju)%fnow(:,:,jk ) = utmp(:,:) ; sd(iv)%fnow(:,:,jk ) = vtmp(:,:)
759	ENDIF
760	END DO
761	sd(ju)%rotn = .TRUE. ! vector was rotated
762	IF( lwp .AND. kt == nit000 ) WRITE(numout,*) &
763	& 'fld_read: vector pair ('//TRIM(sd(ju)%clvar)//', '//TRIM(sd(iv)%clvar)//') rotated on to model grid'
764	ENDIF
765	ENDIF
766	ENDIF
767	END DO
768	!
769	CALL wrk_dealloc( jpi,jpj, utmp, vtmp )
770	!
771	END SUBROUTINE fld_rot
772
773
774	SUBROUTINE fld_clopn( sdjf, kyear, kmonth, kday, ldstop )
775	!!---------------------------------------------------------------------
776	!! * ROUTINE fld_clopn *
777	!!
778	!! ** Purpose : update the file name and open the file
779	!!----------------------------------------------------------------------
780	TYPE(FLD) , INTENT(inout) :: sdjf ! input field related variables
781	INTEGER , INTENT(in ) :: kyear ! year value
782	INTEGER , INTENT(in ) :: kmonth ! month value
783	INTEGER , INTENT(in ) :: kday ! day value
784	LOGICAL, OPTIONAL, INTENT(in ) :: ldstop ! stop if open to read a non-existing file (default = .TRUE.)
785	!!----------------------------------------------------------------------
786
787	IF( sdjf%num /= 0 ) CALL iom_close( sdjf%num ) ! close file if already open
788	! build the new filename if not climatological data
789	sdjf%clname=TRIM(sdjf%clrootname)
790	!
791	! note that sdjf%ln_clim is is only acting on presence of the year in the file
792	IF( .NOT. sdjf%ln_clim ) THEN
793	WRITE(sdjf%clname, '(a,"_y",i4.4)' ) TRIM( sdjf%clrootname ), kyear ! add year
794	IF( sdjf%cltype /= 'yearly' ) WRITE(sdjf%clname, '(a,"m" ,i2.2)' ) TRIM( sdjf%clname ), kmonth ! add month
795	ELSE
796	! build the new filename if climatological data
797	IF( sdjf%cltype /= 'yearly' ) WRITE(sdjf%clname, '(a,"_m",i2.2)' ) TRIM( sdjf%clrootname ), kmonth ! add month
798	ENDIF
799	IF( sdjf%cltype == 'daily' .OR. sdjf%cltype(1:4) == 'week' ) &
800	& WRITE(sdjf%clname, '(a,"d" ,i2.2)' ) TRIM( sdjf%clname ), kday ! add day
801	!
802	CALL iom_open( sdjf%clname, sdjf%num, ldstop = ldstop, ldiof = LEN(TRIM(sdjf%wgtname)) > 0 )
803	!
804	END SUBROUTINE fld_clopn
805
806
807	SUBROUTINE fld_fill( sdf, sdf_n, cdir, cdcaller, cdtitle, cdnam )
808	!!---------------------------------------------------------------------
809	!! * ROUTINE fld_fill *
810	!!
811	!! ** Purpose : fill sdf with sdf_n and control print
812	!!----------------------------------------------------------------------
813	TYPE(FLD) , DIMENSION(:), INTENT(inout) :: sdf ! structure of input fields (file informations, fields read)
814	TYPE(FLD_N), DIMENSION(:), INTENT(in ) :: sdf_n ! array of namelist information structures
815	CHARACTER(len=*) , INTENT(in ) :: cdir ! Root directory for location of flx files
816	CHARACTER(len=*) , INTENT(in ) :: cdcaller !
817	CHARACTER(len=*) , INTENT(in ) :: cdtitle !
818	CHARACTER(len=*) , INTENT(in ) :: cdnam !
819	!
820	INTEGER :: jf ! dummy indices
821	!!---------------------------------------------------------------------
822
823	DO jf = 1, SIZE(sdf)
824	sdf(jf)%clrootname = TRIM( cdir )//TRIM( sdf_n(jf)%clname )
825	sdf(jf)%nfreqh = sdf_n(jf)%nfreqh
826	sdf(jf)%clvar = sdf_n(jf)%clvar
827	sdf(jf)%ln_tint = sdf_n(jf)%ln_tint
828	sdf(jf)%ln_clim = sdf_n(jf)%ln_clim
829	sdf(jf)%cltype = sdf_n(jf)%cltype
830	sdf(jf)%wgtname = " "
831	IF( LEN( TRIM(sdf_n(jf)%wname) ) > 0 ) sdf(jf)%wgtname = TRIM( cdir )//TRIM( sdf_n(jf)%wname )
832	sdf(jf)%vcomp = sdf_n(jf)%vcomp
833	sdf(jf)%rotn = .FALSE.
834	END DO
835
836	IF(lwp) THEN ! control print
837	WRITE(numout,*)
838	WRITE(numout,*) TRIM( cdcaller )//' : '//TRIM( cdtitle )
839	WRITE(numout,*) (/ ('~', jf = 1, LEN_TRIM( cdcaller ) ) /)
840	WRITE(numout,*) ' '//TRIM( cdnam )//' Namelist'
841	WRITE(numout,*) ' list of files and frequency (>0: in hours ; <0 in months)'
842	DO jf = 1, SIZE(sdf)
843	WRITE(numout,*) ' root filename: ' , TRIM( sdf(jf)%clrootname ), &
844	& ' variable name: ' , TRIM( sdf(jf)%clvar )
845	WRITE(numout,*) ' frequency: ' , sdf(jf)%nfreqh , &
846	& ' time interp: ' , sdf(jf)%ln_tint , &
847	& ' climatology: ' , sdf(jf)%ln_clim , &
848	& ' weights : ' , TRIM( sdf(jf)%wgtname ), &
849	& ' pairing : ' , TRIM( sdf(jf)%vcomp ), &
850	& ' data type: ' , sdf(jf)%cltype
851	call flush(numout)
852	END DO
853	ENDIF
854
855	END SUBROUTINE fld_fill
856
857
858	SUBROUTINE wgt_list( sd, kwgt )
859	!!---------------------------------------------------------------------
860	!! * ROUTINE wgt_list *
861	!!
862	!! ** Purpose : search array of WGTs and find a weights file
863	!! entry, or return a new one adding it to the end
864	!! if it is a new entry, the weights data is read in and
865	!! restructured (fld_weight)
866	!!----------------------------------------------------------------------
867	TYPE( FLD ), INTENT(in ) :: sd ! field with name of weights file
868	INTEGER , INTENT(inout) :: kwgt ! index of weights
869	!!
870	INTEGER :: kw, nestid ! local integer
871	LOGICAL :: found ! local logical
872	!!----------------------------------------------------------------------
873	!
874	!! search down linked list
875	!! weights filename is either present or we hit the end of the list
876	found = .FALSE.
877
878	!! because agrif nest part of filenames are now added in iom_open
879	!! to distinguish between weights files on the different grids, need to track
880	!! nest number explicitly
881	nestid = 0
882	#if defined key_agrif
883	nestid = Agrif_Fixed()
884	#endif
885	DO kw = 1, nxt_wgt-1
886	IF( TRIM(ref_wgts(kw)%wgtname) == TRIM(sd%wgtname) .AND. &
887	ref_wgts(kw)%nestid == nestid) THEN
888	kwgt = kw
889	found = .TRUE.
890	EXIT
891	ENDIF
892	END DO
893	IF( .NOT.found ) THEN
894	kwgt = nxt_wgt
895	CALL fld_weight( sd )
896	ENDIF
897	!
898	END SUBROUTINE wgt_list
899
900
901	SUBROUTINE wgt_print( )
902	!!---------------------------------------------------------------------
903	!! * ROUTINE wgt_print *
904	!!
905	!! ** Purpose : print the list of known weights
906	!!----------------------------------------------------------------------
907	INTEGER :: kw !
908	!!----------------------------------------------------------------------
909	!
910	DO kw = 1, nxt_wgt-1
911	WRITE(numout,*) 'weight file: ',TRIM(ref_wgts(kw)%wgtname)
912	WRITE(numout,*) ' ddims: ',ref_wgts(kw)%ddims(1),ref_wgts(kw)%ddims(2)
913	WRITE(numout,*) ' numwgt: ',ref_wgts(kw)%numwgt
914	WRITE(numout,*) ' jpiwgt: ',ref_wgts(kw)%jpiwgt
915	WRITE(numout,*) ' jpjwgt: ',ref_wgts(kw)%jpjwgt
916	WRITE(numout,*) ' botleft: ',ref_wgts(kw)%botleft
917	WRITE(numout,*) ' topright: ',ref_wgts(kw)%topright
918	IF( ref_wgts(kw)%cyclic ) THEN
919	WRITE(numout,*) ' cyclical'
920	IF( ref_wgts(kw)%overlap > 0 ) WRITE(numout,*) ' with overlap of ', ref_wgts(kw)%overlap
921	ELSE
922	WRITE(numout,*) ' not cyclical'
923	ENDIF
924	IF( ASSOCIATED(ref_wgts(kw)%data_wgt) ) WRITE(numout,*) ' allocated'
925	END DO
926	!
927	END SUBROUTINE wgt_print
928
929
930	SUBROUTINE fld_weight( sd )
931	!!---------------------------------------------------------------------
932	!! * ROUTINE fld_weight *
933	!!
934	!! ** Purpose : create a new WGT structure and fill in data from
935	!! file, restructuring as required
936	!!----------------------------------------------------------------------
937	TYPE( FLD ), INTENT(in) :: sd ! field with name of weights file
938	!!
939	INTEGER :: jn ! dummy loop indices
940	INTEGER :: inum ! temporary logical unit
941	INTEGER :: id ! temporary variable id
942	INTEGER :: ipk ! temporary vertical dimension
943	CHARACTER (len=5) :: aname
944	INTEGER , DIMENSION(3) :: ddims
945	INTEGER , POINTER, DIMENSION(:,:) :: data_src
946	REAL(wp), POINTER, DIMENSION(:,:) :: data_tmp
947	LOGICAL :: cyclical
948	INTEGER :: zwrap ! local integer
949	!!----------------------------------------------------------------------
950	!
951	CALL wrk_alloc( jpi,jpj, data_src ) ! integer
952	CALL wrk_alloc( jpi,jpj, data_tmp )
953	!
954	IF( nxt_wgt > tot_wgts ) THEN
955	CALL ctl_stop("fld_weight: weights array size exceeded, increase tot_wgts")
956	ENDIF
957	!
958	!! new weights file entry, add in extra information
959	!! a weights file represents a 2D grid of a certain shape, so we assume that the current
960	!! input data file is representative of all other files to be opened and processed with the
961	!! current weights file
962
963	!! open input data file (non-model grid)
964	CALL iom_open( sd%clname, inum, ldiof = LEN(TRIM(sd%wgtname)) > 0 )
965
966	!! get dimensions
967	id = iom_varid( inum, sd%clvar, ddims )
968
969	!! close it
970	CALL iom_close( inum )
971
972	!! now open the weights file
973
974	CALL iom_open ( sd%wgtname, inum ) ! interpolation weights
975	IF ( inum > 0 ) THEN
976
977	!! determine whether we have an east-west cyclic grid
978	!! from global attribute called "ew_wrap" in the weights file
979	!! note that if not found, iom_getatt returns -999 and cyclic with no overlap is assumed
980	!! since this is the most common forcing configuration
981
982	CALL iom_getatt(inum, 'ew_wrap', zwrap)
983	IF( zwrap >= 0 ) THEN
984	cyclical = .TRUE.
985	ELSE IF( zwrap == -999 ) THEN
986	cyclical = .TRUE.
987	zwrap = 0
988	ELSE
989	cyclical = .FALSE.
990	ENDIF
991
992	ref_wgts(nxt_wgt)%ddims(1) = ddims(1)
993	ref_wgts(nxt_wgt)%ddims(2) = ddims(2)
994	ref_wgts(nxt_wgt)%wgtname = sd%wgtname
995	ref_wgts(nxt_wgt)%overlap = zwrap
996	ref_wgts(nxt_wgt)%cyclic = cyclical
997	ref_wgts(nxt_wgt)%nestid = 0
998	#if defined key_agrif
999	ref_wgts(nxt_wgt)%nestid = Agrif_Fixed()
1000	#endif
1001	!! weights file is stored as a set of weights (wgt01->wgt04 or wgt01->wgt16)
1002	!! for each weight wgtNN there is an integer array srcNN which gives the point in
1003	!! the input data grid which is to be multiplied by the weight
1004	!! they are both arrays on the model grid so the result of the multiplication is
1005	!! added into an output array on the model grid as a running sum
1006
1007	!! two possible cases: bilinear (4 weights) or bicubic (16 weights)
1008	id = iom_varid(inum, 'src05', ldstop=.FALSE.)
1009	IF( id <= 0) THEN
1010	ref_wgts(nxt_wgt)%numwgt = 4
1011	ELSE
1012	ref_wgts(nxt_wgt)%numwgt = 16
1013	ENDIF
1014
1015	ALLOCATE( ref_wgts(nxt_wgt)%data_jpi(jpi,jpj,4) )
1016	ALLOCATE( ref_wgts(nxt_wgt)%data_jpj(jpi,jpj,4) )
1017	ALLOCATE( ref_wgts(nxt_wgt)%data_wgt(jpi,jpj,ref_wgts(nxt_wgt)%numwgt) )
1018
1019	DO jn = 1,4
1020	aname = ' '
1021	WRITE(aname,'(a3,i2.2)') 'src',jn
1022	data_tmp(:,:) = 0
1023	CALL iom_get ( inum, jpdom_data, aname, data_tmp(:,:) )
1024	data_src(:,:) = INT(data_tmp(:,:))
1025	ref_wgts(nxt_wgt)%data_jpj(:,:,jn) = 1 + (data_src(:,:)-1) / ref_wgts(nxt_wgt)%ddims(1)
1026	ref_wgts(nxt_wgt)%data_jpi(:,:,jn) = data_src(:,:) - ref_wgts(nxt_wgt)%ddims(1)*(ref_wgts(nxt_wgt)%data_jpj(:,:,jn)-1)
1027	END DO
1028
1029	DO jn = 1, ref_wgts(nxt_wgt)%numwgt
1030	aname = ' '
1031	WRITE(aname,'(a3,i2.2)') 'wgt',jn
1032	ref_wgts(nxt_wgt)%data_wgt(:,:,jn) = 0.0
1033	CALL iom_get ( inum, jpdom_data, aname, ref_wgts(nxt_wgt)%data_wgt(:,:,jn) )
1034	END DO
1035	CALL iom_close (inum)
1036
1037	! find min and max indices in grid
1038	ref_wgts(nxt_wgt)%botleft(1) = MINVAL(ref_wgts(nxt_wgt)%data_jpi(:,:,:))
1039	ref_wgts(nxt_wgt)%botleft(2) = MINVAL(ref_wgts(nxt_wgt)%data_jpj(:,:,:))
1040	ref_wgts(nxt_wgt)%topright(1) = MAXVAL(ref_wgts(nxt_wgt)%data_jpi(:,:,:))
1041	ref_wgts(nxt_wgt)%topright(2) = MAXVAL(ref_wgts(nxt_wgt)%data_jpj(:,:,:))
1042
1043	! and therefore dimensions of the input box
1044	ref_wgts(nxt_wgt)%jpiwgt = ref_wgts(nxt_wgt)%topright(1) - ref_wgts(nxt_wgt)%botleft(1) + 1
1045	ref_wgts(nxt_wgt)%jpjwgt = ref_wgts(nxt_wgt)%topright(2) - ref_wgts(nxt_wgt)%botleft(2) + 1
1046
1047	! shift indexing of source grid
1048	ref_wgts(nxt_wgt)%data_jpi(:,:,:) = ref_wgts(nxt_wgt)%data_jpi(:,:,:) - ref_wgts(nxt_wgt)%botleft(1) + 1
1049	ref_wgts(nxt_wgt)%data_jpj(:,:,:) = ref_wgts(nxt_wgt)%data_jpj(:,:,:) - ref_wgts(nxt_wgt)%botleft(2) + 1
1050
1051	! create input grid, give it a halo to allow gradient calculations
1052	! SA: +3 stencil is a patch to avoid out-of-bound computation in some configuration.
1053	! a more robust solution will be given in next release
1054	ipk = SIZE(sd%fnow, 3)
1055	ALLOCATE( ref_wgts(nxt_wgt)%fly_dta(ref_wgts(nxt_wgt)%jpiwgt+3, ref_wgts(nxt_wgt)%jpjwgt+3 ,ipk) )
1056	IF( ref_wgts(nxt_wgt)%cyclic ) ALLOCATE( ref_wgts(nxt_wgt)%col(1,ref_wgts(nxt_wgt)%jpjwgt+3,ipk) )
1057
1058	nxt_wgt = nxt_wgt + 1
1059
1060	ELSE
1061	CALL ctl_stop( ' fld_weight : unable to read the file ' )
1062	ENDIF
1063
1064	CALL wrk_dealloc( jpi,jpj, data_src ) ! integer
1065	CALL wrk_dealloc( jpi,jpj, data_tmp )
1066	!
1067	END SUBROUTINE fld_weight
1068
1069
1070	SUBROUTINE fld_interp( num, clvar, kw, kk, dta, nrec )
1071	!!---------------------------------------------------------------------
1072	!! * ROUTINE fld_interp *
1073	!!
1074	!! ** Purpose : apply weights to input gridded data to create data
1075	!! on model grid
1076	!!----------------------------------------------------------------------
1077	INTEGER , INTENT(in ) :: num ! stream number
1078	CHARACTER(LEN=*) , INTENT(in ) :: clvar ! variable name
1079	INTEGER , INTENT(in ) :: kw ! weights number
1080	INTEGER , INTENT(in ) :: kk ! vertical dimension of kk
1081	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: dta ! output field on model grid
1082	INTEGER , INTENT(in ) :: nrec ! record number to read (ie time slice)
1083	!!
1084	INTEGER, DIMENSION(3) :: rec1,recn ! temporary arrays for start and length
1085	INTEGER :: jk, jn, jm ! loop counters
1086	INTEGER :: ni, nj ! lengths
1087	INTEGER :: jpimin,jpiwid ! temporary indices
1088	INTEGER :: jpjmin,jpjwid ! temporary indices
1089	INTEGER :: jpi1,jpi2,jpj1,jpj2 ! temporary indices
1090	!!----------------------------------------------------------------------
1091	!
1092	!! for weighted interpolation we have weights at four corners of a box surrounding
1093	!! a model grid point, each weight is multiplied by a grid value (bilinear case)
1094	!! or by a grid value and gradients at the corner point (bicubic case)
1095	!! so we need to have a 4 by 4 subgrid surrounding each model point to cover both cases
1096
1097	!! sub grid from non-model input grid which encloses all grid points in this nemo process
1098	jpimin = ref_wgts(kw)%botleft(1)
1099	jpjmin = ref_wgts(kw)%botleft(2)
1100	jpiwid = ref_wgts(kw)%jpiwgt
1101	jpjwid = ref_wgts(kw)%jpjwgt
1102
1103	!! when reading in, expand this sub-grid by one halo point all the way round for calculating gradients
1104	rec1(1) = MAX( jpimin-1, 1 )
1105	rec1(2) = MAX( jpjmin-1, 1 )
1106	rec1(3) = 1
1107	recn(1) = MIN( jpiwid+2, ref_wgts(kw)%ddims(1)-rec1(1)+1 )
1108	recn(2) = MIN( jpjwid+2, ref_wgts(kw)%ddims(2)-rec1(2)+1 )
1109	recn(3) = kk
1110
1111	!! where we need to put it in the non-nemo grid fly_dta
1112	!! note that jpi1 and jpj1 only differ from 1 when jpimin and jpjmin are 1
1113	!! (ie at the extreme west or south of the whole input grid) and similarly for jpi2 and jpj2
1114	jpi1 = 2 + rec1(1) - jpimin
1115	jpj1 = 2 + rec1(2) - jpjmin
1116	jpi2 = jpi1 + recn(1) - 1
1117	jpj2 = jpj1 + recn(2) - 1
1118
1119	ref_wgts(kw)%fly_dta(:,:,:) = 0.0
1120	SELECT CASE( SIZE(ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,:),3) )
1121	CASE(1)
1122	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,1), nrec, rec1, recn)
1123	CASE DEFAULT
1124	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,:), nrec, rec1, recn)
1125	END SELECT
1126
1127	!! first four weights common to both bilinear and bicubic
1128	!! data_jpi, data_jpj have already been shifted to (1,1) corresponding to botleft
1129	!! note that we have to offset by 1 into fly_dta array because of halo
1130	dta(:,:,:) = 0.0
1131	DO jk = 1,4
1132	DO jn = 1, jpj
1133	DO jm = 1,jpi
1134	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1135	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1136	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk) * ref_wgts(kw)%fly_dta(ni+1,nj+1,:)
1137	END DO
1138	END DO
1139	END DO
1140
1141	IF (ref_wgts(kw)%numwgt .EQ. 16) THEN
1142
1143	!! fix up halo points that we couldnt read from file
1144	IF( jpi1 == 2 ) THEN
1145	ref_wgts(kw)%fly_dta(jpi1-1,:,:) = ref_wgts(kw)%fly_dta(jpi1,:,:)
1146	ENDIF
1147	IF( jpi2 + jpimin - 1 == ref_wgts(kw)%ddims(1)+1 ) THEN
1148	ref_wgts(kw)%fly_dta(jpi2+1,:,:) = ref_wgts(kw)%fly_dta(jpi2,:,:)
1149	ENDIF
1150	IF( jpj1 == 2 ) THEN
1151	ref_wgts(kw)%fly_dta(:,jpj1-1,:) = ref_wgts(kw)%fly_dta(:,jpj1,:)
1152	ENDIF
1153	IF( jpj2 + jpjmin - 1 == ref_wgts(kw)%ddims(2)+1 .AND. jpj2 .lt. jpjwid+2 ) THEN
1154	ref_wgts(kw)%fly_dta(:,jpj2+1,:) = 2.0*ref_wgts(kw)%fly_dta(:,jpj2,:) - ref_wgts(kw)%fly_dta(:,jpj2-1,:)
1155	ENDIF
1156
1157	!! if data grid is cyclic we can do better on east-west edges
1158	!! but have to allow for whether first and last columns are coincident
1159	IF( ref_wgts(kw)%cyclic ) THEN
1160	rec1(2) = MAX( jpjmin-1, 1 )
1161	recn(1) = 1
1162	recn(2) = MIN( jpjwid+2, ref_wgts(kw)%ddims(2)-rec1(2)+1 )
1163	jpj1 = 2 + rec1(2) - jpjmin
1164	jpj2 = jpj1 + recn(2) - 1
1165	IF( jpi1 == 2 ) THEN
1166	rec1(1) = ref_wgts(kw)%ddims(1) - ref_wgts(kw)%overlap
1167	SELECT CASE( SIZE( ref_wgts(kw)%col(:,jpj1:jpj2,:),3) )
1168	CASE(1)
1169	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,1), nrec, rec1, recn)
1170	CASE DEFAULT
1171	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,:), nrec, rec1, recn)
1172	END SELECT
1173	ref_wgts(kw)%fly_dta(jpi1-1,jpj1:jpj2,:) = ref_wgts(kw)%col(1,jpj1:jpj2,:)
1174	ENDIF
1175	IF( jpi2 + jpimin - 1 == ref_wgts(kw)%ddims(1)+1 ) THEN
1176	rec1(1) = 1 + ref_wgts(kw)%overlap
1177	SELECT CASE( SIZE( ref_wgts(kw)%col(:,jpj1:jpj2,:),3) )
1178	CASE(1)
1179	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,1), nrec, rec1, recn)
1180	CASE DEFAULT
1181	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,:), nrec, rec1, recn)
1182	END SELECT
1183	ref_wgts(kw)%fly_dta(jpi2+1,jpj1:jpj2,:) = ref_wgts(kw)%col(1,jpj1:jpj2,:)
1184	ENDIF
1185	ENDIF
1186
1187	! gradient in the i direction
1188	DO jk = 1,4
1189	DO jn = 1, jpj
1190	DO jm = 1,jpi
1191	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1192	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1193	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+4) * 0.5 * &
1194	(ref_wgts(kw)%fly_dta(ni+2,nj+1,:) - ref_wgts(kw)%fly_dta(ni,nj+1,:))
1195	END DO
1196	END DO
1197	END DO
1198
1199	! gradient in the j direction
1200	DO jk = 1,4
1201	DO jn = 1, jpj
1202	DO jm = 1,jpi
1203	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1204	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1205	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+8) * 0.5 * &
1206	(ref_wgts(kw)%fly_dta(ni+1,nj+2,:) - ref_wgts(kw)%fly_dta(ni+1,nj,:))
1207	END DO
1208	END DO
1209	END DO
1210
1211	! gradient in the ij direction
1212	DO jk = 1,4
1213	DO jn = 1, jpj
1214	DO jm = 1,jpi
1215	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1216	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1217	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+12) * 0.25 * ( &
1218	(ref_wgts(kw)%fly_dta(ni+2,nj+2,:) - ref_wgts(kw)%fly_dta(ni ,nj+2,:)) - &
1219	(ref_wgts(kw)%fly_dta(ni+2,nj ,:) - ref_wgts(kw)%fly_dta(ni ,nj ,:)))
1220	END DO
1221	END DO
1222	END DO
1223	!
1224	END IF
1225	!
1226	END SUBROUTINE fld_interp
1227
1228
1229	FUNCTION ksec_week( cdday )
1230	!!---------------------------------------------------------------------
1231	!! * FUNCTION kshift_week *
1232	!!
1233	!! ** Purpose :
1234	!!---------------------------------------------------------------------
1235	CHARACTER(len=*), INTENT(in) :: cdday !3 first letters of the first day of the weekly file
1236	!!
1237	INTEGER :: ksec_week ! output variable
1238	INTEGER :: ijul !temp variable
1239	INTEGER :: ishift !temp variable
1240	CHARACTER(len=3),DIMENSION(7) :: cl_week
1241	!!----------------------------------------------------------------------
1242	cl_week = (/"sun","sat","fri","thu","wed","tue","mon"/)
1243	DO ijul = 1, 7
1244	IF( cl_week(ijul) == TRIM(cdday) ) EXIT
1245	END DO
1246	IF( ijul .GT. 7 ) CALL ctl_stop( 'ksec_week: wrong day for sdjf%cltype(6:8): '//TRIM(cdday) )
1247	!
1248	ishift = ijul * NINT(rday)
1249	!
1250	ksec_week = nsec_week + ishift
1251	ksec_week = MOD( ksec_week, 7*NINT(rday) )
1252	!
1253	END FUNCTION ksec_week
1254
1255	!!======================================================================
1256	END MODULE fldread

Note: See TracBrowser for help on using the repository browser.

Download in other formats: