3 |
|
|
4 |
#include "CPP_OPTIONS.h" |
#include "CPP_OPTIONS.h" |
5 |
|
|
6 |
|
CBOP |
7 |
|
C !ROUTINE: DYNAMICS |
8 |
|
C !INTERFACE: |
9 |
SUBROUTINE DYNAMICS(myTime, myIter, myThid) |
SUBROUTINE DYNAMICS(myTime, myIter, myThid) |
10 |
C /==========================================================\ |
C !DESCRIPTION: \bv |
11 |
C | SUBROUTINE DYNAMICS | |
C *==========================================================* |
12 |
C | o Controlling routine for the explicit part of the model | |
C | SUBROUTINE DYNAMICS |
13 |
C | dynamics. | |
C | o Controlling routine for the explicit part of the model |
14 |
C |==========================================================| |
C | dynamics. |
15 |
C | This routine evaluates the "dynamics" terms for each | |
C *==========================================================* |
16 |
C | block of ocean in turn. Because the blocks of ocean have | |
C | This routine evaluates the "dynamics" terms for each |
17 |
C | overlap regions they are independent of one another. | |
C | block of ocean in turn. Because the blocks of ocean have |
18 |
C | If terms involving lateral integrals are needed in this | |
C | overlap regions they are independent of one another. |
19 |
C | routine care will be needed. Similarly finite-difference | |
C | If terms involving lateral integrals are needed in this |
20 |
C | operations with stencils wider than the overlap region | |
C | routine care will be needed. Similarly finite-difference |
21 |
C | require special consideration. | |
C | operations with stencils wider than the overlap region |
22 |
C | Notes | |
C | require special consideration. |
23 |
C | ===== | |
C | The algorithm... |
24 |
C | C*P* comments indicating place holders for which code is | |
C | |
25 |
C | presently being developed. | |
C | "Correction Step" |
26 |
C \==========================================================/ |
C | ================= |
27 |
|
C | Here we update the horizontal velocities with the surface |
28 |
|
C | pressure such that the resulting flow is either consistent |
29 |
|
C | with the free-surface evolution or the rigid-lid: |
30 |
|
C | U[n] = U* + dt x d/dx P |
31 |
|
C | V[n] = V* + dt x d/dy P |
32 |
|
C | |
33 |
|
C | "Calculation of Gs" |
34 |
|
C | =================== |
35 |
|
C | This is where all the accelerations and tendencies (ie. |
36 |
|
C | physics, parameterizations etc...) are calculated |
37 |
|
C | rho = rho ( theta[n], salt[n] ) |
38 |
|
C | b = b(rho, theta) |
39 |
|
C | K31 = K31 ( rho ) |
40 |
|
C | Gu[n] = Gu( u[n], v[n], wVel, b, ... ) |
41 |
|
C | Gv[n] = Gv( u[n], v[n], wVel, b, ... ) |
42 |
|
C | Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... ) |
43 |
|
C | Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... ) |
44 |
|
C | |
45 |
|
C | "Time-stepping" or "Prediction" |
46 |
|
C | ================================ |
47 |
|
C | The models variables are stepped forward with the appropriate |
48 |
|
C | time-stepping scheme (currently we use Adams-Bashforth II) |
49 |
|
C | - For momentum, the result is always *only* a "prediction" |
50 |
|
C | in that the flow may be divergent and will be "corrected" |
51 |
|
C | later with a surface pressure gradient. |
52 |
|
C | - Normally for tracers the result is the new field at time |
53 |
|
C | level [n+1} *BUT* in the case of implicit diffusion the result |
54 |
|
C | is also *only* a prediction. |
55 |
|
C | - We denote "predictors" with an asterisk (*). |
56 |
|
C | U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] ) |
57 |
|
C | V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] ) |
58 |
|
C | theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
59 |
|
C | salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
60 |
|
C | With implicit diffusion: |
61 |
|
C | theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
62 |
|
C | salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
63 |
|
C | (1 + dt * K * d_zz) theta[n] = theta* |
64 |
|
C | (1 + dt * K * d_zz) salt[n] = salt* |
65 |
|
C | |
66 |
|
C *==========================================================* |
67 |
|
C \ev |
68 |
|
C !USES: |
69 |
IMPLICIT NONE |
IMPLICIT NONE |
|
|
|
70 |
C == Global variables === |
C == Global variables === |
71 |
#include "SIZE.h" |
#include "SIZE.h" |
72 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
76 |
#ifdef ALLOW_PASSIVE_TRACER |
#ifdef ALLOW_PASSIVE_TRACER |
77 |
#include "TR1.h" |
#include "TR1.h" |
78 |
#endif |
#endif |
|
|
|
79 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
80 |
# include "tamc.h" |
# include "tamc.h" |
81 |
# include "tamc_keys.h" |
# include "tamc_keys.h" |
87 |
# include "GMREDI.h" |
# include "GMREDI.h" |
88 |
# endif |
# endif |
89 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
|
|
|
90 |
#ifdef ALLOW_TIMEAVE |
#ifdef ALLOW_TIMEAVE |
91 |
#include "TIMEAVE_STATV.h" |
#include "TIMEAVE_STATV.h" |
92 |
#endif |
#endif |
93 |
|
|
94 |
|
C !CALLING SEQUENCE: |
95 |
|
C DYNAMICS() |
96 |
|
C | |
97 |
|
C |-- CALC_GRAD_PHI_SURF |
98 |
|
C | |
99 |
|
C |-- CALC_VISCOSITY |
100 |
|
C | |
101 |
|
C |-- CALC_PHI_HYD |
102 |
|
C | |
103 |
|
C |-- MOM_FLUXFORM |
104 |
|
C | |
105 |
|
C |-- MOM_VECINV |
106 |
|
C | |
107 |
|
C |-- TIMESTEP |
108 |
|
C | |
109 |
|
C |-- OBCS_APPLY_UV |
110 |
|
C | |
111 |
|
C |-- IMPLDIFF |
112 |
|
C | |
113 |
|
C |-- OBCS_APPLY_UV |
114 |
|
C | |
115 |
|
C |-- CALL TIMEAVE_CUMUL_1T |
116 |
|
C |-- CALL DEBUG_STATS_RL |
117 |
|
|
118 |
|
C !INPUT/OUTPUT PARAMETERS: |
119 |
C == Routine arguments == |
C == Routine arguments == |
120 |
C myTime - Current time in simulation |
C myTime - Current time in simulation |
121 |
C myIter - Current iteration number in simulation |
C myIter - Current iteration number in simulation |
124 |
INTEGER myIter |
INTEGER myIter |
125 |
INTEGER myThid |
INTEGER myThid |
126 |
|
|
127 |
|
C !LOCAL VARIABLES: |
128 |
C == Local variables |
C == Local variables |
|
C maskUp o maskUp: land/water mask for W points |
|
129 |
C fVer[STUV] o fVer: Vertical flux term - note fVer |
C fVer[STUV] o fVer: Vertical flux term - note fVer |
130 |
C is "pipelined" in the vertical |
C is "pipelined" in the vertical |
131 |
C so we need an fVer for each |
C so we need an fVer for each |
144 |
C k, kup, - Index for layer above and below. kup and kDown |
C k, kup, - Index for layer above and below. kup and kDown |
145 |
C kDown, km1 are switched with layer to be the appropriate |
C kDown, km1 are switched with layer to be the appropriate |
146 |
C index into fVerTerm. |
C index into fVerTerm. |
|
C tauAB - Adams-Bashforth timestepping weight: 0=forward ; 1/2=Adams-Bashf. |
|
|
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
147 |
_RL fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
148 |
_RL fVerV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
149 |
_RL phiHyd (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL phiHyd (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
156 |
_RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
157 |
_RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
158 |
_RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
|
_RL tauAB |
|
|
|
|
|
C This is currently used by IVDC and Diagnostics |
|
|
_RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
|
159 |
|
|
160 |
INTEGER iMin, iMax |
INTEGER iMin, iMax |
161 |
INTEGER jMin, jMax |
INTEGER jMin, jMax |
162 |
INTEGER bi, bj |
INTEGER bi, bj |
163 |
INTEGER i, j |
INTEGER i, j |
164 |
INTEGER k, km1, kup, kDown |
INTEGER k, km1, kp1, kup, kDown |
165 |
|
|
166 |
Cjmc : add for phiHyd output <- but not working if multi tile per CPU |
Cjmc : add for phiHyd output <- but not working if multi tile per CPU |
167 |
c CHARACTER*(MAX_LEN_MBUF) suff |
c CHARACTER*(MAX_LEN_MBUF) suff |
212 |
C (1 + dt * K * d_zz) theta[n] = theta* |
C (1 + dt * K * d_zz) theta[n] = theta* |
213 |
C (1 + dt * K * d_zz) salt[n] = salt* |
C (1 + dt * K * d_zz) salt[n] = salt* |
214 |
C--- |
C--- |
215 |
|
CEOP |
216 |
|
|
217 |
C-- Set up work arrays with valid (i.e. not NaN) values |
C-- Set up work arrays with valid (i.e. not NaN) values |
218 |
C These inital values do not alter the numerical results. They |
C These inital values do not alter the numerical results. They |
256 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
257 |
act1 = bi - myBxLo(myThid) |
act1 = bi - myBxLo(myThid) |
258 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
|
|
|
259 |
act2 = bj - myByLo(myThid) |
act2 = bj - myByLo(myThid) |
260 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
|
|
|
261 |
act3 = myThid - 1 |
act3 = myThid - 1 |
262 |
max3 = nTx*nTy |
max3 = nTx*nTy |
|
|
|
263 |
act4 = ikey_dynamics - 1 |
act4 = ikey_dynamics - 1 |
|
|
|
264 |
ikey = (act1 + 1) + act2*max1 |
ikey = (act1 + 1) + act2*max1 |
265 |
& + act3*max1*max2 |
& + act3*max1*max2 |
266 |
& + act4*max1*max2*max3 |
& + act4*max1*max2*max3 |
283 |
jMax = sNy+OLy-1 |
jMax = sNy+OLy-1 |
284 |
|
|
285 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
|
CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte |
|
|
CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte |
|
286 |
CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte |
CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte |
287 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
288 |
|
|
296 |
I myThid ) |
I myThid ) |
297 |
ENDIF |
ENDIF |
298 |
|
|
299 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
300 |
|
CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte |
301 |
|
CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte |
302 |
|
#ifdef ALLOW_KPP |
303 |
|
CADJ STORE KPPviscAz (:,:,:,bi,bj) |
304 |
|
CADJ & = comlev1_bibj, key=ikey, byte=isbyte |
305 |
|
#endif /* ALLOW_KPP */ |
306 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
307 |
|
|
308 |
|
#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL |
309 |
|
C-- Calculate the total vertical diffusivity |
310 |
|
DO k=1,Nr |
311 |
|
CALL CALC_VISCOSITY( |
312 |
|
I bi,bj,iMin,iMax,jMin,jMax,k, |
313 |
|
O KappaRU,KappaRV, |
314 |
|
I myThid) |
315 |
|
ENDDO |
316 |
|
#endif |
317 |
|
|
318 |
C-- Start of dynamics loop |
C-- Start of dynamics loop |
319 |
DO k=1,Nr |
DO k=1,Nr |
320 |
|
|
323 |
C-- kDown Cycles through 2,1 to point to current layer |
C-- kDown Cycles through 2,1 to point to current layer |
324 |
|
|
325 |
km1 = MAX(1,k-1) |
km1 = MAX(1,k-1) |
326 |
|
kp1 = MIN(k+1,Nr) |
327 |
kup = 1+MOD(k+1,2) |
kup = 1+MOD(k+1,2) |
328 |
kDown= 1+MOD(k,2) |
kDown= 1+MOD(k,2) |
329 |
|
|
337 |
IF (staggerTimeStep) THEN |
IF (staggerTimeStep) THEN |
338 |
CALL CALC_PHI_HYD( |
CALL CALC_PHI_HYD( |
339 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
I bi,bj,iMin,iMax,jMin,jMax,k, |
340 |
I gTnm1, gSnm1, |
I gT, gS, |
341 |
U phiHyd, |
U phiHyd, |
342 |
I myThid ) |
I myThid ) |
343 |
ELSE |
ELSE |
348 |
I myThid ) |
I myThid ) |
349 |
ENDIF |
ENDIF |
350 |
|
|
|
#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL |
|
|
C-- Calculate the total vertical diffusivity |
|
|
CALL CALC_VISCOSITY( |
|
|
I bi,bj,iMin,iMax,jMin,jMax,k, |
|
|
I maskUp, |
|
|
O KappaRU,KappaRV, |
|
|
I myThid) |
|
|
#endif |
|
|
|
|
351 |
C-- Calculate accelerations in the momentum equations (gU, gV, ...) |
C-- Calculate accelerations in the momentum equations (gU, gV, ...) |
352 |
C and step forward storing the result in gUnm1, gVnm1, etc... |
C and step forward storing the result in gUnm1, gVnm1, etc... |
353 |
IF ( momStepping ) THEN |
IF ( momStepping ) THEN |
354 |
CALL CALC_MOM_RHS( |
#ifndef DISABLE_MOM_FLUXFORM |
355 |
|
IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM( |
356 |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
357 |
I phiHyd,KappaRU,KappaRV, |
I phiHyd,KappaRU,KappaRV, |
358 |
U fVerU, fVerV, |
U fVerU, fVerV, |
359 |
I myTime, myThid) |
I myTime, myIter, myThid) |
360 |
|
#endif |
361 |
|
#ifndef DISABLE_MOM_VECINV |
362 |
|
IF (vectorInvariantMomentum) CALL MOM_VECINV( |
363 |
|
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
364 |
|
I phiHyd,KappaRU,KappaRV, |
365 |
|
U fVerU, fVerV, |
366 |
|
I myTime, myIter, myThid) |
367 |
|
#endif |
368 |
CALL TIMESTEP( |
CALL TIMESTEP( |
369 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
I bi,bj,iMin,iMax,jMin,jMax,k, |
370 |
I phiHyd, phiSurfX, phiSurfY, |
I phiHyd, phiSurfX, phiSurfY, |
461 |
IF (taveFreq.GT.0.) THEN |
IF (taveFreq.GT.0.) THEN |
462 |
CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr, |
CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr, |
463 |
I deltaTclock, bi, bj, myThid) |
I deltaTclock, bi, bj, myThid) |
|
IF (ivdc_kappa.NE.0.) THEN |
|
|
CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr, |
|
|
I deltaTclock, bi, bj, myThid) |
|
|
ENDIF |
|
464 |
ENDIF |
ENDIF |
465 |
#endif /* ALLOW_TIMEAVE */ |
#endif /* ALLOW_TIMEAVE */ |
466 |
|
|
467 |
ENDDO |
ENDDO |
468 |
ENDDO |
ENDDO |
469 |
|
|
470 |
#ifndef EXCLUDE_DEBUGMODE |
#ifndef DISABLE_DEBUGMODE |
471 |
If (debugMode) THEN |
If (debugMode) THEN |
472 |
CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) |
CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) |
473 |
CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) |
CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) |