/[MITgcm]/MITgcm/model/src/calc_gs.F
ViewVC logotype

Diff of /MITgcm/model/src/calc_gs.F

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

revision 1.3 by cnh, Wed May 27 21:01:47 1998 UTC revision 1.18 by adcroft, Tue May 18 18:01:12 1999 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    
3  #include "CPP_EEOPTIONS.h"  #include "CPP_OPTIONS.h"
4    
5  CStartOfInterFace  CStartOfInterFace
6        SUBROUTINE CALC_GS(        SUBROUTINE CALC_GS(
7       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
8       I           xA,yA,uTrans,vTrans,wTrans,maskup,       I           xA,yA,uTrans,vTrans,rTrans,maskup,maskC,
9       U           af,df,fZon,fMer, fVerS,       I           K13,K23,KappaRS,KapGM,
10       I           myThid )       U           af,df,fZon,fMer,fVerS,
11         I           myCurrentTime, myThid )
12  C     /==========================================================\  C     /==========================================================\
13  C     | SUBROUTINE CALC_GS                                       |  C     | SUBROUTINE CALC_GS                                       |
14  C     | o Calculate the salinity tendency terms.                 |  C     | o Calculate the salt tendency terms.                     |
15  C     |==========================================================|  C     |==========================================================|
16  C     | A procedure called EXTERNAL_FORCING_S is called from     |  C     | A procedure called EXTERNAL_FORCING_S is called from     |
17  C     | here. These procedures can be used to add per problem    |  C     | here. These procedures can be used to add per problem    |
18  C     | fresh water flux source terms.                           |  C     | E-P  flux source terms.                                  |
19  C     | Note: Although it is slightly counter-intuitive the      |  C     | Note: Although it is slightly counter-intuitive the      |
20  C     |       EXTERNAL_FORCING routine is not the place to put   |  C     |       EXTERNAL_FORCING routine is not the place to put   |
21  C     |       file I/O. Instead files that are required to       |  C     |       file I/O. Instead files that are required to       |
# Line 41  C     == GLobal variables == Line 42  C     == GLobal variables ==
42  #include "EEPARAMS.h"  #include "EEPARAMS.h"
43  #include "PARAMS.h"  #include "PARAMS.h"
44  #include "GRID.h"  #include "GRID.h"
45    #include "FFIELDS.h"
46    #ifdef ALLOW_KPP
47    #include "KPPMIX.h"
48    #endif
49    
50  C     == Routine arguments ==  C     == Routine arguments ==
51  C     fZon    - Work array for flux of temperature in the east-west  C     fZon    - Work array for flux of temperature in the east-west
52  C               direction at the west face of a cell.  C               direction at the west face of a cell.
53  C     fMer    - Work array for flux of temperature in the north-south  C     fMer    - Work array for flux of temperature in the north-south
54  C               direction at the south face of a cell.  C               direction at the south face of a cell.
55  C     fVerS   - Flux of salinity (S) in the vertical  C     fVerS   - Flux of salt (S) in the vertical
56  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.
57  C     maskUp  - Land mask used to denote base of the domain.  C     maskUp  - Land mask used to denote base of the domain.
58    C     maskC   - Land mask for salt cells (used in TOP_LAYER only)
59  C     xA      - Tracer cell face area normal to X  C     xA      - Tracer cell face area normal to X
60  C     yA      - Tracer cell face area normal to X  C     yA      - Tracer cell face area normal to X
61  C     uTrans  - Zonal volume transport through cell face  C     uTrans  - Zonal volume transport through cell face
62  C     vTrans  - Meridional volume transport through cell face  C     vTrans  - Meridional volume transport through cell face
63  C     wTrans  - Vertical volume transport through cell face  C     rTrans  - Vertical volume transport through cell face
64  C     af      - Advective flux component work array  C     af      - Advective flux component work array
65  C     df      - Diffusive flux component work array  C     df      - Diffusive flux component work array
66  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
67  C                                      results will be set.  C                                      results will be set.
68  C     myThid - Instance number for this innvocation of CALC_GS  C     myThid - Instance number for this innvocation of CALC_GT
69        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fZon  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
70        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fMer  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
71        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
# Line 67  C     myThid - Instance number for this Line 73  C     myThid - Instance number for this
73        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
74        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76        _RL wTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
77        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78          _RS maskC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
79          _RL K13   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
80          _RL K23   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
81          _RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
82          _RL KapGM (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
85        INTEGER kUp,kDown,kM1        INTEGER k,kUp,kDown,kM1
86        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
87          _RL     myCurrentTime
88        INTEGER myThid        INTEGER myThid
89  CEndOfInterface  CEndOfInterface
90    
91  C     == Local variables ==  C     == Local variables ==
92  C     I, J, K - Loop counters  C     I, J, K - Loop counters
93        INTEGER i,j,k        INTEGER i,j
94        INTEGER afFacS, dfFacS        LOGICAL TOP_LAYER
95          _RL afFacS, dfFacS
96          _RL dSdx(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97          _RL dSdy(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98    
99        afFacS = 1. _d 0        afFacS = 1. _d 0
100        dfFacS = 1. _d 0        dfFacS = 1. _d 0
101          TOP_LAYER = K .EQ. 1
102    
 C---  
103  C---  Calculate advective and diffusive fluxes between cells.  C---  Calculate advective and diffusive fluxes between cells.
 C---  
104    
105  C--   Zonal flux (fZon is at west face of "salt" cell)  C--   Zonal flux (fZon is at west face of "salt" cell)
106  C     Advective component of zonal flux  C     Advective component of zonal flux
# Line 96  C     Advective component of zonal flux Line 110  C     Advective component of zonal flux
110       &   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
111         ENDDO         ENDDO
112        ENDDO        ENDDO
113    C     Zonal tracer gradient
114          DO j=jMin,jMax
115           DO i=iMin,iMax
116            dSdx(i,j) = _recip_dxC(i,j,bi,bj)*
117         &  (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))
118           ENDDO
119          ENDDO
120  C     Diffusive component of zonal flux  C     Diffusive component of zonal flux
121        DO j=jMin,jMax        DO j=jMin,jMax
122         DO i=iMin,iMax         DO i=iMin,iMax
123          df(i,j) =          df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i-1,j)))*
124       &   -diffKhS*xA(i,j)*_rdxC(i,j,bi,bj)       &            xA(i,j)*dSdx(i,j)
      &   *(salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))  
