/[MITgcm]/MITgcm_contrib/jscott/code_rafmod/calc_gt.F
ViewVC logotype

Annotation of /MITgcm_contrib/jscott/code_rafmod/calc_gt.F

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


Revision 1.1 - (hide annotations) (download)
Tue Aug 21 16:34:17 2007 UTC (17 years, 11 months ago) by jscott
Branch: MAIN
code directory for crude ML horizontal mixing scheme

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

  ViewVC Help
Powered by ViewVC 1.1.22