/[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.2 by cnh, Fri Apr 24 02:05:40 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,       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
13       U           af,df,fZon,fMer, fVerS,       I           KappaRS,
14       I           myThid )       U           fVerS,
15  C     /==========================================================\       I           myTime,myIter,myThid )
16  C     | SUBROUTINE CALC_GS                                       |  C     !DESCRIPTION: \bv
17  C     | o Calculate the salinity tendency terms.                 |  C     *==========================================================*
18  C     |==========================================================|  C     | SUBROUTINE CALC_GS                                        
19  C     | A procedure called EXTERNAL_FORCING_S is called from     |  C     | o Calculate the salt tendency terms.                      
20  C     | here. These procedures can be used to add per problem    |  C     *==========================================================*
21  C     | fresh water flux source terms.                           |  C     | A procedure called EXTERNAL_FORCING_S is called from      
22  C     | Note: Although it is slightly counter-intuitive the      |  C     | here. These procedures can be used to add per problem    
23  C     |       EXTERNAL_FORCING routine is not the place to put   |  C     | E-P  flux source terms.                                  
24  C     |       file I/O. Instead files that are required to       |  C     | Note: Although it is slightly counter-intuitive the      
25  C     |       calculate the external source terms are generally  |  C     |       EXTERNAL_FORCING routine is not the place to put    
26  C     |       read during the model main loop. This makes the    |  C     |       file I/O. Instead files that are required to        
27  C     |       logisitics of multi-processing simpler and also    |  C     |       calculate the external source terms are generally  
28  C     |       makes the adjoint generation simpler. It also      |  C     |       read during the model main loop. This makes the    
29  C     |       allows for I/O to overlap computation where that   |  C     |       logisitics of multi-processing simpler and also    
30  C     |       is supported by hardware.                          |  C     |       makes the adjoint generation simpler. It also      
31  C     | Aside from the problem specific term the code here       |  C     |       allows for I/O to overlap computation where that    
32  C     | forms the tendency terms due to advection and mixing     |  C     |       is supported by hardware.                          
33  C     | The baseline implementation here uses a centered         |  C     | Aside from the problem specific term the code here        
34  C     | difference form for the advection term and a tensorial   |  C     | forms the tendency terms due to advection and mixing      
35  C     | divergence of a flux form for the diffusive term. The    |  C     | The baseline implementation here uses a centered          
36  C     | diffusive term is formulated so that isopycnal mixing and|  C     | difference form for the advection term and a tensorial    
37  C     | GM-style subgrid-scale terms can be incorporated b simply|  C     | divergence of a flux form for the diffusive term. The    
38  C     | setting the diffusion tensor terms appropriately.        |  C     | diffusive term is formulated so that isopycnal mixing and
39  C     \==========================================================/  C     | GM-style subgrid-scale terms can be incorporated b simply
40        IMPLICIT NONE  C     | setting the diffusion tensor terms appropriately.        
41    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 "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 salinity (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     xA      - Tracer cell face area normal to X  C     xA      :: Tracer cell face area normal to X
65  C     yA      - Tracer cell face area normal to X  C     yA      :: Tracer cell face area normal to X
66  C     uTrans  - Zonal volume transport through cell face  C     uTrans  :: Zonal volume transport through cell face
67  C     vTrans  - Meridional volume transport through cell face  C     vTrans  :: Meridional volume transport through cell face
68  C     wTrans  - Vertical volume transport through cell face  C     rTrans  ::   Vertical volume transport at interface k
69  C     af      - Advective flux component work array  C     rTransKp1 :: Vertical volume transport at inteface k+1
70  C     df      - Diffusive flux component work array  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  
71  C                                      results will be set.  C                                      results will be set.
72  C     myThid - Instance number for this innvocation of CALC_GS  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        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
82        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        INTEGER k,kUp,kDown,kM1
       INTEGER 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,k  #ifdef ALLOW_GENERIC_ADVDIFF
