/[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.36 by jmc, Sat Jun 26 02:38:09 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3    
4  #include "CPP_EEOPTIONS.h"  #include "CPP_OPTIONS.h"
5    
6  CStartOfInterFace  CBOP
7    C     !ROUTINE: CALC_GS
8    C     !INTERFACE:
9        SUBROUTINE CALC_GS(        SUBROUTINE CALC_GS(
10       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
11       I           xA,yA,uTrans,vTrans,wTrans,maskup,       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
12       U           af,df,fZon,fMer, fVerS,       I           KappaRS,
13       I           myThid )       U           fVerS,
14  C     /==========================================================\       I           myTime,myIter,myThid )
15  C     | SUBROUTINE CALC_GS                                       |  C     !DESCRIPTION: \bv
16  C     | o Calculate the salinity tendency terms.                 |  C     *==========================================================*
17  C     |==========================================================|  C     | SUBROUTINE CALC_GS                                        
18  C     | A procedure called EXTERNAL_FORCING_S is called from     |  C     | o Calculate the salt tendency terms.                      
19  C     | here. These procedures can be used to add per problem    |  C     *==========================================================*
20  C     | fresh water flux source terms.                           |  C     | A procedure called EXTERNAL_FORCING_S is called from      
21  C     | Note: Although it is slightly counter-intuitive the      |  C     | here. These procedures can be used to add per problem    
22  C     |       EXTERNAL_FORCING routine is not the place to put   |  C     | E-P  flux source terms.                                  
23  C     |       file I/O. Instead files that are required to       |  C     | Note: Although it is slightly counter-intuitive the      
24  C     |       calculate the external source terms are generally  |  C     |       EXTERNAL_FORCING routine is not the place to put    
25  C     |       read during the model main loop. This makes the    |  C     |       file I/O. Instead files that are required to        
26  C     |       logisitics of multi-processing simpler and also    |  C     |       calculate the external source terms are generally  
27  C     |       makes the adjoint generation simpler. It also      |  C     |       read during the model main loop. This makes the    
28  C     |       allows for I/O to overlap computation where that   |  C     |       logisitics of multi-processing simpler and also    
29  C     |       is supported by hardware.                          |  C     |       makes the adjoint generation simpler. It also      
30  C     | Aside from the problem specific term the code here       |  C     |       allows for I/O to overlap computation where that    
31  C     | forms the tendency terms due to advection and mixing     |  C     |       is supported by hardware.                          
32  C     | The baseline implementation here uses a centered         |  C     | Aside from the problem specific term the code here        
33  C     | difference form for the advection term and a tensorial   |  C     | forms the tendency terms due to advection and mixing      
34  C     | divergence of a flux form for the diffusive term. The    |  C     | The baseline implementation here uses a centered          
35  C     | diffusive term is formulated so that isopycnal mixing and|  C     | difference form for the advection term and a tensorial    
36  C     | GM-style subgrid-scale terms can be incorporated b simply|  C     | divergence of a flux form for the diffusive term. The    
37  C     | setting the diffusion tensor terms appropriately.        |  C     | diffusive term is formulated so that isopycnal mixing and
38  C     \==========================================================/  C     | GM-style subgrid-scale terms can be incorporated b simply
39        IMPLICIT NONE  C     | setting the diffusion tensor terms appropriately.        
40    C     *==========================================================*
41    C     \ev
42    
43    C     !USES:
44          IMPLICIT NONE
45  C     == GLobal variables ==  C     == GLobal variables ==
46  #include "SIZE.h"  #include "SIZE.h"
47  #include "DYNVARS.h"  #include "DYNVARS.h"
48  #include "EEPARAMS.h"  #include "EEPARAMS.h"
49  #include "PARAMS.h"  #include "PARAMS.h"
50  #include "GRID.h"  #include "GAD.h"
51    
52    C     !INPUT/OUTPUT PARAMETERS:
53  C     == Routine arguments ==  C     == Routine arguments ==
54  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  
55  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.
56  C     maskUp  - Land mask used to denote base of the domain.  C     maskUp  :: Land mask used to denote base of the domain.
57  C     xA      - Tracer cell face area normal to X  C     xA      :: Tracer cell face area normal to X
58  C     yA      - Tracer cell face area normal to X  C     yA      :: Tracer cell face area normal to X
59  C     uTrans  - Zonal volume transport through cell face  C     uTrans  :: Zonal volume transport through cell face
60  C     vTrans  - Meridional volume transport through cell face  C     vTrans  :: Meridional volume transport through cell face
61  C     wTrans  - Vertical volume transport through cell face  C     rTrans  ::   Vertical volume transport at interface k
62  C     af      - Advective flux component work array  C     rTransKp1 :: Vertical volume transport at inteface k+1
63  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  
64  C                                      results will be set.  C                                      results will be set.
65  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)  
66        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
67        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
68        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
69        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
70        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
71        _RL wTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
72          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
73        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
74        _RL af    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
75        _RL df    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        INTEGER k,kUp,kDown,kM1
       INTEGER kUp,kDown,kM1  
76        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
77          _RL     myTime
78          INTEGER myIter
79        INTEGER myThid        INTEGER myThid
 CEndOfInterface  
