/[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.11 by adcroft, Wed Jul 15 22:22:24 1998 UTC revision 1.44 by jmc, Wed Mar 1 03:08:50 2006 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3    
4  #include "CPP_EEOPTIONS.h"  #include "PACKAGES_CONFIG.h"
5    #include "CPP_OPTIONS.h"
6    
7  CStartOfInterFace  CBOP
8    C     !ROUTINE: CALC_GS
9    C     !INTERFACE:
10        SUBROUTINE CALC_GS(        SUBROUTINE CALC_GS(
11       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
12       I           xA,yA,uTrans,vTrans,wTrans,maskup,maskC,       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
13       I           K13,K23,KappaZS,KapGM,       I           KappaRS,
14       U           af,df,fZon,fMer,fVerS,       U           fVerS,
15       I           myThid )       I           myTime,myIter,myThid )
16  C     /==========================================================\  C     !DESCRIPTION: \bv
17  C     | SUBROUTINE CALC_GS                                       |  C     *==========================================================*
18  C     | o Calculate the salt tendency terms.                     |  C     | SUBROUTINE CALC_GS                                        
19  C     |==========================================================|  C     | o Calculate the salt tendency terms.                      
20  C     | A procedure called EXTERNAL_FORCING_S is called from     |  C     *==========================================================*
21  C     | here. These procedures can be used to add per problem    |  C     | A procedure called EXTERNAL_FORCING_S is called from      
22  C     | E-P  flux source terms.                                  |  C     | here. These procedures can be used to add per problem    
23  C     | Note: Although it is slightly counter-intuitive the      |  C     | E-P  flux source terms.                                  
24  C     |       EXTERNAL_FORCING routine is not the place to put   |  C     | Note: Although it is slightly counter-intuitive the      
25  C     |       file I/O. Instead files that are required to       |  C     |       EXTERNAL_FORCING routine is not the place to put    
26  C     |       calculate the external source terms are generally  |  C     |       file I/O. Instead files that are required to        
27  C     |       read during the model main loop. This makes the    |  C     |       calculate the external source terms are generally  
28  C     |       logisitics of multi-processing simpler and also    |  C     |       read during the model main loop. This makes the    
29  C     |       makes the adjoint generation simpler. It also      |  C     |       logisitics of multi-processing simpler and also    
30  C     |       allows for I/O to overlap computation where that   |  C     |       makes the adjoint generation simpler. It also      
31  C     |       is supported by hardware.                          |  C     |       allows for I/O to overlap computation where that    
32  C     | Aside from the problem specific term the code here       |  C     |       is supported by hardware.                          
33  C     | forms the tendency terms due to advection and mixing     |  C     | Aside from the problem specific term the code here        
34  C     | The baseline implementation here uses a centered         |  C     | forms the tendency terms due to advection and mixing      
35  C     | difference form for the advection term and a tensorial   |  C     | The baseline implementation here uses a centered          
36  C     | divergence of a flux form for the diffusive term. The    |  C     | difference form for the advection term and a tensorial    
37  C     | diffusive term is formulated so that isopycnal mixing and|  C     | divergence of a flux form for the diffusive term. The    
38  C     | GM-style subgrid-scale terms can be incorporated b simply|  C     | diffusive term is formulated so that isopycnal mixing and
39  C     | setting the diffusion tensor terms appropriately.        |  C     | GM-style subgrid-scale terms can be incorporated b simply
40  C     \==========================================================/  C     | setting the diffusion tensor terms appropriately.        
41        IMPLICIT NONE  C     *==========================================================*
42    C     \ev
43    
44    C     !USES:
45          IMPLICIT NONE
46  C     == GLobal variables ==  C     == GLobal variables ==
47  #include "SIZE.h"  #include "SIZE.h"
48  #include "DYNVARS.h"  #include "DYNVARS.h"
49  #include "EEPARAMS.h"  #include "EEPARAMS.h"
50  #include "PARAMS.h"  #include "PARAMS.h"
51  #include "GRID.h"  #ifdef ALLOW_GENERIC_ADVDIFF
52  #include "FFIELDS.h"  #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 ==  C     == Routine arguments ==
61  C     fZon    - Work array for flux of temperature in the east-west  C     fVerS   :: Flux of salt (S) in the vertical
 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.  
 C     fVerS   - Flux of salt (S) in the vertical  
62  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.
63  C     maskUp  - Land mask used to denote base of the domain.  C     maskUp  :: Land mask used to denote base of the domain.
64  C     maskC   - Land mask for salt cells (used in TOP_LAYER only)  C     xA      :: Tracer cell face area normal to X
65  C     xA      - Tracer cell face area normal to X  C     yA      :: Tracer cell face area normal to X
66  C     yA      - Tracer cell face area normal to X  C     uTrans  :: Zonal volume transport through cell face
67  C     uTrans  - Zonal volume transport through cell face  C     vTrans  :: Meridional volume transport through cell face
68  C     vTrans  - Meridional volume transport through cell face  C     rTrans  ::   Vertical volume transport at interface k
69  C     wTrans  - Vertical volume transport through cell face  C     rTransKp1 :: Vertical volume transport at inteface k+1
70  C     af      - Advective flux component work array  C     bi, bj, iMin, iMax, jMin, jMax :: Range of points for which calculation
 C     df      - Diffusive flux component work array  
 C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation  
71  C                                      results will be set.  C                                      results will be set.
72  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)  
73        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
74        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
77        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78        _RL wTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _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)        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
81        _RS maskC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL K13   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nz)  
       _RL K23   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nz)  
       _RL KappaZS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nz)  
       _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)  