91        INTEGER afFacS, dfFacS  C     === Local variables ===
92          LOGICAL calcAdvection
93        afFacS = 1. _d 0        INTEGER iterNb
94        dfFacS = 1. _d 0  #ifdef ALLOW_ADAMSBASHFORTH_3
95          INTEGER m1, m2
96  C---  #endif
97  C---  Calculate advective and diffusive fluxes between cells.  
98  C---  #ifdef ALLOW_AUTODIFF_TAMC
99              act1 = bi - myBxLo(myThid)
100  C--   Zonal flux (fZon is at west face of "salt" cell)            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
101  C     Advective component of zonal flux            act2 = bj - myByLo(myThid)
102        DO j=jMin,jMax            max2 = myByHi(myThid) - myByLo(myThid) + 1
103         DO i=iMin,iMax            act3 = myThid - 1
104          af(i,j) =            max3 = nTx*nTy
105       &   uTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i-1,j,k,bi,bj))*0.5 _d 0            act4 = ikey_dynamics - 1
106         ENDDO            itdkey = (act1 + 1) + act2*max1
107        ENDDO       &                      + act3*max1*max2
108  C     Diffusive component of zonal flux       &                      + act4*max1*max2*max3
109        DO j=jMin,jMax            kkey = (itdkey-1)*Nr + k
110         DO i=iMin,iMax  #endif /* ALLOW_AUTODIFF_TAMC */
111          df(i,j) =  
112       &   -diffKhS*xA(i,j)*rdxC(i,j,bi,bj)  #ifdef ALLOW_AUTODIFF_TAMC
113       &   *(salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))  C--   only the kUp part of fverS is set in this subroutine
114         ENDDO  C--   the kDown is still required
115        ENDDO        fVerS(1,1,kDown) = fVerS(1,1,kDown)
116  C     Net zonal flux  # ifdef NONLIN_FRSURF
117        DO j=jMin,jMax  CADJ STORE fVerS(:,:,:) = comlev1_bibj_k, key=kkey, byte=isbyte
118         DO i=iMin,iMax  # endif
119          fZon(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)  #endif
120         ENDDO  
121        ENDDO  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
122    
123  C--   Meridional flux (fMer is at south face of "salt" cell)        calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec
124  C     Advective component of meridional flux        iterNb = myIter
125        DO j=jMin,jMax        IF (staggerTimeStep) iterNb = myIter - 1
126         DO i=iMin,iMax  
127  C       Advective component of meridional flux  #ifdef ALLOW_ADAMSBASHFORTH_3
128          af(i,j) =          m1 = 1 + MOD(iterNb+1,2)
129       &   vTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j-1,k,bi,bj))*0.5 _d 0          m2 = 1 + MOD( iterNb ,2)
130         ENDDO          CALL GAD_CALC_RHS(
131        ENDDO       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
132  C     Diffusive 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          df(i,j) =       I           gsNm(1-Olx,1-Oly,1,1,1,m2), salt,
136       &   -diffKhS*yA(i,j)*rdyC(i,j,bi,bj)       I           GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
137       &   *(salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))       I           calcAdvection, saltImplVertAdv, AdamsBashforth_S,
138         ENDDO       U           fVerS, gS,
139        ENDDO       I           myTime, myIter, myThid )
140  C     Net meridional flux  #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          fMer(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
144         ENDDO       I           uVel, vVel, wVel,
145        ENDDO       I           diffKhS, diffK4S, KappaRS, gsNm1, salt,
146         I           GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
147  C--   Vertical flux (fVerS) above       I           calcAdvection, saltImplVertAdv, AdamsBashforth_S,
148  C     Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper       U           fVerS, gS,
149  C           boundary condition.       I           myTime, myIter, myThid )
150  C     Advective component of vertical flux  #endif /* ALLOW_ADAMSBASHFORTH_3 */
151        DO j=jMin,jMax  
152         DO i=iMin,iMax  C--   External salinity forcing term(s) inside Adams-Bashforth:
153          af(i,j) =        IF ( saltForcing .AND. forcing_In_AB )
154       &   wTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j,kM1,bi,bj))*0.5 _d 0       & CALL EXTERNAL_FORCING_S(
155         ENDDO       I     iMin,iMax,jMin,jMax,bi,bj,k,
156        ENDDO       I     myTime,myThid)
157  C     Diffusive component of vertical flux  
158        DO j=jMin,jMax        IF ( AdamsBashforthGs ) THEN
159         DO i=iMin,iMax  #ifdef ALLOW_ADAMSBASHFORTH_3
160          df(i,j) =          CALL ADAMS_BASHFORTH3(
161       &   -diffKzS*zA(i,j,bi,bj)*rdzC(k)       I                        bi, bj, k,
162       &   *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))       U                        gS, gsNm,
163         ENDDO       I                        saltStartAB, iterNb, myThid )
164        ENDDO  #else
165  C     Net vertical flux          CALL ADAMS_BASHFORTH2(
166        DO j=jMin,jMax       I                        bi, bj, k,
167         DO i=iMin,iMax       U                        gS, gsNm1,
168          fVerS(i,j,kUp) = (afFacS*af(i,j) + dfFacS*df(i,j))*maskUp(i,j)       I                        iterNb, myThid )
169         ENDDO  #endif
170        ENDDO        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          gS(i,j,k,bi,bj)=          CALL FREESURF_RESCALE_G(
181       &   -rHFacC(i,j,k,bi,bj)*rdzF(k)*rDxF(i,j,bi,bj)*rDyF(i,j,bi,bj)       I                          bi, bj, k,
182       &   *(       U                          gS,
183       &    +( fZon(i+1,j)-fZon(i,j) )       I                          myThid )
184       &    +( fMer(i,j+1)-fMer(i,j) )          IF ( AdamsBashforthGs ) THEN
185       &    +( fVerS(i,j,kUp)-fVerS(i,j,kDown) )  #ifdef ALLOW_ADAMSBASHFORTH_3
186       &    )          CALL FREESURF_RESCALE_G(
187         ENDDO       I                          bi, bj, k,
188        ENDDO       U                          gsNm(1-OLx,1-OLy,1,1,1,1),
189         I                          myThid )
190            CALL FREESURF_RESCALE_G(
191         I                          bi, bj, k,
192         U                          gsNm(1-OLx,1-OLy,1,1,1,2),
193         I                          myThid )
194    #else
195            CALL FREESURF_RESCALE_G(
196         I                          bi, bj, k,
197         U                          gsNm1,
198         I                          myThid )
199    #endif
200            ENDIF
201          ENDIF
202    #endif /* NONLIN_FRSURF */
203    
204  C--   External haline forcing term(s)  #endif /* ALLOW_GENERIC_ADVDIFF */
205    
206        RETURN        RETURN
207        END        END
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.44
  ViewVC Help
Powered by ViewVC 1.1.22