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