| 1 |
C $Header: /u/gcmpack/MITgcm/model/src/calc_r_star.F,v 1.20 2011/02/21 16:47:47 jmc Exp $ |
| 2 |
C $Name: $ |
| 3 |
|
| 4 |
#include "PACKAGES_CONFIG.h" |
| 5 |
#include "CPP_OPTIONS.h" |
| 6 |
#ifdef ALLOW_EXCH2 |
| 7 |
# include "W2_OPTIONS.h" |
| 8 |
#endif |
| 9 |
|
| 10 |
CBOP |
| 11 |
C !ROUTINE: CALC_R_STAR |
| 12 |
C !INTERFACE: |
| 13 |
SUBROUTINE CALC_R_STAR( etaFld, |
| 14 |
I myTime, myIter, myThid ) |
| 15 |
C !DESCRIPTION: \bv |
| 16 |
C *==========================================================* |
| 17 |
C | SUBROUTINE CALC_R_STAR |
| 18 |
C | o Calculate new column thickness & scaling factor for r* |
| 19 |
C | according to the surface r-position (Non-Lin Free-Surf) |
| 20 |
C *==========================================================* |
| 21 |
C \ev |
| 22 |
|
| 23 |
C !USES: |
| 24 |
IMPLICIT NONE |
| 25 |
C == Global variables |
| 26 |
#include "SIZE.h" |
| 27 |
#include "EEPARAMS.h" |
| 28 |
#include "PARAMS.h" |
| 29 |
#include "GRID.h" |
| 30 |
#include "SURFACE.h" |
| 31 |
|
| 32 |
C !INPUT/OUTPUT PARAMETERS: |
| 33 |
C == Routine arguments == |
| 34 |
C etaFld :: current eta field used to update the hFactor |
| 35 |
C myTime :: current time in simulation |
| 36 |
C myIter :: current iteration number in simulation |
| 37 |
C myThid :: thread number for this instance of the routine. |
| 38 |
_RL etaFld(1-Olx:sNx+Olx,1-Oly:sNy+Oly,nSx,nSy) |
| 39 |
_RL myTime |
| 40 |
INTEGER myIter |
| 41 |
INTEGER myThid |
| 42 |
|
| 43 |
#ifdef NONLIN_FRSURF |
| 44 |
|
| 45 |
C !LOCAL VARIABLES: |
| 46 |
C Local variables |
| 47 |
C rStarAreaWeight :: use area weighted average for rStarFac at U & V point |
| 48 |
C i,j, bi,bj :: loop counter |
| 49 |
C numbWrite :: count the Number of warning written on STD-ERR file |
| 50 |
C numbWrMax :: maximum Number of warning written on STD-ERR file |
| 51 |
LOGICAL rStarAreaWeight |
| 52 |
INTEGER i,j,bi,bj |
| 53 |
INTEGER numbWrite, numbWrMax |
| 54 |
INTEGER icntc1, icntc2, icntw, icnts |
| 55 |
INTEGER iic, jjc, iic2, jjc2, iiw, jjw, iis, jjs |
| 56 |
_RL tmpfldW, tmpfldS |
| 57 |
CEOP |
| 58 |
|
| 59 |
#ifdef W2_FILL_NULL_REGIONS |
| 60 |
INTEGER ii,jj |
| 61 |
#endif |
| 62 |
DATA numbWrite / 0 / |
| 63 |
numbWrMax = Nx*Ny |
| 64 |
|
| 65 |
rStarAreaWeight = .TRUE. |
| 66 |
C- Area-weighted average consistent with KE (& vert. advection): |
| 67 |
IF ( vectorInvariantMomentum .AND. |
| 68 |
& (selectKEscheme.EQ.1 .OR. selectKEscheme.EQ.3) |
| 69 |
& ) rStarAreaWeight =.FALSE. |
| 70 |
|
| 71 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
| 72 |
|
| 73 |
#ifdef ALLOW_DEBUG |
| 74 |
IF (debugMode) CALL DEBUG_ENTER('CALC_R_STAR',myThid) |
| 75 |
#endif |
| 76 |
|
| 77 |
DO bj=myByLo(myThid), myByHi(myThid) |
| 78 |
DO bi=myBxLo(myThid), myBxHi(myThid) |
| 79 |
|
| 80 |
C-- before updating rStarFacC/S/W save current fields |
| 81 |
DO j=1-Oly,sNy+Oly |
| 82 |
DO i=1-Olx,sNx+Olx |
| 83 |
rStarFacNm1C(i,j,bi,bj) = rStarFacC(i,j,bi,bj) |
| 84 |
rStarFacNm1S(i,j,bi,bj) = rStarFacS(i,j,bi,bj) |
| 85 |
rStarFacNm1W(i,j,bi,bj) = rStarFacW(i,j,bi,bj) |
| 86 |
ENDDO |
| 87 |
ENDDO |
| 88 |
|
| 89 |
C- 1rst bi,bj loop : |
| 90 |
|
| 91 |
C-- copy rStarFacX -> rStarExpX |
| 92 |
DO j=1-Oly,sNy+Oly |
| 93 |
DO i=1-Olx,sNx+Olx |
| 94 |
rStarExpC(i,j,bi,bj) = rStarFacC(i,j,bi,bj) |
| 95 |
rStarExpW(i,j,bi,bj) = rStarFacW(i,j,bi,bj) |
| 96 |
rStarExpS(i,j,bi,bj) = rStarFacS(i,j,bi,bj) |
| 97 |
ENDDO |
| 98 |
ENDDO |
| 99 |
|
| 100 |
C-- Compute the new column thikness : |
| 101 |
DO j=0,sNy+1 |
| 102 |
DO i=0,sNx+1 |
| 103 |
IF (kSurfC(i,j,bi,bj).LE.Nr ) THEN |
| 104 |
rStarFacC(i,j,bi,bj) = |
| 105 |
& (etaFld(i,j,bi,bj)+Ro_surf(i,j,bi,bj)-R_low(i,j,bi,bj)) |
| 106 |
& *recip_Rcol(i,j,bi,bj) |
| 107 |
ELSE |
| 108 |
rStarFacC(i,j,bi,bj) = 1. |
| 109 |
ENDIF |
| 110 |
ENDDO |
| 111 |
ENDDO |
| 112 |
IF ( rStarAreaWeight ) THEN |
| 113 |
C- Area weighted average |
| 114 |
DO j=1,sNy |
| 115 |
DO i=1,sNx+1 |
| 116 |
IF ( kSurfW(i,j,bi,bj).LE.Nr ) THEN |
| 117 |
tmpfldW = rSurfW(i,j,bi,bj) - rLowW(i,j,bi,bj) |
| 118 |
rStarFacW(i,j,bi,bj) = |
| 119 |
& ( 0.5 _d 0 *( etaFld(i-1,j,bi,bj)*rA(i-1,j,bi,bj) |
| 120 |
& +etaFld(i,j,bi,bj)*rA(i,j,bi,bj) |
| 121 |
& )*recip_rAw(i,j,bi,bj) |
| 122 |
& +tmpfldW )/tmpfldW |
| 123 |
ELSE |
| 124 |
rStarFacW(i,j,bi,bj) = 1. |
| 125 |
ENDIF |
| 126 |
ENDDO |
| 127 |
ENDDO |
| 128 |
DO j=1,sNy+1 |
| 129 |
DO i=1,sNx |
| 130 |
IF ( kSurfS(i,j,bi,bj).LE.Nr ) THEN |
| 131 |
tmpfldS = rSurfS(i,j,bi,bj) - rLowS(i,j,bi,bj) |
| 132 |
rStarFacS(i,j,bi,bj) = |
| 133 |
& ( 0.5 _d 0 *( etaFld(i,j-1,bi,bj)*rA(i,j-1,bi,bj) |
| 134 |
& +etaFld(i,j,bi,bj)*rA(i,j,bi,bj) |
| 135 |
& )*recip_rAs(i,j,bi,bj) |
| 136 |
& +tmpfldS )/tmpfldS |
| 137 |
ELSE |
| 138 |
rStarFacS(i,j,bi,bj) = 1. |
| 139 |
ENDIF |
| 140 |
ENDDO |
| 141 |
ENDDO |
| 142 |
ELSE |
| 143 |
C- Simple average |
| 144 |
DO j=1,sNy |
| 145 |
DO i=1,sNx+1 |
| 146 |
IF ( kSurfW(i,j,bi,bj).LE.Nr ) THEN |
| 147 |
tmpfldW = rSurfW(i,j,bi,bj) - rLowW(i,j,bi,bj) |
| 148 |
rStarFacW(i,j,bi,bj) = |
| 149 |
& ( 0.5 _d 0 *( etaFld(i-1,j,bi,bj) + etaFld(i,j,bi,bj) ) |
| 150 |
& +tmpfldW )/tmpfldW |
| 151 |
ELSE |
| 152 |
rStarFacW(i,j,bi,bj) = 1. |
| 153 |
ENDIF |
| 154 |
ENDDO |
| 155 |
ENDDO |
| 156 |
DO j=1,sNy+1 |
| 157 |
DO i=1,sNx |
| 158 |
IF ( kSurfS(i,j,bi,bj).LE.Nr ) THEN |
| 159 |
tmpfldS = rSurfS(i,j,bi,bj) - rLowS(i,j,bi,bj) |
| 160 |
rStarFacS(i,j,bi,bj) = |
| 161 |
& ( 0.5 _d 0 *( etaFld(i,j-1,bi,bj) + etaFld(i,j,bi,bj) ) |
| 162 |
& +tmpfldS )/tmpfldS |
| 163 |
ELSE |
| 164 |
rStarFacS(i,j,bi,bj) = 1. |
| 165 |
ENDIF |
| 166 |
ENDDO |
| 167 |
ENDDO |
| 168 |
ENDIF |
| 169 |
#ifdef ALLOW_OBCS |
| 170 |
IF (useOBCS) THEN |
| 171 |
CALL OBCS_APPLY_R_STAR( |
| 172 |
I bi, bj, etaFld, |
| 173 |
U rStarFacC, rStarFacW, rStarFacS, |
| 174 |
I myTime, myIter, myThid ) |
| 175 |
ENDIF |
| 176 |
#endif /* ALLOW_OBCS */ |
| 177 |
|
| 178 |
C- Needs to do something when r* ratio is too small ; |
| 179 |
C for now, just stop |
| 180 |
icntc1 = 0 |
| 181 |
icntc2 = 0 |
| 182 |
icntw = 0 |
| 183 |
icnts = 0 |
| 184 |
DO j=1,sNy+1 |
| 185 |
DO i=1,sNx+1 |
| 186 |
IF ( rStarFacC(i,j,bi,bj).LT.hFacInf ) THEN |
| 187 |
icntc1 = icntc1 + 1 |
| 188 |
iic = i |
| 189 |
jjc = j |
| 190 |
ENDIF |
| 191 |
IF ( rStarFacW(i,j,bi,bj).LT.hFacInf ) THEN |
| 192 |
icntw = icntw + 1 |
| 193 |
iiw = i |
| 194 |
jjw = j |
| 195 |
ENDIF |
| 196 |
IF ( rStarFacS(i,j,bi,bj).LT.hFacInf ) THEN |
| 197 |
icnts = icnts + 1 |
| 198 |
iis = i |
| 199 |
jjs = j |
| 200 |
ENDIF |
| 201 |
IF ( rStarFacC(i,j,bi,bj).GT.hFacSup ) THEN |
| 202 |
icntc2 = icntc2 + 1 |
| 203 |
iic2 = i |
| 204 |
jjc2 = j |
| 205 |
ENDIF |
| 206 |
ENDDO |
| 207 |
ENDDO |
| 208 |
IF ( icntc1+icnts+icntw .GT. 0 ) THEN |
| 209 |
C- Print an error msg and then stop: |
| 210 |
IF ( icntw .GT. 0 ) THEN |
| 211 |
tmpfldW = rSurfW(iiw,jjw,bi,bj) - rLowW(iiw,jjw,bi,bj) |
| 212 |
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)') |
| 213 |
& 'WARNING: r*FacW < hFacInf at',icntw, |
| 214 |
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter |
| 215 |
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P3E14.6)') |
| 216 |
& ' e.g. at i,j=',iiw,jjw,' ; rStarFac,H,eta =', |
| 217 |
& rStarFacW(iiw,jjw,bi,bj), tmpfldW, |
| 218 |
& etaFld(iiw-1,jjw,bi,bj), etaFld(iiw,jjw,bi,bj) |
| 219 |
WRITE(errorMessageUnit,'(A)') |
| 220 |
& 'STOP in CALC_R_STAR : too SMALL rStarFacW !' |
| 221 |
ENDIF |
| 222 |
IF ( icnts .GT. 0 ) THEN |
| 223 |
tmpfldS = rSurfS(iis,jjs,bi,bj) - rLowS(iis,jjs,bi,bj) |
| 224 |
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)') |
| 225 |
& 'WARNING: r*FacS < hFacInf at',icnts, |
| 226 |
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter |
| 227 |
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P3E14.6)') |
| 228 |
& ' e.g. at i,j=',iis,jjs,' ; rStarFac,H,eta =', |
| 229 |
& rStarFacS(iis,jjs,bi,bj), tmpfldS, |
| 230 |
& etaFld(iis,jjs-1,bi,bj), etaFld(iis,jjs,bi,bj) |
| 231 |
WRITE(errorMessageUnit,'(A)') |
| 232 |
& 'STOP in CALC_R_STAR : too SMALL rStarFacS !' |
| 233 |
ENDIF |
| 234 |
IF ( icntc1 .GT. 0 ) THEN |
| 235 |
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)') |
| 236 |
& 'WARNING: r*FacC < hFacInf at',icntc1, |
| 237 |
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter |
| 238 |
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P2E14.6)') |
| 239 |
& ' e.g. at i,j=',iic,jjc,' ; rStarFac,H,eta =', |
| 240 |
& rStarFacC(iic,jjc,bi,bj), |
| 241 |
& Ro_surf(iic,jjc,bi,bj)-R_low(iic,jjc,bi,bj), |
| 242 |
& etaFld(iic,jjc,bi,bj) |
| 243 |
WRITE(errorMessageUnit,'(A)') |
| 244 |
& 'STOP in CALC_R_STAR : too SMALL rStarFacC !' |
| 245 |
ENDIF |
| 246 |
STOP 'ABNORMAL END: S/R CALC_R_STAR' |
| 247 |
ENDIF |
| 248 |
C-- Usefull warning when r*Fac becomes very large: |
| 249 |
IF ( icntc2.GT.0 .AND. numbWrite.LE.numbWrMax ) THEN |
| 250 |
numbWrite = numbWrite + 1 |
| 251 |
WRITE(errorMessageUnit,'(A,I8,A,3I4,I10)') |
| 252 |
& 'WARNING: r*FacC > hFacSup at',icntc2, |
| 253 |
& ' pts : bi,bj,Thid,Iter=',bi,bj,myThid,myIter |
| 254 |
WRITE(errorMessageUnit,'(A,2I4,A,1F10.6,1P2E14.6)') |
| 255 |
& ' e.g. at i,j=',iic2,jjc2,' ; rStarFac,H,eta =', |
| 256 |
& rStarFacC(iic2,jjc2,bi,bj), |
| 257 |
& Ro_surf(iic2,jjc2,bi,bj)-R_low(iic2,jjc2,bi,bj), |
| 258 |
& etaFld(iic2,jjc2,bi,bj) |
| 259 |
ENDIF |
| 260 |
|
| 261 |
C- end 1rst bi,bj loop. |
| 262 |
ENDDO |
| 263 |
ENDDO |
| 264 |
|
| 265 |
_EXCH_XY_RL( rStarFacC, myThid ) |
| 266 |
CALL EXCH_UV_XY_RL(rStarFacW,rStarFacS,.FALSE.,myThid) |
| 267 |
|
| 268 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
| 269 |
|
| 270 |
DO bj=myByLo(myThid), myByHi(myThid) |
| 271 |
DO bi=myBxLo(myThid), myBxHi(myThid) |
| 272 |
C- 2nd bi,bj loop : |
| 273 |
|
| 274 |
#ifdef ALLOW_EXCH2 |
| 275 |
#ifdef W2_FILL_NULL_REGIONS |
| 276 |
C- Note: rStarFacC was non-zero EVERYWHERE before exch, but exch2 put zeros |
| 277 |
C in the corner regions of the tile (e.g.:[1-Olx:0,1-Oly:0]) |
| 278 |
C => need to add those lines (or to fix exch2): |
| 279 |
DO j=1,Oly |
| 280 |
DO i=1,Olx |
| 281 |
ii = sNx+i |
| 282 |
jj = sNy+j |
| 283 |
|
| 284 |
IF (kSurfC(1-i,1-j,bi,bj).GT.Nr) rStarFacC(1-i,1-j,bi,bj)= 1. |
| 285 |
IF (kSurfC(ii, 1-j,bi,bj).GT.Nr) rStarFacC(ii, 1-j,bi,bj)= 1. |
| 286 |
IF (kSurfC(1-i,jj, bi,bj).GT.Nr) rStarFacC(1-i,jj, bi,bj)= 1. |
| 287 |
IF (kSurfC(ii, jj, bi,bj).GT.Nr) rStarFacC(ii, jj, bi,bj)= 1. |
| 288 |
|
| 289 |
IF (kSurfW(1-i,1-j,bi,bj).GT.Nr) rStarFacW(1-i,1-j,bi,bj)= 1. |
| 290 |
IF (kSurfW(ii, 1-j,bi,bj).GT.Nr) rStarFacW(ii, 1-j,bi,bj)= 1. |
| 291 |
IF (kSurfW(1-i,jj, bi,bj).GT.Nr) rStarFacW(1-i,jj, bi,bj)= 1. |
| 292 |
IF (kSurfW(ii, jj, bi,bj).GT.Nr) rStarFacW(ii, jj, bi,bj)= 1. |
| 293 |
|
| 294 |
IF (kSurfS(1-i,1-j,bi,bj).GT.Nr) rStarFacS(1-i,1-j,bi,bj)= 1. |
| 295 |
IF (kSurfS(ii, 1-j,bi,bj).GT.Nr) rStarFacS(ii, 1-j,bi,bj)= 1. |
| 296 |
IF (kSurfS(1-i,jj, bi,bj).GT.Nr) rStarFacS(1-i,jj, bi,bj)= 1. |
| 297 |
IF (kSurfS(ii, jj, bi,bj).GT.Nr) rStarFacS(ii, jj, bi,bj)= 1. |
| 298 |
|
| 299 |
ENDDO |
| 300 |
ENDDO |
| 301 |
#endif /* W2_FILL_NULL_REGIONS */ |
| 302 |
#endif /* ALLOW_EXCH2 */ |
| 303 |
|
| 304 |
DO j=1-Oly,sNy+Oly |
| 305 |
DO i=1-Olx,sNx+Olx |
| 306 |
rStarDhCDt(i,j,bi,bj)=(rStarFacC(i,j,bi,bj) |
| 307 |
& -rStarExpC(i,j,bi,bj))/deltaTfreesurf |
| 308 |
rStarDhWDt(i,j,bi,bj)=(rStarFacW(i,j,bi,bj) |
| 309 |
& -rStarExpW(i,j,bi,bj))/deltaTfreesurf |
| 310 |
rStarDhSDt(i,j,bi,bj)=(rStarFacS(i,j,bi,bj) |
| 311 |
& -rStarExpS(i,j,bi,bj))/deltaTfreesurf |
| 312 |
rStarExpC(i,j,bi,bj) = rStarFacC(i,j,bi,bj) |
| 313 |
& / rStarExpC(i,j,bi,bj) |
| 314 |
rStarExpW(i,j,bi,bj) = rStarFacW(i,j,bi,bj) |
| 315 |
& / rStarExpW(i,j,bi,bj) |
| 316 |
rStarExpS(i,j,bi,bj) = rStarFacS(i,j,bi,bj) |
| 317 |
& / rStarExpS(i,j,bi,bj) |
| 318 |
ENDDO |
| 319 |
ENDDO |
| 320 |
|
| 321 |
C- end 2nd bi,bj loop. |
| 322 |
ENDDO |
| 323 |
ENDDO |
| 324 |
|
| 325 |
#ifdef ALLOW_DEBUG |
| 326 |
IF (debugMode) CALL DEBUG_LEAVE('CALC_R_STAR',myThid) |
| 327 |
#endif |
| 328 |
|
| 329 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
| 330 |
#endif /* NONLIN_FRSURF */ |
| 331 |
|
| 332 |
RETURN |
| 333 |
END |
Parent Directory
| 
Revision Log
| 
Revision Graph