125         ENDDO         ENDDO
126        ENDDO        ENDDO
127  C     Net zonal flux  C     Net zonal flux
# Line 120  C       Advective component of meridiona Line 140  C       Advective component of meridiona
140       &   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
141         ENDDO         ENDDO
142        ENDDO        ENDDO
143    C     Zonal tracer gradient
144          DO j=jMin,jMax
145           DO i=iMin,iMax
146            dSdy(i,j) = _recip_dyC(i,j,bi,bj)*
147         &  (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))
148           ENDDO
149          ENDDO
150  C     Diffusive component of meridional flux  C     Diffusive component of meridional flux
151        DO j=jMin,jMax        DO j=jMin,jMax
152         DO i=iMin,iMax         DO i=iMin,iMax
153          df(i,j) =          df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i,j-1)))*
154       &   -diffKhS*yA(i,j)*rdyC(i,j,bi,bj)       &            yA(i,j)*dSdy(i,j)
      &   *(salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))  
155         ENDDO         ENDDO
156        ENDDO        ENDDO
157  C     Net meridional flux  C     Net meridional flux
# Line 135  C     Net meridional flux Line 161  C     Net meridional flux
161         ENDDO         ENDDO
162        ENDDO        ENDDO
163    
164    C--   Interpolate terms for Redi/GM scheme
165          DO j=jMin,jMax
166           DO i=iMin,iMax
167            dSdx(i,j) = 0.5*(
168         &   +0.5*(_maskW(i+1,j,k,bi,bj)
169         &         *_recip_dxC(i+1,j,bi,bj)*
170         &           (salt(i+1,j,k,bi,bj)-salt(i,j,k,bi,bj))
171         &        +_maskW(i,j,k,bi,bj)
172         &         *_recip_dxC(i,j,bi,bj)*
173         &           (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj)))
174         &   +0.5*(_maskW(i+1,j,km1,bi,bj)
175         &         *_recip_dxC(i+1,j,bi,bj)*
176         &           (salt(i+1,j,km1,bi,bj)-salt(i,j,km1,bi,bj))
177         &        +_maskW(i,j,km1,bi,bj)
178         &         *_recip_dxC(i,j,bi,bj)*
179         &           (salt(i,j,km1,bi,bj)-salt(i-1,j,km1,bi,bj)))
180         &       )
181           ENDDO
182          ENDDO
183          DO j=jMin,jMax
184           DO i=iMin,iMax
185            dSdy(i,j) = 0.5*(
186         &   +0.5*(_maskS(i,j,k,bi,bj)
187         &         *_recip_dyC(i,j,bi,bj)*
188         &           (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))
189         &        +_maskS(i,j+1,k,bi,bj)
190         &         *_recip_dyC(i,j+1,bi,bj)*
191         &           (salt(i,j+1,k,bi,bj)-salt(i,j,k,bi,bj)))
192         &   +0.5*(_maskS(i,j,km1,bi,bj)
193         &         *_recip_dyC(i,j,bi,bj)*
194         &           (salt(i,j,km1,bi,bj)-salt(i,j-1,km1,bi,bj))
195         &        +_maskS(i,j+1,km1,bi,bj)
196         &         *_recip_dyC(i,j+1,bi,bj)*
197         &           (salt(i,j+1,km1,bi,bj)-salt(i,j,km1,bi,bj)))
198         &       )
199           ENDDO
200          ENDDO
201    
202  C--   Vertical flux (fVerS) above  C--   Vertical flux (fVerS) above
 C     Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper  
 C           boundary condition.  
