1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
C Copyright 1981-2016 ECMWF.
C
C This software is licensed under the terms of the Apache Licence
C Version 2.0 which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
C
C In applying this licence, ECMWF does not waive the privileges and immunities
C granted to it by virtue of its status as an intergovernmental organisation
C nor does it submit to any jurisdiction.
C
INTEGER FUNCTION IGLSMB( OISTAND, HIFILE, KIREC, KIGRID, KILINE,
X OOSTAND, HOFILE, KOREC, KOGRID, KOLINE, KPR, KERR)
C
C---->
C**** *IGLSMB*
C
C PURPOSE
C -------
C
C Calculate the effects of the land-sea masks on the unnormalised
C interpolation weights for regular input and output fields.
C
C
C INTERFACE
C ---------
C
C IERR = IGLSMB( OISTAND, HIFILE, KIREC, KIGRID, KILINE, OOSTAND,
C X HOFILE, KOREC, KOGRID, KOLINE, KPR, KERR)
C
C
C Input parameters
C ----------------
C
C OISTAND - Flag indicating whether the input land-sea mask
C is a pre-stored "standard" field.
C
C HIFILE - The filename for the input land-sea mask.
C
C KIREC - The length of one latitude record in the input file.
C
C KIGRID - An array of length 2 giving the row and column
C strides in a pre-stored land sea mask file for the
C input grid.
C
C KILINE - An array of length 2 giving the offsets of the
C Northern and Western starting points in a
C pre-stored land sea mask file for the input grid.
C
C OOSTAND - Flag indicating whether the output land-sea mask
C is a prestored "standard" field.
C
C HOFILE - The filename for the output land-sea mask.
C
C KOREC - The length of one latitude record in the output file.
C
C KOGRID - An array of length 2 giving the row and column
C strides in a pre-stored land sea mask file for the
C output grid.
C
C KOLINE - An array of length 2 giving the offsets of the
C Northern and Western starting points in a
C pre-stored land sea mask file for the output grid.
C
C KPR - The debug print switch.
C 0 , No debugging output.
C 1 , Produce debugging output.
C
C KERR - The error control flag.
C -ve, No error message. Return error code.
C 0 , Hard failure with error message.
C +ve, Print error message. Return error code.
C
C
C Output parameters
C -----------------
C
C The common variable WFACT is modified by this routine.
C
C An error indicator
C
C 22401 An error exit was returned from the I/O routine PBOPEN.
C 22402 An error exit was returned from the I/O routine PBCLOSE.
C
C
C Common block usage
C ------------------
C
C nifld.common - This file contains all the input field
C definition variables.
C
C NINS - Number of grid points in NS direction for input
C field (used in grspace.h).
C NIWE - Number of grid points in WE direction for input
C field is used.
C
C nofld.common - This file contains all the output field
C definition variables.
C
C NONS - Number of grid points in NS direction for output
C field is used.
C NOWE - Number of grid points in WE direction for output
C field is used.
C
C grspace.h - This file contains all the work space array
C definitions for grid point to grid point
C interpolation.
C
C MEXPAND - Array of length JPLG01 (see parim.h) used to
C expand one latitude line of the 10 minute land
C sea mask file to have one word per bit for
C improved efficiency.
C MWORK - Array of length JPLONG (see parim.h) used to
C read one latitude line of a standard land sea
C mask file.
C
C MILATG - The input field latitudes.
C MILONG - The input field longitudes.
C MILSM - Work array used in calculating the effects of
C the land sea mask on interpolation.
C MNSIND - The latitude line numbers (array offset) of the
C input field associated with each line of
C latitude in the output field.
C MOLATG - The output field latitudes.
C MOLONG - The output field longitudes.
C MOLSM - Work array used in calculating the effects of
C the land sea mask on interpolation.
C MWEIND - This array holds the longitude points (array
C offset) from the input field associated with
C each longitude point in the output field.
C WFACT - The interpolation weights for each point in the
C output field.
C
C
C Externals
C ---------
C
C ABORTX - Standard routine to kill task.
C IGLSM01 - Read and process one latitude row from the 10
C minute land sea mask.
C IGLSMR - Calculate the effects of the land-sea masks for one
C line of latitude on the unnormalised interpolation
C weights.
C IGLSMST - Read and process one line of latitude from a
C standard land sea mask file.
C PBCLOSE - Close a land sea mask file after processing.
C PBOPEN - Open a land sea mask file for processing.
C INTLOG(R) - Logs messages.
C JINDEX - Returns length of character string
C
C
C Method
C ------
C
C All the land sea mask data is in (0-1) form. If a point in the
C input field has a different land sea mask value from the
C corresponding point in the output field then its interpolating
C weight is multiplied by a scaling factor. This scaling factor
C is currently 0.2 so that the effect of such points in the final
C interpolation is reduced.
C
C The land-sea mask files are kept open between calls to this
C routine.
C
C
C Reference
C ---------
C None
C
C
C Comments
C --------
C None
C
C
C AUTHOR
C ------
C K. Fielding *ECMWF* Oct 1993
C
C
C Modifications
C -------------
C
C J.D.Chambers ECMWF Oct 1996
C Reduced number of parameters in call to IGLSMST and IGLSM01
C
C----<
C
C -----------------------------------------------------------------|
C* Section 0. Definition of variables.
C -----------------------------------------------------------------|
C
C
IMPLICIT NONE
C
#include "parim.h"
#include "nifld.common"
#include "nofld.common"
#include "grspace.h"
C
C Dummy arguments
LOGICAL OISTAND, OOSTAND
CHARACTER *(*) HIFILE, HOFILE
INTEGER KIREC, KOREC, KPR, KERR
INTEGER KIGRID(2), KILINE(2), KOGRID(2), KOLINE(2)
C
C Local variables
INTEGER IIUNIT, IOUNIT, IIFILE, IOFILE
INTEGER ILATN, ILATS, IISTRIDE, IOSTRIDE, IOFF, IPR, IERR
INTEGER JOLAT
CHARACTER*256 XHIFILE, XHOFILE
CHARACTER*2 NEWFILE, MSKFILE
INTEGER XIIUNIT, XIOUNIT, II
DATA XIIUNIT/0/
DATA XIOUNIT/0/
SAVE XHIFILE, XHOFILE, XIIUNIT, XIOUNIT
C
INTEGER JPROUTINE
PARAMETER (JPROUTINE = 22400)
C
C External functions
INTEGER IGLSMR, IGLSMST, IGLSM01, JINDEX
C
C -----------------------------------------------------------------|
C* Section 1. Initialisation
C -----------------------------------------------------------------|
C
100 CONTINUE
C
IF( KPR.GE.1 ) CALL INTLOG(JP_DEBUG,'IGLSMB: Section 1.',JPQUIET)
C
IGLSMB = 0
C
IIFILE = JINDEX(HIFILE)
IOFILE = JINDEX(HOFILE)
C
IF( KPR.GE.1 ) THEN
CALL INTLOG(JP_DEBUG,'IGLSMB: Input parameters are:',JPQUIET)
CALL INTLOG(JP_DEBUG,'IGLSMB: Land sea mask file name:',JPQUIET)
CALL INTLOG(JP_DEBUG,HIFILE(1: IIFILE),JPQUIET)
IF( OISTAND ) THEN
CALL INTLOG(JP_DEBUG,'IGLSMB: Stnd fld flag = TRUE',JPQUIET)
ELSE
CALL INTLOG(JP_DEBUG,'IGLSMB: Stnd fld flag = FALSE',JPQUIET)
ENDIF
CALL INTLOG(JP_DEBUG,'IGLSMB: LSM file rec len = ',KIREC)
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid stride WE = ',KIGRID(1))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid stride NS = ',KIGRID(2))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid start N = ',KILINE(1))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid start W = ',KILINE(2))
C
CALL INTLOG(JP_DEBUG,'IGLSMB: Output parameters are:',JPQUIET)
CALL INTLOG(JP_DEBUG,'IGLSMB: Land sea mask file name:',JPQUIET)
CALL INTLOG(JP_DEBUG,HOFILE(1: IIFILE),JPQUIET)
IF( OOSTAND ) THEN
CALL INTLOG(JP_DEBUG,'IGLSMB: Stnd fld flag = TRUE',JPQUIET)
ELSE
CALL INTLOG(JP_DEBUG,'IGLSMB: Stnd fld flag = FALSE',JPQUIET)
ENDIF
CALL INTLOG(JP_DEBUG,'IGLSMB: LSM file rec len = ',KOREC)
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid stride WE = ',KOGRID(1))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid stride NS = ',KOGRID(2))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid start N = ',KOLINE(1))
CALL INTLOG(JP_DEBUG,'IGLSMB: The grid start W = ',KOLINE(2))
ENDIF
C
IF( MILONG(2).GE.MILONG(1) ) THEN
IISTRIDE = MILONG(2) - MILONG(1)
ELSE
IISTRIDE = MILONG(2) + JP360 - MILONG(1)
ENDIF
C
IF( MOLONG(2).GE.MOLONG(1) ) THEN
IOSTRIDE = MOLONG(2) - MOLONG(1)
ELSE
IOSTRIDE = MOLONG(2) + JP360 - MOLONG(1)
ENDIF
C
C -----------------------------------------------------------------|
C* Section 2. Open files for input and output land sea masks
C -----------------------------------------------------------------|
C
200 CONTINUE
C
IF( KPR.GE.1 ) CALL INTLOG(JP_DEBUG,'IGLSMB: Section 2.',JPQUIET)
C
C See if first time through or input land sea mask filename has
C changed since last access
C
II = JINDEX(HIFILE)
IF( XHIFILE(1:II).NE.HIFILE(1:II) ) THEN
C
C Open input land sea mask file
C
IF( XIIUNIT.NE.0 ) CALL PBCLOSE(XIIUNIT,IERR)
CALL PBOPEN(IIUNIT, HIFILE, 'r', IERR)
IF( IERR.NE.0 ) THEN
IGLSMB = JPROUTINE + 1
C
IF( KERR.GE.0 ) THEN
CALL INTLOG(JP_ERROR,'IGLSMB: PBOPEN error = ',IERR)
CALL INTLOG(JP_ERROR,'IGLSMB: trying to open file:',JPQUIET)
CALL INTLOG(JP_ERROR, HIFILE(1:IIFILE) ,JPQUIET)
C
IF( KERR.EQ.0 ) CALL INTLOG(JP_FATAL,
X 'IGLSMB: Interpolation failed.',JPQUIET)
ENDIF
GOTO 900
ENDIF
XIIUNIT = IIUNIT
XHIFILE(1:II) = HIFILE(1:II)
NEWFILE(1:1) = 'Y'
C
C Just rewind if same file still in use
C
ELSE
IIUNIT = XIIUNIT
NEWFILE(1:1) = 'N'
ENDIF
C
C See if first time through or output land sea mask filename has
C changed since last access
C
II = JINDEX(HOFILE)
IF( XHOFILE(1:II).NE.HOFILE(1:II) ) THEN
C
C Open output land sea mask file
C
IF( XIOUNIT.NE.0 ) CALL PBCLOSE(XIOUNIT,IERR)
CALL PBOPEN(IOUNIT, HOFILE, 'r', IERR)
IF( IERR.NE.0 ) THEN
IGLSMB = JPROUTINE + 1
C
IF( KERR.GE.0 ) THEN
CALL INTLOG(JP_ERROR,'IGLSMB: PBOPEN error = ',IERR)
CALL INTLOG(JP_ERROR,'IGLSMB: trying to open file:',JPQUIET)
CALL INTLOG(JP_ERROR, HOFILE(1:IOFILE) ,JPQUIET)
C
IF( KERR.EQ.0 ) CALL INTLOG(JP_FATAL,
X 'IGLSMB: Interpolation failed.',JPQUIET)
GOTO 900
ENDIF
ENDIF
XIOUNIT = IOUNIT
XHOFILE(1:II) = HOFILE(1:II)
NEWFILE(2:2) = 'Y'
C
C Just rewind if same file still in use
C
ELSE
IOUNIT = XIOUNIT
NEWFILE(2:2) = 'N'
ENDIF
C -----------------------------------------------------------------|
C* Section 3. Calculate arrays of weights
C -----------------------------------------------------------------|
C
300 CONTINUE
C
IF( KPR.GE.1 ) CALL INTLOG(JP_DEBUG,'IGLSMB: Section 3.',JPQUIET)
C
IPR = KPR
C
DO JOLAT = 1, NONS
C
C Get line for output array
C
IF( OOSTAND ) THEN
C
IOFF = (KOLINE(JPNORTH) + (JOLAT - 1) * KOGRID(JPNSSTEP)
X - 1) * KOREC
C
MSKFILE(2:2) = 'O'
MSKFILE(1:1) = NEWFILE(2:2)
IERR = IGLSMST(IOUNIT, IOFF, NOWE, KOLINE(JPWEST),
X KOGRID(JPWESTEP), KOREC, MOLSM, MSKFILE)
NEWFILE(2:2) = 'N'
C
ELSE
IERR = IGLSM01(IOUNIT, NOWE, MOLONG, MOLATG(JOLAT),
X MEXPAND, KOREC, MOLSM)
ENDIF
C
IF( IERR.GT.0 ) THEN
IGLSMB = IERR
GOTO 900
ENDIF
C
ILATN = MNSIND(JP_I_N, JOLAT)
ILATS = MNSIND(JP_I_S, JOLAT)
C
C Get lines for input array
C
IF( OISTAND ) THEN
C
IOFF = (KILINE(JPNORTH) + (ILATN - 1) * KIGRID(JPNSSTEP)
X - 1) * KIREC
C
MSKFILE(2:2) = 'I'
MSKFILE(1:1) = NEWFILE(1:1)
IERR = IGLSMST(IIUNIT, IOFF, NIWE, KILINE(JPWEST),
X KIGRID(JPWESTEP), KIREC, MILSM(1, JP_I_N), MSKFILE)
NEWFILE(1:1) = 'N'
C
IF( IERR.GT.0 ) THEN
IGLSMB = IERR
GOTO 900
ENDIF
C
IOFF = (KILINE(JPNORTH) + (ILATS - 1) * KIGRID(JPNSSTEP)
X - 1) * KIREC
C
MSKFILE(2:2) = 'I'
MSKFILE(1:1) = NEWFILE(1:1)
IERR = IGLSMST(IIUNIT, IOFF, NIWE, KILINE(JPWEST),
X KIGRID(JPWESTEP), KIREC, MILSM(1, JP_I_S), MSKFILE)
NEWFILE(1:1) = 'N'
C
ELSE
C
IERR = IGLSM01(IIUNIT, NIWE, MILONG, MILATG(ILATN),
X MEXPAND, KIREC, MILSM(1, JP_I_N))
C
IF( IERR.GT.0 ) THEN
IGLSMB = IERR
GOTO 900
ENDIF
C
IERR = IGLSM01(IIUNIT, NIWE, MILONG, MILATG(ILATS),
X MEXPAND, KIREC, MILSM(1, JP_I_S))
C
ENDIF
C
IF( IERR.GT.0 ) THEN
IGLSMB = IERR
GOTO 900
ENDIF
C
C Now modify the unormalised weight for land-sea mask
C
IERR = IGLSMR(MILSM(1, JP_I_N), MILSM(1, JP_I_S), MOLSM,
X MWEIND, MWEIND, NOWE, WFACT(1,(JOLAT - 1) * NOWE + 1),
X IPR, KERR)
C
IF( IERR.GT.0 ) THEN
IGLSMB = IERR
GOTO 900
ENDIF
C
IPR = KPR - 1
C
ENDDO
C
C -----------------------------------------------------------------|
C* Section 9. Return to calling routine. Format statements
C -----------------------------------------------------------------|
C
900 CONTINUE
C
IF( KPR.GE.1 ) CALL INTLOG(JP_DEBUG,'IGLSMB: Section 9.',JPQUIET)
C
9001 FORMAT(' IGLSMB ERROR', I6, ' - ', A, ' returned code', I6 /
1 21X, ' when ', A, 'ing file - ', A)
C
C
RETURN
END
|
