1 |
heimbach |
1.50 |
C $Header: /u/gcmpack/MITgcm/model/src/calc_gs.F,v 1.49 2007/10/19 14:41:39 jmc Exp $ |
2 |
adcroft |
1.31 |
C $Name: $ |
3 |
cnh |
1.1 |
|
4 |
jmc |
1.39 |
#include "PACKAGES_CONFIG.h" |
5 |
cnh |
1.17 |
#include "CPP_OPTIONS.h" |
6 |
cnh |
1.1 |
|
7 |
cnh |
1.32 |
CBOP |
8 |
|
|
C !ROUTINE: CALC_GS |
9 |
|
|
C !INTERFACE: |
10 |
jmc |
1.47 |
SUBROUTINE CALC_GS( |
11 |
cnh |
1.1 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
12 |
jmc |
1.47 |
I xA, yA, maskUp, uFld, vFld, wFld, |
13 |
|
|
I uTrans, vTrans, rTrans, rTransKp1, |
14 |
adcroft |
1.21 |
I KappaRS, |
15 |
adcroft |
1.23 |
U fVerS, |
16 |
adcroft |
1.31 |
I myTime,myIter,myThid ) |
17 |
cnh |
1.32 |
C !DESCRIPTION: \bv |
18 |
|
|
C *==========================================================* |
19 |
jmc |
1.47 |
C | SUBROUTINE CALC_GS |
20 |
|
|
C | o Calculate the salt tendency terms. |
21 |
cnh |
1.32 |
C *==========================================================* |
22 |
jmc |
1.47 |
C | A procedure called EXTERNAL_FORCING_S is called from |
23 |
|
|
C | here. These procedures can be used to add per problem |
24 |
|
|
C | E-P 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 |
cnh |
1.32 |
C *==========================================================* |
43 |
|
|
C \ev |
44 |
|
|
|
45 |
|
|
C !USES: |
46 |
cnh |
1.1 |
IMPLICIT NONE |
47 |
|
|
C == GLobal variables == |
48 |
|
|
#include "SIZE.h" |
49 |
|
|
#include "DYNVARS.h" |
50 |
|
|
#include "EEPARAMS.h" |
51 |
|
|
#include "PARAMS.h" |
52 |
jmc |
1.49 |
#include "RESTART.h" |
53 |
jmc |
1.39 |
#ifdef ALLOW_GENERIC_ADVDIFF |
54 |
adcroft |
1.30 |
#include "GAD.h" |
55 |
jmc |
1.39 |
#endif |
56 |
heimbach |
1.42 |
#ifdef ALLOW_AUTODIFF_TAMC |
57 |
|
|
# include "tamc.h" |
58 |
|
|
# include "tamc_keys.h" |
59 |
|
|
#endif |
60 |
cnh |
1.1 |
|
61 |
cnh |
1.32 |
C !INPUT/OUTPUT PARAMETERS: |
62 |
cnh |
1.1 |
C == Routine arguments == |
63 |
jmc |
1.47 |
C bi, bj, :: tile indices |
64 |
|
|
C iMin,iMax, jMin,jMax :: Range of points for which calculation |
65 |
|
|
C results will be set. |
66 |
|
|
C k :: vertical index |
67 |
|
|
C kM1 :: =k-1 for k>1, =1 for k=1 |
68 |
|
|
C kUp :: index into 2 1/2D array, toggles between 1|2 |
69 |
|
|
C kDown :: index into 2 1/2D array, toggles between 2|1 |
70 |
|
|
C xA :: Tracer cell face area normal to X |
71 |
|
|
C yA :: Tracer cell face area normal to X |
72 |
|
|
C maskUp :: Land mask used to denote base of the domain. |
73 |
|
|
C uFld,vFld :: Local copy of horizontal velocity field |
74 |
|
|
C wFld :: Local copy of vertical velocity field |
75 |
|
|
C uTrans :: Zonal volume transport through cell face |
76 |
|
|
C vTrans :: Meridional volume transport through cell face |
77 |
|
|
C rTrans :: Vertical volume transport at interface k |
78 |
jmc |
1.35 |
C rTransKp1 :: Vertical volume transport at inteface k+1 |
79 |
jmc |
1.47 |
C KappaRS :: Vertical diffusion for Salinity |
80 |
|
|
C fVerS :: Flux of salt (S) in the vertical direction |
81 |
|
|
C at the upper(U) and lower(D) faces of a cell. |
82 |
|
|
C myTime :: current time |
83 |
|
|
C myIter :: current iteration number |
84 |
|
|
C myThid :: my Thread Id. number |
85 |
|
|
|
86 |
|
|
INTEGER bi,bj,iMin,iMax,jMin,jMax |
87 |
|
|
INTEGER k,kUp,kDown,kM1 |
88 |
|
|
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
89 |
|
|
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
90 |
|
|
_RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
91 |
|
|
_RL uFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
92 |
|
|
_RL vFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
93 |
|
|
_RL wFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
94 |
|
|
_RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
95 |
|
|
_RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
96 |
|
|
_RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
97 |
jmc |
1.35 |
_RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
98 |
jmc |
1.38 |
_RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
99 |
jmc |
1.47 |
_RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
100 |
adcroft |
1.31 |
_RL myTime |
101 |
|
|
INTEGER myIter |
102 |
cnh |
1.1 |
INTEGER myThid |
103 |
cnh |
1.32 |
CEOP |
104 |
heimbach |
1.20 |
|
105 |
jmc |
1.39 |
#ifdef ALLOW_GENERIC_ADVDIFF |
106 |
jmc |
1.33 |
C === Local variables === |
107 |
|
|
LOGICAL calcAdvection |
108 |
jmc |
1.40 |
INTEGER iterNb |
109 |
jmc |
1.41 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
110 |
|
|
INTEGER m1, m2 |
111 |
|
|
#endif |
112 |
jmc |
1.33 |
|
113 |
heimbach |
1.20 |
#ifdef ALLOW_AUTODIFF_TAMC |
114 |
heimbach |
1.42 |
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 |
heimbach |
1.20 |
C-- only the kUp part of fverS is set in this subroutine |
129 |
|
|
C-- the kDown is still required |
130 |
|
|
fVerS(1,1,kDown) = fVerS(1,1,kDown) |
131 |
heimbach |
1.42 |
# ifdef NONLIN_FRSURF |
132 |
heimbach |
1.45 |
CADJ STORE fVerS(:,:,:) = |
133 |
heimbach |
1.50 |
CADJ & comlev1_bibj_k, key=kkey, byte=isbyte, |
134 |
|
|
CADJ & kind = isbyte |
135 |
jmc |
1.49 |
CADJ STORE gsNm1(:,:,k,bi,bj) = |
136 |
heimbach |
1.50 |
CADJ & comlev1_bibj_k, key=kkey, byte=isbyte, |
137 |
|
|
CADJ & kind = isbyte |
138 |
heimbach |
1.42 |
# endif |
139 |
adcroft |
1.27 |
#endif |
140 |
cnh |
1.1 |
|
141 |
jmc |
1.41 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
142 |
|
|
|
143 |
jmc |
1.33 |
calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec |
144 |
jmc |
1.41 |
iterNb = myIter |
145 |
|
|
IF (staggerTimeStep) iterNb = myIter - 1 |
146 |
|
|
|
147 |
|
|
#ifdef ALLOW_ADAMSBASHFORTH_3 |
148 |
|
|
m1 = 1 + MOD(iterNb+1,2) |
149 |
|
|
m2 = 1 + MOD( iterNb ,2) |
150 |
|
|
CALL GAD_CALC_RHS( |
151 |
adcroft |
1.30 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
152 |
jmc |
1.47 |
I xA, yA, maskUp, uFld, vFld, wFld, |
153 |
|
|
I uTrans, vTrans, rTrans, rTransKp1, |
154 |
jmc |
1.41 |
I diffKhS, diffK4S, KappaRS, |
155 |
|
|
I gsNm(1-Olx,1-Oly,1,1,1,m2), salt, |
156 |
jmc |
1.36 |
I GAD_SALINITY, saltAdvScheme, saltVertAdvScheme, |
157 |
jmc |
1.44 |
I calcAdvection, saltImplVertAdv, AdamsBashforth_S, |
158 |
jmc |
1.48 |
I useGMRedi, useKPP, |
159 |
adcroft |
1.30 |
U fVerS, gS, |
160 |
jmc |
1.37 |
I myTime, myIter, myThid ) |
161 |
jmc |
1.43 |
#else /* ALLOW_ADAMSBASHFORTH_3 */ |
162 |
|
|
CALL GAD_CALC_RHS( |
163 |
|
|
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
164 |
jmc |
1.47 |
I xA, yA, maskUp, uFld, vFld, wFld, |
165 |
|
|
I uTrans, vTrans, rTrans, rTransKp1, |
166 |
jmc |
1.43 |
I diffKhS, diffK4S, KappaRS, gsNm1, salt, |
167 |
|
|
I GAD_SALINITY, saltAdvScheme, saltVertAdvScheme, |
168 |
jmc |
1.44 |
I calcAdvection, saltImplVertAdv, AdamsBashforth_S, |
169 |
jmc |
1.48 |
I useGMRedi, useKPP, |
170 |
jmc |
1.43 |
U fVerS, gS, |
171 |
|
|
I myTime, myIter, myThid ) |
172 |
|
|
#endif /* ALLOW_ADAMSBASHFORTH_3 */ |
173 |
cnh |
1.1 |
|
174 |
jmc |
1.33 |
C-- External salinity forcing term(s) inside Adams-Bashforth: |
175 |
jmc |
1.46 |
IF ( saltForcing .AND. tracForcingOutAB.NE.1 ) |
176 |
jmc |
1.33 |
& CALL EXTERNAL_FORCING_S( |
177 |
cnh |
1.16 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
178 |
adcroft |
1.31 |
I myTime,myThid) |
179 |
|
|
|
180 |
jmc |
1.41 |
IF ( AdamsBashforthGs ) THEN |
181 |
jmc |
1.40 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
182 |
|
|
CALL ADAMS_BASHFORTH3( |
183 |
|
|
I bi, bj, k, |
184 |
|
|
U gS, gsNm, |
185 |
jmc |
1.41 |
I saltStartAB, iterNb, myThid ) |
186 |
jmc |
1.40 |
#else |
187 |
adcroft |
1.31 |
CALL ADAMS_BASHFORTH2( |
188 |
jmc |
1.40 |
I bi, bj, k, |
189 |
|
|
U gS, gsNm1, |
190 |
jmc |
1.49 |
I saltStartAB, iterNb, myThid ) |
191 |
jmc |
1.40 |
#endif |
192 |
adcroft |
1.31 |
ENDIF |
193 |
jmc |
1.33 |
|
194 |
|
|
C-- External salinity forcing term(s) outside Adams-Bashforth: |
195 |
jmc |
1.46 |
IF ( saltForcing .AND. tracForcingOutAB.EQ.1 ) |
196 |
jmc |
1.33 |
& CALL EXTERNAL_FORCING_S( |
197 |
|
|
I iMin,iMax,jMin,jMax,bi,bj,k, |
198 |
|
|
I myTime,myThid) |
199 |
adcroft |
1.31 |
|
200 |
|
|
#ifdef NONLIN_FRSURF |
201 |
|
|
IF (nonlinFreeSurf.GT.0) THEN |
202 |
|
|
CALL FREESURF_RESCALE_G( |
203 |
jmc |
1.40 |
I bi, bj, k, |
204 |
adcroft |
1.31 |
U gS, |
205 |
jmc |
1.34 |
I myThid ) |
206 |
jmc |
1.41 |
IF ( AdamsBashforthGs ) THEN |
207 |
jmc |
1.40 |
#ifdef ALLOW_ADAMSBASHFORTH_3 |
208 |
|
|
CALL FREESURF_RESCALE_G( |
209 |
|
|
I bi, bj, k, |
210 |
|
|
U gsNm(1-OLx,1-OLy,1,1,1,1), |
211 |
|
|
I myThid ) |
212 |
|
|
CALL FREESURF_RESCALE_G( |
213 |
|
|
I bi, bj, k, |
214 |
|
|
U gsNm(1-OLx,1-OLy,1,1,1,2), |
215 |
adcroft |
1.31 |
I myThid ) |
216 |
jmc |
1.40 |
#else |
217 |
|
|
CALL FREESURF_RESCALE_G( |
218 |
|
|
I bi, bj, k, |
219 |
|
|
U gsNm1, |
220 |
|
|
I myThid ) |
221 |
|
|
#endif |
222 |
|
|
ENDIF |
223 |
adcroft |
1.31 |
ENDIF |
224 |
|
|
#endif /* NONLIN_FRSURF */ |
225 |
cnh |
1.1 |
|
226 |
jmc |
1.39 |
#endif /* ALLOW_GENERIC_ADVDIFF */ |
227 |
|
|
|
228 |
cnh |
1.1 |
RETURN |
229 |
|
|
END |