1 |
C $Header$ |
C $Header$ |
2 |
|
C $Name$ |
3 |
|
|
4 |
#include "CPP_EEOPTIONS.h" |
#include "CPP_OPTIONS.h" |
5 |
|
|
6 |
CStartOfInterFace |
CStartOfInterFace |
7 |
SUBROUTINE CALC_GS( |
SUBROUTINE CALC_GS( |
8 |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
9 |
I xA,yA,uTrans,vTrans,rTrans,maskup,maskC, |
I xA,yA,uTrans,vTrans,rTrans,maskup,maskC, |
10 |
I K13,K23,KappaRS,KapGM, |
I KappaRS, |
11 |
U af,df,fZon,fMer,fVerS, |
U fVerS, |
12 |
I myThid ) |
I myCurrentTime, myThid ) |
13 |
C /==========================================================\ |
C /==========================================================\ |
14 |
C | SUBROUTINE CALC_GS | |
C | SUBROUTINE CALC_GS | |
15 |
C | o Calculate the salt tendency terms. | |
C | o Calculate the salt tendency terms. | |
46 |
#include "FFIELDS.h" |
#include "FFIELDS.h" |
47 |
|
|
48 |
C == Routine arguments == |
C == Routine arguments == |
|
C fZon - Work array for flux of temperature in the east-west |
|
|
C direction at the west face of a cell. |
|
|
C fMer - Work array for flux of temperature in the north-south |
|
|
C direction at the south face of a cell. |
|
49 |
C fVerS - Flux of salt (S) in the vertical |
C fVerS - Flux of salt (S) in the vertical |
50 |
C direction at the upper(U) and lower(D) faces of a cell. |
C direction at the upper(U) and lower(D) faces of a cell. |
51 |
C maskUp - Land mask used to denote base of the domain. |
C maskUp - Land mask used to denote base of the domain. |
54 |
C yA - Tracer cell face area normal to X |
C yA - Tracer cell face area normal to X |
55 |
C uTrans - Zonal volume transport through cell face |
C uTrans - Zonal volume transport through cell face |
56 |
C vTrans - Meridional volume transport through cell face |
C vTrans - Meridional volume transport through cell face |
57 |
C wTrans - Vertical volume transport through cell face |
C rTrans - Vertical volume transport through cell face |
|
C af - Advective flux component work array |
|
|
C df - Diffusive flux component work array |
|
58 |
C bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation |
C bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation |
59 |
C results will be set. |
C results will be set. |
60 |
C myThid - Instance number for this innvocation of CALC_GT |
C myThid - Instance number for this innvocation of CALC_GT |
|
_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
|
_RL fMer (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
61 |
_RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
62 |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
63 |
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
66 |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
67 |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
68 |
_RS maskC (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS maskC (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
_RL K13 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
|
|
_RL K23 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
|
69 |
_RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
|
_RL KapGM (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
|
_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
|
_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
|
70 |
INTEGER k,kUp,kDown,kM1 |
INTEGER k,kUp,kDown,kM1 |
71 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
72 |
|
_RL myCurrentTime |
73 |
INTEGER myThid |
INTEGER myThid |
74 |
CEndOfInterface |
CEndOfInterface |
75 |
|
|
80 |
_RL afFacS, dfFacS |
_RL afFacS, dfFacS |
81 |
_RL dSdx(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL dSdx(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
82 |
_RL dSdy(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL dSdy(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
83 |
|
_RL df4 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
84 |
|
_RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
85 |
|
_RL fMer (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
86 |
|
_RL af (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
87 |
|
_RL df (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
88 |
|
|
89 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
90 |
|
C-- only the kUp part of fverS is set in this subroutine |
91 |
|
C-- the kDown is still required |
92 |
|
|
93 |
|
fVerS(1,1,kDown) = fVerS(1,1,kDown) |
94 |
|
DO j=1-OLy,sNy+OLy |
95 |
|
DO i=1-OLx,sNx+OLx |
96 |
|
fZon(i,j) = 0.0 |
97 |
|
fMer(i,j) = 0.0 |
98 |
|
fVerS(i,j,kUp) = 0.0 |
99 |
|
ENDDO |
100 |
|
ENDDO |
101 |
|
#endif |
102 |
|
|
103 |
afFacS = 1. _d 0 |
afFacS = 1. _d 0 |
104 |
dfFacS = 1. _d 0 |
dfFacS = 1. _d 0 |
106 |
|
|
107 |
C--- Calculate advective and diffusive fluxes between cells. |
C--- Calculate advective and diffusive fluxes between cells. |
108 |
|
|
109 |
|
#ifdef INCLUDE_T_DIFFUSION_CODE |
110 |
|
C o Zonal tracer gradient |
111 |
|
DO j=1-Oly,sNy+Oly |
112 |
|
DO i=1-Olx+1,sNx+Olx |
113 |
|
dSdx(i,j) = _recip_dxC(i,j,bi,bj)* |
114 |
|
& (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj)) |
115 |
|
ENDDO |
116 |
|
ENDDO |
117 |
|
C o Meridional tracer gradient |
118 |
|
DO j=1-Oly+1,sNy+Oly |
119 |
|
DO i=1-Olx,sNx+Olx |
120 |
|
dSdy(i,j) = _recip_dyC(i,j,bi,bj)* |
121 |
|
& (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj)) |
122 |
|
ENDDO |
123 |
|
ENDDO |
124 |
|
|
125 |
|
C-- del^2 of S, needed for bi-harmonic (del^4) term |
126 |
|
IF (diffK4S .NE. 0.) THEN |
127 |
|
DO j=1-Oly+1,sNy+Oly-1 |
128 |
|
DO i=1-Olx+1,sNx+Olx-1 |
129 |
|
df4(i,j)= _recip_hFacC(i,j,k,bi,bj) |
130 |
|
& *recip_drF(k)/_rA(i,j,bi,bj) |
131 |
|
& *( |
132 |
|
& +( xA(i+1,j)*dSdx(i+1,j)-xA(i,j)*dSdx(i,j) ) |
133 |
|
& +( yA(i,j+1)*dSdy(i,j+1)-yA(i,j)*dSdy(i,j) ) |
134 |
|
& ) |
135 |
|
ENDDO |
136 |
|
ENDDO |
137 |
|
ENDIF |
138 |
|
#endif |
139 |
|
|
140 |
C-- Zonal flux (fZon is at west face of "salt" cell) |
C-- Zonal flux (fZon is at west face of "salt" cell) |
141 |
C Advective component of zonal flux |
C Advective component of zonal flux |
142 |
DO j=jMin,jMax |
DO j=jMin,jMax |
145 |
& uTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i-1,j,k,bi,bj))*0.5 _d 0 |
& uTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i-1,j,k,bi,bj))*0.5 _d 0 |
146 |
ENDDO |
ENDDO |
147 |
ENDDO |
ENDDO |
148 |
C Zonal tracer gradient |
C o Diffusive component of zonal flux |
149 |
DO j=jMin,jMax |
DO j=jMin,jMax |
150 |
DO i=iMin,iMax |
DO i=iMin,iMax |
151 |
dSdx(i,j) = _recip_dxC(i,j,bi,bj)* |
df(i,j) = -diffKhS*xA(i,j)*dSdx(i,j) |
|
& (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj)) |
|
152 |
ENDDO |
ENDDO |
153 |
ENDDO |
ENDDO |
154 |
C Diffusive component of zonal flux |
#ifdef ALLOW_GMREDI |
155 |
DO j=jMin,jMax |
IF (useGMRedi) CALL GMREDI_XTRANSPORT( |
156 |
DO i=iMin,iMax |
I iMin,iMax,jMin,jMax,bi,bj,K, |
157 |
df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i-1,j)))* |
I xA,salt, |
158 |
& xA(i,j)*dSdx(i,j) |
U df, |
159 |
|
I myThid) |
160 |
|
#endif |
161 |
|
C o Add the bi-harmonic contribution |
162 |
|
IF (diffK4S .NE. 0.) THEN |
163 |
|
DO j=jMin,jMax |
164 |
|
DO i=iMin,iMax |
165 |
|
df(i,j) = df(i,j) + xA(i,j)* |
166 |
|
& diffK4S*(df4(i,j)-df4(i-1,j))*_recip_dxC(i,j,bi,bj) |
167 |
|
ENDDO |
168 |
ENDDO |
ENDDO |
169 |
ENDDO |
ENDIF |
170 |
C Net zonal flux |
C Net zonal flux |
171 |
DO j=jMin,jMax |
DO j=jMin,jMax |
172 |
DO i=iMin,iMax |
DO i=iMin,iMax |
183 |
& vTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j-1,k,bi,bj))*0.5 _d 0 |
& vTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j-1,k,bi,bj))*0.5 _d 0 |
184 |
ENDDO |
ENDDO |
185 |
ENDDO |
ENDDO |
|
C Zonal tracer gradient |
|
|
DO j=jMin,jMax |
|
|
DO i=iMin,iMax |
|
|
dSdy(i,j) = _recip_dyC(i,j,bi,bj)* |
|
|
& (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj)) |
|
|
ENDDO |
|
|
ENDDO |
|
186 |
C Diffusive component of meridional flux |
C Diffusive component of meridional flux |
187 |
DO j=jMin,jMax |
DO j=jMin,jMax |
188 |
DO i=iMin,iMax |
DO i=iMin,iMax |
189 |
df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i,j-1)))* |
df(i,j) = -diffKhS*yA(i,j)*dSdy(i,j) |
|
& yA(i,j)*dSdy(i,j) |
|
190 |
ENDDO |
ENDDO |
191 |
ENDDO |
ENDDO |
192 |
C Net meridional flux |
#ifdef ALLOW_GMREDI |
193 |
DO j=jMin,jMax |
IF (useGMRedi) CALL GMREDI_YTRANSPORT( |
194 |
DO i=iMin,iMax |
I iMin,iMax,jMin,jMax,bi,bj,K, |
195 |
fMer(i,j) = afFacS*af(i,j) + dfFacS*df(i,j) |
I yA,salt, |
196 |
|
U df, |
197 |
|
I myThid) |
198 |
|
#endif |
199 |
|
C o Add the bi-harmonic contribution |
200 |
|
IF (diffK4S .NE. 0.) THEN |
201 |
|
DO j=jMin,jMax |
202 |
|
DO i=iMin,iMax |
203 |
|
df(i,j) = df(i,j) + yA(i,j)* |
204 |
|
& diffK4S*(df4(i,j)-df4(i,j-1))*_recip_dyC(i,j,bi,bj) |
205 |
|
ENDDO |
206 |
ENDDO |
ENDDO |
207 |
ENDDO |
ENDIF |
208 |
|
|
209 |
C-- Interpolate terms for Redi/GM scheme |
C Net meridional flux |
|
DO j=jMin,jMax |
|
|
DO i=iMin,iMax |
|
|
dSdx(i,j) = 0.5*( |
|
|
& +0.5*(_maskW(i+1,j,k,bi,bj)*_recip_dxC(i+1,j,bi,bj)* |
|
|
& (salt(i+1,j,k,bi,bj)-salt(i,j,k,bi,bj)) |
|
|
& +_maskW(i,j,k,bi,bj)*_recip_dxC(i,j,bi,bj)* |
|
|
& (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))) |
|
|
& +0.5*(_maskW(i+1,j,km1,bi,bj)*_recip_dxC(i+1,j,bi,bj)* |
|
|
& (salt(i+1,j,km1,bi,bj)-salt(i,j,km1,bi,bj)) |
|
|
& +_maskW(i,j,km1,bi,bj)*_recip_dxC(i,j,bi,bj)* |
|
|
& (salt(i,j,km1,bi,bj)-salt(i-1,j,km1,bi,bj))) |
|
|
& ) |
|
|
ENDDO |
|
|
ENDDO |
|
210 |
DO j=jMin,jMax |
DO j=jMin,jMax |
211 |
DO i=iMin,iMax |
DO i=iMin,iMax |
212 |
dSdy(i,j) = 0.5*( |
fMer(i,j) = afFacS*af(i,j) + dfFacS*df(i,j) |
|
& +0.5*(_maskS(i,j,k,bi,bj)*_recip_dyC(i,j,bi,bj)* |
|
|
& (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj)) |
|
|
& +_maskS(i,j+1,k,bi,bj)*_recip_dyC(i,j+1,bi,bj)* |
|
|
& (salt(i,j+1,k,bi,bj)-salt(i,j,k,bi,bj))) |
|
|
& +0.5*(_maskS(i,j,km1,bi,bj)*_recip_dyC(i,j,bi,bj)* |
|
|
& (salt(i,j,km1,bi,bj)-salt(i,j-1,km1,bi,bj)) |
|
|
& +_maskS(i,j+1,km1,bi,bj)*_recip_dyC(i,j+1,bi,bj)* |
|
|
& (salt(i,j+1,km1,bi,bj)-salt(i,j,km1,bi,bj))) |
|
|
& ) |
|
213 |
ENDDO |
ENDDO |
214 |
ENDDO |
ENDDO |
215 |
|
|
223 |
& rTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j,kM1,bi,bj))*0.5 _d 0 |
& rTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j,kM1,bi,bj))*0.5 _d 0 |
224 |
ENDDO |
ENDDO |
225 |
ENDDO |
ENDDO |
226 |
C Diffusive component of vertical flux |
C o Diffusive component of vertical flux |
227 |
C Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper |
C Note: For K=1 then KM1=1 and this gives a dS/dr = 0 upper |
228 |
C boundary condition. |
C boundary condition. |
229 |
DO j=jMin,jMax |
IF (implicitDiffusion) THEN |
230 |
DO i=iMin,iMax |
DO j=jMin,jMax |
231 |
df(i,j) = _rA(i,j,bi,bj)*( |
DO i=iMin,iMax |
232 |
& -KapGM(i,j)*K13(i,j,k)*dSdx(i,j) |
df(i,j) = 0. |
233 |
& -KapGM(i,j)*K23(i,j,k)*dSdy(i,j) |
ENDDO |
|
& ) |
|
234 |
ENDDO |
ENDDO |
235 |
ENDDO |
ELSE |
|
IF (.NOT.implicitDiffusion) THEN |
|
236 |
DO j=jMin,jMax |
DO j=jMin,jMax |
237 |
DO i=iMin,iMax |
DO i=iMin,iMax |
238 |
df(i,j) = df(i,j) + _rA(i,j,bi,bj)*( |
df(i,j) = - _rA(i,j,bi,bj)*( |
239 |
& -KappaRS(i,j,k)*recip_drC(k) |
& KappaRS(i,j,k)*recip_drC(k) |
240 |
& *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))*rkFac |
& *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))*rkFac |
241 |
& ) |
& ) |
242 |
ENDDO |
ENDDO |
243 |
ENDDO |
ENDDO |
244 |
ENDIF |
ENDIF |
245 |
|
|
246 |
|
#ifdef ALLOW_GMREDI |
247 |
|
IF (useGMRedi) CALL GMREDI_RTRANSPORT( |
248 |
|
I iMin,iMax,jMin,jMax,bi,bj,K, |
249 |
|
I maskUp,salt, |
250 |
|
U df, |
251 |
|
I myThid) |
252 |
|
#endif |
253 |
|
|
254 |
|
#ifdef ALLOW_KPP |
255 |
|
C-- Add non-local KPP transport term (ghat) to diffusive salt flux. |
256 |
|
IF (useKPP) CALL KPP_TRANSPORT_S( |
257 |
|
I iMin,iMax,jMin,jMax,bi,bj,k,km1, |
258 |
|
I maskC,KappaRS, |
259 |
|
U df ) |
260 |
|
#endif |
261 |
|
|
262 |
C Net vertical flux |
C Net vertical flux |
263 |
DO j=jMin,jMax |
DO j=jMin,jMax |
264 |
DO i=iMin,iMax |
DO i=iMin,iMax |
281 |
C are not used. |
C are not used. |
282 |
DO j=jMin,jMax |
DO j=jMin,jMax |
283 |
DO i=iMin,iMax |
DO i=iMin,iMax |
284 |
#define _recip_VolS(i,j,k,bi,bj) _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)/_rA(i,j,bi,bj) |
#define _recip_VolS1(i,j,k,bi,bj) _recip_hFacC(i,j,k,bi,bj)*recip_drF(k) |
285 |
|
#define _recip_VolS2(i,j,k,bi,bj) /_rA(i,j,bi,bj) |
286 |
gS(i,j,k,bi,bj)= |
gS(i,j,k,bi,bj)= |
287 |
& -_recip_VolS(i,j,k,bi,bj) |
& -_recip_VolS1(i,j,k,bi,bj) |
288 |
|
& _recip_VolS2(i,j,k,bi,bj) |
289 |
& *( |
& *( |
290 |
& +( fZon(i+1,j)-fZon(i,j) ) |
& +( fZon(i+1,j)-fZon(i,j) ) |
291 |
& +( fMer(i,j+1)-fMer(i,j) ) |
& +( fMer(i,j+1)-fMer(i,j) ) |
294 |
ENDDO |
ENDDO |
295 |
ENDDO |
ENDDO |
296 |
|
|
297 |
C-- External P-E forcing term(s) |
C-- External forcing term(s) |
298 |
C o Surface relaxation term |
CALL EXTERNAL_FORCING_S( |
299 |
IF ( TOP_LAYER ) THEN |
I iMin,iMax,jMin,jMax,bi,bj,k, |
300 |
DO j=jMin,jMax |
I maskC, |
301 |
DO i=iMin,iMax |
I myCurrentTime,myThid) |
|
gS(i,j,k,bi,bj)=gS(i,j,k,bi,bj) |
|
|
& +maskC(i,j)*( |
|
|
& -lambdaSaltClimRelax*(salt(i,j,k,bi,bj)-SSS(i,j,bi,bj)) |
|
|
& +EmPmR(i,j,bi,bj) ) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
|
|
302 |
|
|
303 |
RETURN |
RETURN |
304 |
END |
END |