forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cost_generic.F
441 lines (364 loc) · 13 KB
/
cost_generic.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
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
C $Header: /u/gcmpack/MITgcm/pkg/ecco/cost_generic.F,v 1.39 2016/03/22 22:29:25 gforget Exp $
C $Name: $
#include "ECCO_OPTIONS.h"
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: cost_generic
C !INTERFACE:
subroutine cost_generic(
& nnzbar, localbarfile, dummy,
& nnzobs, localobsfile, localerrfile,
& mult_local, nrecloc, nrecobs,
& localstartdate, localperiod,
& ylocmask, spminloc, spmaxloc, spzeroloc,
& preproc, preproc_c, preproc_i, preproc_r,
& posproc, posproc_c, posproc_i, posproc_r,
& outlev, outname,
& objf_local, num_local,
& myiter, mytime, mythid )
C !DESCRIPTION: \bv
C Generic routine for evaluating time-dependent
c cost function contribution
C \ev
C !USES:
implicit none
c == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "GRID.h"
#ifdef ALLOW_CAL
# include "cal.h"
#endif
#ifdef ALLOW_ECCO
# include "ecco.h"
#endif
#ifdef ALLOW_SEAICE
# include "SEAICE_COST.h"
#endif
c == routine arguments ==
integer myiter
integer mythid
integer nnzbar, nnzobs
integer nrecloc, nrecobs
integer localstartdate(4)
integer outlev
integer preproc_i(NGENPPROC)
integer posproc_i(NGENPPROC)
_RL objf_local(nsx,nsy)
_RL num_local(nsx,nsy)
_RL dummy
_RL mult_local
_RL mytime
_RL localperiod
_RL spminloc
_RL spmaxloc
_RL spzeroloc
_RL preproc_r(NGENPPROC)
_RL posproc_r(NGENPPROC)
character*(1) ylocmask
character*(MAX_LEN_FNAM) localbarfile
character*(MAX_LEN_FNAM) localobsfile
character*(MAX_LEN_FNAM) localerrfile
character*(MAX_LEN_FNAM) preproc(NGENPPROC)
character*(MAX_LEN_FNAM) preproc_c(NGENPPROC)
character*(MAX_LEN_FNAM) posproc(NGENPPROC)
character*(MAX_LEN_FNAM) posproc_c(NGENPPROC)
character*(MAX_LEN_FNAM) outname
#ifdef ALLOW_ECCO
c == local variables ==
integer bi,bj,k2
integer itlo,ithi
integer jtlo,jthi
logical domean, doanom
_RL localdifmean1 (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdifmean2 (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
CEOP
jtlo = mybylo(mythid)
jthi = mybyhi(mythid)
itlo = mybxlo(mythid)
ithi = mybxhi(mythid)
c-- Initialise local variables.
do bj = jtlo,jthi
do bi = itlo,ithi
objf_local(bi,bj) = 0. _d 0
num_local(bi,bj) = 0. _d 0
enddo
enddo
call ecco_zero(localdifmean1,Nr,zeroRL,myThid)
call ecco_zero(localdifmean2,Nr,zeroRL,myThid)
domean=.FALSE.
doanom=.FALSE.
do k2 = 1, NGENPPROC
if (preproc(k2).EQ.'mean') domean=.TRUE.
if (preproc(k2).EQ.'anom') doanom=.TRUE.
enddo
C Extra time loop to compute time-mean fields and costs
if ( (.NOT. ( localobsfile.EQ.' ' ) )
& .AND. ( domean .OR. doanom ) ) then
call cost_genloop(
& localdifmean1,localdifmean2,.FALSE.,
& nnzbar, localbarfile, dummy,
& nnzobs, localobsfile, localerrfile,
& mult_local, nrecloc, nrecobs,
& localstartdate, localperiod,
& ylocmask, spminloc, spmaxloc, spzeroloc,
& preproc, preproc_c, preproc_i, preproc_r,
& posproc, posproc_c, posproc_i, posproc_r,
& outlev, outname,
& objf_local, num_local,
& myiter, mytime, mythid )
endif
call ecco_zero(localdifmean1,Nr,zeroRL,myThid)
if ((.NOT.(localobsfile.EQ.' ')).AND.(.NOT.domean)) then
call cost_genloop(
& localdifmean2,localdifmean1,.TRUE.,
& nnzbar, localbarfile, dummy,
& nnzobs, localobsfile, localerrfile,
& mult_local, nrecloc, nrecobs,
& localstartdate, localperiod,
& ylocmask, spminloc, spmaxloc, spzeroloc,
& preproc, preproc_c, preproc_i, preproc_r,
& posproc, posproc_c, posproc_i, posproc_r,
& outlev, outname,
& objf_local, num_local,
& myiter, mytime, mythid )
endif
#endif /* ALLOW_ECCO */
return
end
C--------------
subroutine cost_genloop(
& localdifmeanIn,localdifmeanOut, addVariaCost,
& nnzbar, localbarfile, dummy,
& nnzobs, localobsfile, localerrfile,
& mult_local, nrecloc, nrecobs,
& localstartdate, localperiod,
& ylocmask, spminloc, spmaxloc, spzeroloc,
& preproc, preproc_c, preproc_i, preproc_r,
& posproc, posproc_c, posproc_i, posproc_r,
& outlev, outname,
& objf_local, num_local,
& myiter, mytime, mythid )
C !DESCRIPTION: \bv
C Generic routine for evaluating time-dependent
c cost function contribution
C \ev
C !USES:
implicit none
c == global variables ==
#include "EEPARAMS.h"
#include "SIZE.h"
#include "PARAMS.h"
#include "GRID.h"
#ifdef ALLOW_CAL
# include "cal.h"
#endif
#ifdef ALLOW_ECCO
# include "ecco.h"
#endif
#ifdef ALLOW_SEAICE
# include "SEAICE_COST.h"
#endif
c == routine arguments ==
integer myiter
integer mythid
integer nnzbar, nnzobs
integer nrecloc, nrecobs
integer localstartdate(4)
integer outlev
integer preproc_i(NGENPPROC)
integer posproc_i(NGENPPROC)
_RL objf_local(nsx,nsy)
_RL num_local(nsx,nsy)
_RL dummy
_RL mult_local
_RL mytime
_RL localperiod
_RL spminloc
_RL spmaxloc
_RL spzeroloc
_RL preproc_r(NGENPPROC)
_RL posproc_r(NGENPPROC)
character*(1) ylocmask
character*(MAX_LEN_FNAM) localbarfile
character*(MAX_LEN_FNAM) localobsfile
character*(MAX_LEN_FNAM) localerrfile
character*(MAX_LEN_FNAM) preproc(NGENPPROC)
character*(MAX_LEN_FNAM) preproc_c(NGENPPROC)
character*(MAX_LEN_FNAM) posproc(NGENPPROC)
character*(MAX_LEN_FNAM) posproc_c(NGENPPROC)
character*(MAX_LEN_FNAM) outname
logical addVariaCost
_RL localdifmeanIn (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdifmeanOut (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
#ifdef ALLOW_ECCO
c == local variables ==
integer bi,bj
integer itlo,ithi
integer jtlo,jthi
integer irec, jrec
integer il, k2
integer localrec, obsrec
integer nrecloop, nrecclim, k2smooth
logical domean, doanom, dovarwei, doclim, dosmooth, dosumsq
_RL localmask (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localbar (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localweight(1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localtmp (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localobs (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdif (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL difmask (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdifmsk (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdifsum (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL localdifnum (1-olx:snx+olx,1-oly:sny+oly,Nr,nsx,nsy)
_RL fac
character*(128) fname1, fname2, fname3
character*200 msgbuf
logical exst
c == external functions ==
integer ilnblnk
external ilnblnk
CEOP
call ecco_zero(localbar,Nr,zeroRL,myThid)
call ecco_zero(localweight,Nr,zeroRL,myThid)
call ecco_zero(localtmp,Nr,zeroRL,myThid)
call ecco_zero(localmask,Nr,zeroRL,myThid)
call ecco_zero(localobs,Nr,zeroRL,myThid)
call ecco_zero(localdif,Nr,zeroRL,myThid)
call ecco_zero(difmask,Nr,zeroRL,myThid)
call ecco_zero(localdifmsk,Nr,zeroRL,myThid)
call ecco_zero(localdifsum,Nr,zeroRL,myThid)
call ecco_zero(localdifnum,Nr,zeroRL,myThid)
dosumsq=.TRUE.
domean=.FALSE.
doanom=.FALSE.
dovarwei=.FALSE.
dosmooth=.FALSE.
k2smooth=1
doclim=.FALSE.
nrecclim=nrecloc
fac=oneRL
do k2 = 1, NGENPPROC
if (preproc(k2).EQ.'mean') domean=.TRUE.
if (preproc(k2).EQ.'anom') doanom=.TRUE.
if (preproc(k2).EQ.'variaweight') dovarwei=.TRUE.
if (preproc(k2).EQ.'nosumsq') dosumsq=.FALSE.
if (posproc(k2).EQ.'smooth') then
dosmooth=.TRUE.
k2smooth=k2
endif
if (preproc(k2).EQ.'clim') then
doclim=.TRUE.
nrecclim=preproc_i(k2)
endif
if (preproc(k2).EQ.'factor') then
fac=preproc_r(k2)
endif
enddo
c-- Assign mask
if ( ylocmask .EQ. 'C' .OR. ylocmask .EQ. 'c' ) then
call ecco_cprsrl(maskC,nr,localmask,nr,myThid)
elseif ( ylocmask .EQ. 'S' .OR. ylocmask .EQ. 's' ) then
call ecco_cprsrl(maskS,nr,localmask,nr,myThid)
elseif ( ylocmask .EQ. 'W' .OR. ylocmask .EQ. 'w' ) then
call ecco_cprsrl(maskW,nr,localmask,nr,myThid)
else
STOP 'cost_generic: wrong ylocmask'
endif
c-- set nrecloop to nrecloc
nrecloop=nrecloc
c-- reset nrecloop, if needed, according to preproc
if ( doclim ) nrecloop=MIN(nrecloop,nrecclim)
c-- loop over obsfile records
do irec = 1, nrecloop
c-- load weights
exst=.FALSE.
jrec=1
if( dovarwei ) jrec = irec
call cost_gencal(localbarfile, localerrfile,
& jrec, localstartdate, localperiod, fname1,
& fname3, localrec, obsrec, exst, mythid )
call ecco_zero(localweight,nnzobs,zeroRL,myThid)
if ( (localrec .GT. 0).AND.(obsrec .GT. 0).AND.(exst) )
& call ecco_readwei(fname3,localweight,localrec,nnzobs,mythid)
c-- determine records and file names
exst=.FALSE.
call cost_gencal(localbarfile, localobsfile,
& irec, localstartdate, localperiod, fname1,
& fname2, localrec, obsrec, exst, mythid )
c-- load model average and observed average
call ecco_zero(localbar,nnzbar,zeroRL,myThid)
call cost_genread( fname1, localbar, localtmp, irec, nnzbar,
& nrecloc, preproc, preproc_c, preproc_i, preproc_r,
& dummy, mythid )
call ecco_mult(localbar,nnzbar,fac,myThid)
call ecco_zero(localobs,nnzobs,spzeroloc,myThid)
if ( (localrec .GT. 0).AND.(obsrec .GT. 0).AND.(exst) )
& call mdsreadfield( fname2, cost_iprec, cost_yftype, nnzobs,
& localobs, localrec, mythid )
c-- Compute masked model-data difference
call ecco_diffmsk( localbar, nnzbar, localobs, nnzobs,
& localmask, spminloc, spmaxloc, spzeroloc,
& localdif, difmask, myThid )
if ( doanom ) call ecco_subtract( localdifmeanIn,
& nnzobs, localdif, nnzobs, myThid )
if ( domean.OR.doanom )
& call ecco_addmask(localdif,difmask, nnzobs,localdifsum,
& localdifnum, nnzobs,myThid)
if (addVariaCost) then
#ifdef ALLOW_SMOOTH
if ( useSMOOTH.AND.dosmooth.AND.
& (nnzbar.EQ.1).AND.(nnzobs.EQ.1) )
& call smooth_hetero2d(localdif,maskc,
& posproc_c(k2smooth),posproc_i(k2smooth),mythid)
#endif
c-- Compute normalized model-obs cost function
call ecco_addcost(
I localdif, localweight, difmask, nnzobs, dosumsq,
U objf_local, num_local,
I myThid
& )
c-- output model-data difference to disk
if ( outlev.GT.0 ) then
il=ilnblnk(outname)
write(fname3(1:128),'(2a)') 'misfit_', outname(1:il)
if ( nnzobs.EQ.1 ) CALL
& WRITE_REC_XY_RL( fname3, localdif,irec, eccoiter, mythid )
if ( nnzobs.EQ.nr ) CALL
& WRITE_REC_XYZ_RL( fname3, localdif,irec, eccoiter, mythid )
endif
endif
enddo
c-- End of loop over obsfile records.
call ecco_zero(localdifmeanOut,Nr,zeroRL,myThid)
call ecco_cp(localdifsum,nnzobs,localdifmeanOut,nnzobs,myThid)
call ecco_divfield(localdifmeanOut,nnzobs,localdifnum,myThid)
call ecco_cp(localdifnum,nnzobs,localdifmsk,nnzobs,myThid)
call ecco_divfield(localdifmsk,nnzobs,localdifnum,myThid)
if ( domean ) then
c-- Compute normalized model-obs cost function
call ecco_addcost(
I localdifmeanOut, localweight, localdifmsk, nnzobs, dosumsq,
U objf_local, num_local, myThid)
c-- output model-data difference to disk
if ( outlev.GT.0 ) then
il=ilnblnk(outname)
write(fname3(1:128),'(2a)') 'misfit_', outname(1:il)
if ( nnzobs.EQ.1 ) CALL
& WRITE_REC_XY_RL(fname3,localdifmeanOut,1,eccoiter,mythid)
if ( nnzobs.EQ.nr ) CALL
& WRITE_REC_XYZ_RL(fname3,localdifmeanOut,1,eccoiter,mythid)
endif
endif
if ( outlev.GT.1 ) then
il=ilnblnk(outname)
write(fname3(1:128),'(2a)') 'weight_', outname(1:il)
if ( nnzobs.EQ.1 ) CALL
& WRITE_REC_XY_RL( fname3, localweight,irec, eccoiter, mythid )
if ( nnzobs.EQ.nr ) CALL
& WRITE_REC_XYZ_RL( fname3, localweight,irec, eccoiter, mythid )
endif
#endif /* ALLOW_ECCO */
return
end