82        INTEGER k,kUp,kDown,kM1        INTEGER k,kUp,kDown,kM1
83        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
84          _RL     myTime
85          INTEGER myIter
86        INTEGER myThid        INTEGER myThid
 CEndOfInterface  
87    
88  C     == Local variables ==  CEOP
89  C     I, J, K - Loop counters  
90        INTEGER i,j  #ifdef ALLOW_GENERIC_ADVDIFF
91        LOGICAL TOP_LAYER  C     === Local variables ===
92        _RL afFacS, dfFacS        LOGICAL calcAdvection
93        _RL dSdx(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        INTEGER iterNb
94        _RL dSdy(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_ADAMSBASHFORTH_3
95          INTEGER m1, m2
96        afFacS = 1. _d 0  #endif
97        dfFacS = 1. _d 0  
98        TOP_LAYER = K .EQ. 1  #ifdef ALLOW_AUTODIFF_TAMC
99              act1 = bi - myBxLo(myThid)
100  C---  Calculate advective and diffusive fluxes between cells.            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
101              act2 = bj - myByLo(myThid)
102  C--   Zonal flux (fZon is at west face of "salt" cell)            max2 = myByHi(myThid) - myByLo(myThid) + 1
103  C     Advective component of zonal flux            act3 = myThid - 1
104        DO j=jMin,jMax            max3 = nTx*nTy
105         DO i=iMin,iMax            act4 = ikey_dynamics - 1
106          af(i,j) =            itdkey = (act1 + 1) + act2*max1
107       &   uTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i-1,j,k,bi,bj))*0.5 _d 0       &                      + act3*max1*max2
108         ENDDO       &                      + act4*max1*max2*max3
109        ENDDO            kkey = (itdkey-1)*Nr + k
110  C     Zonal tracer gradient  #endif /* ALLOW_AUTODIFF_TAMC */
111        DO j=jMin,jMax  
112         DO i=iMin,iMax  #ifdef ALLOW_AUTODIFF_TAMC
113          dSdx(i,j) = _rdxC(i,j,bi,bj)*  C--   only the kUp part of fverS is set in this subroutine
114       &  (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))  C--   the kDown is still required
115         ENDDO        fVerS(1,1,kDown) = fVerS(1,1,kDown)
116        ENDDO  # ifdef NONLIN_FRSURF
117  C     Diffusive component of zonal flux  CADJ STORE fVerS(:,:,:) = comlev1_bibj_k, key=kkey, byte=isbyte
118        DO j=jMin,jMax  # endif
119         DO i=iMin,iMax  #endif
120          df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i-1,j)))*  
121       &            xA(i,j)*dSdx(i,j)  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
122         ENDDO  
123        ENDDO        calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec
124  C     Net zonal flux        iterNb = myIter
125        DO j=jMin,jMax        IF (staggerTimeStep) iterNb = myIter - 1
126         DO i=iMin,iMax  
127          fZon(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)  #ifdef ALLOW_ADAMSBASHFORTH_3
128         ENDDO          m1 = 1 + MOD(iterNb+1,2)
129        ENDDO          m2 = 1 + MOD( iterNb ,2)
130            CALL GAD_CALC_RHS(
131  C--   Meridional flux (fMer is at south face of "salt" cell)       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
132  C     Advective component of meridional flux       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
133        DO j=jMin,jMax       I           uVel, vVel, wVel,
134         DO i=iMin,iMax       I           diffKhS, diffK4S, KappaRS,
135  C       Advective component of meridional flux       I           gsNm(1-Olx,1-Oly,1,1,1,m2), salt,
136          af(i,j) =       I           GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
137       &   vTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j-1,k,bi,bj))*0.5 _d 0       I           calcAdvection, saltImplVertAdv, AdamsBashforth_S,
138         ENDDO       U           fVerS, gS,
139        ENDDO       I           myTime, myIter, myThid )
140  C     Zonal tracer gradient  #else /* ALLOW_ADAMSBASHFORTH_3 */
141        DO j=jMin,jMax          CALL GAD_CALC_RHS(
142         DO i=iMin,iMax       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
143          dSdy(i,j) = _rdyC(i,j,bi,bj)*       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
144       &  (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))       I           uVel, vVel, wVel,
145         ENDDO       I           diffKhS, diffK4S, KappaRS, gsNm1, salt,
146        ENDDO       I           GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
147  C     Diffusive component of meridional flux       I           calcAdvection, saltImplVertAdv, AdamsBashforth_S,
148        DO j=jMin,jMax       U           fVerS, gS,
149         DO i=iMin,iMax       I           myTime, myIter, myThid )
150          df(i,j) = -(diffKhS+0.5*(KapGM(i,j)+KapGM(i,j-1)))*  #endif /* ALLOW_ADAMSBASHFORTH_3 */
151       &            yA(i,j)*dSdy(i,j)  
152         ENDDO  C--   External salinity forcing term(s) inside Adams-Bashforth:
153        ENDDO        IF ( saltForcing .AND. forcing_In_AB )
154  C     Net meridional flux       & CALL EXTERNAL_FORCING_S(
155        DO j=jMin,jMax       I     iMin,iMax,jMin,jMax,bi,bj,k,
156         DO i=iMin,iMax       I     myTime,myThid)
157          fMer(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)  
158         ENDDO        IF ( AdamsBashforthGs ) THEN
159        ENDDO  #ifdef ALLOW_ADAMSBASHFORTH_3
160            CALL ADAMS_BASHFORTH3(
161  C--   Interpolate terms for Redi/GM scheme       I                        bi, bj, k,
162        DO j=jMin,jMax       U                        gS, gsNm,
163         DO i=iMin,iMax       I                        saltStartAB, iterNb, myThid )
164          dSdx(i,j) = 0.5*(  #else
165       &   +0.5*(_maskW(i+1,j,k,bi,bj)*_rdxC(i+1,j,bi,bj)*          CALL ADAMS_BASHFORTH2(
166       &           (salt(i+1,j,k,bi,bj)-salt(i,j,k,bi,bj))       I                        bi, bj, k,
167       &        +_maskW(i,j,k,bi,bj)*_rdxC(i,j,bi,bj)*       U                        gS, gsNm1,
168       &           (salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj)))       I                        iterNb, myThid )
169       &   +0.5*(_maskW(i+1,j,km1,bi,bj)*_rdxC(i+1,j,bi,bj)*  #endif
      &           (salt(i+1,j,km1,bi,bj)-salt(i,j,km1,bi,bj))  
      &        +_maskW(i,j,km1,bi,bj)*_rdxC(i,j,bi,bj)*  
      &           (salt(i,j,km1,bi,bj)-salt(i-1,j,km1,bi,bj)))  
      &       )  
        ENDDO  
       ENDDO  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         dSdy(i,j) = 0.5*(  
      &   +0.5*(_maskS(i,j,k,bi,bj)*_rdyC(i,j,bi,bj)*  
      &           (salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))  
      &        +_maskS(i,j+1,k,bi,bj)*_rdyC(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)*_rdyC(i,j,bi,bj)*  
      &           (salt(i,j,km1,bi,bj)-salt(i,j-1,km1,bi,bj))  
      &        +_maskS(i,j+1,km1,bi,bj)*_rdyC(i,j+1,bi,bj)*  
      &           (salt(i,j+1,km1,bi,bj)-salt(i,j,km1,bi,bj)))  
      &       )  
        ENDDO  
       ENDDO  
   
 C--   Vertical flux (fVerS) above  
 C     Advective component of vertical flux  
 C     Note: For K=1 then KM1=1 this gives a barZ(T) = T  
 C     (this plays the role of the free-surface correction)  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         af(i,j) =  
      &   wTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j,kM1,bi,bj))*0.5 _d 0  
        ENDDO  
       ENDDO  
 C     Diffusive component of vertical flux  
 C     Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper  
 C           boundary condition.  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         df(i,j) = _zA(i,j,bi,bj)*(  
      &   -KapGM(i,j)*K13(i,j,k)*dSdx(i,j)  
      &   -KapGM(i,j)*K23(i,j,k)*dSdy(i,j)  
      &   )  
        ENDDO  
       ENDDO  
       IF (.NOT.implicitDiffusion) THEN  
        DO j=jMin,jMax  
         DO i=iMin,iMax  
          df(i,j) = df(i,j) + _zA(i,j,bi,bj)*(  
      &    -KappaZS(i,j,k)*rdzC(k)  
      &    *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))  
      &    )  
         ENDDO  
        ENDDO  
       ENDIF  
 C     Net vertical flux  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fVerS(i,j,kUp) = ( afFacS*af(i,j)+  dfFacS*df(i,j) )*maskUp(i,j)  
        ENDDO  
       ENDDO  
       IF ( TOP_LAYER ) THEN  
        DO j=jMin,jMax  
         DO i=iMin,iMax  
          fVerS(i,j,kUp) = afFacS*af(i,j)*freeSurfFac  
         ENDDO  
        ENDDO  
