1 |
C $Header: /u/gcmpack/MITgcm/pkg/mom_vecinv/mom_vecinv.F,v 1.69 2013/07/28 21:04:25 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "MOM_VECINV_OPTIONS.h" |
5 |
#ifdef ALLOW_MOM_COMMON |
6 |
# include "MOM_COMMON_OPTIONS.h" |
7 |
#endif |
8 |
|
9 |
SUBROUTINE MOM_VECINV( |
10 |
I bi,bj,k,iMin,iMax,jMin,jMax, |
11 |
I KappaRU, KappaRV, |
12 |
I fVerUkm, fVerVkm, |
13 |
O fVerUkp, fVerVkp, |
14 |
O guDiss, gvDiss, |
15 |
I myTime, myIter, myThid ) |
16 |
C *==========================================================* |
17 |
C | S/R MOM_VECINV | |
18 |
C | o Form the right hand-side of the momentum equation. | |
19 |
C *==========================================================* |
20 |
C | Terms are evaluated one layer at a time working from | |
21 |
C | the bottom to the top. The vertically integrated | |
22 |
C | barotropic flow tendency term is evluated by summing the | |
23 |
C | tendencies. | |
24 |
C | Notes: | |
25 |
C | We have not sorted out an entirely satisfactory formula | |
26 |
C | for the diffusion equation bc with lopping. The present | |
27 |
C | form produces a diffusive flux that does not scale with | |
28 |
C | open-area. Need to do something to solidfy this and to | |
29 |
C | deal "properly" with thin walls. | |
30 |
C *==========================================================* |
31 |
IMPLICIT NONE |
32 |
|
33 |
C == Global variables == |
34 |
#include "SIZE.h" |
35 |
#include "EEPARAMS.h" |
36 |
#include "PARAMS.h" |
37 |
#include "GRID.h" |
38 |
#include "DYNVARS.h" |
39 |
#ifdef ALLOW_MOM_COMMON |
40 |
# include "MOM_VISC.h" |
41 |
#endif |
42 |
#ifdef ALLOW_TIMEAVE |
43 |
# include "TIMEAVE_STATV.h" |
44 |
#endif |
45 |
#ifdef ALLOW_MNC |
46 |
# include "MNC_PARAMS.h" |
47 |
#endif |
48 |
#ifdef ALLOW_AUTODIFF_TAMC |
49 |
# include "tamc.h" |
50 |
# include "tamc_keys.h" |
51 |
#endif |
52 |
|
53 |
C == Routine arguments == |
54 |
C bi,bj :: current tile indices |
55 |
C k :: current vertical level |
56 |
C iMin,iMax,jMin,jMax :: loop ranges |
57 |
C fVerU :: Flux of momentum in the vertical direction, out of the upper |
58 |
C fVerV :: face of a cell K ( flux into the cell above ). |
59 |
C fVerUkm :: vertical viscous flux of U, interface above (k-1/2) |
60 |
C fVerVkm :: vertical viscous flux of V, interface above (k-1/2) |
61 |
C fVerUkp :: vertical viscous flux of U, interface below (k+1/2) |
62 |
C fVerVkp :: vertical viscous flux of V, interface below (k+1/2) |
63 |
|
64 |
C guDiss :: dissipation tendency (all explicit terms), u component |
65 |
C gvDiss :: dissipation tendency (all explicit terms), v component |
66 |
C myTime :: current time |
67 |
C myIter :: current time-step number |
68 |
C myThid :: my Thread Id number |
69 |
INTEGER bi,bj,k |
70 |
INTEGER iMin,iMax,jMin,jMax |
71 |
_RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
72 |
_RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
73 |
_RL fVerUkm(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
74 |
_RL fVerVkm(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
75 |
_RL fVerUkp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
76 |
_RL fVerVkp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
77 |
_RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
78 |
_RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
79 |
_RL myTime |
80 |
INTEGER myIter |
81 |
INTEGER myThid |
82 |
|
83 |
#ifdef ALLOW_MOM_VECINV |
84 |
|
85 |
C == Functions == |
86 |
LOGICAL DIFFERENT_MULTIPLE |
87 |
EXTERNAL DIFFERENT_MULTIPLE |
88 |
|
89 |
C == Local variables == |
90 |
_RL vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
91 |
_RL vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
92 |
_RL uCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
93 |
_RL vCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
94 |
_RS hFacZ (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
95 |
_RS r_hFacZ (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
96 |
_RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
97 |
_RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
98 |
_RL del2u (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
99 |
_RL del2v (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
100 |
_RL dStar (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
101 |
_RL zStar (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
102 |
_RL tension (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
103 |
_RL strain (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
104 |
_RL KE (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
105 |
_RL omega3 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
106 |
_RL vort3 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
107 |
_RL hDiv (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
108 |
_RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
109 |
_RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
110 |
_RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
111 |
_RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
112 |
C i,j :: Loop counters |
113 |
INTEGER i,j |
114 |
C xxxFac :: On-off tracer parameters used for switching terms off. |
115 |
_RL ArDudrFac |
116 |
_RL ArDvdrFac |
117 |
_RL sideMaskFac |
118 |
LOGICAL bottomDragTerms |
119 |
LOGICAL writeDiag |
120 |
#ifdef ALLOW_AUTODIFF_TAMC |
121 |
INTEGER imomkey |
122 |
#endif |
123 |
|
124 |
#ifdef ALLOW_MNC |
125 |
INTEGER offsets(9) |
126 |
CHARACTER*(1) pf |
127 |
#endif |
128 |
|
129 |
#ifdef ALLOW_AUTODIFF_TAMC |
130 |
C-- only the kDown part of fverU/V is set in this subroutine |
131 |
C-- the kUp is still required |
132 |
C-- In the case of mom_fluxform Kup is set as well |
133 |
C-- (at least in part) |
134 |
fVerUkm(1,1) = fVerUkm(1,1) |
135 |
fVerVkm(1,1) = fVerVkm(1,1) |
136 |
#endif |
137 |
|
138 |
#ifdef ALLOW_AUTODIFF_TAMC |
139 |
act0 = k - 1 |
140 |
max0 = Nr |
141 |
act1 = bi - myBxLo(myThid) |
142 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
143 |
act2 = bj - myByLo(myThid) |
144 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
145 |
act3 = myThid - 1 |
146 |
max3 = nTx*nTy |
147 |
act4 = ikey_dynamics - 1 |
148 |
imomkey = (act0 + 1) |
149 |
& + act1*max0 |
150 |
& + act2*max0*max1 |
151 |
& + act3*max0*max1*max2 |
152 |
& + act4*max0*max1*max2*max3 |
153 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
154 |
|
155 |
writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime, deltaTClock) |
156 |
|
157 |
#ifdef ALLOW_MNC |
158 |
IF (useMNC .AND. snapshot_mnc .AND. writeDiag) THEN |
159 |
IF ( writeBinaryPrec .EQ. precFloat64 ) THEN |
160 |
pf(1:1) = 'D' |
161 |
ELSE |
162 |
pf(1:1) = 'R' |
163 |
ENDIF |
164 |
IF ((bi .EQ. 1).AND.(bj .EQ. 1).AND.(k .EQ. 1)) THEN |
165 |
CALL MNC_CW_SET_UDIM('mom_vi', -1, myThid) |
166 |
CALL MNC_CW_RL_W_S('D','mom_vi',0,0,'T',myTime,myThid) |
167 |
CALL MNC_CW_SET_UDIM('mom_vi', 0, myThid) |
168 |
CALL MNC_CW_I_W_S('I','mom_vi',0,0,'iter',myIter,myThid) |
169 |
ENDIF |
170 |
DO i = 1,9 |
171 |
offsets(i) = 0 |
172 |
ENDDO |
173 |
offsets(3) = k |
174 |
c write(*,*) 'offsets = ',(offsets(i),i=1,9) |
175 |
ENDIF |
176 |
#endif /* ALLOW_MNC */ |
177 |
|
178 |
C-- Initialise intermediate terms |
179 |
DO j=1-OLy,sNy+OLy |
180 |
DO i=1-OLx,sNx+OLx |
181 |
vF(i,j) = 0. |
182 |
vrF(i,j) = 0. |
183 |
uCf(i,j) = 0. |
184 |
vCf(i,j) = 0. |
185 |
del2u(i,j) = 0. |
186 |
del2v(i,j) = 0. |
187 |
dStar(i,j) = 0. |
188 |
zStar(i,j) = 0. |
189 |
guDiss(i,j)= 0. |
190 |
gvDiss(i,j)= 0. |
191 |
vort3(i,j) = 0. |
192 |
omega3(i,j)= 0. |
193 |
KE(i,j) = 0. |
194 |
C- need to initialise hDiv for MOM_VI_DEL2UV(call FILL_CS_CORNER_TR_RL) |
195 |
hDiv(i,j) = 0. |
196 |
c viscAh_Z(i,j) = 0. |
197 |
c viscAh_D(i,j) = 0. |
198 |
c viscA4_Z(i,j) = 0. |
199 |
c viscA4_D(i,j) = 0. |
200 |
strain(i,j) = 0. _d 0 |
201 |
tension(i,j) = 0. _d 0 |
202 |
#ifdef ALLOW_AUTODIFF_TAMC |
203 |
hFacZ(i,j) = 0. _d 0 |
204 |
#endif |
205 |
ENDDO |
206 |
ENDDO |
207 |
|
208 |
C-- Term by term tracer parmeters |
209 |
C o U momentum equation |
210 |
ArDudrFac = vfFacMom*1. |
211 |
C o V momentum equation |
212 |
ArDvdrFac = vfFacMom*1. |
213 |
|
214 |
C note: using standard stencil (no mask) results in under-estimating |
215 |
C vorticity at a no-slip boundary by a factor of 2 = sideDragFactor |
216 |
IF ( no_slip_sides ) THEN |
217 |
sideMaskFac = sideDragFactor |
218 |
ELSE |
219 |
sideMaskFac = 0. _d 0 |
220 |
ENDIF |
221 |
|
222 |
IF ( no_slip_bottom |
223 |
& .OR. bottomDragQuadratic.NE.0. |
224 |
& .OR. bottomDragLinear.NE.0.) THEN |
225 |
bottomDragTerms=.TRUE. |
226 |
ELSE |
227 |
bottomDragTerms=.FALSE. |
228 |
ENDIF |
229 |
|
230 |
C-- Calculate open water fraction at vorticity points |
231 |
CALL MOM_CALC_HFACZ(bi,bj,k,hFacZ,r_hFacZ,myThid) |
232 |
|
233 |
C Make local copies of horizontal flow field |
234 |
DO j=1-OLy,sNy+OLy |
235 |
DO i=1-OLx,sNx+OLx |
236 |
uFld(i,j) = uVel(i,j,k,bi,bj) |
237 |
vFld(i,j) = vVel(i,j,k,bi,bj) |
238 |
ENDDO |
239 |
ENDDO |
240 |
|
241 |
C note (jmc) : Dissipation and Vort3 advection do not necesary |
242 |
C use the same maskZ (and hFacZ) => needs 2 call(s) |
243 |
c CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid) |
244 |
|
245 |
CALL MOM_CALC_KE(bi,bj,k,selectKEscheme,uFld,vFld,KE,myThid) |
246 |
|
247 |
CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid) |
248 |
|
249 |
IF (momViscosity) THEN |
250 |
C-- For viscous term, compute horizontal divergence, tension & strain |
251 |
C and mask relative vorticity (free-slip case): |
252 |
|
253 |
#ifdef ALLOW_AUTODIFF_TAMC |
254 |
CADJ STORE vort3(:,:) = |
255 |
CADJ & comlev1_bibj_k, key = imomkey, byte = isbyte |
256 |
#endif |
257 |
|
258 |
CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid) |
259 |
|
260 |
CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid) |
261 |
|
262 |
CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid) |
263 |
|
264 |
C- account for no-slip / free-slip BC: |
265 |
DO j=1-OLy,sNy+OLy |
266 |
DO i=1-OLx,sNx+OLx |
267 |
IF ( hFacZ(i,j).EQ.0. ) THEN |
268 |
vort3(i,j) = sideMaskFac*vort3(i,j) |
269 |
strain(i,j) = sideMaskFac*strain(i,j) |
270 |
ENDIF |
271 |
ENDDO |
272 |
ENDDO |
273 |
|
274 |
C-- Calculate Lateral Viscosities |
275 |
DO j=1-OLy,sNy+OLy |
276 |
DO i=1-OLx,sNx+OLx |
277 |
viscAh_D(i,j) = viscAhD |
278 |
viscAh_Z(i,j) = viscAhZ |
279 |
viscA4_D(i,j) = viscA4D |
280 |
viscA4_Z(i,j) = viscA4Z |
281 |
ENDDO |
282 |
ENDDO |
283 |
IF ( useVariableVisc ) THEN |
284 |
CALL MOM_CALC_VISC( bi, bj, k, |
285 |
O viscAh_Z, viscAh_D, viscA4_Z, viscA4_D, |
286 |
I hDiv, vort3, tension, strain, KE, hfacZ, |
287 |
I myThid ) |
288 |
ENDIF |
289 |
|
290 |
C Calculate del^2 u and del^2 v for bi-harmonic term |
291 |
IF (useBiharmonicVisc) THEN |
292 |
CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ, |
293 |
O del2u,del2v, |
294 |
& myThid) |
295 |
CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid) |
296 |
CALL MOM_CALC_RELVORT3(bi,bj,k, |
297 |
& del2u,del2v,hFacZ,zStar,myThid) |
298 |
IF ( writeDiag ) THEN |
299 |
CALL WRITE_LOCAL_RL( 'del2u', 'I10', 1, del2u, |
300 |
& bi,bj,k, myIter, myThid ) |
301 |
CALL WRITE_LOCAL_RL( 'del2v', 'I10', 1, del2v, |
302 |
& bi,bj,k, myIter, myThid ) |
303 |
CALL WRITE_LOCAL_RL( 'dStar', 'I10', 1, dStar, |
304 |
& bi,bj,k, myIter, myThid ) |
305 |
CALL WRITE_LOCAL_RL( 'zStar', 'I10', 1, zStar, |
306 |
& bi,bj,k, myIter, myThid ) |
307 |
ENDIF |
308 |
ENDIF |
309 |
|
310 |
C- Strain diagnostics: |
311 |
IF ( writeDiag ) THEN |
312 |
IF (snapshot_mdsio) THEN |
313 |
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
314 |
ENDIF |
315 |
#ifdef ALLOW_MNC |
316 |
IF (useMNC .AND. snapshot_mnc) THEN |
317 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Ds',strain, |
318 |
& offsets, myThid) |
319 |
ENDIF |
320 |
#endif /* ALLOW_MNC */ |
321 |
ENDIF |
322 |
#ifdef ALLOW_DIAGNOSTICS |
323 |
IF ( useDiagnostics ) THEN |
324 |
CALL DIAGNOSTICS_FILL(strain, 'Strain ',k,1,2,bi,bj,myThid) |
325 |
ENDIF |
326 |
#endif /* ALLOW_DIAGNOSTICS */ |
327 |
|
328 |
C--- Calculate dissipation terms for U and V equations |
329 |
|
330 |
C in terms of tension and strain |
331 |
IF (useStrainTensionVisc) THEN |
332 |
C mask strain as if free-slip since side-drag is computed separately |
333 |
DO j=1-OLy,sNy+OLy |
334 |
DO i=1-OLx,sNx+OLx |
335 |
IF ( hFacZ(i,j).EQ.0. ) strain(i,j) = 0. _d 0 |
336 |
ENDDO |
337 |
ENDDO |
338 |
CALL MOM_HDISSIP( bi, bj, k, |
339 |
I hDiv, vort3, tension, strain, KE, hFacZ, |
340 |
I viscAh_Z, viscAh_D, viscA4_Z, viscA4_D, |
341 |
I useHarmonicVisc, useBiharmonicVisc, useVariableVisc, |
342 |
O guDiss, gvDiss, |
343 |
I myThid ) |
344 |
ELSE |
345 |
C in terms of vorticity and divergence |
346 |
CALL MOM_VI_HDISSIP( bi, bj, k, |
347 |
I hDiv, vort3, tension, strain, KE, hFacZ,dStar,zStar, |
348 |
I viscAh_Z, viscAh_D, viscA4_Z, viscA4_D, |
349 |
I useHarmonicVisc, useBiharmonicVisc, useVariableVisc, |
350 |
O guDiss, gvDiss, |
351 |
& myThid ) |
352 |
ENDIF |
353 |
|
354 |
C--- Other dissipation terms in Zonal momentum equation |
355 |
|
356 |
C-- Vertical flux (fVer is at upper face of "u" cell) |
357 |
C Eddy component of vertical flux (interior component only) -> vrF |
358 |
IF ( .NOT.implicitViscosity ) THEN |
359 |
CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid) |
360 |
C Combine fluxes |
361 |
DO j=jMin,jMax |
362 |
DO i=iMin,iMax |
363 |
fVerUkp(i,j) = ArDudrFac*vrF(i,j) |
364 |
ENDDO |
365 |
ENDDO |
366 |
C-- Tendency is minus divergence of the fluxes |
367 |
DO j=jMin,jMax |
368 |
DO i=iMin,iMax |
369 |
guDiss(i,j) = guDiss(i,j) |
370 |
& -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k) |
371 |
& *recip_rAw(i,j,bi,bj) |
372 |
& *( fVerUkp(i,j) - fVerUkm(i,j) )*rkSign |
373 |
ENDDO |
374 |
ENDDO |
375 |
ENDIF |
376 |
|
377 |
C-- No-slip and drag BCs appear as body forces in cell abutting topography |
378 |
IF ( no_slip_sides ) THEN |
379 |
C- No-slip BCs impose a drag at walls... |
380 |
CALL MOM_U_SIDEDRAG( bi, bj, k, |
381 |
I uFld, del2u, hFacZ, |
382 |
I viscAh_Z, viscA4_Z, |
383 |
I useHarmonicVisc, useBiharmonicVisc, useVariableVisc, |
384 |
O vF, |
385 |
I myThid ) |
386 |
DO j=jMin,jMax |
387 |
DO i=iMin,iMax |
388 |
guDiss(i,j) = guDiss(i,j)+vF(i,j) |
389 |
ENDDO |
390 |
ENDDO |
391 |
ENDIF |
392 |
|
393 |
C- No-slip BCs impose a drag at bottom |
394 |
IF ( bottomDragTerms ) THEN |
395 |
CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid) |
396 |
DO j=jMin,jMax |
397 |
DO i=iMin,iMax |
398 |
guDiss(i,j) = guDiss(i,j)+vF(i,j) |
399 |
ENDDO |
400 |
ENDDO |
401 |
ENDIF |
402 |
#ifdef ALLOW_SHELFICE |
403 |
IF ( useShelfIce.AND.bottomDragTerms ) THEN |
404 |
CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid) |
405 |
DO j=jMin,jMax |
406 |
DO i=iMin,iMax |
407 |
guDiss(i,j) = guDiss(i,j) + vF(i,j) |
408 |
ENDDO |
409 |
ENDDO |
410 |
ENDIF |
411 |
#endif /* ALLOW_SHELFICE */ |
412 |
|
413 |
C--- Other dissipation terms in Meridional momentum equation |
414 |
|
415 |
C-- Vertical flux (fVer is at upper face of "v" cell) |
416 |
C Eddy component of vertical flux (interior component only) -> vrF |
417 |
IF ( .NOT.implicitViscosity ) THEN |
418 |
CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid) |
419 |
C Combine fluxes -> fVerV |
420 |
DO j=jMin,jMax |
421 |
DO i=iMin,iMax |
422 |
fVerVkp(i,j) = ArDvdrFac*vrF(i,j) |
423 |
ENDDO |
424 |
ENDDO |
425 |
C-- Tendency is minus divergence of the fluxes |
426 |
DO j=jMin,jMax |
427 |
DO i=iMin,iMax |
428 |
gvDiss(i,j) = gvDiss(i,j) |
429 |
& -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k) |
430 |
& *recip_rAs(i,j,bi,bj) |
431 |
& *( fVerVkp(i,j) - fVerVkm(i,j) )*rkSign |
432 |
ENDDO |
433 |
ENDDO |
434 |
ENDIF |
435 |
|
436 |
C-- No-slip and drag BCs appear as body forces in cell abutting topography |
437 |
IF ( no_slip_sides ) THEN |
438 |
C- No-slip BCs impose a drag at walls... |
439 |
CALL MOM_V_SIDEDRAG( bi, bj, k, |
440 |
I vFld, del2v, hFacZ, |
441 |
I viscAh_Z, viscA4_Z, |
442 |
I useHarmonicVisc, useBiharmonicVisc, useVariableVisc, |
443 |
O vF, |
444 |
I myThid ) |
445 |
DO j=jMin,jMax |
446 |
DO i=iMin,iMax |
447 |
gvDiss(i,j) = gvDiss(i,j)+vF(i,j) |
448 |
ENDDO |
449 |
ENDDO |
450 |
ENDIF |
451 |
|
452 |
C- No-slip BCs impose a drag at bottom |
453 |
IF ( bottomDragTerms ) THEN |
454 |
CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid) |
455 |
DO j=jMin,jMax |
456 |
DO i=iMin,iMax |
457 |
gvDiss(i,j) = gvDiss(i,j)+vF(i,j) |
458 |
ENDDO |
459 |
ENDDO |
460 |
ENDIF |
461 |
#ifdef ALLOW_SHELFICE |
462 |
IF (useShelfIce.AND.bottomDragTerms ) THEN |
463 |
CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid) |
464 |
DO j=jMin,jMax |
465 |
DO i=iMin,iMax |
466 |
gvDiss(i,j) = gvDiss(i,j) + vF(i,j) |
467 |
ENDDO |
468 |
ENDDO |
469 |
ENDIF |
470 |
#endif /* ALLOW_SHELFICE */ |
471 |
|
472 |
C-- if (momViscosity) end of block. |
473 |
ENDIF |
474 |
|
475 |
C- Return to standard hfacZ (min-4) and mask vort3 accordingly: |
476 |
c CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid) |
477 |
|
478 |
C- Vorticity diagnostics: |
479 |
IF ( writeDiag ) THEN |
480 |
IF (snapshot_mdsio) THEN |
481 |
CALL WRITE_LOCAL_RL('Z3','I10',1,vort3, bi,bj,k,myIter,myThid) |
482 |
ENDIF |
483 |
#ifdef ALLOW_MNC |
484 |
IF (useMNC .AND. snapshot_mnc) THEN |
485 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Z3',vort3, |
486 |
& offsets, myThid) |
487 |
ENDIF |
488 |
#endif /* ALLOW_MNC */ |
489 |
ENDIF |
490 |
#ifdef ALLOW_DIAGNOSTICS |
491 |
IF ( useDiagnostics ) THEN |
492 |
CALL DIAGNOSTICS_FILL(vort3, 'momVort3',k,1,2,bi,bj,myThid) |
493 |
ENDIF |
494 |
#endif /* ALLOW_DIAGNOSTICS */ |
495 |
|
496 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
497 |
|
498 |
C--- Prepare for Advection & Coriolis terms: |
499 |
C- Mask relative vorticity and calculate absolute vorticity |
500 |
DO j=1-OLy,sNy+OLy |
501 |
DO i=1-OLx,sNx+OLx |
502 |
IF ( hFacZ(i,j).EQ.0. ) vort3(i,j) = 0. |
503 |
ENDDO |
504 |
ENDDO |
505 |
IF (useAbsVorticity) |
506 |
& CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
507 |
|
508 |
C-- Horizontal Coriolis terms |
509 |
c IF (useCoriolis .AND. .NOT.useCDscheme |
510 |
c & .AND. .NOT. useAbsVorticity) THEN |
511 |
C- jmc: change it to keep the Coriolis terms when useAbsVorticity=T & momAdvection=F |
512 |
IF ( useCoriolis .AND. |
513 |
& .NOT.( useCDscheme .OR. useAbsVorticity.AND.momAdvection ) |
514 |
& ) THEN |
515 |
IF (useAbsVorticity) THEN |
516 |
CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ, |
517 |
& uCf,myThid) |
518 |
CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ, |
519 |
& vCf,myThid) |
520 |
ELSE |
521 |
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ, |
522 |
& uCf,vCf,myThid) |
523 |
ENDIF |
524 |
DO j=jMin,jMax |
525 |
DO i=iMin,iMax |
526 |
gU(i,j,k,bi,bj) = uCf(i,j) |
527 |
gV(i,j,k,bi,bj) = vCf(i,j) |
528 |
ENDDO |
529 |
ENDDO |
530 |
IF ( writeDiag ) THEN |
531 |
IF (snapshot_mdsio) THEN |
532 |
CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid) |
533 |
CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid) |
534 |
ENDIF |
535 |
#ifdef ALLOW_MNC |
536 |
IF (useMNC .AND. snapshot_mnc) THEN |
537 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fV', uCf, |
538 |
& offsets, myThid) |
539 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'fU', vCf, |
540 |
& offsets, myThid) |
541 |
ENDIF |
542 |
#endif /* ALLOW_MNC */ |
543 |
ENDIF |
544 |
#ifdef ALLOW_DIAGNOSTICS |
545 |
IF ( useDiagnostics ) THEN |
546 |
CALL DIAGNOSTICS_FILL(uCf,'Um_Cori ',k,1,2,bi,bj,myThid) |
547 |
CALL DIAGNOSTICS_FILL(vCf,'Vm_Cori ',k,1,2,bi,bj,myThid) |
548 |
ENDIF |
549 |
#endif /* ALLOW_DIAGNOSTICS */ |
550 |
ELSE |
551 |
DO j=jMin,jMax |
552 |
DO i=iMin,iMax |
553 |
gU(i,j,k,bi,bj) = 0. _d 0 |
554 |
gV(i,j,k,bi,bj) = 0. _d 0 |
555 |
ENDDO |
556 |
ENDDO |
557 |
ENDIF |
558 |
|
559 |
IF (momAdvection) THEN |
560 |
C-- Horizontal advection of relative (or absolute) vorticity |
561 |
IF ( (highOrderVorticity.OR.upwindVorticity) |
562 |
& .AND.useAbsVorticity ) THEN |
563 |
CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ, |
564 |
& uCf,myThid) |
565 |
ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN |
566 |
CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ, |
567 |
& uCf,myThid) |
568 |
ELSEIF ( useAbsVorticity ) THEN |
569 |
CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ, |
570 |
& uCf,myThid) |
571 |
ELSE |
572 |
CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3, hFacZ,r_hFacZ, |
573 |
& uCf,myThid) |
574 |
ENDIF |
575 |
DO j=jMin,jMax |
576 |
DO i=iMin,iMax |
577 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
578 |
ENDDO |
579 |
ENDDO |
580 |
IF ( (highOrderVorticity.OR.upwindVorticity) |
581 |
& .AND.useAbsVorticity ) THEN |
582 |
CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ, |
583 |
& vCf,myThid) |
584 |
ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN |
585 |
CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ, |
586 |
& vCf,myThid) |
587 |
ELSEIF ( useAbsVorticity ) THEN |
588 |
CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ, |
589 |
& vCf,myThid) |
590 |
ELSE |
591 |
CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3, hFacZ,r_hFacZ, |
592 |
& vCf,myThid) |
593 |
ENDIF |
594 |
DO j=jMin,jMax |
595 |
DO i=iMin,iMax |
596 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
597 |
ENDDO |
598 |
ENDDO |
599 |
|
600 |
IF ( writeDiag ) THEN |
601 |
IF (snapshot_mdsio) THEN |
602 |
CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid) |
603 |
CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid) |
604 |
ENDIF |
605 |
#ifdef ALLOW_MNC |
606 |
IF (useMNC .AND. snapshot_mnc) THEN |
607 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zV', uCf, |
608 |
& offsets, myThid) |
609 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'zU', vCf, |
610 |
& offsets, myThid) |
611 |
ENDIF |
612 |
#endif /* ALLOW_MNC */ |
613 |
ENDIF |
614 |
|
615 |
#ifdef ALLOW_TIMEAVE |
616 |
IF (taveFreq.GT.0.) THEN |
617 |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
618 |
& Nr, k, bi, bj, myThid) |
619 |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
620 |
& Nr, k, bi, bj, myThid) |
621 |
ENDIF |
622 |
#endif /* ALLOW_TIMEAVE */ |
623 |
#ifdef ALLOW_DIAGNOSTICS |
624 |
IF ( useDiagnostics ) THEN |
625 |
CALL DIAGNOSTICS_FILL(uCf,'Um_AdvZ3',k,1,2,bi,bj,myThid) |
626 |
CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvZ3',k,1,2,bi,bj,myThid) |
627 |
ENDIF |
628 |
#endif /* ALLOW_DIAGNOSTICS */ |
629 |
|
630 |
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
631 |
IF ( .NOT. momImplVertAdv ) THEN |
632 |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
633 |
DO j=jMin,jMax |
634 |
DO i=iMin,iMax |
635 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
636 |
ENDDO |
637 |
ENDDO |
638 |
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
639 |
DO j=jMin,jMax |
640 |
DO i=iMin,iMax |
641 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
642 |
ENDDO |
643 |
ENDDO |
644 |
#ifdef ALLOW_DIAGNOSTICS |
645 |
IF ( useDiagnostics ) THEN |
646 |
CALL DIAGNOSTICS_FILL(uCf,'Um_AdvRe',k,1,2,bi,bj,myThid) |
647 |
CALL DIAGNOSTICS_FILL(vCf,'Vm_AdvRe',k,1,2,bi,bj,myThid) |
648 |
ENDIF |
649 |
#endif /* ALLOW_DIAGNOSTICS */ |
650 |
ENDIF |
651 |
|
652 |
C-- Bernoulli term |
653 |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
654 |
DO j=jMin,jMax |
655 |
DO i=iMin,iMax |
656 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
657 |
ENDDO |
658 |
ENDDO |
659 |
CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid) |
660 |
DO j=jMin,jMax |
661 |
DO i=iMin,iMax |
662 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
663 |
ENDDO |
664 |
ENDDO |
665 |
IF ( writeDiag ) THEN |
666 |
IF (snapshot_mdsio) THEN |
667 |
CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid) |
668 |
CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid) |
669 |
ENDIF |
670 |
#ifdef ALLOW_MNC |
671 |
IF (useMNC .AND. snapshot_mnc) THEN |
672 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEx', uCf, |
673 |
& offsets, myThid) |
674 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj, 'KEy', vCf, |
675 |
& offsets, myThid) |
676 |
ENDIF |
677 |
#endif /* ALLOW_MNC */ |
678 |
ENDIF |
679 |
|
680 |
C-- end if momAdvection |
681 |
ENDIF |
682 |
|
683 |
C-- 3.D Coriolis term (horizontal momentum, Eastward component: -fprime*w) |
684 |
IF ( use3dCoriolis ) THEN |
685 |
CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,uCf,myThid) |
686 |
DO j=jMin,jMax |
687 |
DO i=iMin,iMax |
688 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
689 |
ENDDO |
690 |
ENDDO |
691 |
IF ( usingCurvilinearGrid ) THEN |
692 |
C- presently, non zero angleSinC array only supported with Curvilinear-Grid |
693 |
CALL MOM_V_CORIOLIS_NH(bi,bj,k,wVel,vCf,myThid) |
694 |
DO j=jMin,jMax |
695 |
DO i=iMin,iMax |
696 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
697 |
ENDDO |
698 |
ENDDO |
699 |
ENDIF |
700 |
ENDIF |
701 |
|
702 |
C-- Non-Hydrostatic (spherical) metric terms |
703 |
IF ( useNHMTerms ) THEN |
704 |
CALL MOM_U_METRIC_NH(bi,bj,k,uFld,wVel,uCf,myThid) |
705 |
DO j=jMin,jMax |
706 |
DO i=iMin,iMax |
707 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
708 |
ENDDO |
709 |
ENDDO |
710 |
CALL MOM_V_METRIC_NH(bi,bj,k,vFld,wVel,vCf,myThid) |
711 |
DO j=jMin,jMax |
712 |
DO i=iMin,iMax |
713 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
714 |
ENDDO |
715 |
ENDDO |
716 |
ENDIF |
717 |
|
718 |
C-- Set du/dt & dv/dt on boundaries to zero |
719 |
DO j=jMin,jMax |
720 |
DO i=iMin,iMax |
721 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj) |
722 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj) |
723 |
ENDDO |
724 |
ENDDO |
725 |
|
726 |
#ifdef ALLOW_DEBUG |
727 |
IF ( debugLevel .GE. debLevC |
728 |
& .AND. k.EQ.4 .AND. myIter.EQ.nIter0 |
729 |
& .AND. nPx.EQ.1 .AND. nPy.EQ.1 |
730 |
& .AND. useCubedSphereExchange ) THEN |
731 |
CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV', |
732 |
& guDiss,gvDiss, k, standardMessageUnit,bi,bj,myThid ) |
733 |
ENDIF |
734 |
#endif /* ALLOW_DEBUG */ |
735 |
|
736 |
IF ( writeDiag ) THEN |
737 |
IF (snapshot_mdsio) THEN |
738 |
CALL WRITE_LOCAL_RL('W3','I10',1,omega3, bi,bj,k,myIter,myThid) |
739 |
CALL WRITE_LOCAL_RL('KE','I10',1,KE, bi,bj,k,myIter,myThid) |
740 |
CALL WRITE_LOCAL_RL('D', 'I10',1,hDiv, bi,bj,k,myIter,myThid) |
741 |
CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid) |
742 |
CALL WRITE_LOCAL_RL('Du','I10',1,guDiss, bi,bj,k,myIter,myThid) |
743 |
CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss, bi,bj,k,myIter,myThid) |
744 |
ENDIF |
745 |
#ifdef ALLOW_MNC |
746 |
IF (useMNC .AND. snapshot_mnc) THEN |
747 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'W3',omega3, |
748 |
& offsets, myThid) |
749 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'KE',KE, |
750 |
& offsets, myThid) |
751 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'D', hDiv, |
752 |
& offsets, myThid) |
753 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dt',tension, |
754 |
& offsets, myThid) |
755 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Du',guDiss, |
756 |
& offsets, myThid) |
757 |
CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dv',gvDiss, |
758 |
& offsets, myThid) |
759 |
ENDIF |
760 |
#endif /* ALLOW_MNC */ |
761 |
ENDIF |
762 |
|
763 |
#ifdef ALLOW_DIAGNOSTICS |
764 |
IF ( useDiagnostics ) THEN |
765 |
CALL DIAGNOSTICS_FILL(KE, 'momKE ',k,1,2,bi,bj,myThid) |
766 |
IF (momViscosity) THEN |
767 |
CALL DIAGNOSTICS_FILL(hDiv, 'momHDiv ',k,1,2,bi,bj,myThid) |
768 |
CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid) |
769 |
CALL DIAGNOSTICS_FILL(guDiss, 'Um_Diss ',k,1,2,bi,bj,myThid) |
770 |
CALL DIAGNOSTICS_FILL(gvDiss, 'Vm_Diss ',k,1,2,bi,bj,myThid) |
771 |
ENDIF |
772 |
CALL DIAGNOSTICS_FILL(gU(1-OLx,1-OLy,k,bi,bj), |
773 |
& 'Um_Advec',k,1,2,bi,bj,myThid) |
774 |
CALL DIAGNOSTICS_FILL(gV(1-OLx,1-OLy,k,bi,bj), |
775 |
& 'Vm_Advec',k,1,2,bi,bj,myThid) |
776 |
ENDIF |
777 |
#endif /* ALLOW_DIAGNOSTICS */ |
778 |
|
779 |
#endif /* ALLOW_MOM_VECINV */ |
780 |
|
781 |
RETURN |
782 |
END |