1 |
jmc |
1.3 |
C $Header: /u/gcmpack/MITgcm/pkg/shap_filt/shap_filt_uv_s4.F,v 1.2 2001/05/29 14:01:40 adcroft Exp $ |
2 |
|
|
C $Name: $ |
3 |
adcroft |
1.2 |
|
4 |
|
|
#include "SHAP_FILT_OPTIONS.h" |
5 |
|
|
|
6 |
jmc |
1.3 |
CBOP |
7 |
|
|
C !ROUTINE: SHAP_FILT_UV_S4 |
8 |
|
|
C !INTERFACE: |
9 |
|
|
SUBROUTINE SHAP_FILT_UV_S4( |
10 |
|
|
U uFld, vFld, tmpFldU, tmpFldV, |
11 |
|
|
I kSize, myTime, myThid ) |
12 |
|
|
C !DESCRIPTION: \bv |
13 |
|
|
C *==========================================================* |
14 |
|
|
C | S/R SHAP_FILT_UV_S4 |
15 |
|
|
C | o Applies Shapiro filter to velocity field (u & v). |
16 |
|
|
C | o use filtering function "S4" = [1 - d_xx^n][1- d_yy^n] |
17 |
|
|
C | with no grid spacing (computational Filter) ; |
18 |
|
|
C | include No-Slip option |
19 |
|
|
C *==========================================================* |
20 |
|
|
C \ev |
21 |
|
|
|
22 |
|
|
C !USES: |
23 |
adcroft |
1.2 |
IMPLICIT NONE |
24 |
|
|
|
25 |
|
|
C == Global variables === |
26 |
|
|
#include "SIZE.h" |
27 |
|
|
#include "EEPARAMS.h" |
28 |
|
|
#include "PARAMS.h" |
29 |
|
|
#include "GRID.h" |
30 |
|
|
#include "SHAP_FILT.h" |
31 |
|
|
|
32 |
jmc |
1.3 |
C !INPUT/OUTPUT PARAMETERS: |
33 |
adcroft |
1.2 |
C == Routine arguments |
34 |
jmc |
1.3 |
C uFld :: velocity field (U component) on which filter applies |
35 |
|
|
C vFld :: velocity field (V component) on which filter applies |
36 |
|
|
C tmpFldU :: working temporary array |
37 |
|
|
C tmpFldV :: working temporary array |
38 |
|
|
C kSize :: length of 3rd Dim : either =1 (2D field) or =Nr (3D field) |
39 |
|
|
C myTime :: Current time in simulation |
40 |
|
|
C myThid :: Thread number for this instance of SHAP_FILT_UV_S4 |
41 |
|
|
INTEGER kSize |
42 |
|
|
_RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
43 |
|
|
_RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
44 |
|
|
_RL tmpFldU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
45 |
|
|
_RL tmpFldV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,kSize,nSx,nSy) |
46 |
adcroft |
1.2 |
_RL myTime |
47 |
|
|
INTEGER myThid |
48 |
|
|
|
49 |
|
|
#ifdef ALLOW_SHAP_FILT |
50 |
|
|
|
51 |
jmc |
1.3 |
C !LOCAL VARIABLES: |
52 |
adcroft |
1.2 |
C == Local variables == |
53 |
jmc |
1.3 |
INTEGER bi,bj,k,i,j,N |
54 |
adcroft |
1.2 |
_RL tmpGrdU(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
55 |
|
|
_RL tmpGrdV(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
56 |
|
|
_RL maskZj,maskZp |
57 |
jmc |
1.3 |
_RL noSlipFact |
58 |
|
|
CEOP |
59 |
|
|
|
60 |
|
|
noSlipFact = Shap_noSlip*2. _d 0 |
61 |
adcroft |
1.2 |
|
62 |
|
|
IF (nShapUV.gt.0) THEN |
63 |
|
|
|
64 |
|
|
DO bj=myByLo(myThid),myByHi(myThid) |
65 |
|
|
DO bi=myBxLo(myThid),myBxHi(myThid) |
66 |
jmc |
1.3 |
DO K=1,kSize |
67 |
|
|
DO J=1-OLy,sNy+OLy |
68 |
|
|
DO I=1-OLx,sNx+OLx |
69 |
adcroft |
1.2 |
tmpFldU(i,j,k,bi,bj)=uFld(i,j,k,bi,bj) |
70 |
|
|
& *_maskW(i,j,k,bi,bj) |
71 |
|
|
tmpFldV(i,j,k,bi,bj)=vFld(i,j,k,bi,bj) |
72 |
|
|
& *_maskS(i,j,k,bi,bj) |
73 |
|
|
ENDDO |
74 |
|
|
ENDDO |
75 |
|
|
ENDDO |
76 |
|
|
ENDDO |
77 |
|
|
ENDDO |
78 |
|
|
|
79 |
|
|
|
80 |
|
|
C d_xx^n tmpFld |
81 |
|
|
|
82 |
|
|
DO N=1,nShapUV |
83 |
|
|
|
84 |
jmc |
1.3 |
IF (kSize.EQ.Nr) THEN |
85 |
|
|
CALL EXCH_UV_XYZ_RL(tmpFldU,tmpFldV,.TRUE.,myThid) |
86 |
|
|
ELSE |
87 |
|
|
CALL EXCH_UV_XY_RL(tmpFldU,tmpFldV,.TRUE.,myThid) |
88 |
|
|
ENDIF |
89 |
adcroft |
1.2 |
|
90 |
|
|
DO bj=myByLo(myThid),myByHi(myThid) |
91 |
|
|
DO bi=myBxLo(myThid),myBxHi(myThid) |
92 |
jmc |
1.3 |
DO K=1,kSize |
93 |
adcroft |
1.2 |
|
94 |
|
|
C Uxx |
95 |
|
|
DO J=1,sNy |
96 |
|
|
DO I=1,sNx+1 |
97 |
|
|
tmpGrdU(i,j) = -0.25*( |
98 |
|
|
& tmpFldU(i-1,j,k,bi,bj) + tmpFldU(i+1,j,k,bi,bj) |
99 |
|
|
& - 2.*tmpFldU(i,j,k,bi,bj) |
100 |
|
|
& )*_maskW(i,j,k,bi,bj) |
101 |
|
|
ENDDO |
102 |
|
|
ENDDO |
103 |
|
|
|
104 |
|
|
DO J=1,sNy |
105 |
|
|
DO I=1,sNx+1 |
106 |
|
|
tmpFldU(i,j,k,bi,bj) = tmpGrdU(i,j) |
107 |
|
|
ENDDO |
108 |
|
|
ENDDO |
109 |
|
|
|
110 |
|
|
C Vyy |
111 |
|
|
DO J=1,sNy+1 |
112 |
|
|
DO I=1,sNx |
113 |
|
|
tmpGrdV(i,j) = -0.25*( |
114 |
|
|
& tmpFldV(i,j-1,k,bi,bj) + tmpFldV(i,j+1,k,bi,bj) |
115 |
|
|
& - 2.*tmpFldV(i,j,k,bi,bj) |
116 |
|
|
& )*_maskS(i,j,k,bi,bj) |
117 |
|
|
ENDDO |
118 |
|
|
ENDDO |
119 |
|
|
|
120 |
|
|
DO J=1,sNy+1 |
121 |
|
|
DO I=1,sNx |
122 |
|
|
tmpFldV(i,j,k,bi,bj) = tmpGrdV(i,j) |
123 |
|
|
ENDDO |
124 |
|
|
ENDDO |
125 |
|
|
|
126 |
|
|
ENDDO |
127 |
|
|
ENDDO |
128 |
|
|
ENDDO |
129 |
|
|
|
130 |
|
|
ENDDO |
131 |
|
|
|
132 |
jmc |
1.3 |
C F <- [1 - d_xx^n *deltaT/tau].F |
133 |
adcroft |
1.2 |
DO bj=myByLo(myThid),myByHi(myThid) |
134 |
|
|
DO bi=myBxLo(myThid),myBxHi(myThid) |
135 |
jmc |
1.3 |
DO K=1,kSize |
136 |
adcroft |
1.2 |
DO J=1,sNy |
137 |
|
|
DO I=1,sNx+1 |
138 |
jmc |
1.3 |
uFld(i,j,k,bi,bj)=uFld(i,j,k,bi,bj) |
139 |
|
|
& -tmpFldU(i,j,k,bi,bj)*deltaTmom/Shap_uvtau |
140 |
|
|
tmpFldU(i,j,k,bi,bj)=uFld(i,j,k,bi,bj) |
141 |
adcroft |
1.2 |
ENDDO |
142 |
|
|
ENDDO |
143 |
|
|
DO J=1,sNy+1 |
144 |
|
|
DO I=1,sNx |
145 |
jmc |
1.3 |
vFld(i,j,k,bi,bj)=vFld(i,j,k,bi,bj) |
146 |
|
|
& -tmpFldV(i,j,k,bi,bj)*deltaTmom/Shap_uvtau |
147 |
|
|
tmpFldV(i,j,k,bi,bj)=vFld(i,j,k,bi,bj) |
148 |
adcroft |
1.2 |
ENDDO |
149 |
|
|
ENDDO |
150 |
|
|
ENDDO |
151 |
|
|
ENDDO |
152 |
|
|
ENDDO |
153 |
|
|
|
154 |
|
|
|
155 |
|
|
C d_yy^n tmpFld |
156 |
|
|
|
157 |
|
|
DO N=1,nShapUV |
158 |
|
|
|
159 |
jmc |
1.3 |
IF (kSize.EQ.Nr) THEN |
160 |
|
|
CALL EXCH_UV_XYZ_RL(tmpFldU,tmpFldV,.TRUE.,myThid) |
161 |
|
|
ELSE |
162 |
|
|
CALL EXCH_UV_XY_RL(tmpFldU,tmpFldV,.TRUE.,myThid) |
163 |
|
|
ENDIF |
164 |
adcroft |
1.2 |
|
165 |
|
|
DO bj=myByLo(myThid),myByHi(myThid) |
166 |
|
|
DO bi=myBxLo(myThid),myBxHi(myThid) |
167 |
jmc |
1.3 |
DO K=1,kSize |
168 |
adcroft |
1.2 |
|
169 |
|
|
C Uyy |
170 |
|
|
DO J=1,sNy |
171 |
|
|
DO I=1,sNx+1 |
172 |
|
|
maskZj=_maskS(i-1, j ,k,bi,bj) |
173 |
|
|
& *_maskS( i , j ,k,bi,bj) |
174 |
|
|
maskZp=_maskS(i-1,j+1,k,bi,bj) |
175 |
|
|
& *_maskS( i ,j+1,k,bi,bj) |
176 |
|
|
tmpGrdU(i,j) = -0.25*( |
177 |
|
|
& (tmpFldU(i,j+1,k,bi,bj)-tmpFldU(i, j ,k,bi,bj))*maskZp |
178 |
|
|
& -(tmpFldU(i, j ,k,bi,bj)-tmpFldU(i,j-1,k,bi,bj))*maskZj |
179 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldU(i,j,k,bi,bj) |
180 |
adcroft |
1.2 |
& )*_maskW(i,j,k,bi,bj) |
181 |
|
|
ENDDO |
182 |
|
|
ENDDO |
183 |
|
|
|
184 |
|
|
IF (useCubedSphereExchange) THEN |
185 |
|
|
J=1 |
186 |
|
|
DO I=1,sNx+1,sNx |
187 |
|
|
maskZj=maskS(i-1, j ,k,bi,bj)*maskS( i , j ,k,bi,bj) |
188 |
|
|
maskZp=maskS(i-1,j+1,k,bi,bj)*maskS( i ,j+1,k,bi,bj) |
189 |
|
|
tmpGrdU(i,j) = -0.25*( |
190 |
|
|
& (tmpFldU(i,j+1,k,bi,bj)-tmpFldU(i, j ,k,bi,bj))*maskZp |
191 |
|
|
& -(tmpFldU(i, j ,k,bi,bj)-0*tmpFldU(i,j-1,k,bi,bj))*maskZj |
192 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldU(i,j,k,bi,bj) |
193 |
adcroft |
1.2 |
& )*_maskW(i,j,k,bi,bj) |
194 |
|
|
ENDDO |
195 |
|
|
J=sNy |
196 |
|
|
DO I=1,sNx+1,sNx |
197 |
|
|
maskZj=maskS(i-1, j ,k,bi,bj)*maskS( i , j ,k,bi,bj) |
198 |
|
|
maskZp=maskS(i-1,j+1,k,bi,bj)*maskS( i ,j+1,k,bi,bj) |
199 |
|
|
tmpGrdU(i,j) = -0.25*( |
200 |
|
|
& (0*tmpFldU(i,j+1,k,bi,bj)-tmpFldU(i, j ,k,bi,bj))*maskZp |
201 |
|
|
& -(tmpFldU(i, j ,k,bi,bj)-tmpFldU(i,j-1,k,bi,bj))*maskZj |
202 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldU(i,j,k,bi,bj) |
203 |
adcroft |
1.2 |
& )*_maskW(i,j,k,bi,bj) |
204 |
|
|
ENDDO |
205 |
|
|
ENDIF |
206 |
|
|
|
207 |
|
|
DO J=1,sNy |
208 |
|
|
DO I=1,sNx+1 |
209 |
|
|
tmpFldU(i,j,k,bi,bj) = tmpGrdU(i,j) |
210 |
|
|
ENDDO |
211 |
|
|
ENDDO |
212 |
|
|
|
213 |
|
|
C Vxx |
214 |
|
|
DO J=1,sNy+1 |
215 |
|
|
DO I=1,sNx |
216 |
|
|
maskZj=_maskW( i ,j-1,k,bi,bj) |
217 |
|
|
& *_maskW( i , j ,k,bi,bj) |
218 |
|
|
maskZp=_maskW(i+1,j-1,k,bi,bj) |
219 |
|
|
& *_maskW(i+1, j ,k,bi,bj) |
220 |
|
|
tmpGrdV(i,j) = -0.25*( |
221 |
|
|
& (tmpFldV(i+1,j,k,bi,bj)-tmpFldV( i ,j,k,bi,bj))*maskZp |
222 |
|
|
& -(tmpFldV( i ,j,k,bi,bj)-tmpFldV(i-1,j,k,bi,bj))*maskZj |
223 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldV(i,j,k,bi,bj) |
224 |
adcroft |
1.2 |
& )*_maskS(i,j,k,bi,bj) |
225 |
|
|
ENDDO |
226 |
|
|
ENDDO |
227 |
|
|
|
228 |
|
|
IF (useCubedSphereExchange) THEN |
229 |
|
|
DO J=1,sNy+1,sNy |
230 |
|
|
I=1 |
231 |
|
|
maskZj=maskW( i ,j-1,k,bi,bj)*maskW( i , j ,k,bi,bj) |
232 |
|
|
maskZp=maskW(i+1,j-1,k,bi,bj)*maskW(i+1, j ,k,bi,bj) |
233 |
|
|
tmpGrdV(i,j) = -0.25*( |
234 |
|
|
& (tmpFldV(i+1,j,k,bi,bj)-tmpFldV( i ,j,k,bi,bj))*maskZp |
235 |
|
|
& -(tmpFldV( i ,j,k,bi,bj)-0*tmpFldV(i-1,j,k,bi,bj))*maskZj |
236 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldV(i,j,k,bi,bj) |
237 |
adcroft |
1.2 |
& -2.*(2.-maskZj-maskZp)*tmpFldV(i,j,k,bi,bj) |
238 |
|
|
& )*_maskS(i,j,k,bi,bj) |
239 |
|
|
ENDDO |
240 |
|
|
DO J=1,sNy+1,sNy |
241 |
|
|
I=sNx |
242 |
|
|
maskZj=maskW( i ,j-1,k,bi,bj)*maskW( i , j ,k,bi,bj) |
243 |
|
|
maskZp=maskW(i+1,j-1,k,bi,bj)*maskW(i+1, j ,k,bi,bj) |
244 |
|
|
tmpGrdV(i,j) = -0.25*( |
245 |
|
|
& (0*tmpFldV(i+1,j,k,bi,bj)-tmpFldV( i ,j,k,bi,bj))*maskZp |
246 |
|
|
& -(tmpFldV( i ,j,k,bi,bj)-tmpFldV(i-1,j,k,bi,bj))*maskZj |
247 |
jmc |
1.3 |
& -noSlipFact*(2.-maskZj-maskZp)*tmpFldV(i,j,k,bi,bj) |
248 |
adcroft |
1.2 |
& )*_maskS(i,j,k,bi,bj) |
249 |
|
|
ENDDO |
250 |
|
|
ENDIF |
251 |
|
|
|
252 |
|
|
DO J=1,sNy+1 |
253 |
|
|
DO I=1,sNx |
254 |
|
|
tmpFldV(i,j,k,bi,bj) = tmpGrdV(i,j) |
255 |
|
|
ENDDO |
256 |
|
|
ENDDO |
257 |
|
|
|
258 |
|
|
ENDDO |
259 |
|
|
ENDDO |
260 |
|
|
ENDDO |
261 |
|
|
|
262 |
|
|
ENDDO |
263 |
|
|
|
264 |
jmc |
1.3 |
C F <- [1 - d_yy^n *deltaT/tau].F |
265 |
adcroft |
1.2 |
DO bj=myByLo(myThid),myByHi(myThid) |
266 |
|
|
DO bi=myBxLo(myThid),myBxHi(myThid) |
267 |
jmc |
1.3 |
DO K=1,kSize |
268 |
adcroft |
1.2 |
DO J=1,sNy |
269 |
|
|
DO I=1,sNx+1 |
270 |
jmc |
1.3 |
uFld(i,j,k,bi,bj)=uFld(i,j,k,bi,bj) |
271 |
|
|
& -tmpFldU(i,j,k,bi,bj)*deltaTmom/Shap_uvtau |
272 |
adcroft |
1.2 |
ENDDO |
273 |
|
|
ENDDO |
274 |
|
|
DO J=1,sNy+1 |
275 |
|
|
DO I=1,sNx |
276 |
jmc |
1.3 |
vFld(i,j,k,bi,bj)=vFld(i,j,k,bi,bj) |
277 |
|
|
& -tmpFldV(i,j,k,bi,bj)*deltaTmom/Shap_uvtau |
278 |
adcroft |
1.2 |
ENDDO |
279 |
|
|
ENDDO |
280 |
|
|
ENDDO |
281 |
|
|
ENDDO |
282 |
|
|
ENDDO |
283 |
jmc |
1.3 |
|
284 |
|
|
IF (kSize.EQ.Nr) THEN |
285 |
|
|
CALL EXCH_UV_XYZ_RL(uFld,vFld,.TRUE.,myThid) |
286 |
|
|
ELSEIF (kSize.EQ.1) THEN |
287 |
|
|
CALL EXCH_UV_XY_RL(uFld,vFld,.TRUE.,myThid) |
288 |
|
|
ELSE |
289 |
|
|
STOP 'S/R SHAP_FILT_UV_S4: kSize is wrong' |
290 |
|
|
ENDIF |
291 |
adcroft |
1.2 |
|
292 |
|
|
ENDIF |
293 |
|
|
#endif /* ALLOW_SHAP_FILT */ |
294 |
|
|
|
295 |
|
|
RETURN |
296 |
|
|
END |