203  C     Advective component of vertical flux  C     Advective component of vertical flux
204    C     Note: For K=1 then KM1=1 this gives a barZ(T) = T
205    C     (this plays the role of the free-surface correction)
206        DO j=jMin,jMax        DO j=jMin,jMax
207         DO i=iMin,iMax         DO i=iMin,iMax
208          af(i,j) =          af(i,j) =
209       &   wTrans(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
210         ENDDO         ENDDO
211        ENDDO        ENDDO
212  C     Diffusive component of vertical flux  C     Diffusive component of vertical flux
213    C     Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper
214    C           boundary condition.
215        DO j=jMin,jMax        DO j=jMin,jMax
216         DO i=iMin,iMax         DO i=iMin,iMax
217          df(i,j) =          df(i,j) = _rA(i,j,bi,bj)*(
218       &   -diffKzS*zA(i,j,bi,bj)*rdzC(k)       &   -KapGM(i,j)*K13(i,j,k)*dSdx(i,j)
219       &   *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))       &   -KapGM(i,j)*K23(i,j,k)*dSdy(i,j)
220         &   )
221         ENDDO         ENDDO
222        ENDDO        ENDDO
223          IF (.NOT.implicitDiffusion) THEN
224           DO j=jMin,jMax
225            DO i=iMin,iMax
226             df(i,j) = df(i,j) + _rA(i,j,bi,bj)*(
227         &    -KappaRS(i,j,k)*recip_drC(k)
228         &    *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))*rkFac
229         &    )
230            ENDDO
231           ENDDO
232          ENDIF
233    #ifdef ALLOW_KPP
234          IF (usingKPPmixing) THEN
235    C--   Add non local transport coefficient (ghat term) to right-hand-side
236    C     The nonlocal transport term is noNrero only for scalars in unstable
237    C     (convective) forcing conditions.
238           IF ( TOP_LAYER ) THEN
239            DO j=jMin,jMax
240             DO i=iMin,iMax
241              df(i,j) = df(i,j) - _rA(i,j,bi,bj) *
242         &              EmPmR(i,j,bi,bj) * delZ(1) *
243         &              ( KappaRS(i,j,k)   * KPPghat(i,j,k,bi,bj)   )
244             ENDDO
245            ENDDO
246           ELSE
247            DO j=jMin,jMax
248             DO i=iMin,iMax
249              df(i,j) = df(i,j) - _rA(i,j,bi,bj) *
250         &              EmPmR(i,j,bi,bj) * delZ(1) *
251         &              ( KappaRS(i,j,k)   * KPPghat(i,j,k,bi,bj)
252         &              - KappaRS(i,j,k-1) * KPPghat(i,j,k-1,bi,bj) )
253             ENDDO
254            ENDDO
255           ENDIF
256          ENDIF
257    #endif /* ALLOW_KPP */
258    
259  C     Net vertical flux  C     Net vertical flux
260        DO j=jMin,jMax        DO j=jMin,jMax
261         DO i=iMin,iMax         DO i=iMin,iMax
262          fVerS(i,j,kUp) = (afFacS*af(i,j) + dfFacS*df(i,j))*maskUp(i,j)          fVerS(i,j,kUp) = ( afFacS*af(i,j)+  dfFacS*df(i,j) )*maskUp(i,j)
263         ENDDO         ENDDO
264        ENDDO        ENDDO
265          IF ( TOP_LAYER ) THEN
266           DO j=jMin,jMax
267            DO i=iMin,iMax
268             fVerS(i,j,kUp) = afFacS*af(i,j)*freeSurfFac
269            ENDDO
270           ENDDO
271          ENDIF
272    
273  C--   Tendency is minus divergence of the fluxes.  C--   Tendency is minus divergence of the fluxes.
274  C     Note. Tendency terms will only be correct for range  C     Note. Tendency terms will only be correct for range
# Line 168  C           they are not algorithmically Line 278  C           they are not algorithmically
278  C           are not used.  C           are not used.
279        DO j=jMin,jMax        DO j=jMin,jMax
280         DO i=iMin,iMax         DO i=iMin,iMax
281    #define _recip_VolS1(i,j,k,bi,bj) _recip_hFacC(i,j,k,bi,bj)*recip_drF(k)
282    #define _recip_VolS2(i,j,k,bi,bj) /_rA(i,j,bi,bj)
283          gS(i,j,k,bi,bj)=          gS(i,j,k,bi,bj)=
284       &   -rHFacC(i,j,k,bi,bj)*rdzF(k)*rDxF(i,j,bi,bj)*rDyF(i,j,bi,bj)       &   -_recip_VolS1(i,j,k,bi,bj)
285         &    _recip_VolS2(i,j,k,bi,bj)
286       &   *(       &   *(
287       &    +( fZon(i+1,j)-fZon(i,j) )       &    +( fZon(i+1,j)-fZon(i,j) )
288       &    +( fMer(i,j+1)-fMer(i,j) )       &    +( fMer(i,j+1)-fMer(i,j) )
289       &    +( fVerS(i,j,kUp)-fVerS(i,j,kDown) )       &    +( fVerS(i,j,kUp)-fVerS(i,j,kDown) )*rkFac
290       &    )       &    )
291         ENDDO         ENDDO
292        ENDDO        ENDDO
293    
294  C--   External haline forcing term(s)  C--   External forcing term(s)
295          CALL EXTERNAL_FORCING_S(
296         I     iMin,iMax,jMin,jMax,bi,bj,k,
297         I     maskC,
298         I     myCurrentTime,myThid)
299    
300    #ifdef INCLUDE_LAT_CIRC_FFT_FILTER_CODE
301    C--
302          CALL FILTER_LATCIRCS_FFT_APPLY( gS, 1, sNy, k, k, bi, bj, 1, myThid)
303    #endif
304    
305        RETURN        RETURN
306        END        END
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.18
  ViewVC Help
Powered by ViewVC 1.1.22