1 |
C $Header: /u/gcmpack/MITgcm/model/src/timestep.F,v 1.49 2009/11/29 03:12:32 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "PACKAGES_CONFIG.h" |
5 |
#include "CPP_OPTIONS.h" |
6 |
#ifdef ALLOW_CD_CODE |
7 |
#include "CD_CODE_OPTIONS.h" |
8 |
#endif |
9 |
|
10 |
CBOP |
11 |
C !ROUTINE: TIMESTEP |
12 |
C !INTERFACE: |
13 |
SUBROUTINE TIMESTEP( bi, bj, iMin, iMax, jMin, jMax, k, |
14 |
I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, |
15 |
I guDissip, gvDissip, |
16 |
I myTime, myIter, myThid ) |
17 |
C !DESCRIPTION: \bv |
18 |
C *==========================================================* |
19 |
C | S/R TIMESTEP |
20 |
C | o Step model fields forward in time |
21 |
C *==========================================================* |
22 |
C \ev |
23 |
|
24 |
C !USES: |
25 |
IMPLICIT NONE |
26 |
C == Global variables == |
27 |
#include "SIZE.h" |
28 |
#include "EEPARAMS.h" |
29 |
#include "PARAMS.h" |
30 |
#include "GRID.h" |
31 |
#include "SURFACE.h" |
32 |
#include "RESTART.h" |
33 |
#include "DYNVARS.h" |
34 |
#ifdef ALLOW_NONHYDROSTATIC |
35 |
#include "NH_VARS.h" |
36 |
#endif |
37 |
|
38 |
C !INPUT/OUTPUT PARAMETERS: |
39 |
C == Routine Arguments == |
40 |
C dPhiHydX,Y :: Gradient (X & Y directions) of Hydrostatic Potential |
41 |
C phiSurfX :: gradient of Surface potential (Pressure/rho, ocean) |
42 |
C phiSurfY :: or geopotential (atmos) in X and Y direction |
43 |
C guDissip :: dissipation tendency (all explicit terms), u component |
44 |
C gvDissip :: dissipation tendency (all explicit terms), v component |
45 |
|
46 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
47 |
INTEGER k |
48 |
_RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
49 |
_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
50 |
_RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
51 |
_RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
52 |
_RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
53 |
_RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
54 |
_RL myTime |
55 |
INTEGER myIter, myThid |
56 |
|
57 |
C !LOCAL VARIABLES: |
58 |
C == Local variables == |
59 |
INTEGER i,j |
60 |
_RL phxFac,phyFac, psFac |
61 |
_RL gUtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
62 |
_RL gVtmp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
63 |
#ifdef ALLOW_NONHYDROSTATIC |
64 |
_RL nhFac |
65 |
#endif |
66 |
#ifdef ALLOW_DIAGNOSTICS |
67 |
C Allow diagnosis of external forcing |
68 |
LOGICAL DIAGNOSTICS_IS_ON |
69 |
EXTERNAL DIAGNOSTICS_IS_ON |
70 |
#endif |
71 |
LOGICAL externForcDiagIsOn |
72 |
#if (defined ALLOW_DIAGNOSTICS) || (defined CD_CODE_NO_AB_MOMENTUM) |
73 |
_RL gUext(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
74 |
_RL gVext(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
75 |
#endif |
76 |
#ifdef ALLOW_CD_CODE |
77 |
_RL guCor(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
78 |
_RL gvCor(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
79 |
#endif |
80 |
CEOP |
81 |
|
82 |
C-- explicit part of the surface potential gradient is added in this S/R |
83 |
psFac = pfFacMom*(1. _d 0 - implicSurfPress) |
84 |
& *recip_deepFacC(k)*recip_rhoFacC(k) |
85 |
|
86 |
C-- factors for gradient (X & Y directions) of Hydrostatic Potential |
87 |
phxFac = pfFacMom |
88 |
phyFac = pfFacMom |
89 |
|
90 |
externForcDiagIsOn = useDiagnostics .AND. momForcing |
91 |
#ifdef ALLOW_DIAGNOSTICS |
92 |
IF ( externForcDiagIsOn ) THEN |
93 |
externForcDiagIsOn = DIAGNOSTICS_IS_ON('Um_Ext ',myThid) |
94 |
& .OR. DIAGNOSTICS_IS_ON('Vm_Ext ',myThid) |
95 |
ENDIF |
96 |
#endif /* ALLOW_DIAGNOSTICS */ |
97 |
|
98 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
99 |
|
100 |
C- Initialize local arrays (not really necessary but safer) |
101 |
DO j=1-Oly,sNy+Oly |
102 |
DO i=1-Olx,sNx+Olx |
103 |
gUtmp(i,j) = 0. _d 0 |
104 |
gVtmp(i,j) = 0. _d 0 |
105 |
#ifdef ALLOW_CD_CODE |
106 |
guCor(i,j) = 0. _d 0 |
107 |
gvCor(i,j) = 0. _d 0 |
108 |
#endif |
109 |
ENDDO |
110 |
ENDDO |
111 |
|
112 |
IF ( .NOT.staggerTimeStep .AND. .NOT. implicitIntGravWave ) THEN |
113 |
C-- Synchronous time step: add grad Phi_Hyp to gU,gV before doing Adams-Bashforth |
114 |
DO j=jMin,jMax |
115 |
DO i=iMin,iMax |
116 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj) - phxFac*dPhiHydX(i,j) |
117 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj) - phyFac*dPhiHydY(i,j) |
118 |
ENDDO |
119 |
ENDDO |
120 |
phxFac = 0. |
121 |
phyFac = 0. |
122 |
c ELSE |
123 |
C-- Stagger time step: grad Phi_Hyp will be added later |
124 |
ENDIF |
125 |
|
126 |
C-- Dissipation term inside the Adams-Bashforth: |
127 |
IF ( momViscosity .AND. momDissip_In_AB) THEN |
128 |
DO j=jMin,jMax |
129 |
DO i=iMin,iMax |
130 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj) + guDissip(i,j) |
131 |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj) + gvDissip(i,j) |
132 |
ENDDO |
133 |
ENDDO |
134 |
ENDIF |
135 |
|
136 |
C-- Forcing term inside the Adams-Bashforth: |
137 |
IF ( momForcing .AND. momForcingOutAB.NE.1 ) THEN |
138 |
#ifdef ALLOW_DIAGNOSTICS |
139 |
IF ( externForcDiagIsOn ) THEN |
140 |
DO j=1,sNy+1 |
141 |
DO i=1,sNx+1 |
142 |
gUext(i,j) = gU(i,j,k,bi,bj) |
143 |
gVext(i,j) = gV(i,j,k,bi,bj) |
144 |
ENDDO |
145 |
ENDDO |
146 |
ENDIF |
147 |
#endif /* ALLOW_DIAGNOSTICS */ |
148 |
|
149 |
CALL EXTERNAL_FORCING_U( |
150 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
151 |
I myTime,myThid) |
152 |
CALL EXTERNAL_FORCING_V( |
153 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
154 |
I myTime,myThid) |
155 |
|
156 |
#ifdef ALLOW_DIAGNOSTICS |
157 |
IF ( externForcDiagIsOn ) THEN |
158 |
DO j=1,sNy+1 |
159 |
DO i=1,sNx+1 |
160 |
gUext(i,j) = gU(i,j,k,bi,bj)-gUext(i,j) |
161 |
gVext(i,j) = gV(i,j,k,bi,bj)-gVext(i,j) |
162 |
ENDDO |
163 |
ENDDO |
164 |
ENDIF |
165 |
#endif /* ALLOW_DIAGNOSTICS */ |
166 |
ENDIF |
167 |
|
168 |
#ifdef CD_CODE_NO_AB_MOMENTUM |
169 |
IF (useCDscheme) THEN |
170 |
C- CD-scheme, before doing AB, store gU,Vtmp = gU,V^n (+dissip. +forcing) |
171 |
DO j=jMin,jMax |
172 |
DO i=iMin,iMax |
173 |
gUtmp(i,j) = gU(i,j,k,bi,bj) |
174 |
gVtmp(i,j) = gV(i,j,k,bi,bj) |
175 |
ENDDO |
176 |
ENDDO |
177 |
ENDIF |
178 |
#endif /* CD_CODE_NO_AB_MOMENTUM */ |
179 |
|
180 |
C- Compute effective gU,gV_[n+1/2] terms (including Adams-Bashforth weights) |
181 |
C and save gU,gV_[n] into guNm1,gvNm1 for the next time step. |
182 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
183 |
CALL ADAMS_BASHFORTH3( |
184 |
I bi, bj, k, |
185 |
U gU, guNm, |
186 |
I mom_StartAB, myIter, myThid ) |
187 |
CALL ADAMS_BASHFORTH3( |
188 |
I bi, bj, k, |
189 |
U gV, gvNm, |
190 |
I mom_StartAB, myIter, myThid ) |
191 |
#else /* ALLOW_ADAMSBASHFORTH_3 */ |
192 |
CALL ADAMS_BASHFORTH2( |
193 |
I bi, bj, k, |
194 |
U gU, guNm1, |
195 |
I mom_StartAB, myIter, myThid ) |
196 |
CALL ADAMS_BASHFORTH2( |
197 |
I bi, bj, k, |
198 |
U gV, gvNm1, |
199 |
I mom_StartAB, myIter, myThid ) |
200 |
#endif /* ALLOW_ADAMSBASHFORTH_3 */ |
201 |
|
202 |
C-- Forcing term outside the Adams-Bashforth: |
203 |
IF ( momForcing .AND. momForcingOutAB.EQ.1 ) THEN |
204 |
|
205 |
#if (defined ALLOW_DIAGNOSTICS) || (defined CD_CODE_NO_AB_MOMENTUM) |
206 |
IF ( externForcDiagIsOn .OR. useCDscheme ) THEN |
207 |
DO j=jMin,jMax |
208 |
DO i=iMin,iMax |
209 |
gUext(i,j) = gU(i,j,k,bi,bj) |
210 |
gVext(i,j) = gV(i,j,k,bi,bj) |
211 |
ENDDO |
212 |
ENDDO |
213 |
ENDIF |
214 |
#endif /* ALLOW_DIAGNOSTICS or CD_CODE_NO_AB_MOMENTUM */ |
215 |
|
216 |
CALL EXTERNAL_FORCING_U( |
217 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
218 |
I myTime,myThid) |
219 |
CALL EXTERNAL_FORCING_V( |
220 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
221 |
I myTime,myThid) |
222 |
|
223 |
#if (defined ALLOW_DIAGNOSTICS) || (defined CD_CODE_NO_AB_MOMENTUM) |
224 |
IF ( externForcDiagIsOn .OR. useCDscheme ) THEN |
225 |
DO j=jMin,jMax |
226 |
DO i=iMin,iMax |
227 |
gUext(i,j) = gU(i,j,k,bi,bj)-gUext(i,j) |
228 |
gVext(i,j) = gV(i,j,k,bi,bj)-gVext(i,j) |
229 |
ENDDO |
230 |
ENDDO |
231 |
ENDIF |
232 |
#endif /* ALLOW_DIAGNOSTICS or CD_CODE_NO_AB_MOMENTUM */ |
233 |
|
234 |
C-- Forcing term outside the Adams-Bashforth: end of if block |
235 |
ENDIF |
236 |
|
237 |
#ifdef ALLOW_CD_CODE |
238 |
IF (useCDscheme) THEN |
239 |
#ifdef CD_CODE_NO_AB_MOMENTUM |
240 |
C- CD-scheme, add forcing to gU,Vtmp = gU,V^n (+ dissip.) |
241 |
IF ( momForcing .AND. momForcingOutAB.EQ.1 ) THEN |
242 |
DO j=jMin,jMax |
243 |
DO i=iMin,iMax |
244 |
gUtmp(i,j) = gUtmp(i,j) + guExt(i,j) |
245 |
gVtmp(i,j) = gVtmp(i,j) + gvExt(i,j) |
246 |
ENDDO |
247 |
ENDDO |
248 |
ENDIF |
249 |
#else /* CD_CODE_NO_AB_MOMENTUM */ |
250 |
C- CD-scheme, store gU,Vtmp = gU,V^n+1/2 (+dissip.) +forcing |
251 |
DO j=jMin,jMax |
252 |
DO i=iMin,iMax |
253 |
gUtmp(i,j) = gU(i,j,k,bi,bj) |
254 |
gVtmp(i,j) = gV(i,j,k,bi,bj) |
255 |
ENDDO |
256 |
ENDDO |
257 |
#endif /* CD_CODE_NO_AB_MOMENTUM */ |
258 |
IF ( momViscosity .AND. .NOT.momDissip_In_AB ) THEN |
259 |
C- CD-scheme, add dissip. to gU,Vtmp = gU,V + forcing |
260 |
DO j=jMin,jMax |
261 |
DO i=iMin,iMax |
262 |
gUtmp(i,j) = gUtmp(i,j) + guDissip(i,j) |
263 |
gVtmp(i,j) = gVtmp(i,j) + gvDissip(i,j) |
264 |
ENDDO |
265 |
ENDDO |
266 |
ENDIF |
267 |
C- Step forward D-grid velocity using C-grid gU,Vtmp = gU,V +dissip +forcing |
268 |
C and return coriolis terms on C-grid (guCor,gvCor) |
269 |
CALL CD_CODE_SCHEME( |
270 |
I bi,bj,k, dPhiHydX,dPhiHydY, gUtmp,gVtmp, |
271 |
O guCor,gvCor, |
272 |
I myTime, myIter, myThid) |
273 |
DO j=jMin,jMax |
274 |
DO i=iMin,iMax |
275 |
gUtmp(i,j) = gU(i,j,k,bi,bj) |
276 |
& + guCor(i,j) |
277 |
gVtmp(i,j) = gV(i,j,k,bi,bj) |
278 |
& + gvCor(i,j) |
279 |
ENDDO |
280 |
ENDDO |
281 |
ELSE |
282 |
#endif /* ALLOW_CD_CODE */ |
283 |
DO j=jMin,jMax |
284 |
DO i=iMin,iMax |
285 |
gUtmp(i,j) = gU(i,j,k,bi,bj) |
286 |
gVtmp(i,j) = gV(i,j,k,bi,bj) |
287 |
ENDDO |
288 |
ENDDO |
289 |
#ifdef ALLOW_CD_CODE |
290 |
ENDIF |
291 |
#endif /* ALLOW_CD_CODE */ |
292 |
|
293 |
#ifdef NONLIN_FRSURF |
294 |
IF ( .NOT. vectorInvariantMomentum |
295 |
& .AND. nonlinFreeSurf.GT.1 ) THEN |
296 |
IF (select_rStar.GT.0) THEN |
297 |
DO j=jMin,jMax |
298 |
DO i=iMin,iMax |
299 |
gUtmp(i,j) = gUtmp(i,j)/rStarExpW(i,j,bi,bj) |
300 |
gVtmp(i,j) = gVtmp(i,j)/rStarExpS(i,j,bi,bj) |
301 |
ENDDO |
302 |
ENDDO |
303 |
ELSE |
304 |
DO j=jMin,jMax |
305 |
DO i=iMin,iMax |
306 |
IF ( k.EQ.ksurfW(i,j,bi,bj) ) THEN |
307 |
gUtmp(i,j) = gUtmp(i,j) |
308 |
& *_hFacW(i,j,k,bi,bj)/hFac_surfW(i,j,bi,bj) |
309 |
ENDIF |
310 |
IF ( k.EQ.ksurfS(i,j,bi,bj) ) THEN |
311 |
gVtmp(i,j) = gVtmp(i,j) |
312 |
& *_hFacS(i,j,k,bi,bj)/hFac_surfS(i,j,bi,bj) |
313 |
ENDIF |
314 |
ENDDO |
315 |
ENDDO |
316 |
ENDIF |
317 |
ENDIF |
318 |
#endif /* NONLIN_FRSURF */ |
319 |
|
320 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
321 |
|
322 |
C-- Dissipation term outside the Adams-Bashforth: |
323 |
IF ( momViscosity .AND. .NOT.momDissip_In_AB ) THEN |
324 |
DO j=jMin,jMax |
325 |
DO i=iMin,iMax |
326 |
gUtmp(i,j) = gUtmp(i,j) + guDissip(i,j) |
327 |
gVtmp(i,j) = gVtmp(i,j) + gvDissip(i,j) |
328 |
ENDDO |
329 |
ENDDO |
330 |
ENDIF |
331 |
|
332 |
#ifdef ALLOW_NONHYDROSTATIC |
333 |
C-- explicit part of the NH pressure gradient is added here |
334 |
IF ( use3Dsolver .AND. implicitNHPress.NE.1. _d 0 ) THEN |
335 |
nhFac = pfFacMom*(1. _d 0 - implicitNHPress) |
336 |
& *recip_deepFacC(k)*recip_rhoFacC(k) |
337 |
DO j=jMin,jMax |
338 |
DO i=iMin,iMax |
339 |
gUtmp(i,j) = gUtmp(i,j) |
340 |
& - nhFac*_recip_dxC(i,j,bi,bj)* |
341 |
& (phi_nh(i,j,k,bi,bj)-phi_nh(i-1,j,k,bi,bj)) |
342 |
gVtmp(i,j) = gVtmp(i,j) |
343 |
& - nhFac*_recip_dyC(i,j,bi,bj)* |
344 |
& (phi_nh(i,j,k,bi,bj)-phi_nh(i,j-1,k,bi,bj)) |
345 |
ENDDO |
346 |
ENDDO |
347 |
ENDIF |
348 |
#endif /* ALLOW_NONHYDROSTATIC */ |
349 |
|
350 |
C Step forward zonal velocity (store in Gu) |
351 |
DO j=jMin,jMax |
352 |
DO i=iMin,iMax |
353 |
gU(i,j,k,bi,bj) = uVel(i,j,k,bi,bj) |
354 |
& +deltaTmom*( |
355 |
& gUtmp(i,j) |
356 |
& - psFac*phiSurfX(i,j) |
357 |
& - phxFac*dPhiHydX(i,j) |
358 |
& )*_maskW(i,j,k,bi,bj) |
359 |
ENDDO |
360 |
ENDDO |
361 |
|
362 |
C Step forward meridional velocity (store in Gv) |
363 |
DO j=jMin,jMax |
364 |
DO i=iMin,iMax |
365 |
gV(i,j,k,bi,bj) = vVel(i,j,k,bi,bj) |
366 |
& +deltaTmom*( |
367 |
& gVtmp(i,j) |
368 |
& - psFac*phiSurfY(i,j) |
369 |
& - phyFac*dPhiHydY(i,j) |
370 |
& )*_maskS(i,j,k,bi,bj) |
371 |
ENDDO |
372 |
ENDDO |
373 |
|
374 |
#ifdef ALLOW_DIAGNOSTICS |
375 |
IF ( externForcDiagIsOn ) THEN |
376 |
CALL DIAGNOSTICS_FILL( gUext,'Um_Ext ',k,1,2,bi,bj,myThid ) |
377 |
CALL DIAGNOSTICS_FILL( gVext,'Vm_Ext ',k,1,2,bi,bj,myThid ) |
378 |
ENDIF |
379 |
#ifdef ALLOW_CD_CODE |
380 |
IF ( useCDscheme .AND. useDiagnostics ) THEN |
381 |
CALL DIAGNOSTICS_FILL( guCor,'Um_Cori ',k,1,2,bi,bj,myThid ) |
382 |
CALL DIAGNOSTICS_FILL( gvCor,'Vm_Cori ',k,1,2,bi,bj,myThid ) |
383 |
ENDIF |
384 |
#endif /* ALLOW_CD_CODE */ |
385 |
#endif /* ALLOW_DIAGNOSTICS */ |
386 |
|
387 |
RETURN |
388 |
END |