-
Notifications
You must be signed in to change notification settings - Fork 237
/
remove_mean.F
320 lines (301 loc) · 10.8 KB
/
remove_mean.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
#include "CPP_OPTIONS.h"
C-- File remove_mean.F:
C-- Contents
C-- o REMOVE_MEAN_RL
C-- o REMOVE_MEAN_RS
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: REMOVE_MEAN_RL
C !INTERFACE:
SUBROUTINE REMOVE_MEAN_RL(
I myNr,
U arrFld,
I arrhFac, arrMask, arrArea, arrDr,
I arrName, myTime, myIter, myThid )
C !DESCRIPTION: \bv
C Correct for global-mean imbalance of global "_RL" array "arrFld"
C (i.e., output arrFld has zero mean):
C Apply either (if arrDr(1) > 0) uniform correction
C or (if arrDr(1) < 0) a correction scaled by "arrhFac" weight.
C The global mean imbalance is computed as area (arrArea), mask
C (arrMask) and thickness (arrDr) weighted, as well as thickness
C factor (arrhFac) weighted (1rst case) or not (2nd case).
C Comment: currently this S/R is only applied to 2-D field.
C \ev
C !USES:
IMPLICIT NONE
C === Global data ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
C !INPUT/OUTPUT PARAMETERS:
C myNr :: third dimension of field to correct
C arrFld :: field array to correct for imbalance
C arrhFac :: same size as arrFld ; thickness factor (1rst case)
C :: or correction scaling factor (2nd case)
C arrMask :: 2-D mask for global mean calculation
C arrArea :: 2-D grid-cell area for global mean calculation
C arrDr :: myNr long vector (level thickness)
C arrName :: name of field to correct
C myTime :: Current time in simulation
C myIter :: Current iteration number in simulation
C myThid :: my Thread ID number
INTEGER myNr
_RL arrFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
_RS arrhFac(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
_RS arrMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RS arrArea(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RS arrDr(myNr)
CHARACTER*(*) arrName
_RL myTime
INTEGER myIter
INTEGER myThid
C !LOCAL VARIABLES:
INTEGER bi, bj, i, j, k
_RL volTile(nSx,nSy), sumTile(nSx,nSy)
_RL tmpVol, volGlob, sumGlob, theMean
_RL meanCorr
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
volTile(bi,bj) = 0. _d 0
sumTile(bi,bj) = 0. _d 0
IF ( arrDr(1).GE.zeroRS ) THEN
C-- do (arrhFac) weighted average to apply uniform correction
DO k=1,myNr
DO j=1,sNy
DO i=1,sNx
tmpVol = arrArea(i,j,bi,bj)*arrMask(i,j,bi,bj)
& * arrhFac(i,j,k,bi,bj)*arrDr(k)
volTile(bi,bj) = volTile(bi,bj) + tmpVol
sumTile(bi,bj) = sumTile(bi,bj) + tmpVol*arrFld(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ELSE
C- do simple average to apply (arrhFac) weighted correction
DO k=1,myNr
DO j=1,sNy
DO i=1,sNx
tmpVol = arrArea(i,j,bi,bj)*arrMask(i,j,bi,bj)
& * ABS(arrDr(k))
volTile(bi,bj) = volTile(bi,bj)
& + tmpVol*arrhFac(i,j,k,bi,bj)
sumTile(bi,bj) = sumTile(bi,bj)
& + tmpVol*arrFld(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDIF
ENDDO
ENDDO
CALL GLOBAL_SUM_TILE_RL( volTile, volGlob, myThid )
CALL GLOBAL_SUM_TILE_RL( sumTile, sumGlob, myThid )
IF ( volGlob.GT.zeroRL ) THEN
meanCorr = sumGlob/volGlob
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
IF ( arrDr(1).GE.zeroRS ) THEN
C-- apply uniform correction
DO k=1,myNr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
IF ( arrhFac(i,j,k,bi,bj).NE.zeroRS ) THEN
arrFld(i,j,k,bi,bj) = arrFld(i,j,k,bi,bj) - meanCorr
ENDIF
ENDDO
ENDDO
ENDDO
ELSE
C- apply (arrhFac) weighted correction
DO k=1,myNr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
IF ( arrMask(i,j,bi,bj).NE.zeroRS ) THEN
arrFld(i,j,k,bi,bj) = arrFld(i,j,k,bi,bj)
& - meanCorr*arrhFac(i,j,k,bi,bj)
ENDIF
ENDDO
ENDDO
ENDDO
C- end type correction selection
ENDIF
ENDDO
ENDDO
ELSE
meanCorr = 0. _d 0
ENDIF
C Print the global mean to standard output, this is a measure
C of the magnitude of the correction to array arrFld
IF ( balancePrintMean ) THEN
_BEGIN_MASTER( myThid )
IF ( arrDr(1).GE.zeroRS ) THEN
theMean = meanCorr
WRITE(msgBuf,'(3A,1PE21.14,A,I10)')
& 'REMOVE_MEAN_RL: Global mean of ', arrName, ' = ',
& theMean, ' @ it=', myIter
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
ELSE
theMean = 0. _d 0
IF ( globalArea.GT.zeroRL ) theMean = sumGlob/globalArea
WRITE(msgBuf,'(3A,2(1PE21.14,A),I10)')
& 'REMOVE_MEAN_RL: ', arrName, ' Global mean= ',
& theMean, ', remove: ', meanCorr, ' @ it=', myIter
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
ENDIF
_END_MASTER( myThid )
ENDIF
RETURN
END
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: REMOVE_MEAN_RS
C !INTERFACE:
SUBROUTINE REMOVE_MEAN_RS(
I myNr,
U arrFld,
I arrhFac, arrMask, arrArea, arrDr,
I arrName, myTime, myIter, myThid )
C !DESCRIPTION: \bv
C Correct for global-mean imbalance of global "_RS" array "arrFld"
C (i.e., output arrFld has zero mean):
C Apply either (if arrDr(1) > 0) uniform correction
C or (if arrDr(1) < 0) a correction scaled by "arrhFac" weight.
C The global mean imbalance is computed as area (arrArea), mask
C (arrMask) and thickness (arrDr) weighted, as well as thickness
C factor (arrhFac) weighted (1rst case) or not (2nd case).
C Comment: currently this S/R is only applied to 2-D field.
C \ev
C !USES:
IMPLICIT NONE
C === Global data ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
C !INPUT/OUTPUT PARAMETERS:
C myNr :: third dimension of field to correct
C arrFld :: field array to correct for imbalance
C arrhFac :: same size as arrFld ; thickness factor (1rst case)
C :: or correction scaling factor (2nd case)
C arrMask :: 2-D mask for global mean calculation
C arrArea :: 2-D grid-cell area for global mean calculation
C arrDr :: myNr long vector (level thickness)
C arrName :: name of field to correct
C myTime :: Current time in simulation
C myIter :: Current iteration number in simulation
C myThid :: my Thread ID number
INTEGER myNr
_RS arrFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
_RS arrhFac(1-OLx:sNx+OLx,1-OLy:sNy+OLy,myNr,nSx,nSy)
_RS arrMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RS arrArea(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RS arrDr(myNr)
CHARACTER*(*) arrName
_RL myTime
INTEGER myIter
INTEGER myThid
C !LOCAL VARIABLES:
INTEGER bi, bj, i, j, k
_RL volTile(nSx,nSy), sumTile(nSx,nSy)
_RL tmpVol, volGlob, sumGlob, theMean
_RS meanCorr
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
volTile(bi,bj) = 0. _d 0
sumTile(bi,bj) = 0. _d 0
IF ( arrDr(1).GE.zeroRS ) THEN
C-- do (arrhFac) weighted average to apply uniform correction
DO k=1,myNr
DO j=1,sNy
DO i=1,sNx
tmpVol = arrArea(i,j,bi,bj)*arrMask(i,j,bi,bj)
& * arrhFac(i,j,k,bi,bj)*arrDr(k)
volTile(bi,bj) = volTile(bi,bj) + tmpVol
sumTile(bi,bj) = sumTile(bi,bj) + tmpVol*arrFld(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ELSE
C- do simple average to apply (arrhFac) weighted correction
DO k=1,myNr
DO j=1,sNy
DO i=1,sNx
tmpVol = arrArea(i,j,bi,bj)*arrMask(i,j,bi,bj)
& * ABS(arrDr(k))
volTile(bi,bj) = volTile(bi,bj)
& + tmpVol*arrhFac(i,j,k,bi,bj)
sumTile(bi,bj) = sumTile(bi,bj)
& + tmpVol*arrFld(i,j,k,bi,bj)
ENDDO
ENDDO
ENDDO
ENDIF
ENDDO
ENDDO
CALL GLOBAL_SUM_TILE_RL( volTile, volGlob, myThid )
CALL GLOBAL_SUM_TILE_RL( sumTile, sumGlob, myThid )
IF ( volGlob.GT.zeroRL ) THEN
meanCorr = sumGlob/volGlob
DO bj=myByLo(myThid),myByHi(myThid)
DO bi=myBxLo(myThid),myBxHi(myThid)
IF ( arrDr(1).GE.zeroRS ) THEN
C-- apply uniform correction
DO k=1,myNr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
IF ( arrhFac(i,j,k,bi,bj).NE.zeroRS ) THEN
arrFld(i,j,k,bi,bj) = arrFld(i,j,k,bi,bj) - meanCorr
ENDIF
ENDDO
ENDDO
ENDDO
ELSE
C- apply (arrhFac) weighted correction
DO k=1,myNr
DO j=1-OLy,sNy+OLy
DO i=1-OLx,sNx+OLx
IF ( arrMask(i,j,bi,bj).NE.zeroRS ) THEN
arrFld(i,j,k,bi,bj) = arrFld(i,j,k,bi,bj)
& - meanCorr*arrhFac(i,j,k,bi,bj)
ENDIF
ENDDO
ENDDO
ENDDO
C- end type correction selection
ENDIF
ENDDO
ENDDO
ELSE
meanCorr = 0. _d 0
ENDIF
C Print the global mean to standard output, this is a measure
C of the magnitude of the correction to array arrFld
IF ( balancePrintMean ) THEN
_BEGIN_MASTER( myThid )
IF ( arrDr(1).GE.zeroRS ) THEN
theMean = meanCorr
WRITE(msgBuf,'(3A,1PE21.14,A,I10)')
& 'REMOVE_MEAN_RS: Global mean of ', arrName, ' = ',
& theMean, ' @ it=', myIter
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
ELSE
theMean = 0. _d 0
IF ( globalArea.GT.zeroRL ) theMean = sumGlob/globalArea
WRITE(msgBuf,'(3A,2(1PE21.14,A),I10)')
& 'REMOVE_MEAN_RS: ', arrName, ' Global mean= ',
& theMean, ', remove: ', meanCorr, ' @ it=', myIter
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
ENDIF
_END_MASTER( myThid )
ENDIF
RETURN
END