1 |
C $Header: /u/gcmpack/MITgcm/model/src/thermodynamics.F,v 1.33 2002/11/22 03:01:18 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "CPP_OPTIONS.h" |
5 |
#ifdef ALLOW_AUTODIFF_TAMC |
6 |
# ifdef ALLOW_GMREDI |
7 |
# include "GMREDI_OPTIONS.h" |
8 |
# endif |
9 |
# ifdef ALLOW_KPP |
10 |
# include "KPP_OPTIONS.h" |
11 |
# endif |
12 |
cswdice --- add ---- |
13 |
#ifdef ALLOW_THERM_SEAICE |
14 |
#include "ICE.h" |
15 |
#endif |
16 |
cswdice ------ |
17 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
18 |
|
19 |
CBOP |
20 |
C !ROUTINE: THERMODYNAMICS |
21 |
C !INTERFACE: |
22 |
SUBROUTINE THERMODYNAMICS(myTime, myIter, myThid) |
23 |
C !DESCRIPTION: \bv |
24 |
C *==========================================================* |
25 |
C | SUBROUTINE THERMODYNAMICS |
26 |
C | o Controlling routine for the prognostic part of the |
27 |
C | thermo-dynamics. |
28 |
C *=========================================================== |
29 |
C | The algorithm... |
30 |
C | |
31 |
C | "Correction Step" |
32 |
C | ================= |
33 |
C | Here we update the horizontal velocities with the surface |
34 |
C | pressure such that the resulting flow is either consistent |
35 |
C | with the free-surface evolution or the rigid-lid: |
36 |
C | U[n] = U* + dt x d/dx P |
37 |
C | V[n] = V* + dt x d/dy P |
38 |
C | |
39 |
C | "Calculation of Gs" |
40 |
C | =================== |
41 |
C | This is where all the accelerations and tendencies (ie. |
42 |
C | physics, parameterizations etc...) are calculated |
43 |
C | rho = rho ( theta[n], salt[n] ) |
44 |
C | b = b(rho, theta) |
45 |
C | K31 = K31 ( rho ) |
46 |
C | Gu[n] = Gu( u[n], v[n], wVel, b, ... ) |
47 |
C | Gv[n] = Gv( u[n], v[n], wVel, b, ... ) |
48 |
C | Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... ) |
49 |
C | Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... ) |
50 |
C | |
51 |
C | "Time-stepping" or "Prediction" |
52 |
C | ================================ |
53 |
C | The models variables are stepped forward with the appropriate |
54 |
C | time-stepping scheme (currently we use Adams-Bashforth II) |
55 |
C | - For momentum, the result is always *only* a "prediction" |
56 |
C | in that the flow may be divergent and will be "corrected" |
57 |
C | later with a surface pressure gradient. |
58 |
C | - Normally for tracers the result is the new field at time |
59 |
C | level [n+1} *BUT* in the case of implicit diffusion the result |
60 |
C | is also *only* a prediction. |
61 |
C | - We denote "predictors" with an asterisk (*). |
62 |
C | U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] ) |
63 |
C | V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] ) |
64 |
C | theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
65 |
C | salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
66 |
C | With implicit diffusion: |
67 |
C | theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
68 |
C | salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) |
69 |
C | (1 + dt * K * d_zz) theta[n] = theta* |
70 |
C | (1 + dt * K * d_zz) salt[n] = salt* |
71 |
C | |
72 |
C *==========================================================* |
73 |
C \ev |
74 |
|
75 |
C !USES: |
76 |
IMPLICIT NONE |
77 |
C == Global variables === |
78 |
#include "SIZE.h" |
79 |
#include "EEPARAMS.h" |
80 |
#include "PARAMS.h" |
81 |
#include "DYNVARS.h" |
82 |
#include "GRID.h" |
83 |
#include "GAD.h" |
84 |
#ifdef ALLOW_PASSIVE_TRACER |
85 |
#include "TR1.h" |
86 |
#endif |
87 |
#ifdef ALLOW_AUTODIFF_TAMC |
88 |
# include "tamc.h" |
89 |
# include "tamc_keys.h" |
90 |
# include "FFIELDS.h" |
91 |
# include "EOS.h" |
92 |
# ifdef ALLOW_KPP |
93 |
# include "KPP.h" |
94 |
# endif |
95 |
# ifdef ALLOW_GMREDI |
96 |
# include "GMREDI.h" |
97 |
# endif |
98 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
99 |
#ifdef ALLOW_TIMEAVE |
100 |
#include "TIMEAVE_STATV.h" |
101 |
#endif |
102 |
|
103 |
C !INPUT/OUTPUT PARAMETERS: |
104 |
C == Routine arguments == |
105 |
C myTime - Current time in simulation |
106 |
C myIter - Current iteration number in simulation |
107 |
C myThid - Thread number for this instance of the routine. |
108 |
_RL myTime |
109 |
INTEGER myIter |
110 |
INTEGER myThid |
111 |
|
112 |
C !LOCAL VARIABLES: |
113 |
C == Local variables |
114 |
C xA, yA - Per block temporaries holding face areas |
115 |
C uTrans, vTrans, rTrans - Per block temporaries holding flow |
116 |
C transport |
117 |
C o uTrans: Zonal transport |
118 |
C o vTrans: Meridional transport |
119 |
C o rTrans: Vertical transport |
120 |
C maskUp o maskUp: land/water mask for W points |
121 |
C fVer[STUV] o fVer: Vertical flux term - note fVer |
122 |
C is "pipelined" in the vertical |
123 |
C so we need an fVer for each |
124 |
C variable. |
125 |
C rhoK, rhoKM1 - Density at current level, and level above |
126 |
C phiHyd - Hydrostatic part of the potential phiHydi. |
127 |
C In z coords phiHydiHyd is the hydrostatic |
128 |
C Potential (=pressure/rho0) anomaly |
129 |
C In p coords phiHydiHyd is the geopotential |
130 |
C surface height anomaly. |
131 |
C phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean) |
132 |
C phiSurfY or geopotentiel (atmos) in X and Y direction |
133 |
C KappaRT, - Total diffusion in vertical for T and S. |
134 |
C KappaRS (background + spatially varying, isopycnal term). |
135 |
C iMin, iMax - Ranges and sub-block indices on which calculations |
136 |
C jMin, jMax are applied. |
137 |
C bi, bj |
138 |
C k, kup, - Index for layer above and below. kup and kDown |
139 |
C kDown, km1 are switched with layer to be the appropriate |
140 |
C index into fVerTerm. |
141 |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
142 |
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
143 |
_RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
144 |
_RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
145 |
_RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
146 |
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
147 |
_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
148 |
_RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
149 |
_RL fVerTr1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
150 |
_RL phiHyd (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
151 |
_RL rhokm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
152 |
_RL rhok (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
153 |
_RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
154 |
_RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
155 |
_RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
156 |
_RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
157 |
_RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
158 |
_RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
159 |
_RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
160 |
C This is currently used by IVDC and Diagnostics |
161 |
_RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
162 |
INTEGER iMin, iMax |
163 |
INTEGER jMin, jMax |
164 |
INTEGER bi, bj |
165 |
INTEGER i, j |
166 |
INTEGER k, km1, kup, kDown |
167 |
|
168 |
CEOP |
169 |
|
170 |
#ifdef ALLOW_AUTODIFF_TAMC |
171 |
C-- dummy statement to end declaration part |
172 |
ikey = 1 |
173 |
itdkey = 1 |
174 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
175 |
|
176 |
C-- Set up work arrays with valid (i.e. not NaN) values |
177 |
C These inital values do not alter the numerical results. They |
178 |
C just ensure that all memory references are to valid floating |
179 |
C point numbers. This prevents spurious hardware signals due to |
180 |
C uninitialised but inert locations. |
181 |
DO j=1-OLy,sNy+OLy |
182 |
DO i=1-OLx,sNx+OLx |
183 |
xA(i,j) = 0. _d 0 |
184 |
yA(i,j) = 0. _d 0 |
185 |
uTrans(i,j) = 0. _d 0 |
186 |
vTrans(i,j) = 0. _d 0 |
187 |
rhok (i,j) = 0. _d 0 |
188 |
phiSurfX(i,j) = 0. _d 0 |
189 |
phiSurfY(i,j) = 0. _d 0 |
190 |
ENDDO |
191 |
ENDDO |
192 |
|
193 |
|
194 |
#ifdef ALLOW_AUTODIFF_TAMC |
195 |
C-- HPF directive to help TAMC |
196 |
CHPF$ INDEPENDENT |
197 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
198 |
|
199 |
DO bj=myByLo(myThid),myByHi(myThid) |
200 |
|
201 |
#ifdef ALLOW_AUTODIFF_TAMC |
202 |
C-- HPF directive to help TAMC |
203 |
CHPF$ INDEPENDENT, NEW (rTrans,fVerT,fVerS |
204 |
CHPF$& ,phiHyd,utrans,vtrans,xA,yA |
205 |
CHPF$& ,KappaRT,KappaRS |
206 |
CHPF$& ) |
207 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
208 |
|
209 |
DO bi=myBxLo(myThid),myBxHi(myThid) |
210 |
|
211 |
#ifdef ALLOW_AUTODIFF_TAMC |
212 |
act1 = bi - myBxLo(myThid) |
213 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
214 |
act2 = bj - myByLo(myThid) |
215 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
216 |
act3 = myThid - 1 |
217 |
max3 = nTx*nTy |
218 |
act4 = ikey_dynamics - 1 |
219 |
itdkey = (act1 + 1) + act2*max1 |
220 |
& + act3*max1*max2 |
221 |
& + act4*max1*max2*max3 |
222 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
223 |
|
224 |
C-- Set up work arrays that need valid initial values |
225 |
DO j=1-OLy,sNy+OLy |
226 |
DO i=1-OLx,sNx+OLx |
227 |
rTrans (i,j) = 0. _d 0 |
228 |
fVerT (i,j,1) = 0. _d 0 |
229 |
fVerT (i,j,2) = 0. _d 0 |
230 |
fVerS (i,j,1) = 0. _d 0 |
231 |
fVerS (i,j,2) = 0. _d 0 |
232 |
fVerTr1(i,j,1) = 0. _d 0 |
233 |
fVerTr1(i,j,2) = 0. _d 0 |
234 |
rhoKM1 (i,j) = 0. _d 0 |
235 |
ENDDO |
236 |
ENDDO |
237 |
|
238 |
DO k=1,Nr |
239 |
DO j=1-OLy,sNy+OLy |
240 |
DO i=1-OLx,sNx+OLx |
241 |
C This is currently also used by IVDC and Diagnostics |
242 |
phiHyd(i,j,k) = 0. _d 0 |
243 |
sigmaX(i,j,k) = 0. _d 0 |
244 |
sigmaY(i,j,k) = 0. _d 0 |
245 |
sigmaR(i,j,k) = 0. _d 0 |
246 |
ConvectCount(i,j,k) = 0. |
247 |
KappaRT(i,j,k) = 0. _d 0 |
248 |
KappaRS(i,j,k) = 0. _d 0 |
249 |
#ifdef ALLOW_AUTODIFF_TAMC |
250 |
cph all the following init. are necessary for TAF |
251 |
cph although some of these are re-initialised later. |
252 |
gT(i,j,k,bi,bj) = 0. _d 0 |
253 |
gS(i,j,k,bi,bj) = 0. _d 0 |
254 |
# ifdef ALLOW_PASSIVE_TRACER |
255 |
gTr1(i,j,k,bi,bj) = 0. _d 0 |
256 |
# endif |
257 |
# ifdef ALLOW_GMREDI |
258 |
Kwx(i,j,k,bi,bj) = 0. _d 0 |
259 |
Kwy(i,j,k,bi,bj) = 0. _d 0 |
260 |
Kwz(i,j,k,bi,bj) = 0. _d 0 |
261 |
# ifdef GM_NON_UNITY_DIAGONAL |
262 |
Kux(i,j,k,bi,bj) = 0. _d 0 |
263 |
Kvy(i,j,k,bi,bj) = 0. _d 0 |
264 |
# endif |
265 |
# ifdef GM_EXTRA_DIAGONAL |
266 |
Kuz(i,j,k,bi,bj) = 0. _d 0 |
267 |
Kvz(i,j,k,bi,bj) = 0. _d 0 |
268 |
# endif |
269 |
# ifdef GM_BOLUS_ADVEC |
270 |
GM_PsiX(i,j,k,bi,bj) = 0. _d 0 |
271 |
GM_PsiY(i,j,k,bi,bj) = 0. _d 0 |
272 |
# endif |
273 |
# endif /* ALLOW_GMREDI */ |
274 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
275 |
ENDDO |
276 |
ENDDO |
277 |
ENDDO |
278 |
|
279 |
iMin = 1-OLx |
280 |
iMax = sNx+OLx |
281 |
jMin = 1-OLy |
282 |
jMax = sNy+OLy |
283 |
|
284 |
|
285 |
#ifdef ALLOW_AUTODIFF_TAMC |
286 |
CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
287 |
CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
288 |
#ifdef ALLOW_KPP |
289 |
CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
290 |
CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
291 |
#endif |
292 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
293 |
|
294 |
C-- Start of diagnostic loop |
295 |
DO k=Nr,1,-1 |
296 |
|
297 |
#ifdef ALLOW_AUTODIFF_TAMC |
298 |
C? Patrick, is this formula correct now that we change the loop range? |
299 |
C? Do we still need this? |
300 |
cph kkey formula corrected. |
301 |
cph Needed for rhok, rhokm1, in the case useGMREDI. |
302 |
kkey = (itdkey-1)*Nr + k |
303 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
304 |
|
305 |
C-- Integrate continuity vertically for vertical velocity |
306 |
c CALL INTEGRATE_FOR_W( |
307 |
c I bi, bj, k, uVel, vVel, |
308 |
c O wVel, |
309 |
c I myThid ) |
310 |
|
311 |
#ifdef ALLOW_OBCS |
312 |
#ifdef ALLOW_NONHYDROSTATIC |
313 |
C-- Apply OBC to W if in N-H mode |
314 |
c IF (useOBCS.AND.nonHydrostatic) THEN |
315 |
c CALL OBCS_APPLY_W( bi, bj, k, wVel, myThid ) |
316 |
c ENDIF |
317 |
#endif /* ALLOW_NONHYDROSTATIC */ |
318 |
#endif /* ALLOW_OBCS */ |
319 |
|
320 |
C-- Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h |
321 |
C-- MOST of THERMODYNAMICS will be disabled |
322 |
#ifndef SINGLE_LAYER_MODE |
323 |
|
324 |
C-- Calculate gradients of potential density for isoneutral |
325 |
C slope terms (e.g. GM/Redi tensor or IVDC diffusivity) |
326 |
c IF ( k.GT.1 .AND. (useGMRedi.OR.ivdc_kappa.NE.0.) ) THEN |
327 |
IF ( useGMRedi .OR. (k.GT.1 .AND. ivdc_kappa.NE.0.) ) THEN |
328 |
#ifdef ALLOW_AUTODIFF_TAMC |
329 |
CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte |
330 |
CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte |
331 |
CADJ STORE pressure(:,:,k,bi,bj) = |
332 |
CADJ & comlev1_bibj_k, key=kkey, byte=isbyte |
333 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
334 |
CALL FIND_RHO( |
335 |
I bi, bj, iMin, iMax, jMin, jMax, k, k, |
336 |
I theta, salt, |
337 |
O rhoK, |
338 |
I myThid ) |
339 |
|
340 |
IF (k.GT.1) THEN |
341 |
#ifdef ALLOW_AUTODIFF_TAMC |
342 |
CADJ STORE theta(:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte |
343 |
CADJ STORE salt (:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte |
344 |
CADJ STORE pressure(:,:,k-1,bi,bj) = |
345 |
CADJ & comlev1_bibj_k, key=kkey, byte=isbyte |
346 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
347 |
CALL FIND_RHO( |
348 |
I bi, bj, iMin, iMax, jMin, jMax, k-1, k, |
349 |
I theta, salt, |
350 |
O rhoKm1, |
351 |
I myThid ) |
352 |
ENDIF |
353 |
CALL GRAD_SIGMA( |
354 |
I bi, bj, iMin, iMax, jMin, jMax, k, |
355 |
I rhoK, rhoKm1, rhoK, |
356 |
O sigmaX, sigmaY, sigmaR, |
357 |
I myThid ) |
358 |
ENDIF |
359 |
|
360 |
#ifdef ALLOW_AUTODIFF_TAMC |
361 |
CADJ STORE rhok (:,:) = comlev1_bibj_k , key=kkey, byte=isbyte |
362 |
CADJ STORE rhokm1 (:,:) = comlev1_bibj_k , key=kkey, byte=isbyte |
363 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
364 |
C-- Implicit Vertical Diffusion for Convection |
365 |
c ==> should use sigmaR !!! |
366 |
IF (k.GT.1 .AND. ivdc_kappa.NE.0.) THEN |
367 |
CALL CALC_IVDC( |
368 |
I bi, bj, iMin, iMax, jMin, jMax, k, |
369 |
I rhoKm1, rhoK, |
370 |
U ConvectCount, KappaRT, KappaRS, |
371 |
I myTime, myIter, myThid) |
372 |
ENDIF |
373 |
|
374 |
#endif /* SINGLE_LAYER_MODE */ |
375 |
|
376 |
C-- end of diagnostic k loop (Nr:1) |
377 |
ENDDO |
378 |
|
379 |
#ifdef ALLOW_AUTODIFF_TAMC |
380 |
cph avoids recomputation of integrate_for_w |
381 |
CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
382 |
CADJ STORE pressure (:,:,:,bi,bj) = |
383 |
CADJ & comlev1_bibj, key=itdkey, byte=isbyte |
384 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
385 |
|
386 |
#ifdef ALLOW_OBCS |
387 |
C-- Calculate future values on open boundaries |
388 |
IF (useOBCS) THEN |
389 |
CALL OBCS_CALC( bi, bj, myTime+deltaT, myIter+1, |
390 |
I uVel, vVel, wVel, theta, salt, |
391 |
I myThid ) |
392 |
ENDIF |
393 |
#endif /* ALLOW_OBCS */ |
394 |
|
395 |
|
396 |
c******************************************** |
397 |
cswdice --- add --- |
398 |
#ifdef ALLOW_THERM_SEAICE |
399 |
C-- Determines forcing terms based on external fields |
400 |
c-- including effects from ice |
401 |
CALL ICE_FORCING( |
402 |
I bi, bj, iMin, iMax, jMin, jMax, |
403 |
I myThid ) |
404 |
#else |
405 |
|
406 |
cswdice --- end add --- |
407 |
|
408 |
C-- Determines forcing terms based on external fields |
409 |
C relaxation terms, etc. |
410 |
CALL EXTERNAL_FORCING_SURF( |
411 |
I bi, bj, iMin, iMax, jMin, jMax, |
412 |
I myThid ) |
413 |
cswdice --- add ---- |
414 |
#endif |
415 |
cswdice --- end add --- |
416 |
c****************************************** |
417 |
|
418 |
|
419 |
|
420 |
|
421 |
#ifdef ALLOW_AUTODIFF_TAMC |
422 |
cph needed for KPP |
423 |
CADJ STORE surfacetendencyU(:,:,bi,bj) |
424 |
CADJ & = comlev1_bibj, key=itdkey, byte=isbyte |
425 |
CADJ STORE surfacetendencyV(:,:,bi,bj) |
426 |
CADJ & = comlev1_bibj, key=itdkey, byte=isbyte |
427 |
CADJ STORE surfacetendencyS(:,:,bi,bj) |
428 |
CADJ & = comlev1_bibj, key=itdkey, byte=isbyte |
429 |
CADJ STORE surfacetendencyT(:,:,bi,bj) |
430 |
CADJ & = comlev1_bibj, key=itdkey, byte=isbyte |
431 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
432 |
|
433 |
C-- Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h |
434 |
C-- MOST of THERMODYNAMICS will be disabled |
435 |
#ifndef SINGLE_LAYER_MODE |
436 |
|
437 |
#ifdef ALLOW_GMREDI |
438 |
|
439 |
#ifdef ALLOW_AUTODIFF_TAMC |
440 |
cph storing here is needed only for one GMREDI_OPTIONS: |
441 |
cph define GM_BOLUS_ADVEC |
442 |
cph but I've avoided the #ifdef for now, in case more things change |
443 |
CADJ STORE sigmaX(:,:,:) = comlev1_bibj, key=itdkey, byte=isbyte |
444 |
CADJ STORE sigmaY(:,:,:) = comlev1_bibj, key=itdkey, byte=isbyte |
445 |
CADJ STORE sigmaR(:,:,:) = comlev1_bibj, key=itdkey, byte=isbyte |
446 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
447 |
C-- Calculate iso-neutral slopes for the GM/Redi parameterisation |
448 |
IF (useGMRedi) THEN |
449 |
CALL GMREDI_CALC_TENSOR( |
450 |
I bi, bj, iMin, iMax, jMin, jMax, |
451 |
I sigmaX, sigmaY, sigmaR, |
452 |
I myThid ) |
453 |
#ifdef ALLOW_AUTODIFF_TAMC |
454 |
ELSE |
455 |
CALL GMREDI_CALC_TENSOR_DUMMY( |
456 |
I bi, bj, iMin, iMax, jMin, jMax, |
457 |
I sigmaX, sigmaY, sigmaR, |
458 |
I myThid ) |
459 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
460 |
ENDIF |
461 |
|
462 |
#ifdef ALLOW_AUTODIFF_TAMC |
463 |
CADJ STORE Kwx(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
464 |
CADJ STORE Kwy(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
465 |
CADJ STORE Kwz(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
466 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
467 |
|
468 |
#endif /* ALLOW_GMREDI */ |
469 |
|
470 |
#ifdef ALLOW_KPP |
471 |
C-- Compute KPP mixing coefficients |
472 |
IF (useKPP) THEN |
473 |
CALL KPP_CALC( |
474 |
I bi, bj, myTime, myThid ) |
475 |
#ifdef ALLOW_AUTODIFF_TAMC |
476 |
ELSE |
477 |
CALL KPP_CALC_DUMMY( |
478 |
I bi, bj, myTime, myThid ) |
479 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
480 |
ENDIF |
481 |
|
482 |
#ifdef ALLOW_AUTODIFF_TAMC |
483 |
CADJ STORE KPPghat (:,:,:,bi,bj) |
484 |
CADJ & , KPPdiffKzT(:,:,:,bi,bj) |
485 |
CADJ & , KPPdiffKzS(:,:,:,bi,bj) |
486 |
CADJ & , KPPfrac (:,: ,bi,bj) |
487 |
CADJ & = comlev1_bibj, key=itdkey, byte=isbyte |
488 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
489 |
|
490 |
#endif /* ALLOW_KPP */ |
491 |
|
492 |
#ifdef ALLOW_AUTODIFF_TAMC |
493 |
CADJ STORE KappaRT(:,:,:) = comlev1_bibj, key=itdkey, byte=isbyte |
494 |
CADJ STORE KappaRS(:,:,:) = comlev1_bibj, key=itdkey, byte=isbyte |
495 |
CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
496 |
CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
497 |
CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
498 |
CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
499 |
#ifdef ALLOW_PASSIVE_TRACER |
500 |
CADJ STORE tr1 (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte |
501 |
#endif |
502 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
503 |
|
504 |
#ifdef ALLOW_AIM |
505 |
C AIM - atmospheric intermediate model, physics package code. |
506 |
IF ( useAIM ) THEN |
507 |
CALL TIMER_START('AIM_DO_PHYSICS [THERMODYNAMICS]', myThid) |
508 |
CALL AIM_DO_PHYSICS( bi, bj, myTime, myIter, myThid ) |
509 |
CALL TIMER_STOP( 'AIM_DO_PHYSICS [THERMODYNAMICS]', myThid) |
510 |
ENDIF |
511 |
#endif /* ALLOW_AIM */ |
512 |
|
513 |
#ifdef ALLOW_TIMEAVE |
514 |
IF (taveFreq.GT.0. .AND. ivdc_kappa.NE.0.) THEN |
515 |
CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr, |
516 |
I deltaTclock, bi, bj, myThid) |
517 |
ENDIF |
518 |
#endif /* ALLOW_TIMEAVE */ |
519 |
|
520 |
#ifndef DISABLE_MULTIDIM_ADVECTION |
521 |
C-- Some advection schemes are better calculated using a multi-dimensional |
522 |
C method in the absence of any other terms and, if used, is done here. |
523 |
C |
524 |
C The CPP flag DISABLE_MULTIDIM_ADVECTION is currently unset in GAD_OPTIONS.h |
525 |
C The default is to use multi-dimensinal advection for non-linear advection |
526 |
C schemes. However, for the sake of efficiency of the adjoint it is necessary |
527 |
C to be able to exclude this scheme to avoid excessive storage and |
528 |
C recomputation. It *is* differentiable, if you need it. |
529 |
C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to |
530 |
C disable this section of code. |
531 |
IF (tempMultiDimAdvec) THEN |
532 |
CALL GAD_ADVECTION(bi,bj,tempAdvScheme,GAD_TEMPERATURE, |
533 |
U theta,gT, |
534 |
I myTime,myIter,myThid) |
535 |
ENDIF |
536 |
IF (saltMultiDimAdvec) THEN |
537 |
CALL GAD_ADVECTION(bi,bj,saltAdvScheme,GAD_SALINITY, |
538 |
U salt,gS, |
539 |
I myTime,myIter,myThid) |
540 |
ENDIF |
541 |
C Since passive tracers are configurable separately from T,S we |
542 |
C call the multi-dimensional method for PTRACERS regardless |
543 |
C of whether multiDimAdvection is set or not. |
544 |
#ifdef ALLOW_PTRACERS |
545 |
IF ( usePTRACERS ) THEN |
546 |
CALL PTRACERS_ADVECTION( bi,bj,myIter,myTime,myThid ) |
547 |
ENDIF |
548 |
#endif /* ALLOW_PTRACERS */ |
549 |
#endif /* DISABLE_MULTIDIM_ADVECTION */ |
550 |
|
551 |
C-- Start of thermodynamics loop |
552 |
DO k=Nr,1,-1 |
553 |
#ifdef ALLOW_AUTODIFF_TAMC |
554 |
C? Patrick Is this formula correct? |
555 |
cph Yes, but I rewrote it. |
556 |
cph Also, the KappaR? need the index and subscript k! |
557 |
kkey = (itdkey-1)*Nr + k |
558 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
559 |
|
560 |
C-- km1 Points to level above k (=k-1) |
561 |
C-- kup Cycles through 1,2 to point to layer above |
562 |
C-- kDown Cycles through 2,1 to point to current layer |
563 |
|
564 |
km1 = MAX(1,k-1) |
565 |
kup = 1+MOD(k+1,2) |
566 |
kDown= 1+MOD(k,2) |
567 |
|
568 |
iMin = 1-OLx |
569 |
iMax = sNx+OLx |
570 |
jMin = 1-OLy |
571 |
jMax = sNy+OLy |
572 |
|
573 |
C-- Get temporary terms used by tendency routines |
574 |
CALL CALC_COMMON_FACTORS ( |
575 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
576 |
O xA,yA,uTrans,vTrans,rTrans,maskUp, |
577 |
I myThid) |
578 |
|
579 |
#ifdef ALLOW_GMREDI |
580 |
C-- Residual transp = Bolus transp + Eulerian transp |
581 |
IF (useGMRedi) THEN |
582 |
CALL GMREDI_CALC_UVFLOW( |
583 |
& uTrans, vTrans, bi, bj, k, myThid) |
584 |
IF (K.GE.2) CALL GMREDI_CALC_WFLOW( |
585 |
& rTrans, bi, bj, k, myThid) |
586 |
ENDIF |
587 |
#endif /* ALLOW_GMREDI */ |
588 |
|
589 |
#ifdef ALLOW_AUTODIFF_TAMC |
590 |
CADJ STORE KappaRT(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte |
591 |
CADJ STORE KappaRS(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte |
592 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
593 |
|
594 |
#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL |
595 |
C-- Calculate the total vertical diffusivity |
596 |
CALL CALC_DIFFUSIVITY( |
597 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
598 |
I maskUp, |
599 |
O KappaRT,KappaRS, |
600 |
I myThid) |
601 |
#endif |
602 |
|
603 |
iMin = 1-OLx+2 |
604 |
iMax = sNx+OLx-1 |
605 |
jMin = 1-OLy+2 |
606 |
jMax = sNy+OLy-1 |
607 |
|
608 |
C-- Calculate active tracer tendencies (gT,gS,...) |
609 |
C and step forward storing result in gTnm1, gSnm1, etc. |
610 |
IF ( tempStepping ) THEN |
611 |
CALL CALC_GT( |
612 |
I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, |
613 |
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
614 |
I KappaRT, |
615 |
U fVerT, |
616 |
I myTime,myIter,myThid) |
617 |
CALL TIMESTEP_TRACER( |
618 |
I bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme, |
619 |
I theta, gT, |
620 |
I myIter, myThid) |
621 |
ENDIF |
622 |
cswdice ---- add --- |
623 |
#ifdef ALLOW_THERM_SEAICE |
624 |
if (k.eq.1) then |
625 |
call ICE_FREEZE(bi, bj, iMin, iMax, jMin, jMax, myThid ) |
626 |
endif |
627 |
#endif |
628 |
cswdice -- end add --- |
629 |
IF ( saltStepping ) THEN |
630 |
CALL CALC_GS( |
631 |
I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, |
632 |
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
633 |
I KappaRS, |
634 |
U fVerS, |
635 |
I myTime,myIter,myThid) |
636 |
CALL TIMESTEP_TRACER( |
637 |
I bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme, |
638 |
I salt, gS, |
639 |
I myIter, myThid) |
640 |
ENDIF |
641 |
#ifdef ALLOW_PASSIVE_TRACER |
642 |
IF ( tr1Stepping ) THEN |
643 |
CALL CALC_GTR1( |
644 |
I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, |
645 |
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
646 |
I KappaRT, |
647 |
U fVerTr1, |
648 |
I myTime,myIter,myThid) |
649 |
CALL TIMESTEP_TRACER( |
650 |
I bi,bj,iMin,iMax,jMin,jMax,k,tracerAdvScheme, |
651 |
I Tr1, gTr1, |
652 |
I myIter,myThid) |
653 |
ENDIF |
654 |
#endif |
655 |
#ifdef ALLOW_PTRACERS |
656 |
IF ( usePTRACERS ) THEN |
657 |
CALL PTRACERS_INTEGERATE( |
658 |
I bi,bj,k, |
659 |
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
660 |
X KappaRS, |
661 |
I myIter,myTime,myThid) |
662 |
ENDIF |
663 |
#endif /* ALLOW_PTRACERS */ |
664 |
|
665 |
#ifdef ALLOW_OBCS |
666 |
C-- Apply open boundary conditions |
667 |
IF (useOBCS) THEN |
668 |
CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid ) |
669 |
END IF |
670 |
#endif /* ALLOW_OBCS */ |
671 |
|
672 |
C-- Freeze water |
673 |
IF ( allowFreezing .AND. .NOT. useSEAICE ) THEN |
674 |
#ifdef ALLOW_AUTODIFF_TAMC |
675 |
CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k |
676 |
CADJ & , key = kkey, byte = isbyte |
677 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
678 |
CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid ) |
679 |
END IF |
680 |
|
681 |
C-- end of thermodynamic k loop (Nr:1) |
682 |
ENDDO |
683 |
|
684 |
cswdice -- add --- |
685 |
#ifdef ALLOW_THERM_SEAICE |
686 |
c timeaveraging for ice model values |
687 |
CALL ICE_AVE(bi,bj,iMin,iMax,jMin,jMax,myThid ) |
688 |
#endif |
689 |
cswdice --- end add --- |
690 |
|
691 |
|
692 |
|
693 |
|
694 |
C-- Implicit diffusion |
695 |
IF (implicitDiffusion) THEN |
696 |
|
697 |
IF (tempStepping) THEN |
698 |
#ifdef ALLOW_AUTODIFF_TAMC |
699 |
CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte |
700 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
701 |
CALL IMPLDIFF( |
702 |
I bi, bj, iMin, iMax, jMin, jMax, |
703 |
I deltaTtracer, KappaRT, recip_HFacC, |
704 |
U gT, |
705 |
I myThid ) |
706 |
ENDIF |
707 |
|
708 |
IF (saltStepping) THEN |
709 |
#ifdef ALLOW_AUTODIFF_TAMC |
710 |
CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte |
711 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
712 |
CALL IMPLDIFF( |
713 |
I bi, bj, iMin, iMax, jMin, jMax, |
714 |
I deltaTtracer, KappaRS, recip_HFacC, |
715 |
U gS, |
716 |
I myThid ) |
717 |
ENDIF |
718 |
|
719 |
#ifdef ALLOW_PASSIVE_TRACER |
720 |
IF (tr1Stepping) THEN |
721 |
#ifdef ALLOW_AUTODIFF_TAMC |
722 |
CADJ STORE gTr1(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte |
723 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
724 |
CALL IMPLDIFF( |
725 |
I bi, bj, iMin, iMax, jMin, jMax, |
726 |
I deltaTtracer, KappaRT, recip_HFacC, |
727 |
U gTr1, |
728 |
I myThid ) |
729 |
ENDIF |
730 |
#endif |
731 |
|
732 |
#ifdef ALLOW_PTRACERS |
733 |
C Vertical diffusion (implicit) for passive tracers |
734 |
IF ( usePTRACERS ) THEN |
735 |
CALL PTRACERS_IMPLDIFF( bi,bj,KappaRS,myThid ) |
736 |
ENDIF |
737 |
#endif /* ALLOW_PTRACERS */ |
738 |
|
739 |
#ifdef ALLOW_OBCS |
740 |
C-- Apply open boundary conditions |
741 |
IF (useOBCS) THEN |
742 |
DO K=1,Nr |
743 |
CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid ) |
744 |
ENDDO |
745 |
END IF |
746 |
#endif /* ALLOW_OBCS */ |
747 |
|
748 |
C-- End If implicitDiffusion |
749 |
ENDIF |
750 |
|
751 |
#endif /* SINGLE_LAYER_MODE */ |
752 |
|
753 |
Ccs- |
754 |
ENDDO |
755 |
ENDDO |
756 |
|
757 |
#ifdef ALLOW_AIM |
758 |
c IF ( useAIM ) THEN |
759 |
c CALL AIM_AIM2DYN_EXCHANGES( myTime, myThid ) |
760 |
c ENDIF |
761 |
#endif /* ALLOW_AIM */ |
762 |
c IF ( staggerTimeStep ) THEN |
763 |
c IF ( useAIM .OR. useCubedSphereExchange ) THEN |
764 |
c IF (tempStepping) _EXCH_XYZ_R8(gT,myThid) |
765 |
c IF (saltStepping) _EXCH_XYZ_R8(gS,myThid) |
766 |
c ELSEIF ( useGMRedi .AND. Oly.LT.4 ) THEN |
767 |
cc .AND. GM_AdvForm .AND. .NOT.GM_AdvSeparate ) THEN |
768 |
c IF (tempMultiDimAdvec) _EXCH_XYZ_R8(gT,myThid) |
769 |
c IF (saltMultiDimAdvec) _EXCH_XYZ_R8(gS,myThid) |
770 |
c ENDIF |
771 |
c ENDIF |
772 |
|
773 |
#ifndef DISABLE_DEBUGMODE |
774 |
If (debugMode) THEN |
775 |
CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid) |
776 |
CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid) |
777 |
CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (THERMODYNAMICS)',myThid) |
778 |
CALL DEBUG_STATS_RL(Nr,theta,'Theta (THERMODYNAMICS)',myThid) |
779 |
CALL DEBUG_STATS_RL(Nr,salt,'Salt (THERMODYNAMICS)',myThid) |
780 |
CALL DEBUG_STATS_RL(Nr,Gt,'Gt (THERMODYNAMICS)',myThid) |
781 |
CALL DEBUG_STATS_RL(Nr,Gs,'Gs (THERMODYNAMICS)',myThid) |
782 |
CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (THERMODYNAMICS)',myThid) |
783 |
CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (THERMODYNAMICS)',myThid) |
784 |
#ifdef ALLOW_PTRACERS |
785 |
IF ( usePTRACERS ) THEN |
786 |
CALL PTRACERS_DEBUG(myThid) |
787 |
ENDIF |
788 |
#endif /* ALLOW_PTRACERS */ |
789 |
ENDIF |
790 |
#endif |
791 |
|
792 |
RETURN |
793 |
END |