170        ENDIF        ENDIF
171    
172  C--   Tendency is minus divergence of the fluxes.  C--   External salinity forcing term(s) outside Adams-Bashforth:
173  C     Note. Tendency terms will only be correct for range        IF ( saltForcing .AND. .NOT.forcing_In_AB )
174  C           i=iMin+1:iMax-1, j=jMin+1:jMax-1. Edge points       & CALL EXTERNAL_FORCING_S(
175  C           will contain valid floating point numbers but       I     iMin,iMax,jMin,jMax,bi,bj,k,
176  C           they are not algorithmically correct. These points       I     myTime,myThid)
177  C           are not used.  
178        DO j=jMin,jMax  #ifdef NONLIN_FRSURF
179         DO i=iMin,iMax        IF (nonlinFreeSurf.GT.0) THEN
180  C    &   -_rhFacC(i,j,k,bi,bj)*rdzF(k)*_rdxF(i,j,bi,bj)*_rdyF(i,j,bi,bj)          CALL FREESURF_RESCALE_G(
181  C    &   -_rhFacC(i,j,k,bi,bj)*rdzF(k)/_zA(i,j,bi,bj)       I                          bi, bj, k,
182  C #define _rVolS(i,j,k,bi,bj) _rhFacC(i,j,k,bi,bj)*rdzF(k)*_rdxF(i,j,bi,bj)*_rdyF(i,j,bi,bj)       U                          gS,
183  #define _rVolS(i,j,k,bi,bj) _rhFacC(i,j,k,bi,bj)*rdzF(k)/_zA(i,j,bi,bj)       I                          myThid )
184          gS(i,j,k,bi,bj)=          IF ( AdamsBashforthGs ) THEN
185       &   -_rVolS(i,j,k,bi,bj)  #ifdef ALLOW_ADAMSBASHFORTH_3
186       &   *(          CALL FREESURF_RESCALE_G(
187       &    +( fZon(i+1,j)-fZon(i,j) )       I                          bi, bj, k,
188       &    +( fMer(i,j+1)-fMer(i,j) )       U                          gsNm(1-OLx,1-OLy,1,1,1,1),
189       &    +( fVerS(i,j,kUp)-fVerS(i,j,kDown) )       I                          myThid )
190       &    )          CALL FREESURF_RESCALE_G(
191         ENDDO       I                          bi, bj, k,
192        ENDDO       U                          gsNm(1-OLx,1-OLy,1,1,1,2),
193         I                          myThid )
194  C--   External P-E forcing term(s)  #else
195  C     o Surface relaxation term          CALL FREESURF_RESCALE_G(
196        IF ( TOP_LAYER ) THEN       I                          bi, bj, k,
197         DO j=jMin,jMax       U                          gsNm1,
198          DO i=iMin,iMax       I                          myThid )
199           gS(i,j,k,bi,bj)=gS(i,j,k,bi,bj)  #endif
200       &   +maskC(i,j)*(          ENDIF
      &   -lambdaSaltClimRelax*(salt(i,j,k,bi,bj)-SSS(i,j,bi,bj))  
      &   +EmPmR(i,j,bi,bj) )  
         ENDDO  
        ENDDO  
201        ENDIF        ENDIF
202    #endif /* NONLIN_FRSURF */
203    
204    #endif /* ALLOW_GENERIC_ADVDIFF */
205    
206        RETURN        RETURN
207        END        END

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.22