/[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.76 - (show annotations) (download)
Mon Aug 13 18:05:26 2001 UTC (22 years, 9 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint40pre6
Changes since 1.75: +76 -27 lines
Modifications related to split into thermodynamics.F, dynamics.F
o missing initialisations in dynamics.F added
o some fields no longer needed in dynamics/thermodynamics deleted
o split of calc_diffusivity.F into calc_viscosity.F
  (plus split of kpp_calc_diff.F into kpp_calc_visc.F)
o Modifications of some store directives for TAF

1 C $Header: /u/gcmpack/models/MITgcmUV/model/src/dynamics.F,v 1.75 2001/08/03 19:06:11 adcroft Exp $
2 C $Name: $
3
4 #include "CPP_OPTIONS.h"
5
6 SUBROUTINE DYNAMICS(myTime, myIter, myThid)
7 C /==========================================================\
8 C | SUBROUTINE DYNAMICS |
9 C | o Controlling routine for the explicit part of the model |
10 C | dynamics. |
11 C |==========================================================|
12 C | This routine evaluates the "dynamics" terms for each |
13 C | block of ocean in turn. Because the blocks of ocean have |
14 C | overlap regions they are independent of one another. |
15 C | If terms involving lateral integrals are needed in this |
16 C | routine care will be needed. Similarly finite-difference |
17 C | operations with stencils wider than the overlap region |
18 C | require special consideration. |
19 C | Notes |
20 C | ===== |
21 C | C*P* comments indicating place holders for which code is |
22 C | presently being developed. |
23 C \==========================================================/
24 IMPLICIT NONE
25
26 C == Global variables ===
27 #include "SIZE.h"
28 #include "EEPARAMS.h"
29 #include "PARAMS.h"
30 #include "DYNVARS.h"
31 #include "GRID.h"
32 #ifdef ALLOW_PASSIVE_TRACER
33 #include "TR1.h"
34 #endif
35
36 #ifdef ALLOW_AUTODIFF_TAMC
37 # include "tamc.h"
38 # include "tamc_keys.h"
39 # include "FFIELDS.h"
40 # ifdef ALLOW_KPP
41 # include "KPP.h"
42 # endif
43 # ifdef ALLOW_GMREDI
44 # include "GMREDI.h"
45 # endif
46 #endif /* ALLOW_AUTODIFF_TAMC */
47
48 #ifdef ALLOW_TIMEAVE
49 #include "TIMEAVE_STATV.h"
50 #endif
51
52 C == Routine arguments ==
53 C myTime - Current time in simulation
54 C myIter - Current iteration number in simulation
55 C myThid - Thread number for this instance of the routine.
56 _RL myTime
57 INTEGER myIter
58 INTEGER myThid
59
60 C == Local variables
61 C maskUp o maskUp: land/water mask for W points
62 C fVer[STUV] o fVer: Vertical flux term - note fVer
63 C is "pipelined" in the vertical
64 C so we need an fVer for each
65 C variable.
66 C rhoK, rhoKM1 - Density at current level, and level above
67 C phiHyd - Hydrostatic part of the potential phiHydi.
68 C In z coords phiHydiHyd is the hydrostatic
69 C Potential (=pressure/rho0) anomaly
70 C In p coords phiHydiHyd is the geopotential
71 C surface height anomaly.
72 C phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)
73 C phiSurfY or geopotentiel (atmos) in X and Y direction
74 C iMin, iMax - Ranges and sub-block indices on which calculations
75 C jMin, jMax are applied.
76 C bi, bj
77 C k, kup, - Index for layer above and below. kup and kDown
78 C kDown, km1 are switched with layer to be the appropriate
79 C index into fVerTerm.
80 C tauAB - Adams-Bashforth timestepping weight: 0=forward ; 1/2=Adams-Bashf.
81 _RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
82 _RL fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
83 _RL fVerV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
84 _RL phiHyd (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
85 _RL rhokm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
86 _RL rhok (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
87 _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
88 _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
89 _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
90 _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
91 _RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
92 _RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
93 _RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
94 _RL tauAB
95
96 C This is currently used by IVDC and Diagnostics
97 _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
98
99 INTEGER iMin, iMax
100 INTEGER jMin, jMax
101 INTEGER bi, bj
102 INTEGER i, j
103 INTEGER k, km1, kup, kDown
104
105 Cjmc : add for phiHyd output <- but not working if multi tile per CPU
106 c CHARACTER*(MAX_LEN_MBUF) suff
107 c LOGICAL DIFFERENT_MULTIPLE
108 c EXTERNAL DIFFERENT_MULTIPLE
109 Cjmc(end)
110
111 C--- The algorithm...
112 C
113 C "Correction Step"
114 C =================
115 C Here we update the horizontal velocities with the surface
116 C pressure such that the resulting flow is either consistent
117 C with the free-surface evolution or the rigid-lid:
118 C U[n] = U* + dt x d/dx P
119 C V[n] = V* + dt x d/dy P
120 C
121 C "Calculation of Gs"
122 C ===================
123 C This is where all the accelerations and tendencies (ie.
124 C physics, parameterizations etc...) are calculated
125 C rho = rho ( theta[n], salt[n] )
126 C b = b(rho, theta)
127 C K31 = K31 ( rho )
128 C Gu[n] = Gu( u[n], v[n], wVel, b, ... )
129 C Gv[n] = Gv( u[n], v[n], wVel, b, ... )
130 C Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
131 C Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
132 C
133 C "Time-stepping" or "Prediction"
134 C ================================
135 C The models variables are stepped forward with the appropriate
136 C time-stepping scheme (currently we use Adams-Bashforth II)
137 C - For momentum, the result is always *only* a "prediction"
138 C in that the flow may be divergent and will be "corrected"
139 C later with a surface pressure gradient.
140 C - Normally for tracers the result is the new field at time
141 C level [n+1} *BUT* in the case of implicit diffusion the result
142 C is also *only* a prediction.
143 C - We denote "predictors" with an asterisk (*).
144 C U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
145 C V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
146 C theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
147 C salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
148 C With implicit diffusion:
149 C theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
150 C salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
151 C (1 + dt * K * d_zz) theta[n] = theta*
152 C (1 + dt * K * d_zz) salt[n] = salt*
153 C---
154
155 C-- Set up work arrays with valid (i.e. not NaN) values
156 C These inital values do not alter the numerical results. They
157 C just ensure that all memory references are to valid floating
158 C point numbers. This prevents spurious hardware signals due to
159 C uninitialised but inert locations.
160 DO j=1-OLy,sNy+OLy
161 DO i=1-OLx,sNx+OLx
162 DO k=1,Nr
163 phiHyd(i,j,k) = 0. _d 0
164 KappaRU(i,j,k) = 0. _d 0
165 KappaRV(i,j,k) = 0. _d 0
166 sigmaX(i,j,k) = 0. _d 0
167 sigmaY(i,j,k) = 0. _d 0
168 sigmaR(i,j,k) = 0. _d 0
169 ENDDO
170 rhoKM1 (i,j) = 0. _d 0
171 rhok (i,j) = 0. _d 0
172 phiSurfX(i,j) = 0. _d 0
173 phiSurfY(i,j) = 0. _d 0
174 ENDDO
175 ENDDO
176
177 #ifdef ALLOW_AUTODIFF_TAMC
178 C-- HPF directive to help TAMC
179 CHPF$ INDEPENDENT
180 #endif /* ALLOW_AUTODIFF_TAMC */
181
182 DO bj=myByLo(myThid),myByHi(myThid)
183
184 #ifdef ALLOW_AUTODIFF_TAMC
185 C-- HPF directive to help TAMC
186 CHPF$ INDEPENDENT, NEW (fVerU,fVerV
187 CHPF$& ,phiHyd
188 CHPF$& ,KappaRU,KappaRV
189 CHPF$& )
190 #endif /* ALLOW_AUTODIFF_TAMC */
191
192 DO bi=myBxLo(myThid),myBxHi(myThid)
193
194 #ifdef ALLOW_AUTODIFF_TAMC
195 act1 = bi - myBxLo(myThid)
196 max1 = myBxHi(myThid) - myBxLo(myThid) + 1
197
198 act2 = bj - myByLo(myThid)
199 max2 = myByHi(myThid) - myByLo(myThid) + 1
200
201 act3 = myThid - 1
202 max3 = nTx*nTy
203
204 act4 = ikey_dynamics - 1
205
206 ikey = (act1 + 1) + act2*max1
207 & + act3*max1*max2
208 & + act4*max1*max2*max3
209 #endif /* ALLOW_AUTODIFF_TAMC */
210
211 C-- Set up work arrays that need valid initial values
212 DO j=1-OLy,sNy+OLy
213 DO i=1-OLx,sNx+OLx
214 fVerU (i,j,1) = 0. _d 0
215 fVerU (i,j,2) = 0. _d 0
216 fVerV (i,j,1) = 0. _d 0
217 fVerV (i,j,2) = 0. _d 0
218 ENDDO
219 ENDDO
220
221 C-- Start computation of dynamics
222 iMin = 1-OLx+2
223 iMax = sNx+OLx-1
224 jMin = 1-OLy+2
225 jMax = sNy+OLy-1
226
227 #ifdef ALLOW_AUTODIFF_TAMC
228 CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
229 CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
230 CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
231 #endif /* ALLOW_AUTODIFF_TAMC */
232
233 C-- Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
234 C (note: this loop will be replaced by CALL CALC_GRAD_ETA)
235 IF (implicSurfPress.NE.1.) THEN
236 CALL CALC_GRAD_PHI_SURF(
237 I bi,bj,iMin,iMax,jMin,jMax,
238 I etaN,
239 O phiSurfX,phiSurfY,
240 I myThid )
241 ENDIF
242
243 C-- Start of dynamics loop
244 DO k=1,Nr
245
246 C-- km1 Points to level above k (=k-1)
247 C-- kup Cycles through 1,2 to point to layer above
248 C-- kDown Cycles through 2,1 to point to current layer
249
250 km1 = MAX(1,k-1)
251 kup = 1+MOD(k+1,2)
252 kDown= 1+MOD(k,2)
253
254 #ifdef ALLOW_AUTODIFF_TAMC
255 kkey = (ikey-1)*Nr + k
256 #endif /* ALLOW_AUTODIFF_TAMC */
257
258 C-- Integrate hydrostatic balance for phiHyd with BC of
259 C phiHyd(z=0)=0
260 C distinguishe between Stagger and Non Stagger time stepping
261 IF (staggerTimeStep) THEN
262 CALL CALC_PHI_HYD(
263 I bi,bj,iMin,iMax,jMin,jMax,k,
264 I gTnm1, gSnm1,
265 U phiHyd,
266 I myThid )
267 ELSE
268 CALL CALC_PHI_HYD(
269 I bi,bj,iMin,iMax,jMin,jMax,k,
270 I theta, salt,
271 U phiHyd,
272 I myThid )
273 ENDIF
274
275 #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL
276 C-- Calculate the total vertical diffusivity
277 CALL CALC_VISCOSITY(
278 I bi,bj,iMin,iMax,jMin,jMax,k,
279 I maskUp,
280 O KappaRU,KappaRV,
281 I myThid)
282 #endif
283
284 C-- Calculate accelerations in the momentum equations (gU, gV, ...)
285 C and step forward storing the result in gUnm1, gVnm1, etc...
286 IF ( momStepping ) THEN
287 CALL CALC_MOM_RHS(
288 I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
289 I phiHyd,KappaRU,KappaRV,
290 U fVerU, fVerV,
291 I myTime, myThid)
292 CALL TIMESTEP(
293 I bi,bj,iMin,iMax,jMin,jMax,k,
294 I phiHyd, phiSurfX, phiSurfY,
295 I myIter, myThid)
296
297 #ifdef ALLOW_OBCS
298 C-- Apply open boundary conditions
299 IF (useOBCS) THEN
300 CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )
301 END IF
302 #endif /* ALLOW_OBCS */
303
304 #ifdef ALLOW_AUTODIFF_TAMC
305 #ifdef INCLUDE_CD_CODE
306 ELSE
307 DO j=1-OLy,sNy+OLy
308 DO i=1-OLx,sNx+OLx
309 guCD(i,j,k,bi,bj) = 0.0
310 gvCD(i,j,k,bi,bj) = 0.0
311 END DO
312 END DO
313 #endif /* INCLUDE_CD_CODE */
314 #endif /* ALLOW_AUTODIFF_TAMC */
315 ENDIF
316
317
318 C-- end of dynamics k loop (1:Nr)
319 ENDDO
320
321
322
323 C-- Implicit viscosity
324 IF (implicitViscosity.AND.momStepping) THEN
325 #ifdef ALLOW_AUTODIFF_TAMC
326 idkey = iikey + 3
327 CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
328 #endif /* ALLOW_AUTODIFF_TAMC */
329 CALL IMPLDIFF(
330 I bi, bj, iMin, iMax, jMin, jMax,
331 I deltaTmom, KappaRU,recip_HFacW,
332 U gUNm1,
333 I myThid )
334 #ifdef ALLOW_AUTODIFF_TAMC
335 idkey = iikey + 4
336 CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
337 #endif /* ALLOW_AUTODIFF_TAMC */
338 CALL IMPLDIFF(
339 I bi, bj, iMin, iMax, jMin, jMax,
340 I deltaTmom, KappaRV,recip_HFacS,
341 U gVNm1,
342 I myThid )
343
344 #ifdef ALLOW_OBCS
345 C-- Apply open boundary conditions
346 IF (useOBCS) THEN
347 DO K=1,Nr
348 CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )
349 ENDDO
350 END IF
351 #endif /* ALLOW_OBCS */
352
353 #ifdef INCLUDE_CD_CODE
354 #ifdef ALLOW_AUTODIFF_TAMC
355 idkey = iikey + 5
356 CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
357 #endif /* ALLOW_AUTODIFF_TAMC */
358 CALL IMPLDIFF(
359 I bi, bj, iMin, iMax, jMin, jMax,
360 I deltaTmom, KappaRU,recip_HFacW,
361 U vVelD,
362 I myThid )
363 #ifdef ALLOW_AUTODIFF_TAMC
364 idkey = iikey + 6
365 CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
366 #endif /* ALLOW_AUTODIFF_TAMC */
367 CALL IMPLDIFF(
368 I bi, bj, iMin, iMax, jMin, jMax,
369 I deltaTmom, KappaRV,recip_HFacS,
370 U uVelD,
371 I myThid )
372 #endif /* INCLUDE_CD_CODE */
373 C-- End If implicitViscosity.AND.momStepping
374 ENDIF
375
376 Cjmc : add for phiHyd output <- but not working if multi tile per CPU
377 c IF ( DIFFERENT_MULTIPLE(dumpFreq,myTime+deltaTClock,myTime)
378 c & .AND. buoyancyRelation .eq. 'ATMOSPHERIC' ) THEN
379 c WRITE(suff,'(I10.10)') myIter+1
380 c CALL WRITE_FLD_XYZ_RL('PH.',suff,phiHyd,myIter+1,myThid)
381 c ENDIF
382 Cjmc(end)
383
384 #ifdef ALLOW_TIMEAVE
385 IF (taveFreq.GT.0.) THEN
386 CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr,
387 I deltaTclock, bi, bj, myThid)
388 IF (ivdc_kappa.NE.0.) THEN
389 CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr,
390 I deltaTclock, bi, bj, myThid)
391 ENDIF
392 ENDIF
393 #endif /* ALLOW_TIMEAVE */
394
395 ENDDO
396 ENDDO
397
398 #ifndef EXCLUDE_DEBUGMODE
399 If (debugMode) THEN
400 CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
401 CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
402 CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
403 CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
404 CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
405 CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
406 CALL DEBUG_STATS_RL(Nr,Gu,'Gu (DYNAMICS)',myThid)
407 CALL DEBUG_STATS_RL(Nr,Gv,'Gv (DYNAMICS)',myThid)
408 CALL DEBUG_STATS_RL(Nr,Gt,'Gt (DYNAMICS)',myThid)
409 CALL DEBUG_STATS_RL(Nr,Gs,'Gs (DYNAMICS)',myThid)
410 CALL DEBUG_STATS_RL(Nr,GuNm1,'GuNm1 (DYNAMICS)',myThid)
411 CALL DEBUG_STATS_RL(Nr,GvNm1,'GvNm1 (DYNAMICS)',myThid)
412 CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (DYNAMICS)',myThid)
413 CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (DYNAMICS)',myThid)
414 ENDIF
415 #endif
416
417 RETURN
418 END

  ViewVC Help
Powered by ViewVC 1.1.22