/[MITgcm]/MITgcm/model/src/dynamics.F
ViewVC logotype

Contents of /MITgcm/model/src/dynamics.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.108 - (show annotations) (download)
Fri Sep 17 23:02:00 2004 UTC (19 years, 8 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint55, checkpoint55b_post, checkpoint55a_post
Changes since 1.107: +1 -8 lines
o bringing adjoint up to date for sheduled c55

1 C $Header: /u/gcmpack/MITgcm/model/src/dynamics.F,v 1.107 2004/07/06 01:05:53 jmc Exp $
2 C $Name: $
3
4 #include "PACKAGES_CONFIG.h"
5 #include "CPP_OPTIONS.h"
6
7 CBOP
8 C !ROUTINE: DYNAMICS
9 C !INTERFACE:
10 SUBROUTINE DYNAMICS(myTime, myIter, myThid)
11 C !DESCRIPTION: \bv
12 C *==========================================================*
13 C | SUBROUTINE DYNAMICS
14 C | o Controlling routine for the explicit part of the model
15 C | dynamics.
16 C *==========================================================*
17 C | This routine evaluates the "dynamics" terms for each
18 C | block of ocean in turn. Because the blocks of ocean have
19 C | overlap regions they are independent of one another.
20 C | If terms involving lateral integrals are needed in this
21 C | routine care will be needed. Similarly finite-difference
22 C | operations with stencils wider than the overlap region
23 C | require special consideration.
24 C | The algorithm...
25 C |
26 C | "Correction Step"
27 C | =================
28 C | Here we update the horizontal velocities with the surface
29 C | pressure such that the resulting flow is either consistent
30 C | with the free-surface evolution or the rigid-lid:
31 C | U[n] = U* + dt x d/dx P
32 C | V[n] = V* + dt x d/dy P
33 C |
34 C | "Calculation of Gs"
35 C | ===================
36 C | This is where all the accelerations and tendencies (ie.
37 C | physics, parameterizations etc...) are calculated
38 C | rho = rho ( theta[n], salt[n] )
39 C | b = b(rho, theta)
40 C | K31 = K31 ( rho )
41 C | Gu[n] = Gu( u[n], v[n], wVel, b, ... )
42 C | Gv[n] = Gv( u[n], v[n], wVel, b, ... )
43 C | Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
44 C | Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
45 C |
46 C | "Time-stepping" or "Prediction"
47 C | ================================
48 C | The models variables are stepped forward with the appropriate
49 C | time-stepping scheme (currently we use Adams-Bashforth II)
50 C | - For momentum, the result is always *only* a "prediction"
51 C | in that the flow may be divergent and will be "corrected"
52 C | later with a surface pressure gradient.
53 C | - Normally for tracers the result is the new field at time
54 C | level [n+1} *BUT* in the case of implicit diffusion the result
55 C | is also *only* a prediction.
56 C | - We denote "predictors" with an asterisk (*).
57 C | U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
58 C | V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
59 C | theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
60 C | salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
61 C | With implicit diffusion:
62 C | theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
63 C | salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
64 C | (1 + dt * K * d_zz) theta[n] = theta*
65 C | (1 + dt * K * d_zz) salt[n] = salt*
66 C |
67 C *==========================================================*
68 C \ev
69 C !USES:
70 IMPLICIT NONE
71 C == Global variables ===
72 #include "SIZE.h"
73 #include "EEPARAMS.h"
74 #include "PARAMS.h"
75 #include "DYNVARS.h"
76 #ifdef ALLOW_CD_CODE
77 #include "CD_CODE_VARS.h"
78 #endif
79 #include "GRID.h"
80 #ifdef ALLOW_AUTODIFF_TAMC
81 # include "tamc.h"
82 # include "tamc_keys.h"
83 # include "FFIELDS.h"
84 # include "EOS.h"
85 # ifdef ALLOW_KPP
86 # include "KPP.h"
87 # endif
88 #endif /* ALLOW_AUTODIFF_TAMC */
89
90 C !CALLING SEQUENCE:
91 C DYNAMICS()
92 C |
93 C |-- CALC_GRAD_PHI_SURF
94 C |
95 C |-- CALC_VISCOSITY
96 C |
97 C |-- CALC_PHI_HYD
98 C |
99 C |-- MOM_FLUXFORM
100 C |
101 C |-- MOM_VECINV
102 C |
103 C |-- TIMESTEP
104 C |
105 C |-- OBCS_APPLY_UV
106 C |
107 C |-- IMPLDIFF
108 C |
109 C |-- OBCS_APPLY_UV
110 C |
111 C |-- CALL TIMEAVE_CUMUL_1T
112 C |-- CALL DEBUG_STATS_RL
113
114 C !INPUT/OUTPUT PARAMETERS:
115 C == Routine arguments ==
116 C myTime - Current time in simulation
117 C myIter - Current iteration number in simulation
118 C myThid - Thread number for this instance of the routine.
119 _RL myTime
120 INTEGER myIter
121 INTEGER myThid
122
123 C !LOCAL VARIABLES:
124 C == Local variables
125 C fVer[STUV] o fVer: Vertical flux term - note fVer
126 C is "pipelined" in the vertical
127 C so we need an fVer for each
128 C variable.
129 C phiHydC :: hydrostatic potential anomaly at cell center
130 C In z coords phiHyd is the hydrostatic potential
131 C (=pressure/rho0) anomaly
132 C In p coords phiHyd is the geopotential height anomaly.
133 C phiHydF :: hydrostatic potential anomaly at middle between 2 centers
134 C dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom.
135 C phiSurfX, :: gradient of Surface potential (Pressure/rho, ocean)
136 C phiSurfY or geopotential (atmos) in X and Y direction
137 C iMin, iMax - Ranges and sub-block indices on which calculations
138 C jMin, jMax are applied.
139 C bi, bj
140 C k, kup, - Index for layer above and below. kup and kDown
141 C kDown, km1 are switched with layer to be the appropriate
142 C index into fVerTerm.
143 _RL fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
144 _RL fVerV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
145 _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
146 _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
147 _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
148 _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
149 _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
150 _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
151 _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
152 _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
153
154 INTEGER iMin, iMax
155 INTEGER jMin, jMax
156 INTEGER bi, bj
157 INTEGER i, j
158 INTEGER k, km1, kp1, kup, kDown
159
160 LOGICAL DIFFERENT_MULTIPLE
161 EXTERNAL DIFFERENT_MULTIPLE
162
163 C--- The algorithm...
164 C
165 C "Correction Step"
166 C =================
167 C Here we update the horizontal velocities with the surface
168 C pressure such that the resulting flow is either consistent
169 C with the free-surface evolution or the rigid-lid:
170 C U[n] = U* + dt x d/dx P
171 C V[n] = V* + dt x d/dy P
172 C
173 C "Calculation of Gs"
174 C ===================
175 C This is where all the accelerations and tendencies (ie.
176 C physics, parameterizations etc...) are calculated
177 C rho = rho ( theta[n], salt[n] )
178 C b = b(rho, theta)
179 C K31 = K31 ( rho )
180 C Gu[n] = Gu( u[n], v[n], wVel, b, ... )
181 C Gv[n] = Gv( u[n], v[n], wVel, b, ... )
182 C Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
183 C Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
184 C
185 C "Time-stepping" or "Prediction"
186 C ================================
187 C The models variables are stepped forward with the appropriate
188 C time-stepping scheme (currently we use Adams-Bashforth II)
189 C - For momentum, the result is always *only* a "prediction"
190 C in that the flow may be divergent and will be "corrected"
191 C later with a surface pressure gradient.
192 C - Normally for tracers the result is the new field at time
193 C level [n+1} *BUT* in the case of implicit diffusion the result
194 C is also *only* a prediction.
195 C - We denote "predictors" with an asterisk (*).
196 C U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
197 C V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
198 C theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
199 C salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
200 C With implicit diffusion:
201 C theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
202 C salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
203 C (1 + dt * K * d_zz) theta[n] = theta*
204 C (1 + dt * K * d_zz) salt[n] = salt*
205 C---
206 CEOP
207
208 C-- Call to routine for calculation of
209 C Eliassen-Palm-flux-forced U-tendency,
210 C if desired:
211 #ifdef INCLUDE_EP_FORCING_CODE
212 CALL CALC_EP_FORCING(myThid)
213 #endif
214
215 #ifdef ALLOW_AUTODIFF_TAMC
216 C-- HPF directive to help TAMC
217 CHPF$ INDEPENDENT
218 #endif /* ALLOW_AUTODIFF_TAMC */
219
220 DO bj=myByLo(myThid),myByHi(myThid)
221
222 #ifdef ALLOW_AUTODIFF_TAMC
223 C-- HPF directive to help TAMC
224 CHPF$ INDEPENDENT, NEW (fVerU,fVerV
225 CHPF$& ,phiHydF
226 CHPF$& ,KappaRU,KappaRV
227 CHPF$& )
228 #endif /* ALLOW_AUTODIFF_TAMC */
229
230 DO bi=myBxLo(myThid),myBxHi(myThid)
231
232 #ifdef ALLOW_AUTODIFF_TAMC
233 act1 = bi - myBxLo(myThid)
234 max1 = myBxHi(myThid) - myBxLo(myThid) + 1
235 act2 = bj - myByLo(myThid)
236 max2 = myByHi(myThid) - myByLo(myThid) + 1
237 act3 = myThid - 1
238 max3 = nTx*nTy
239 act4 = ikey_dynamics - 1
240 idynkey = (act1 + 1) + act2*max1
241 & + act3*max1*max2
242 & + act4*max1*max2*max3
243 #endif /* ALLOW_AUTODIFF_TAMC */
244
245 C-- Set up work arrays with valid (i.e. not NaN) values
246 C These inital values do not alter the numerical results. They
247 C just ensure that all memory references are to valid floating
248 C point numbers. This prevents spurious hardware signals due to
249 C uninitialised but inert locations.
250
251 DO k=1,Nr
252 DO j=1-OLy,sNy+OLy
253 DO i=1-OLx,sNx+OLx
254 KappaRU(i,j,k) = 0. _d 0
255 KappaRV(i,j,k) = 0. _d 0
256 #ifdef ALLOW_AUTODIFF_TAMC
257 cph(
258 c-- need some re-initialisation here to break dependencies
259 c-- totphihyd is assumed zero from ini_pressure, i.e.
260 c-- avoiding iterate pressure p = integral of (g*rho(p)*dz)
261 cph)
262 totPhiHyd(i,j,k,bi,bj) = 0. _d 0
263 gu(i,j,k,bi,bj) = 0. _d 0
264 gv(i,j,k,bi,bj) = 0. _d 0
265 #endif
266 ENDDO
267 ENDDO
268 ENDDO
269 DO j=1-OLy,sNy+OLy
270 DO i=1-OLx,sNx+OLx
271 fVerU (i,j,1) = 0. _d 0
272 fVerU (i,j,2) = 0. _d 0
273 fVerV (i,j,1) = 0. _d 0
274 fVerV (i,j,2) = 0. _d 0
275 phiHydF (i,j) = 0. _d 0
276 phiHydC (i,j) = 0. _d 0
277 dPhiHydX(i,j) = 0. _d 0
278 dPhiHydY(i,j) = 0. _d 0
279 phiSurfX(i,j) = 0. _d 0
280 phiSurfY(i,j) = 0. _d 0
281 ENDDO
282 ENDDO
283
284 C-- Start computation of dynamics
285 iMin = 0
286 iMax = sNx+1
287 jMin = 0
288 jMax = sNy+1
289
290 #ifdef ALLOW_AUTODIFF_TAMC
291 CADJ STORE wvel (:,:,:,bi,bj) =
292 CADJ & comlev1_bibj, key = idynkey, byte = isbyte
293 #endif /* ALLOW_AUTODIFF_TAMC */
294
295 C-- Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
296 C (note: this loop will be replaced by CALL CALC_GRAD_ETA)
297 IF (implicSurfPress.NE.1.) THEN
298 CALL CALC_GRAD_PHI_SURF(
299 I bi,bj,iMin,iMax,jMin,jMax,
300 I etaN,
301 O phiSurfX,phiSurfY,
302 I myThid )
303 ENDIF
304
305 #ifdef ALLOW_AUTODIFF_TAMC
306 CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
307 CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
308 #ifdef ALLOW_KPP
309 CADJ STORE KPPviscAz (:,:,:,bi,bj)
310 CADJ & = comlev1_bibj, key=idynkey, byte=isbyte
311 #endif /* ALLOW_KPP */
312 #endif /* ALLOW_AUTODIFF_TAMC */
313
314 #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL
315 C-- Calculate the total vertical diffusivity
316 DO k=1,Nr
317 CALL CALC_VISCOSITY(
318 I bi,bj,iMin,iMax,jMin,jMax,k,
319 O KappaRU,KappaRV,
320 I myThid)
321 ENDDO
322 #endif
323
324 #ifdef ALLOW_AUTODIFF_TAMC
325 CADJ STORE KappaRU(:,:,:)
326 CADJ & = comlev1_bibj, key=idynkey, byte=isbyte
327 CADJ STORE KappaRV(:,:,:)
328 CADJ & = comlev1_bibj, key=idynkey, byte=isbyte
329 #endif /* ALLOW_AUTODIFF_TAMC */
330
331 C-- Start of dynamics loop
332 DO k=1,Nr
333
334 C-- km1 Points to level above k (=k-1)
335 C-- kup Cycles through 1,2 to point to layer above
336 C-- kDown Cycles through 2,1 to point to current layer
337
338 km1 = MAX(1,k-1)
339 kp1 = MIN(k+1,Nr)
340 kup = 1+MOD(k+1,2)
341 kDown= 1+MOD(k,2)
342
343 #ifdef ALLOW_AUTODIFF_TAMC
344 kkey = (idynkey-1)*Nr + k
345 c
346 CADJ STORE totphihyd (:,:,k,bi,bj)
347 CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte
348 CADJ STORE theta (:,:,k,bi,bj)
349 CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte
350 CADJ STORE salt (:,:,k,bi,bj)
351 CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte
352 #endif /* ALLOW_AUTODIFF_TAMC */
353
354 C-- Integrate hydrostatic balance for phiHyd with BC of
355 C phiHyd(z=0)=0
356 CALL CALC_PHI_HYD(
357 I bi,bj,iMin,iMax,jMin,jMax,k,
358 I theta, salt,
359 U phiHydF,
360 O phiHydC, dPhiHydX, dPhiHydY,
361 I myTime, myIter, myThid )
362
363 C-- Calculate accelerations in the momentum equations (gU, gV, ...)
364 C and step forward storing the result in gU, gV, etc...
365 IF ( momStepping ) THEN
366 #ifdef ALLOW_MOM_FLUXFORM
367 IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(
368 I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
369 I dPhiHydX,dPhiHydY,KappaRU,KappaRV,
370 U fVerU, fVerV,
371 I myTime, myIter, myThid)
372 #endif
373 #ifdef ALLOW_MOM_VECINV
374 IF (vectorInvariantMomentum) CALL MOM_VECINV(
375 I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
376 I dPhiHydX,dPhiHydY,KappaRU,KappaRV,
377 U fVerU, fVerV,
378 I myTime, myIter, myThid)
379 #endif
380 CALL TIMESTEP(
381 I bi,bj,iMin,iMax,jMin,jMax,k,
382 I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
383 I myTime, myIter, myThid)
384
385 #ifdef ALLOW_OBCS
386 C-- Apply open boundary conditions
387 IF (useOBCS) THEN
388 CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
389 ENDIF
390 #endif /* ALLOW_OBCS */
391
392 ENDIF
393
394
395 C-- end of dynamics k loop (1:Nr)
396 ENDDO
397
398 C-- Implicit Vertical advection & viscosity
399 #ifdef INCLUDE_IMPLVERTADV_CODE
400 IF ( momImplVertAdv ) THEN
401 CALL MOM_U_IMPLICIT_R( kappaRU,
402 I bi, bj, myTime, myIter, myThid )
403 CALL MOM_V_IMPLICIT_R( kappaRV,
404 I bi, bj, myTime, myIter, myThid )
405 ELSEIF ( implicitViscosity ) THEN
406 #else /* INCLUDE_IMPLVERTADV_CODE */
407 IF ( implicitViscosity ) THEN
408 #endif /* INCLUDE_IMPLVERTADV_CODE */
409 #ifdef ALLOW_AUTODIFF_TAMC
410 CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
411 CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
412 #endif /* ALLOW_AUTODIFF_TAMC */
413 CALL IMPLDIFF(
414 I bi, bj, iMin, iMax, jMin, jMax,
415 I deltaTmom, KappaRU,recip_HFacW,
416 U gU,
417 I myThid )
418 #ifdef ALLOW_AUTODIFF_TAMC
419 CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
420 CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
421 #endif /* ALLOW_AUTODIFF_TAMC */
422 CALL IMPLDIFF(
423 I bi, bj, iMin, iMax, jMin, jMax,
424 I deltaTmom, KappaRV,recip_HFacS,
425 U gV,
426 I myThid )
427 ENDIF
428
429 #ifdef ALLOW_OBCS
430 C-- Apply open boundary conditions
431 IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN
432 DO K=1,Nr
433 CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
434 ENDDO
435 ENDIF
436 #endif /* ALLOW_OBCS */
437
438 #ifdef ALLOW_CD_CODE
439 IF (implicitViscosity.AND.useCDscheme) THEN
440 #ifdef ALLOW_AUTODIFF_TAMC
441 CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
442 #endif /* ALLOW_AUTODIFF_TAMC */
443 CALL IMPLDIFF(
444 I bi, bj, iMin, iMax, jMin, jMax,
445 I deltaTmom, KappaRU,recip_HFacW,
446 U vVelD,
447 I myThid )
448 #ifdef ALLOW_AUTODIFF_TAMC
449 CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
450 #endif /* ALLOW_AUTODIFF_TAMC */
451 CALL IMPLDIFF(
452 I bi, bj, iMin, iMax, jMin, jMax,
453 I deltaTmom, KappaRV,recip_HFacS,
454 U uVelD,
455 I myThid )
456 ENDIF
457 #endif /* ALLOW_CD_CODE */
458 C-- End implicit Vertical advection & viscosity
459
460 ENDDO
461 ENDDO
462
463 Cml(
464 C In order to compare the variance of phiHydLow of a p/z-coordinate
465 C run with etaH of a z/p-coordinate run the drift of phiHydLow
466 C has to be removed by something like the following subroutine:
467 C CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF,
468 C & 'phiHydLow', myThid )
469 Cml)
470
471 #ifdef ALLOW_DEBUG
472 If ( debugLevel .GE. debLevB ) THEN
473 CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
474 CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
475 CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
476 CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
477 CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
478 CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
479 CALL DEBUG_STATS_RL(Nr,Gu,'Gu (DYNAMICS)',myThid)
480 CALL DEBUG_STATS_RL(Nr,Gv,'Gv (DYNAMICS)',myThid)
481 CALL DEBUG_STATS_RL(Nr,Gt,'Gt (DYNAMICS)',myThid)
482 CALL DEBUG_STATS_RL(Nr,Gs,'Gs (DYNAMICS)',myThid)
483 CALL DEBUG_STATS_RL(Nr,GuNm1,'GuNm1 (DYNAMICS)',myThid)
484 CALL DEBUG_STATS_RL(Nr,GvNm1,'GvNm1 (DYNAMICS)',myThid)
485 CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (DYNAMICS)',myThid)
486 CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (DYNAMICS)',myThid)
487 ENDIF
488 #endif
489
490 RETURN
491 END

  ViewVC Help
Powered by ViewVC 1.1.22