forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
exf_set_fld.F
301 lines (275 loc) · 11.1 KB
/
exf_set_fld.F
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
C $Header: /u/gcmpack/MITgcm/pkg/exf/exf_set_fld.F,v 1.2 2017/03/10 00:16:11 jmc Exp $
C $Name: $
#include "EXF_OPTIONS.h"
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
C !ROUTINE: EXF_SET_FLD
C !INTERFACE:
SUBROUTINE EXF_SET_FLD(
I fldName, fldFile, fldMask,
I fldStartTime, fldPeriod, fldRepeatCycle,
I fld_inScale, fldRemove_intercept, fldRemove_slope,
U fldArr, fld0, fld1,
#ifdef USE_EXF_INTERPOLATION
I fld_lon0, fld_lon_inc, fld_lat0, fld_lat_inc,
I fld_nlon, fld_nlat, fld_xout, fld_yout, interp_method,
#endif
I myTime, myIter, myThid )
C !DESCRIPTION: \bv
C *=================================================================*
C | SUBROUTINE EXF_SET_FLD
C | o Set value of one generic external forcing field
C *=================================================================*
C | started: Ralf.Giering@FastOpt.de 25-Mai-2000
C | changed: heimbach@mit.edu 10-Jan-02
C | 20-Dec-02: mods for pkg/seaice, menemenlis@jpl.nasa.gov
C | heimbach@mit.edu: totally re-organized exf_set_...
C | replaced all routines by one generic routine
C | 5-Aug-03: added USE_EXF_INTERPOLATION for arbitrary
C | input grid capability
C | 11-Dec-06 added time-mean and monthly-mean climatology options
C | fldPeriod=0 means input file is one time-constant field
C | fldPeriod=-12 means input file contains 12 monthly means
C *=================================================================*
C \ev
C !USES:
IMPLICIT NONE
C == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "EXF_INTERP_SIZE.h"
#include "EXF_PARAM.h"
#include "EXF_CONSTANTS.h"
C !INPUT/OUTPUT PARAMETERS:
C fldName :: field short name (to print mesg)
C fldFile :: file-name for this field
C fldStartTime :: corresponding starting time (in sec) for this field
C fldPeriod :: time period (in sec) between 2 reccords
C fldRepeatCycle :: time duration of a repeating cycle
C fld_inScale :: input field scaling factor
C fldRemove_intercept ::
C fldRemove_slope ::
C fldArr :: field array containing current time values
C fld0 :: field array holding previous reccord
C fld1 :: field array holding next reccord
#ifdef USE_EXF_INTERPOLATION
C fld_lon0, fld_lat0 :: longitude and latitude of SouthWest
C :: corner of global input grid
C fld_nlon, fld_nlat :: input x-grid and y-grid size
C fld_lon_inc :: scalar x-grid increment
C fld_lat_inc :: vector y-grid increments
C fld_xout, fld_yout :: coordinates for output grid
C fld_xout, fld_yout :: coordinates for output grid
C interp_method :: select interpolation method (integer)
#endif /* USE_EXF_INTERPOLATION */
C myTime :: Current time (in sec) in simulation
C myIter :: Current iteration number
C myThid :: My Thread Id number
CHARACTER*(*) fldName
CHARACTER*(128) fldFile
CHARACTER*1 fldMask
_RL fldStartTime, fldPeriod, fldRepeatCycle
_RL fld_inScale
_RL fldRemove_intercept, fldRemove_slope
_RL fldArr(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RL fld0 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RL fld1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#ifdef USE_EXF_INTERPOLATION
_RL fld_lon0, fld_lon_inc
_RL fld_lat0, fld_lat_inc(MAX_LAT_INC)
INTEGER fld_nlon, fld_nlat
_RS fld_xout (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RS fld_yout (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
INTEGER interp_method
#endif /* USE_EXF_INTERPOLATION */
_RL myTime
INTEGER myIter
INTEGER myThid
C !FUNCTIONS:
INTEGER ILNBLNK
EXTERNAL ILNBLNK
C !LOCAL VARIABLES:
C msgBuf :: Informational/error message buffer
CHARACTER*(MAX_LEN_MBUF) msgBuf
LOGICAL first, changed
INTEGER count0, count1
INTEGER year0, year1
INTEGER bi, bj, i, j
_RL fac
CHARACTER*(128) locFile0, locFile1
#ifdef USE_EXF_INTERPOLATION
CHARACTER*(MAX_LEN_FNAM) out_file
# ifndef EXF_INTERP_USE_DYNALLOC
_RL bufArr( exf_interp_bufferSize )
# endif
#endif /* USE_EXF_INTERPOLATION */
CEOP
IF ( fldFile .NE. ' ' .AND. fldPeriod .NE. 0. ) THEN
IF ( exf_debugLev.GE.debLevD ) THEN
_BEGIN_MASTER( myThid )
j = ILNBLNK(fldFile)
WRITE(msgBuf,'(5A)') 'EXF_SET_FLD: ',
& 'processing field "', fldName, '", file: ', fldFile(1:j)
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER( myThid )
ENDIF
IF ( useCAL .AND. fldPeriod .EQ. -12. ) THEN
#ifdef ALLOW_CAL
C- fldPeriod=-12 means input file contains 12 monthly means
C records, corresponding to Jan. (rec=1) through Dec. (rec=12)
CALL cal_GetMonthsRec(
O fac, first, changed,
O count0, count1,
I myTime, myIter, myThid )
#endif /* ALLOW_CAL */
ELSEIF ( fldPeriod .LT. 0. ) THEN
j = ILNBLNK(fldFile)
WRITE(msgBuf,'(4A,1PE16.8,2A)') 'EXF_SET_FLD: ',
& '"', fldName, '", Invalid fldPeriod=', fldPeriod,
& ' for file: ', fldFile(1:j)
CALL PRINT_ERROR( msgBuf, myThid )
STOP 'ABNORMAL END: S/R EXF_SET_FLD'
ELSE
C- get record numbers and interpolation factor for this field
CALL EXF_GetFFieldRec(
I fldStartTime, fldPeriod, fldRepeatCycle,
I fldName, useExfYearlyFields,
O fac, first, changed,
O count0, count1, year0, year1,
I myTime, myIter, myThid )
ENDIF
IF ( exf_debugLev.GE.debLevD ) THEN
_BEGIN_MASTER( myThid )
WRITE(msgBuf,'(2A,I10,2I7)') 'EXF_SET_FLD: ',
& ' myIter, count0, count1:', myIter, count0, count1
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(2A,2(L2,2X),E16.9)') 'EXF_SET_FLD: ',
& ' first, changed, fac: ', first, changed, fac
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER( myThid )
ENDIF
IF ( first ) THEN
CALL exf_GetYearlyFieldName(
I useExfYearlyFields, twoDigitYear, fldPeriod, year0,
I fldFile,
O locFile0,
I myTime, myIter, myThid )
IF ( exf_debugLev.GE.debLevC ) THEN
_BEGIN_MASTER(myThid)
j = ILNBLNK(locFile0)
WRITE(msgBuf,'(4A,I10,A,I6)') 'EXF_SET_FLD: ',
& 'field "', fldName, '", it=', myIter,
& ', loading rec=', count0
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(4A)') 'EXF_SET_FLD: ',
& ' from file: "', locFile0(1:j), '"'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER(myThid)
ENDIF
#ifdef USE_EXF_INTERPOLATION
IF ( interp_method.GE.1 ) THEN
CALL EXF_INTERP(
I locFile0, exf_iprec,
#ifdef EXF_INTERP_USE_DYNALLOC
O fld1,
#else
O fld1, bufArr,
#endif
I count0, fld_xout, fld_yout,
I fld_lon0, fld_lon_inc, fld_lat0, fld_lat_inc,
I fld_nlon, fld_nlat, interp_method, myIter, myThid )
ELSE
#endif /* USE_EXF_INTERPOLATION */
CALL READ_REC_3D_RL( locFile0, exf_iprec, 1,
& fld1, count0, myIter, myThid )
#ifdef USE_EXF_INTERPOLATION
ENDIF
#endif /* USE_EXF_INTERPOLATION */
#ifdef USE_EXF_INTERPOLATION
IF ( exf_output_interp ) THEN
j = ILNBLNK(locFile0)
WRITE(out_file,'(2A)') locFile0(1:j), '_out'
IF ( count0.NE.1 )
& CALL WRITE_REC_XY_RL( out_file, fld1, 1, myIter, myThid )
CALL WRITE_REC_XY_RL( out_file,fld1,count0,myIter,myThid )
ENDIF
#endif /* USE_EXF_INTERPOLATION */
C- apply mask
CALL EXF_FILTER_RL( fld1, fldMask, myThid )
C- end if ( first ) block
ENDIF
IF ( first .OR. changed ) THEN
CALL exf_SwapFFields( fld0, fld1, myThid )
CALL exf_GetYearlyFieldName(
I useExfYearlyFields, twoDigitYear, fldPeriod, year1,
I fldFile,
O locFile1,
I myTime, myIter, myThid )
IF ( exf_debugLev.GE.debLevC ) THEN
_BEGIN_MASTER(myThid)
j = ILNBLNK(locFile1)
WRITE(msgBuf,'(4A,I10,A,I6)') 'EXF_SET_FLD: ',
& 'field "', fldName, '", it=', myIter,
& ', loading rec=', count1
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(4A)') 'EXF_SET_FLD: ',
& ' from file: "', locFile1(1:j), '"'
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER(myThid)
ENDIF
#ifdef USE_EXF_INTERPOLATION
IF ( interp_method.GE.1 ) THEN
CALL EXF_INTERP(
I locFile1, exf_iprec,
#ifdef EXF_INTERP_USE_DYNALLOC
O fld1,
#else
O fld1, bufArr,
#endif
I count1, fld_xout, fld_yout,
I fld_lon0, fld_lon_inc, fld_lat0, fld_lat_inc,
I fld_nlon, fld_nlat, interp_method, myIter, myThid )
ELSE
#endif /* USE_EXF_INTERPOLATION */
CALL READ_REC_3D_RL( locFile1, exf_iprec, 1,
& fld1, count1, myIter, myThid )
#ifdef USE_EXF_INTERPOLATION
ENDIF
#endif /* USE_EXF_INTERPOLATION */
#ifdef USE_EXF_INTERPOLATION
IF ( exf_output_interp ) THEN
j = ILNBLNK(locFile1)
WRITE(out_file,'(2A)') locFile1(1:j), '_out'
CALL WRITE_REC_XY_RL( out_file,fld1,count1,myIter,myThid )
ENDIF
#endif /* USE_EXF_INTERPOLATION */
C- apply mask
CALL EXF_FILTER_RL( fld1, fldMask, myThid )
C- end if ( first or changed ) block
ENDIF
C Loop over tiles.
DO bj = myByLo(myThid),myByHi(myThid)
DO bi = myBxLo(myThid),mybxhi(myThid)
DO j = 1,sNy
DO i = 1,sNx
C Interpolate linearly onto the time.
fldArr(i,j,bi,bj) = fld_inScale * (
& fac * fld0(i,j,bi,bj)
& + (exf_one - fac)* fld1(i,j,bi,bj) )
fldArr(i,j,bi,bj) = fldArr(i,j,bi,bj)
& - fld_inScale*( fldRemove_intercept
& + fldRemove_slope*(myTime-startTime) )
ENDDO
ENDDO
ENDDO
ENDDO
ENDIF
RETURN
END