80    
81  C     == Local variables ==  CEOP
82  C     I, J, K - Loop counters  
83        INTEGER i,j,k  C     === Local variables ===
84        INTEGER afFacS, dfFacS        LOGICAL calcAdvection
85    
86        afFacS = 1. _d 0  #ifdef ALLOW_AUTODIFF_TAMC
87        dfFacS = 1. _d 0  C--   only the kUp part of fverS is set in this subroutine
88    C--   the kDown is still required
89  C---        fVerS(1,1,kDown) = fVerS(1,1,kDown)
90  C---  Calculate advective and diffusive fluxes between cells.  #endif
91  C---  
92          calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec
93  C--   Zonal flux (fZon is at west face of "salt" cell)        CALL GAD_CALC_RHS(
94  C     Advective component of zonal flux       I           bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
95        DO j=jMin,jMax       I           xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
96         DO i=iMin,iMax       I           uVel, vVel, wVel,
97          af(i,j) =       I           diffKhS, diffK4S, KappaRS, Salt,
98       &   uTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i-1,j,k,bi,bj))*0.5 _d 0       I           GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
99         ENDDO       I           calcAdvection, saltImplVertAdv,
100        ENDDO       U           fVerS, gS,
101  C     Diffusive component of zonal flux       I           myThid )
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         df(i,j) =  
      &   -diffKhS*xA(i,j)*rdxC(i,j,bi,bj)  
      &   *(salt(i,j,k,bi,bj)-salt(i-1,j,k,bi,bj))  
        ENDDO  
       ENDDO  
 C     Net zonal flux  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fZon(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)  
        ENDDO  
       ENDDO  
   
 C--   Meridional flux (fMer is at south face of "salt" cell)  
 C     Advective component of meridional flux  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
 C       Advective component of meridional flux  
         af(i,j) =  
      &   vTrans(i,j)*(salt(i,j,k,bi,bj)+salt(i,j-1,k,bi,bj))*0.5 _d 0  
        ENDDO  
       ENDDO  
 C     Diffusive component of meridional flux  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         df(i,j) =  
      &   -diffKhS*yA(i,j)*rdyC(i,j,bi,bj)  
      &   *(salt(i,j,k,bi,bj)-salt(i,j-1,k,bi,bj))  
        ENDDO  
       ENDDO  
 C     Net meridional flux  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         fMer(i,j) = afFacS*af(i,j) + dfFacS*df(i,j)  
        ENDDO  
       ENDDO  
   
 C--   Vertical flux (fVerS) above  
 C     Note: For K=1 then KM1=1 this gives a dS/dz = 0 upper  
 C           boundary condition.  
 C     Advective component of vertical flux  
       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  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         df(i,j) =  
      &   -diffKzS*zA(i,j,bi,bj)*rdzC(k)  
      &   *(salt(i,j,kM1,bi,bj)-salt(i,j,k,bi,bj))  
        ENDDO  
       ENDDO  
 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  
   
 C--   Tendency is minus divergence of the fluxes.  
 C     Note. Tendency terms will only be correct for range  
 C           i=iMin+1:iMax-1, j=jMin+1:jMax-1. Edge points  
 C           will contain valid floating point numbers but  
 C           they are not algorithmically correct. These points  
 C           are not used.  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gS(i,j,k,bi,bj)=  
      &   -rHFacC(i,j,k,bi,bj)*rdzF(k)*rDxF(i,j,bi,bj)*rDyF(i,j,bi,bj)  
      &   *(  
      &    +( fZon(i+1,j)-fZon(i,j) )  
      &    +( fMer(i,j+1)-fMer(i,j) )  
      &    +( fVerS(i,j,kUp)-fVerS(i,j,kDown) )  
      &    )  
        ENDDO  
       ENDDO  
102    
103  C--   External haline forcing term(s)  C--   External salinity forcing term(s) inside Adams-Bashforth:
104          IF ( saltForcing .AND. forcing_In_AB )
105         & CALL EXTERNAL_FORCING_S(
106         I     iMin,iMax,jMin,jMax,bi,bj,k,
107         I     myTime,myThid)
108    
109          IF ( saltAdamsBashforth ) THEN
110            CALL ADAMS_BASHFORTH2(
111         I                        bi, bj, K,
112         U                        gS, gSnm1,
113         I                        myIter, myThid )
114          ENDIF
115    
116    C--   External salinity forcing term(s) outside Adams-Bashforth:
117          IF ( saltForcing .AND. .NOT.forcing_In_AB )
118         & CALL EXTERNAL_FORCING_S(
119         I     iMin,iMax,jMin,jMax,bi,bj,k,
120         I     myTime,myThid)
121    
122    #ifdef NONLIN_FRSURF
123          IF (nonlinFreeSurf.GT.0) THEN
124            CALL FREESURF_RESCALE_G(
125         I                          bi, bj, K,
126         U                          gS,
127         I                          myThid )
128            IF ( saltAdamsBashforth )
129         &  CALL FREESURF_RESCALE_G(
130         I                          bi, bj, K,
131         U                          gSnm1,
132         I                          myThid )
133          ENDIF
134    #endif /* NONLIN_FRSURF */
135    
136        RETURN        RETURN
137        END        END
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.36
  ViewVC Help
Powered by ViewVC 1.1.22