forked from altMITgcm/MITgcm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
diagstats_local.F
242 lines (221 loc) · 9.3 KB
/
diagstats_local.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
C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagstats_local.F,v 1.10 2012/09/03 20:29:47 jmc Exp $
C $Name: $
#include "DIAG_OPTIONS.h"
CBOP
C !ROUTINE: DIAGSTATS_LOCAL
C !INTERFACE:
SUBROUTINE DIAGSTATS_LOCAL(
U statFld,
I inpFld, frcFld,
I scaleFact, power, useFract, sizF,
I sizI1,sizI2,sizJ1,sizJ2,sizK,sizTx,sizTy,
I iRun,jRun,kIn,biIn,bjIn,
I k,bi,bj, region2fill, ndId, parsFld,
I myThid )
C !DESCRIPTION:
C Update array statFld
C by adding statistics over the range [1:iRun],[1:jRun]
C from input field array inpFld
C- note:
C a) this S/R should not see DIAGNOSTICS pkg commons blocks (in DIAGNOSTICS.h)
C b) for main grid variables, get area & weigting factors (to compute global mean)
C from the main common blocks.
C c) for other type of grids, call a specifics S/R which include its own
C grid common blocks
C !USES:
IMPLICIT NONE
#include "EEPARAMS.h"
#include "SIZE.h"
#include "DIAGNOSTICS_SIZE.h"
#include "DIAGSTATS_REGIONS.h"
#include "PARAMS.h"
#include "GRID.h"
c #include "SURFACE.h"
C !INPUT/OUTPUT PARAMETERS:
C == Routine Arguments ==
C statFld :: cumulative statistics array (updated)
C inpFld :: input field array to process (compute stats & add to statFld)
C frcFld :: fraction used for weighted-average diagnostics
C scaleFact :: scaling factor
C power :: option to fill-in with the field square (power=2)
C useFract :: if True, use fraction-weight
C sizF :: size of frcFld array: 3rd dimension
C sizI1,sizI2 :: size of inpFld array: 1rst index range (min,max)
C sizJ1,sizJ2 :: size of inpFld array: 2nd index range (min,max)
C sizK :: size of inpFld array: 3rd dimension
C sizTx,sizTy :: size of inpFld array: tile dimensions
C iRun,jRun :: range of 1rst & 2nd index
C kIn :: level index of inpFld array to process
C biIn,bjIn :: tile indices of inpFld array to process
C k,bi,bj :: level and tile indices used for weighting (mask,area ...)
C region2fill :: indicates whether to compute statistics over this region
C ndId :: Diagnostics Id Number (in available diag. list)
C parsFld :: parser field with characteristics of the diagnostics
C myThid :: my Thread Id number
_RL statFld(0:nStats,0:nRegions)
INTEGER sizI1,sizI2,sizJ1,sizJ2
INTEGER sizF,sizK,sizTx,sizTy
_RL inpFld(sizI1:sizI2,sizJ1:sizJ2,sizK,sizTx,sizTy)
_RL frcFld(sizI1:sizI2,sizJ1:sizJ2,sizF,sizTx,sizTy)
_RL scaleFact
INTEGER power
LOGICAL useFract
INTEGER iRun, jRun, kIn, biIn, bjIn
INTEGER k, bi, bj, ndId
INTEGER region2fill(0:nRegions)
CHARACTER*16 parsFld
INTEGER myThid
CEOP
C !FUNCTIONS:
#ifdef ALLOW_FIZHI
_RL getcon
EXTERNAL getcon
#endif
C !LOCAL VARIABLES:
C i,j :: loop indices
INTEGER i, n, kFr, kRegMsk
INTEGER im, ix, iv
PARAMETER ( iv = nStats - 2 , im = nStats - 1 , ix = nStats )
LOGICAL exclSpVal
LOGICAL useWeight
_RL statLoc(0:nStats)
_RL drLoc
_RL specialVal
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
useWeight = .FALSE.
exclSpVal = .FALSE.
specialVal = 0.
#ifdef ALLOW_FIZHI
IF ( useFIZHI ) THEN
exclSpVal = .TRUE.
specialVal = getcon('UNDEF')
ENDIF
#endif
kFr = MIN(kIn,sizF)
DO n=0,nRegions
IF (region2fill(n).NE.0) THEN
C--- Compute statistics for this tile, level and region:
kRegMsk = diagSt_kRegMsk(n)
IF ( parsFld(10:10) .EQ. 'R' ) THEN
drLoc = drF(k)
IF ( parsFld(9:9).EQ.'L') drLoc = drC(k)
IF ( parsFld(9:9).EQ.'U') drLoc = drC(MIN(k+1,Nr))
IF ( parsFld(9:9).EQ.'M') useWeight = .TRUE.
IF ( parsFld(2:2).EQ.'U' ) THEN
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskW(1-OLx,1-OLy,k,bi,bj),
I hFacW(1-OLx,1-OLy,k,bi,bj), rAw(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
c I drLoc, k,bi,bj, parsFld, myThid )
ELSEIF ( parsFld(2:2).EQ.'V' ) THEN
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskS(1-OLx,1-OLy,k,bi,bj),
I hFacS(1-OLx,1-OLy,k,bi,bj), rAs(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
ELSE
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskC(1-OLx,1-OLy,k,bi,bj),
I hFacC(1-OLx,1-OLy,k,bi,bj), rA(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
ENDIF
ELSEIF ( useFIZHI .AND.
& (parsFld(10:10).EQ.'L' .OR. parsFld(10:10).EQ.'M')
& ) THEN
CALL DIAGSTATS_LM_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskInC(1-OLx,1-OLy,bi,bj), rA(1-OLx,1-OLy,bi,bj),
I specialVal, exclSpVal,
I k,bi,bj, parsFld, myThid )
ELSEIF ( useLand .AND.
& (parsFld(10:10).EQ.'G' .OR. parsFld(10:10).EQ.'g')
& ) THEN
CALL DIAGSTATS_G_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I rA(1-OLx,1-OLy,bi,bj),
I specialVal, exclSpVal,
I k,bi,bj, parsFld, myThid )
c ELSEIF ( parsFld(10:10) .EQ. 'I' ) THEN
c ELSEIF ( parsFld(10:10) .EQ. '1' ) THEN
ELSE
drLoc = 1. _d 0
IF ( parsFld(2:2).EQ.'U' ) THEN
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskInW(1-OLx,1-OLy,bi,bj),
I maskInW(1-OLx,1-OLy,bi,bj),rAw(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
ELSEIF ( parsFld(2:2).EQ.'V' ) THEN
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskInS(1-OLx,1-OLy,bi,bj),
I maskInS(1-OLx,1-OLy,bi,bj),rAs(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
ELSE
CALL DIAGSTATS_CALC(
O statLoc,
I inpFld(sizI1,sizJ1,kIn,biIn,bjIn),
I frcFld(sizI1,sizJ1,kFr,biIn,bjIn),
I scaleFact, power, useFract, n, diagSt_vRegMsk(n),
I nStats,sizI1,sizI2,sizJ1,sizJ2,iRun,jRun,
I diagSt_regMask(1-OLx,1-OLy,kRegMsk,bi,bj),
I maskInC(1-OLx,1-OLy,bi,bj),
I maskInC(1-OLx,1-OLy,bi,bj), rA(1-OLx,1-OLy,bi,bj),
I drLoc, specialVal, exclSpVal, useWeight, myThid )
ENDIF
ENDIF
C Update cumulative statistics array
IF ( statLoc(0).GT.0. ) THEN
IF ( statFld(0,n).LE.0. ) THEN
statFld(im,n) = statLoc(im)
statFld(ix,n) = statLoc(ix)
ELSE
statFld(im,n) = MIN( statFld(im,n), statLoc(im) )
statFld(ix,n) = MAX( statFld(ix,n), statLoc(ix) )
ENDIF
DO i=0,iv
statFld(i,n) = statFld(i,n) + statLoc(i)
ENDDO
ENDIF
C--- processing region "n" ends here.
ENDIF
ENDDO
RETURN
END