1 |
C $Header: /u/gcmpack/MITgcm/model/src/calc_gt.F,v 1.46 2005/12/08 15:44:33 heimbach Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "PACKAGES_CONFIG.h" |
5 |
#include "CPP_OPTIONS.h" |
6 |
|
7 |
CBOP |
8 |
C !ROUTINE: CALC_GT |
9 |
C !INTERFACE: |
10 |
SUBROUTINE CALC_GT( |
11 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
12 |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
13 |
I KappaRT, |
14 |
U fVerT, |
15 |
I myTime,myIter,myThid ) |
16 |
C !DESCRIPTION: \bv |
17 |
C *==========================================================* |
18 |
C | SUBROUTINE CALC_GT |
19 |
C | o Calculate the temperature tendency terms. |
20 |
C *==========================================================* |
21 |
C | A procedure called EXTERNAL_FORCING_T is called from |
22 |
C | here. These procedures can be used to add per problem |
23 |
C | heat flux source terms. |
24 |
C | Note: Although it is slightly counter-intuitive the |
25 |
C | EXTERNAL_FORCING routine is not the place to put |
26 |
C | file I/O. Instead files that are required to |
27 |
C | calculate the external source terms are generally |
28 |
C | read during the model main loop. This makes the |
29 |
C | logisitics of multi-processing simpler and also |
30 |
C | makes the adjoint generation simpler. It also |
31 |
C | allows for I/O to overlap computation where that |
32 |
C | is supported by hardware. |
33 |
C | Aside from the problem specific term the code here |
34 |
C | forms the tendency terms due to advection and mixing |
35 |
C | The baseline implementation here uses a centered |
36 |
C | difference form for the advection term and a tensorial |
37 |
C | divergence of a flux form for the diffusive term. The |
38 |
C | diffusive term is formulated so that isopycnal mixing and |
39 |
C | GM-style subgrid-scale terms can be incorporated b simply |
40 |
C | setting the diffusion tensor terms appropriately. |
41 |
C *==========================================================* |
42 |
C \ev |
43 |
|
44 |
C !USES: |
45 |
IMPLICIT NONE |
46 |
C == GLobal variables == |
47 |
#include "SIZE.h" |
48 |
#include "DYNVARS.h" |
49 |
#include "EEPARAMS.h" |
50 |
#include "PARAMS.h" |
51 |
#ifdef ALLOW_GENERIC_ADVDIFF |
52 |
#include "GAD.h" |
53 |
#endif |
54 |
#ifdef ALLOW_AUTODIFF_TAMC |
55 |
# include "tamc.h" |
56 |
# include "tamc_keys.h" |
57 |
#endif |
58 |
|
59 |
C !INPUT/OUTPUT PARAMETERS: |
60 |
C == Routine arguments == |
61 |
C fVerT :: Flux of temperature (T) in the vertical |
62 |
C direction at the upper(U) and lower(D) faces of a cell. |
63 |
C maskUp :: Land mask used to denote base of the domain. |
64 |
C xA :: Tracer cell face area normal to X |
65 |
C yA :: Tracer cell face area normal to X |
66 |
C uTrans :: Zonal volume transport through cell face |
67 |
C vTrans :: Meridional volume transport through cell face |
68 |
C rTrans :: Vertical volume transport at interface k |
69 |
C rTransKp1 :: Vertical volume transport at inteface k+1 |
70 |
C bi, bj, iMin, iMax, jMin, jMax :: Range of points for which calculation |
71 |
C results will be set. |
72 |
C myThid :: Instance number for this innvocation of CALC_GT |
73 |
_RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
74 |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
75 |
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
76 |
_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
77 |
_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
78 |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
79 |
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
80 |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
81 |
_RL KappaRT(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
82 |
INTEGER k,kUp,kDown,kM1 |
83 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
84 |
_RL myTime |
85 |
INTEGER myIter |
86 |
INTEGER myThid |
87 |
CEOP |
88 |
|
89 |
#ifdef ALLOW_GENERIC_ADVDIFF |
90 |
C === Local variables === |
91 |
LOGICAL calcAdvection |
92 |
INTEGER iterNb |
93 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
94 |
INTEGER m1, m2 |
95 |
#endif |
96 |
|
97 |
#ifdef ALLOW_AUTODIFF_TAMC |
98 |
act1 = bi - myBxLo(myThid) |
99 |
max1 = myBxHi(myThid) - myBxLo(myThid) + 1 |
100 |
act2 = bj - myByLo(myThid) |
101 |
max2 = myByHi(myThid) - myByLo(myThid) + 1 |
102 |
act3 = myThid - 1 |
103 |
max3 = nTx*nTy |
104 |
act4 = ikey_dynamics - 1 |
105 |
itdkey = (act1 + 1) + act2*max1 |
106 |
& + act3*max1*max2 |
107 |
& + act4*max1*max2*max3 |
108 |
kkey = (itdkey-1)*Nr + k |
109 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
110 |
|
111 |
#ifdef ALLOW_AUTODIFF_TAMC |
112 |
C-- only the kUp part of fverT is set in this subroutine |
113 |
C-- the kDown is still required |
114 |
fVerT(1,1,kDown) = fVerT(1,1,kDown) |
115 |
# ifdef NONLIN_FRSURF |
116 |
CADJ STORE fVerT(:,:,:) = comlev1_bibj_k, key=kkey, byte=isbyte |
117 |
# endif |
118 |
#endif |
119 |
|
120 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
121 |
|
122 |
calcAdvection = tempAdvection .AND. .NOT.tempMultiDimAdvec |
123 |
iterNb = myIter |
124 |
IF (staggerTimeStep) iterNb = myIter -1 |
125 |
|
126 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
127 |
IF ( AdamsBashforth_T ) THEN |
128 |
m1 = 1 + MOD(iterNb+1,2) |
129 |
m2 = 1 + MOD( iterNb ,2) |
130 |
CALL GAD_CALC_RHS( |
131 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
132 |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
133 |
I uVel, vVel, wVel, |
134 |
I diffKhT, diffK4T, KappaRT, |
135 |
I gtNm(1-Olx,1-Oly,1,1,1,m2), theta, |
136 |
I GAD_TEMPERATURE, tempAdvScheme, tempVertAdvScheme, |
137 |
I calcAdvection, tempImplVertAdv, |
138 |
U fVerT, gT, |
139 |
I myTime, myIter, myThid ) |
140 |
ELSE |
141 |
CALL GAD_CALC_RHS( |
142 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
143 |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
144 |
I uVel, vVel, wVel, |
145 |
I diffKhT, diffK4T, KappaRT, theta, theta, |
146 |
I GAD_TEMPERATURE, tempAdvScheme, tempVertAdvScheme, |
147 |
I calcAdvection, tempImplVertAdv, |
148 |
U fVerT, gT, |
149 |
I myTime, myIter, myThid ) |
150 |
ENDIF |
151 |
#else /* ALLOW_ADAMSBASHFORTH_3 */ |
152 |
CALL GAD_CALC_RHS( |
153 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
154 |
I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, |
155 |
I uVel, vVel, wVel, |
156 |
I diffKhT, diffK4T, KappaRT, gtNm1, theta, |
157 |
I GAD_TEMPERATURE, tempAdvScheme, tempVertAdvScheme, |
158 |
I calcAdvection, tempImplVertAdv, |
159 |
U fVerT, gT, |
160 |
I myTime, myIter, myThid ) |
161 |
#endif |
162 |
|
163 |
C-- External thermal forcing term(s) inside Adams-Bashforth: |
164 |
IF ( tempForcing .AND. forcing_In_AB ) |
165 |
& CALL EXTERNAL_FORCING_T( |
166 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
167 |
I myTime,myThid) |
168 |
|
169 |
IF ( AdamsBashforthGt ) THEN |
170 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
171 |
CALL ADAMS_BASHFORTH3( |
172 |
I bi, bj, k, |
173 |
U gT, gtNm, |
174 |
I tempStartAB, iterNb, myThid ) |
175 |
#else |
176 |
CALL ADAMS_BASHFORTH2( |
177 |
I bi, bj, k, |
178 |
U gT, gtNm1, |
179 |
I iterNb, myThid ) |
180 |
#endif |
181 |
ENDIF |
182 |
|
183 |
C-- External thermal forcing term(s) outside Adams-Bashforth: |
184 |
IF ( tempForcing .AND. .NOT.forcing_In_AB ) |
185 |
& CALL EXTERNAL_FORCING_T( |
186 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
187 |
I myTime,myThid) |
188 |
|
189 |
#ifdef NONLIN_FRSURF |
190 |
IF (nonlinFreeSurf.GT.0) THEN |
191 |
CALL FREESURF_RESCALE_G( |
192 |
I bi, bj, k, |
193 |
U gT, |
194 |
I myThid ) |
195 |
IF ( AdamsBashforthGt ) THEN |
196 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
197 |
CALL FREESURF_RESCALE_G( |
198 |
I bi, bj, k, |
199 |
U gtNm(1-Olx,1-Oly,1,1,1,1), |
200 |
I myThid ) |
201 |
CALL FREESURF_RESCALE_G( |
202 |
I bi, bj, k, |
203 |
U gtNm(1-Olx,1-Oly,1,1,1,2), |
204 |
I myThid ) |
205 |
#else |
206 |
CALL FREESURF_RESCALE_G( |
207 |
I bi, bj, k, |
208 |
U gtNm1, |
209 |
I myThid ) |
210 |
#endif |
211 |
ENDIF |
212 |
ENDIF |
213 |
#endif /* NONLIN_FRSURF */ |
214 |
|
215 |
#endif /* ALLOW_GENERIC_ADVDIFF */ |
216 |
|
217 |
RETURN |
218 |
END |