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_v3_4_STABLE_2012/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

Context Navigation

source: branches/2012/dev_v3_4_STABLE_2012/NEMOGCM/NEMO/OPA_SRC/SBC/fldread.F90 @ 4783

Last change on this file since 4783 was 4783, checked in by jamesharle, 10 years ago
Correction to monthly and yearly interpolation in fld_rec subroutine (see ticket #1201 for details)
Property svn:keywords set to `Id`
File size: 67.9 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( nsec_year, wp ) / ( REAL( nyear_len(1), wp ) * rday ) + 0.5
502	IF( PRESENT(jit) ) THEN
503	ztmp = ztmp + (jit+itime_add)rdt/REAL(nn_baro,wp) / ( REAL( nyear_len(1), wp ) rday )
504	ELSE
505	ztmp = ztmp + itime_addrdttra(1) / ( REAL( nyear_len(1), wp ) rday )
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 - (1 - INT(ztmp)) * NINT(0.5 * rday) * nyear_len(0) + &
510	& INT(ztmp) * NINT( 0.5 * rday) * nyear_len(1)
511	ELSE ; sdjf%nrec_a(2) = nsec1jan000 + (1 - INT(ztmp)) * NINT(0.5 * rday) * nyear_len(1) + &
512	& INT(ztmp) * INT(rday) * nyear_len(1) + INT(ztmp) * NINT( 0.5 * rday) * nyear_len(2)
513	ENDIF
514	ELSE ! no time interpolation
515	sdjf%nrec_a(1) = 1
516	sdjf%nrec_a(2) = NINT(rday) * nyear_len(1) + nsec1jan000 ! swap at the end of the year
517	sdjf%nrec_b(2) = nsec1jan000 ! beginning of the year (only for print)
518	ENDIF
519	!
520	! ! ============ !
521	ELSEIF( sdjf%nfreqh == -1 ) THEN ! monthly mean !
522	! ! ============ !
523	!
524	IF( sdjf%ln_tint ) THEN ! time interpolation, shift by 1/2 record
525	!
526	! INT( ztmp )
527	! /\|\
528	! 1 \| *----
529	! 0 \|----(
530	! \|----+----\|--> time
531	! 0 /\|\ 1 (nday/nmonth_len(nmonth))
532	! \|
533	! \|
534	! forcing record : nmonth
535	!
536	ztmp = REAL( nsec_month, wp ) / ( REAL( nmonth_len(nmonth), wp ) * rday ) + 0.5
537	IF( PRESENT(jit) ) THEN
538	ztmp = ztmp + (jit+itime_add)rdt/REAL(nn_baro,wp) / ( REAL( nmonth_len(nmonth), wp ) rday )
539	ELSE
540	ztmp = ztmp + itime_addrdttra(1) / ( REAL( nmonth_len(nmonth), wp ) rday )
541	ENDIF
542	imth = nmonth + INT( ztmp ) - COUNT((/llbefore/))
543	IF( sdjf%cltype == 'monthly' ) THEN ; sdjf%nrec_a(1) = 1 + INT( ztmp ) - COUNT((/llbefore/))
544	ELSE ; sdjf%nrec_a(1) = imth
545	ENDIF
546	sdjf%nrec_a(2) = nmonth_half( imth ) + nsec1jan000 ! swap at the middle of the month
547	ELSE ! no time interpolation
548	IF( sdjf%cltype == 'monthly' ) THEN ; sdjf%nrec_a(1) = 1
549	ELSE ; sdjf%nrec_a(1) = nmonth
550	ENDIF
551	sdjf%nrec_a(2) = nmonth_end(nmonth ) + nsec1jan000 ! swap at the end of the month
552	sdjf%nrec_b(2) = nmonth_end(nmonth-1) + nsec1jan000 ! beginning of the month (only for print)
553	ENDIF
554	!
555	! ! ================================ !
556	ELSE ! higher frequency mean (in hours)
557	! ! ================================ !
558	!
559	ifreq_sec = sdjf%nfreqh * 3600 ! frequency mean (in seconds)
560	IF( sdjf%cltype(1:4) == 'week' ) isec_week = ksec_week( sdjf%cltype(6:8) ) ! since the first day of the current week
561	! number of second since the beginning of the file
562	IF( sdjf%cltype == 'monthly' ) THEN ; ztmp = REAL(nsec_month,wp) ! since the first day of the current month
563	ELSEIF( sdjf%cltype(1:4) == 'week' ) THEN ; ztmp = REAL(isec_week ,wp) ! since the first day of the current week
564	ELSEIF( sdjf%cltype == 'daily' ) THEN ; ztmp = REAL(nsec_day ,wp) ! since 00h of the current day
565	ELSE ; ztmp = REAL(nsec_year ,wp) ! since 00h on Jan 1 of the current year
566	ENDIF
567	ztmp = ztmp + 0.5 * REAL(kn_fsbc - 1, wp) * rdttra(1) ! shift time to be centrered in the middle of sbc time step
568	ztmp = ztmp + 0.01 * rdttra(1) ! add 0.01 time step to avoid truncation error
569	IF( PRESENT(jit) ) THEN
570	ztmp = ztmp + (jit+itime_add)*rdt/REAL(nn_baro,wp)
571	ELSE
572	ztmp = ztmp + itime_add*rdttra(1)
573	ENDIF
574	IF( sdjf%ln_tint ) THEN ! time interpolation, shift by 1/2 record
575	!
576	! INT( ztmp )
577	! /\|\
578	! 2 \| *-----(
579	! 1 \| *-----(
580	! 0 \|--(
581	! \|--+--\|--+--\|--+--\|--> time
582	! 0 /\|\ 1 /\|\ 2 /\|\ 3 (nsec_year/ifreq_sec) or (nsec_month/ifreq_sec)
583	! \| \| \|
584	! \| \| \|
585	! forcing record : 1 2 3
586	!
587	ztmp= ztmp / REAL(ifreq_sec, wp) + 0.5
588	ELSE ! no time interpolation
589	!
590	! INT( ztmp )
591	! /\|\
592	! 2 \| *-----(
593	! 1 \| *-----(
594	! 0 \|-----(
595	! \|--+--\|--+--\|--+--\|--> time
596	! 0 /\|\ 1 /\|\ 2 /\|\ 3 (nsec_year/ifreq_sec) or (nsec_month/ifreq_sec)
597	! \| \| \|
598	! \| \| \|
599	! forcing record : 1 2 3
600	!
601	ztmp= ztmp / REAL(ifreq_sec, wp)
602	ENDIF
603	sdjf%nrec_a(1) = 1 + INT( ztmp ) - COUNT((/llbefore/)) ! record nomber to be read
604
605	iendrec = ifreq_sec * sdjf%nrec_a(1) + nsec1jan000 ! end of this record (in second)
606	! add the number of seconds between 00h Jan 1 and the end of previous month/week/day (ok if nmonth=1)
607	IF( sdjf%cltype == 'monthly' ) iendrec = iendrec + NINT(rday) * SUM(nmonth_len(1:nmonth -1))
608	IF( sdjf%cltype(1:4) == 'week' ) iendrec = iendrec + ( nsec_year - isec_week )
609	IF( sdjf%cltype == 'daily' ) iendrec = iendrec + NINT(rday) * ( nday_year - 1 )
610	IF( sdjf%ln_tint ) THEN
611	sdjf%nrec_a(2) = iendrec - ifreq_sec / 2 ! swap at the middle of the record
612	ELSE
613	sdjf%nrec_a(2) = iendrec ! swap at the end of the record
614	sdjf%nrec_b(2) = iendrec - ifreq_sec ! beginning of the record (only for print)
615	ENDIF
616	!
617	ENDIF
618	!
619	END SUBROUTINE fld_rec
620
621
622	SUBROUTINE fld_get( sdjf, map )
623	!!---------------------------------------------------------------------
624	!! * ROUTINE fld_get *
625	!!
626	!! ** Purpose : read the data
627	!!----------------------------------------------------------------------
628	TYPE(FLD), INTENT(inout) :: sdjf ! input field related variables
629	INTEGER , INTENT(in), OPTIONAL, DIMENSION(:) :: map ! global-to-local mapping indices
630	!!
631	INTEGER :: ipk ! number of vertical levels of sdjf%fdta ( 2D: ipk=1 ; 3D: ipk=jpk )
632	INTEGER :: iw ! index into wgts array
633	!!---------------------------------------------------------------------
634
635	ipk = SIZE( sdjf%fnow, 3 )
636
637	IF( PRESENT(map) ) THEN
638	IF( sdjf%ln_tint ) THEN ; CALL fld_map( sdjf%num, sdjf%clvar, sdjf%fdta(:,:,:,2), sdjf%nrec_a(1), map )
639	ELSE ; CALL fld_map( sdjf%num, sdjf%clvar, sdjf%fnow(:,:,: ), sdjf%nrec_a(1), map )
640	ENDIF
641	ELSE IF( LEN(TRIM(sdjf%wgtname)) > 0 ) THEN
642	CALL wgt_list( sdjf, iw )
643	IF( sdjf%ln_tint ) THEN ; CALL fld_interp( sdjf%num, sdjf%clvar, iw , ipk , sdjf%fdta(:,:,:,2), sdjf%nrec_a(1) )
644	ELSE ; CALL fld_interp( sdjf%num, sdjf%clvar, iw , ipk , sdjf%fnow(:,:,: ), sdjf%nrec_a(1) )
645	ENDIF
646	ELSE
647	SELECT CASE( ipk )
648	CASE(1)
649	IF( sdjf%ln_tint ) THEN ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fdta(:,:,1,2), sdjf%nrec_a(1) )
650	ELSE ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fnow(:,:,1 ), sdjf%nrec_a(1) )
651	ENDIF
652	CASE DEFAULT
653	IF( sdjf%ln_tint ) THEN ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fdta(:,:,:,2), sdjf%nrec_a(1) )
654	ELSE ; CALL iom_get( sdjf%num, jpdom_data, sdjf%clvar, sdjf%fnow(:,:,: ), sdjf%nrec_a(1) )
655	ENDIF
656	END SELECT
657	ENDIF
658	!
659	sdjf%rotn = .false. ! vector not yet rotated
660
661	END SUBROUTINE fld_get
662
663	SUBROUTINE fld_map( num, clvar, dta, nrec, map )
664	!!---------------------------------------------------------------------
665	!! * ROUTINE fld_get *
666	!!
667	!! ** Purpose : read global data from file and map onto local data
668	!! using a general mapping (for open boundaries)
669	!!----------------------------------------------------------------------
670	#if defined key_bdy
671	USE bdy_oce, ONLY: dta_global ! workspace to read in global data arrays
672	#endif
673
674	INTEGER , INTENT(in ) :: num ! stream number
675	CHARACTER(LEN=*) , INTENT(in ) :: clvar ! variable name
676	REAL(wp), DIMENSION(:,:,:), INTENT(out) :: dta ! output field on model grid (2 dimensional)
677	INTEGER , INTENT(in ) :: nrec ! record number to read (ie time slice)
678	INTEGER, DIMENSION(:) , INTENT(in ) :: map ! global-to-local mapping indices
679	!!
680	INTEGER :: ipi ! length of boundary data on local process
681	INTEGER :: ipj ! length of dummy dimension ( = 1 )
682	INTEGER :: ipk ! number of vertical levels of dta ( 2D: ipk=1 ; 3D: ipk=jpk )
683	INTEGER :: ilendta ! length of data in file
684	INTEGER :: idvar ! variable ID
685	INTEGER :: ib, ik ! loop counters
686	INTEGER :: ierr
687	REAL(wp), POINTER, DIMENSION(:,:,:) :: dta_read ! work space for global data
688	!!---------------------------------------------------------------------
689
690	#if defined key_bdy
691	dta_read => dta_global
692	#endif
693
694	ipi = SIZE( dta, 1 )
695	ipj = 1
696	ipk = SIZE( dta, 3 )
697
698	idvar = iom_varid( num, clvar )
699	ilendta = iom_file(num)%dimsz(1,idvar)
700	IF(lwp) WRITE(numout,*) 'Dim size for ',TRIM(clvar),' is ', ilendta
701	IF(lwp) WRITE(numout,*) 'Number of levels for ',TRIM(clvar),' is ', ipk
702
703	SELECT CASE( ipk )
704	CASE(1)
705	CALL iom_get ( num, jpdom_unknown, clvar, dta_read(1:ilendta,1:ipj,1 ), nrec )
706	CASE DEFAULT
707	CALL iom_get ( num, jpdom_unknown, clvar, dta_read(1:ilendta,1:ipj,1:ipk), nrec )
708	END SELECT
709	!
710	DO ib = 1, ipi
711	DO ik = 1, ipk
712	dta(ib,1,ik) = dta_read(map(ib),1,ik)
713	END DO
714	END DO
715
716	END SUBROUTINE fld_map
717
718
719	SUBROUTINE fld_rot( kt, sd )
720	!!---------------------------------------------------------------------
721	!! * ROUTINE fld_rot *
722	!!
723	!! ** Purpose : Vector fields may need to be rotated onto the local grid direction
724	!!----------------------------------------------------------------------
725	INTEGER , INTENT(in ) :: kt ! ocean time step
726	TYPE(FLD), INTENT(inout), DIMENSION(:) :: sd ! input field related variables
727	!!
728	INTEGER :: ju, jv, jk ! loop indices
729	INTEGER :: imf ! size of the structure sd
730	INTEGER :: ill ! character length
731	INTEGER :: iv ! indice of V component
732	REAL(wp), POINTER, DIMENSION(:,:) :: utmp, vtmp ! temporary arrays for vector rotation
733	CHARACTER (LEN=100) :: clcomp ! dummy weight name
734	!!---------------------------------------------------------------------
735
736	CALL wrk_alloc( jpi,jpj, utmp, vtmp )
737
738	!! (sga: following code should be modified so that pairs arent searched for each time
739	!
740	imf = SIZE( sd )
741	DO ju = 1, imf
742	ill = LEN_TRIM( sd(ju)%vcomp )
743	IF( ill > 0 .AND. .NOT. sd(ju)%rotn ) THEN ! find vector rotations required
744	IF( sd(ju)%vcomp(1:1) == 'U' ) THEN ! east-west component has symbolic name starting with 'U'
745	! look for the north-south component which has same symbolic name but with 'U' replaced with 'V'
746	clcomp = 'V' // sd(ju)%vcomp(2:ill) ! works even if ill == 1
747	iv = -1
748	DO jv = 1, imf
749	IF( TRIM(sd(jv)%vcomp) == TRIM(clcomp) ) iv = jv
750	END DO
751	IF( iv > 0 ) THEN ! fields ju and iv are two components which need to be rotated together
752	DO jk = 1, SIZE( sd(ju)%fnow, 3 )
753	IF( sd(ju)%ln_tint )THEN
754	CALL rot_rep( sd(ju)%fdta(:,:,jk,2), sd(iv)%fdta(:,:,jk,2), 'T', 'en->i', utmp(:,:) )
755	CALL rot_rep( sd(ju)%fdta(:,:,jk,2), sd(iv)%fdta(:,:,jk,2), 'T', 'en->j', vtmp(:,:) )
756	sd(ju)%fdta(:,:,jk,2) = utmp(:,:) ; sd(iv)%fdta(:,:,jk,2) = vtmp(:,:)
757	ELSE
758	CALL rot_rep( sd(ju)%fnow(:,:,jk ), sd(iv)%fnow(:,:,jk ), 'T', 'en->i', utmp(:,:) )
759	CALL rot_rep( sd(ju)%fnow(:,:,jk ), sd(iv)%fnow(:,:,jk ), 'T', 'en->j', vtmp(:,:) )
760	sd(ju)%fnow(:,:,jk ) = utmp(:,:) ; sd(iv)%fnow(:,:,jk ) = vtmp(:,:)
761	ENDIF
762	END DO
763	sd(ju)%rotn = .TRUE. ! vector was rotated
764	IF( lwp .AND. kt == nit000 ) WRITE(numout,*) &
765	& 'fld_read: vector pair ('//TRIM(sd(ju)%clvar)//', '//TRIM(sd(iv)%clvar)//') rotated on to model grid'
766	ENDIF
767	ENDIF
768	ENDIF
769	END DO
770	!
771	CALL wrk_dealloc( jpi,jpj, utmp, vtmp )
772	!
773	END SUBROUTINE fld_rot
774
775
776	SUBROUTINE fld_clopn( sdjf, kyear, kmonth, kday, ldstop )
777	!!---------------------------------------------------------------------
778	!! * ROUTINE fld_clopn *
779	!!
780	!! ** Purpose : update the file name and open the file
781	!!----------------------------------------------------------------------
782	TYPE(FLD) , INTENT(inout) :: sdjf ! input field related variables
783	INTEGER , INTENT(in ) :: kyear ! year value
784	INTEGER , INTENT(in ) :: kmonth ! month value
785	INTEGER , INTENT(in ) :: kday ! day value
786	LOGICAL, OPTIONAL, INTENT(in ) :: ldstop ! stop if open to read a non-existing file (default = .TRUE.)
787	!!----------------------------------------------------------------------
788
789	IF( sdjf%num /= 0 ) CALL iom_close( sdjf%num ) ! close file if already open
790	! build the new filename if not climatological data
791	sdjf%clname=TRIM(sdjf%clrootname)
792	!
793	! note that sdjf%ln_clim is is only acting on presence of the year in the file
794	IF( .NOT. sdjf%ln_clim ) THEN
795	WRITE(sdjf%clname, '(a,"_y",i4.4)' ) TRIM( sdjf%clrootname ), kyear ! add year
796	IF( sdjf%cltype /= 'yearly' ) WRITE(sdjf%clname, '(a,"m" ,i2.2)' ) TRIM( sdjf%clname ), kmonth ! add month
797	ELSE
798	! build the new filename if climatological data
799	IF( sdjf%cltype /= 'yearly' ) WRITE(sdjf%clname, '(a,"_m",i2.2)' ) TRIM( sdjf%clrootname ), kmonth ! add month
800	ENDIF
801	IF( sdjf%cltype == 'daily' .OR. sdjf%cltype(1:4) == 'week' ) &
802	& WRITE(sdjf%clname, '(a,"d" ,i2.2)' ) TRIM( sdjf%clname ), kday ! add day
803	!
804	CALL iom_open( sdjf%clname, sdjf%num, ldstop = ldstop, ldiof = LEN(TRIM(sdjf%wgtname)) > 0 )
805	!
806	END SUBROUTINE fld_clopn
807
808
809	SUBROUTINE fld_fill( sdf, sdf_n, cdir, cdcaller, cdtitle, cdnam )
810	!!---------------------------------------------------------------------
811	!! * ROUTINE fld_fill *
812	!!
813	!! ** Purpose : fill sdf with sdf_n and control print
814	!!----------------------------------------------------------------------
815	TYPE(FLD) , DIMENSION(:), INTENT(inout) :: sdf ! structure of input fields (file informations, fields read)
816	TYPE(FLD_N), DIMENSION(:), INTENT(in ) :: sdf_n ! array of namelist information structures
817	CHARACTER(len=*) , INTENT(in ) :: cdir ! Root directory for location of flx files
818	CHARACTER(len=*) , INTENT(in ) :: cdcaller !
819	CHARACTER(len=*) , INTENT(in ) :: cdtitle !
820	CHARACTER(len=*) , INTENT(in ) :: cdnam !
821	!
822	INTEGER :: jf ! dummy indices
823	!!---------------------------------------------------------------------
824
825	DO jf = 1, SIZE(sdf)
826	sdf(jf)%clrootname = TRIM( cdir )//TRIM( sdf_n(jf)%clname )
827	sdf(jf)%nfreqh = sdf_n(jf)%nfreqh
828	sdf(jf)%clvar = sdf_n(jf)%clvar
829	sdf(jf)%ln_tint = sdf_n(jf)%ln_tint
830	sdf(jf)%ln_clim = sdf_n(jf)%ln_clim
831	sdf(jf)%cltype = sdf_n(jf)%cltype
832	sdf(jf)%wgtname = " "
833	IF( LEN( TRIM(sdf_n(jf)%wname) ) > 0 ) sdf(jf)%wgtname = TRIM( cdir )//TRIM( sdf_n(jf)%wname )
834	sdf(jf)%vcomp = sdf_n(jf)%vcomp
835	sdf(jf)%rotn = .TRUE.
836	END DO
837
838	IF(lwp) THEN ! control print
839	WRITE(numout,*)
840	WRITE(numout,*) TRIM( cdcaller )//' : '//TRIM( cdtitle )
841	WRITE(numout,*) (/ ('~', jf = 1, LEN_TRIM( cdcaller ) ) /)
842	WRITE(numout,*) ' '//TRIM( cdnam )//' Namelist'
843	WRITE(numout,*) ' list of files and frequency (>0: in hours ; <0 in months)'
844	DO jf = 1, SIZE(sdf)
845	WRITE(numout,*) ' root filename: ' , TRIM( sdf(jf)%clrootname ), &
846	& ' variable name: ' , TRIM( sdf(jf)%clvar )
847	WRITE(numout,*) ' frequency: ' , sdf(jf)%nfreqh , &
848	& ' time interp: ' , sdf(jf)%ln_tint , &
849	& ' climatology: ' , sdf(jf)%ln_clim , &
850	& ' weights : ' , TRIM( sdf(jf)%wgtname ), &
851	& ' pairing : ' , TRIM( sdf(jf)%vcomp ), &
852	& ' data type: ' , sdf(jf)%cltype
853	call flush(numout)
854	END DO
855	ENDIF
856
857	END SUBROUTINE fld_fill
858
859
860	SUBROUTINE wgt_list( sd, kwgt )
861	!!---------------------------------------------------------------------
862	!! * ROUTINE wgt_list *
863	!!
864	!! ** Purpose : search array of WGTs and find a weights file
865	!! entry, or return a new one adding it to the end
866	!! if it is a new entry, the weights data is read in and
867	!! restructured (fld_weight)
868	!!----------------------------------------------------------------------
869	TYPE( FLD ), INTENT(in ) :: sd ! field with name of weights file
870	INTEGER , INTENT(inout) :: kwgt ! index of weights
871	!!
872	INTEGER :: kw, nestid ! local integer
873	LOGICAL :: found ! local logical
874	!!----------------------------------------------------------------------
875	!
876	!! search down linked list
877	!! weights filename is either present or we hit the end of the list
878	found = .FALSE.
879
880	!! because agrif nest part of filenames are now added in iom_open
881	!! to distinguish between weights files on the different grids, need to track
882	!! nest number explicitly
883	nestid = 0
884	#if defined key_agrif
885	nestid = Agrif_Fixed()
886	#endif
887	DO kw = 1, nxt_wgt-1
888	IF( TRIM(ref_wgts(kw)%wgtname) == TRIM(sd%wgtname) .AND. &
889	ref_wgts(kw)%nestid == nestid) THEN
890	kwgt = kw
891	found = .TRUE.
892	EXIT
893	ENDIF
894	END DO
895	IF( .NOT.found ) THEN
896	kwgt = nxt_wgt
897	CALL fld_weight( sd )
898	ENDIF
899	!
900	END SUBROUTINE wgt_list
901
902
903	SUBROUTINE wgt_print( )
904	!!---------------------------------------------------------------------
905	!! * ROUTINE wgt_print *
906	!!
907	!! ** Purpose : print the list of known weights
908	!!----------------------------------------------------------------------
909	INTEGER :: kw !
910	!!----------------------------------------------------------------------
911	!
912	DO kw = 1, nxt_wgt-1
913	WRITE(numout,*) 'weight file: ',TRIM(ref_wgts(kw)%wgtname)
914	WRITE(numout,*) ' ddims: ',ref_wgts(kw)%ddims(1),ref_wgts(kw)%ddims(2)
915	WRITE(numout,*) ' numwgt: ',ref_wgts(kw)%numwgt
916	WRITE(numout,*) ' jpiwgt: ',ref_wgts(kw)%jpiwgt
917	WRITE(numout,*) ' jpjwgt: ',ref_wgts(kw)%jpjwgt
918	WRITE(numout,*) ' botleft: ',ref_wgts(kw)%botleft
919	WRITE(numout,*) ' topright: ',ref_wgts(kw)%topright
920	IF( ref_wgts(kw)%cyclic ) THEN
921	WRITE(numout,*) ' cyclical'
922	IF( ref_wgts(kw)%overlap > 0 ) WRITE(numout,*) ' with overlap of ', ref_wgts(kw)%overlap
923	ELSE
924	WRITE(numout,*) ' not cyclical'
925	ENDIF
926	IF( ASSOCIATED(ref_wgts(kw)%data_wgt) ) WRITE(numout,*) ' allocated'
927	END DO
928	!
929	END SUBROUTINE wgt_print
930
931
932	SUBROUTINE fld_weight( sd )
933	!!---------------------------------------------------------------------
934	!! * ROUTINE fld_weight *
935	!!
936	!! ** Purpose : create a new WGT structure and fill in data from
937	!! file, restructuring as required
938	!!----------------------------------------------------------------------
939	TYPE( FLD ), INTENT(in) :: sd ! field with name of weights file
940	!!
941	INTEGER :: jn ! dummy loop indices
942	INTEGER :: inum ! temporary logical unit
943	INTEGER :: id ! temporary variable id
944	INTEGER :: ipk ! temporary vertical dimension
945	CHARACTER (len=5) :: aname
946	INTEGER , DIMENSION(3) :: ddims
947	INTEGER , POINTER, DIMENSION(:,:) :: data_src
948	REAL(wp), POINTER, DIMENSION(:,:) :: data_tmp
949	LOGICAL :: cyclical
950	INTEGER :: zwrap ! local integer
951	!!----------------------------------------------------------------------
952	!
953	CALL wrk_alloc( jpi,jpj, data_src ) ! integer
954	CALL wrk_alloc( jpi,jpj, data_tmp )
955	!
956	IF( nxt_wgt > tot_wgts ) THEN
957	CALL ctl_stop("fld_weight: weights array size exceeded, increase tot_wgts")
958	ENDIF
959	!
960	!! new weights file entry, add in extra information
961	!! a weights file represents a 2D grid of a certain shape, so we assume that the current
962	!! input data file is representative of all other files to be opened and processed with the
963	!! current weights file
964
965	!! open input data file (non-model grid)
966	CALL iom_open( sd%clname, inum, ldiof = LEN(TRIM(sd%wgtname)) > 0 )
967
968	!! get dimensions
969	id = iom_varid( inum, sd%clvar, ddims )
970
971	!! close it
972	CALL iom_close( inum )
973
974	!! now open the weights file
975
976	CALL iom_open ( sd%wgtname, inum ) ! interpolation weights
977	IF ( inum > 0 ) THEN
978
979	!! determine whether we have an east-west cyclic grid
980	!! from global attribute called "ew_wrap" in the weights file
981	!! note that if not found, iom_getatt returns -999 and cyclic with no overlap is assumed
982	!! since this is the most common forcing configuration
983
984	CALL iom_getatt(inum, 'ew_wrap', zwrap)
985	IF( zwrap >= 0 ) THEN
986	cyclical = .TRUE.
987	ELSE IF( zwrap == -999 ) THEN
988	cyclical = .TRUE.
989	zwrap = 0
990	ELSE
991	cyclical = .FALSE.
992	ENDIF
993
994	ref_wgts(nxt_wgt)%ddims(1) = ddims(1)
995	ref_wgts(nxt_wgt)%ddims(2) = ddims(2)
996	ref_wgts(nxt_wgt)%wgtname = sd%wgtname
997	ref_wgts(nxt_wgt)%overlap = zwrap
998	ref_wgts(nxt_wgt)%cyclic = cyclical
999	ref_wgts(nxt_wgt)%nestid = 0
1000	#if defined key_agrif
1001	ref_wgts(nxt_wgt)%nestid = Agrif_Fixed()
1002	#endif
1003	!! weights file is stored as a set of weights (wgt01->wgt04 or wgt01->wgt16)
1004	!! for each weight wgtNN there is an integer array srcNN which gives the point in
1005	!! the input data grid which is to be multiplied by the weight
1006	!! they are both arrays on the model grid so the result of the multiplication is
1007	!! added into an output array on the model grid as a running sum
1008
1009	!! two possible cases: bilinear (4 weights) or bicubic (16 weights)
1010	id = iom_varid(inum, 'src05', ldstop=.FALSE.)
1011	IF( id <= 0) THEN
1012	ref_wgts(nxt_wgt)%numwgt = 4
1013	ELSE
1014	ref_wgts(nxt_wgt)%numwgt = 16
1015	ENDIF
1016
1017	ALLOCATE( ref_wgts(nxt_wgt)%data_jpi(jpi,jpj,4) )
1018	ALLOCATE( ref_wgts(nxt_wgt)%data_jpj(jpi,jpj,4) )
1019	ALLOCATE( ref_wgts(nxt_wgt)%data_wgt(jpi,jpj,ref_wgts(nxt_wgt)%numwgt) )
1020
1021	DO jn = 1,4
1022	aname = ' '
1023	WRITE(aname,'(a3,i2.2)') 'src',jn
1024	data_tmp(:,:) = 0
1025	CALL iom_get ( inum, jpdom_data, aname, data_tmp(:,:) )
1026	data_src(:,:) = INT(data_tmp(:,:))
1027	ref_wgts(nxt_wgt)%data_jpj(:,:,jn) = 1 + (data_src(:,:)-1) / ref_wgts(nxt_wgt)%ddims(1)
1028	ref_wgts(nxt_wgt)%data_jpi(:,:,jn) = data_src(:,:) - ref_wgts(nxt_wgt)%ddims(1)*(ref_wgts(nxt_wgt)%data_jpj(:,:,jn)-1)
1029	END DO
1030
1031	DO jn = 1, ref_wgts(nxt_wgt)%numwgt
1032	aname = ' '
1033	WRITE(aname,'(a3,i2.2)') 'wgt',jn
1034	ref_wgts(nxt_wgt)%data_wgt(:,:,jn) = 0.0
1035	CALL iom_get ( inum, jpdom_data, aname, ref_wgts(nxt_wgt)%data_wgt(:,:,jn) )
1036	END DO
1037	CALL iom_close (inum)
1038
1039	! find min and max indices in grid
1040	ref_wgts(nxt_wgt)%botleft(1) = MINVAL(ref_wgts(nxt_wgt)%data_jpi(:,:,:))
1041	ref_wgts(nxt_wgt)%botleft(2) = MINVAL(ref_wgts(nxt_wgt)%data_jpj(:,:,:))
1042	ref_wgts(nxt_wgt)%topright(1) = MAXVAL(ref_wgts(nxt_wgt)%data_jpi(:,:,:))
1043	ref_wgts(nxt_wgt)%topright(2) = MAXVAL(ref_wgts(nxt_wgt)%data_jpj(:,:,:))
1044
1045	! and therefore dimensions of the input box
1046	ref_wgts(nxt_wgt)%jpiwgt = ref_wgts(nxt_wgt)%topright(1) - ref_wgts(nxt_wgt)%botleft(1) + 1
1047	ref_wgts(nxt_wgt)%jpjwgt = ref_wgts(nxt_wgt)%topright(2) - ref_wgts(nxt_wgt)%botleft(2) + 1
1048
1049	! shift indexing of source grid
1050	ref_wgts(nxt_wgt)%data_jpi(:,:,:) = ref_wgts(nxt_wgt)%data_jpi(:,:,:) - ref_wgts(nxt_wgt)%botleft(1) + 1
1051	ref_wgts(nxt_wgt)%data_jpj(:,:,:) = ref_wgts(nxt_wgt)%data_jpj(:,:,:) - ref_wgts(nxt_wgt)%botleft(2) + 1
1052
1053	! create input grid, give it a halo to allow gradient calculations
1054	! SA: +3 stencil is a patch to avoid out-of-bound computation in some configuration.
1055	! a more robust solution will be given in next release
1056	ipk = SIZE(sd%fnow, 3)
1057	ALLOCATE( ref_wgts(nxt_wgt)%fly_dta(ref_wgts(nxt_wgt)%jpiwgt+3, ref_wgts(nxt_wgt)%jpjwgt+3 ,ipk) )
1058	IF( ref_wgts(nxt_wgt)%cyclic ) ALLOCATE( ref_wgts(nxt_wgt)%col(1,ref_wgts(nxt_wgt)%jpjwgt+3,ipk) )
1059
1060	nxt_wgt = nxt_wgt + 1
1061
1062	ELSE
1063	CALL ctl_stop( ' fld_weight : unable to read the file ' )
1064	ENDIF
1065
1066	CALL wrk_dealloc( jpi,jpj, data_src ) ! integer
1067	CALL wrk_dealloc( jpi,jpj, data_tmp )
1068	!
1069	END SUBROUTINE fld_weight
1070
1071
1072	SUBROUTINE fld_interp( num, clvar, kw, kk, dta, nrec )
1073	!!---------------------------------------------------------------------
1074	!! * ROUTINE fld_interp *
1075	!!
1076	!! ** Purpose : apply weights to input gridded data to create data
1077	!! on model grid
1078	!!----------------------------------------------------------------------
1079	INTEGER , INTENT(in ) :: num ! stream number
1080	CHARACTER(LEN=*) , INTENT(in ) :: clvar ! variable name
1081	INTEGER , INTENT(in ) :: kw ! weights number
1082	INTEGER , INTENT(in ) :: kk ! vertical dimension of kk
1083	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: dta ! output field on model grid
1084	INTEGER , INTENT(in ) :: nrec ! record number to read (ie time slice)
1085	!!
1086	INTEGER, DIMENSION(3) :: rec1,recn ! temporary arrays for start and length
1087	INTEGER :: jk, jn, jm ! loop counters
1088	INTEGER :: ni, nj ! lengths
1089	INTEGER :: jpimin,jpiwid ! temporary indices
1090	INTEGER :: jpjmin,jpjwid ! temporary indices
1091	INTEGER :: jpi1,jpi2,jpj1,jpj2 ! temporary indices
1092	!!----------------------------------------------------------------------
1093	!
1094	!! for weighted interpolation we have weights at four corners of a box surrounding
1095	!! a model grid point, each weight is multiplied by a grid value (bilinear case)
1096	!! or by a grid value and gradients at the corner point (bicubic case)
1097	!! so we need to have a 4 by 4 subgrid surrounding each model point to cover both cases
1098
1099	!! sub grid from non-model input grid which encloses all grid points in this nemo process
1100	jpimin = ref_wgts(kw)%botleft(1)
1101	jpjmin = ref_wgts(kw)%botleft(2)
1102	jpiwid = ref_wgts(kw)%jpiwgt
1103	jpjwid = ref_wgts(kw)%jpjwgt
1104
1105	!! when reading in, expand this sub-grid by one halo point all the way round for calculating gradients
1106	rec1(1) = MAX( jpimin-1, 1 )
1107	rec1(2) = MAX( jpjmin-1, 1 )
1108	rec1(3) = 1
1109	recn(1) = MIN( jpiwid+2, ref_wgts(kw)%ddims(1)-rec1(1)+1 )
1110	recn(2) = MIN( jpjwid+2, ref_wgts(kw)%ddims(2)-rec1(2)+1 )
1111	recn(3) = kk
1112
1113	!! where we need to put it in the non-nemo grid fly_dta
1114	!! note that jpi1 and jpj1 only differ from 1 when jpimin and jpjmin are 1
1115	!! (ie at the extreme west or south of the whole input grid) and similarly for jpi2 and jpj2
1116	jpi1 = 2 + rec1(1) - jpimin
1117	jpj1 = 2 + rec1(2) - jpjmin
1118	jpi2 = jpi1 + recn(1) - 1
1119	jpj2 = jpj1 + recn(2) - 1
1120
1121	ref_wgts(kw)%fly_dta(:,:,:) = 0.0
1122	SELECT CASE( SIZE(ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,:),3) )
1123	CASE(1)
1124	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,1), nrec, rec1, recn)
1125	CASE DEFAULT
1126	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%fly_dta(jpi1:jpi2,jpj1:jpj2,:), nrec, rec1, recn)
1127	END SELECT
1128
1129	!! first four weights common to both bilinear and bicubic
1130	!! data_jpi, data_jpj have already been shifted to (1,1) corresponding to botleft
1131	!! note that we have to offset by 1 into fly_dta array because of halo
1132	dta(:,:,:) = 0.0
1133	DO jk = 1,4
1134	DO jn = 1, jpj
1135	DO jm = 1,jpi
1136	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1137	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1138	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk) * ref_wgts(kw)%fly_dta(ni+1,nj+1,:)
1139	END DO
1140	END DO
1141	END DO
1142
1143	IF (ref_wgts(kw)%numwgt .EQ. 16) THEN
1144
1145	!! fix up halo points that we couldnt read from file
1146	IF( jpi1 == 2 ) THEN
1147	ref_wgts(kw)%fly_dta(jpi1-1,:,:) = ref_wgts(kw)%fly_dta(jpi1,:,:)
1148	ENDIF
1149	IF( jpi2 + jpimin - 1 == ref_wgts(kw)%ddims(1)+1 ) THEN
1150	ref_wgts(kw)%fly_dta(jpi2+1,:,:) = ref_wgts(kw)%fly_dta(jpi2,:,:)
1151	ENDIF
1152	IF( jpj1 == 2 ) THEN
1153	ref_wgts(kw)%fly_dta(:,jpj1-1,:) = ref_wgts(kw)%fly_dta(:,jpj1,:)
1154	ENDIF
1155	IF( jpj2 + jpjmin - 1 == ref_wgts(kw)%ddims(2)+1 .AND. jpj2 .lt. jpjwid+2 ) THEN
1156	ref_wgts(kw)%fly_dta(:,jpj2+1,:) = 2.0*ref_wgts(kw)%fly_dta(:,jpj2,:) - ref_wgts(kw)%fly_dta(:,jpj2-1,:)
1157	ENDIF
1158
1159	!! if data grid is cyclic we can do better on east-west edges
1160	!! but have to allow for whether first and last columns are coincident
1161	IF( ref_wgts(kw)%cyclic ) THEN
1162	rec1(2) = MAX( jpjmin-1, 1 )
1163	recn(1) = 1
1164	recn(2) = MIN( jpjwid+2, ref_wgts(kw)%ddims(2)-rec1(2)+1 )
1165	jpj1 = 2 + rec1(2) - jpjmin
1166	jpj2 = jpj1 + recn(2) - 1
1167	IF( jpi1 == 2 ) THEN
1168	rec1(1) = ref_wgts(kw)%ddims(1) - ref_wgts(kw)%overlap
1169	SELECT CASE( SIZE( ref_wgts(kw)%col(:,jpj1:jpj2,:),3) )
1170	CASE(1)
1171	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,1), nrec, rec1, recn)
1172	CASE DEFAULT
1173	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,:), nrec, rec1, recn)
1174	END SELECT
1175	ref_wgts(kw)%fly_dta(jpi1-1,jpj1:jpj2,:) = ref_wgts(kw)%col(1,jpj1:jpj2,:)
1176	ENDIF
1177	IF( jpi2 + jpimin - 1 == ref_wgts(kw)%ddims(1)+1 ) THEN
1178	rec1(1) = 1 + ref_wgts(kw)%overlap
1179	SELECT CASE( SIZE( ref_wgts(kw)%col(:,jpj1:jpj2,:),3) )
1180	CASE(1)
1181	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,1), nrec, rec1, recn)
1182	CASE DEFAULT
1183	CALL iom_get( num, jpdom_unknown, clvar, ref_wgts(kw)%col(:,jpj1:jpj2,:), nrec, rec1, recn)
1184	END SELECT
1185	ref_wgts(kw)%fly_dta(jpi2+1,jpj1:jpj2,:) = ref_wgts(kw)%col(1,jpj1:jpj2,:)
1186	ENDIF
1187	ENDIF
1188
1189	! gradient in the i direction
1190	DO jk = 1,4
1191	DO jn = 1, jpj
1192	DO jm = 1,jpi
1193	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1194	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1195	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+4) * 0.5 * &
1196	(ref_wgts(kw)%fly_dta(ni+2,nj+1,:) - ref_wgts(kw)%fly_dta(ni,nj+1,:))
1197	END DO
1198	END DO
1199	END DO
1200
1201	! gradient in the j direction
1202	DO jk = 1,4
1203	DO jn = 1, jpj
1204	DO jm = 1,jpi
1205	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1206	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1207	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+8) * 0.5 * &
1208	(ref_wgts(kw)%fly_dta(ni+1,nj+2,:) - ref_wgts(kw)%fly_dta(ni+1,nj,:))
1209	END DO
1210	END DO
1211	END DO
1212
1213	! gradient in the ij direction
1214	DO jk = 1,4
1215	DO jn = 1, jpj
1216	DO jm = 1,jpi
1217	ni = ref_wgts(kw)%data_jpi(jm,jn,jk)
1218	nj = ref_wgts(kw)%data_jpj(jm,jn,jk)
1219	dta(jm,jn,:) = dta(jm,jn,:) + ref_wgts(kw)%data_wgt(jm,jn,jk+12) * 0.25 * ( &
1220	(ref_wgts(kw)%fly_dta(ni+2,nj+2,:) - ref_wgts(kw)%fly_dta(ni ,nj+2,:)) - &
1221	(ref_wgts(kw)%fly_dta(ni+2,nj ,:) - ref_wgts(kw)%fly_dta(ni ,nj ,:)))
1222	END DO
1223	END DO
1224	END DO
1225	!
1226	END IF
1227	!
1228	END SUBROUTINE fld_interp
1229
1230
1231	FUNCTION ksec_week( cdday )
1232	!!---------------------------------------------------------------------
1233	!! * FUNCTION kshift_week *
1234	!!
1235	!! ** Purpose :
1236	!!---------------------------------------------------------------------
1237	CHARACTER(len=*), INTENT(in) :: cdday !3 first letters of the first day of the weekly file
1238	!!
1239	INTEGER :: ksec_week ! output variable
1240	INTEGER :: ijul !temp variable
1241	INTEGER :: ishift !temp variable
1242	CHARACTER(len=3),DIMENSION(7) :: cl_week
1243	!!----------------------------------------------------------------------
1244	cl_week = (/"sun","sat","fri","thu","wed","tue","mon"/)
1245	DO ijul = 1, 7
1246	IF( cl_week(ijul) == TRIM(cdday) ) EXIT
1247	END DO
1248	IF( ijul .GT. 7 ) CALL ctl_stop( 'ksec_week: wrong day for sdjf%cltype(6:8): '//TRIM(cdday) )
1249	!
1250	ishift = ijul * NINT(rday)
1251	!
1252	ksec_week = nsec_week + ishift
1253	ksec_week = MOD( ksec_week, 7*NINT(rday) )
1254	!
1255	END FUNCTION ksec_week
1256
1257	!!======================================================================
1258	END MODULE fldread

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

Download in other formats: