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

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

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


Revision 1.38 - (hide annotations) (download)
Thu Oct 21 21:25:33 2004 UTC (19 years, 6 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint56b_post, checkpoint56, checkpoint55i_post, checkpoint55j_post, checkpoint56a_post, checkpoint56c_post
Changes since 1.37: +2 -2 lines
Explicit vertical diffusivity: use a 2.D vertical diffusivity array

1 jmc 1.38 C $Header: /u/gcmpack/MITgcm/model/src/calc_gs.F,v 1.37 2004/09/24 16:58:17 jmc Exp $
2 adcroft 1.31 C $Name: $
3 cnh 1.1
4 cnh 1.17 #include "CPP_OPTIONS.h"
5 cnh 1.1
6 cnh 1.32 CBOP
7     C !ROUTINE: CALC_GS
8     C !INTERFACE:
9 cnh 1.1 SUBROUTINE CALC_GS(
10     I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
11 jmc 1.35 I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
12 adcroft 1.21 I KappaRS,
13 adcroft 1.23 U fVerS,
14 adcroft 1.31 I myTime,myIter,myThid )
15 cnh 1.32 C !DESCRIPTION: \bv
16     C *==========================================================*
17     C | SUBROUTINE CALC_GS
18     C | o Calculate the salt tendency terms.
19     C *==========================================================*
20     C | A procedure called EXTERNAL_FORCING_S is called from
21     C | here. These procedures can be used to add per problem
22     C | E-P flux source terms.
23     C | Note: Although it is slightly counter-intuitive the
24     C | EXTERNAL_FORCING routine is not the place to put
25     C | file I/O. Instead files that are required to
26     C | calculate the external source terms are generally
27     C | read during the model main loop. This makes the
28     C | logisitics of multi-processing simpler and also
29     C | makes the adjoint generation simpler. It also
30     C | allows for I/O to overlap computation where that
31     C | is supported by hardware.
32     C | Aside from the problem specific term the code here
33     C | forms the tendency terms due to advection and mixing
34     C | The baseline implementation here uses a centered
35     C | difference form for the advection term and a tensorial
36     C | divergence of a flux form for the diffusive term. The
37     C | diffusive term is formulated so that isopycnal mixing and
38     C | GM-style subgrid-scale terms can be incorporated b simply
39     C | setting the diffusion tensor terms appropriately.
40     C *==========================================================*
41     C \ev
42    
43     C !USES:
44 cnh 1.1 IMPLICIT NONE
45     C == GLobal variables ==
46     #include "SIZE.h"
47     #include "DYNVARS.h"
48     #include "EEPARAMS.h"
49     #include "PARAMS.h"
50 adcroft 1.30 #include "GAD.h"
51 cnh 1.1
52 cnh 1.32 C !INPUT/OUTPUT PARAMETERS:
53 cnh 1.1 C == Routine arguments ==
54 cnh 1.32 C fVerS :: Flux of salt (S) in the vertical
55 cnh 1.1 C direction at the upper(U) and lower(D) faces of a cell.
56 cnh 1.32 C maskUp :: Land mask used to denote base of the domain.
57     C xA :: Tracer cell face area normal to X
58     C yA :: Tracer cell face area normal to X
59     C uTrans :: Zonal volume transport through cell face
60     C vTrans :: Meridional volume transport through cell face
61 jmc 1.35 C rTrans :: Vertical volume transport at interface k
62     C rTransKp1 :: Vertical volume transport at inteface k+1
63 cnh 1.32 C bi, bj, iMin, iMax, jMin, jMax :: Range of points for which calculation
64 cnh 1.1 C results will be set.
65 cnh 1.32 C myThid :: Instance number for this innvocation of CALC_GT
66 cnh 1.1 _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
67     _RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
68     _RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
69     _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
70     _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
71 cnh 1.12 _RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
72 jmc 1.35 _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
73 cnh 1.1 _RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
74 jmc 1.38 _RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75 adcroft 1.7 INTEGER k,kUp,kDown,kM1
76 cnh 1.1 INTEGER bi,bj,iMin,iMax,jMin,jMax
77 adcroft 1.31 _RL myTime
78     INTEGER myIter
79 cnh 1.1 INTEGER myThid
80    
81 cnh 1.32 CEOP
82 heimbach 1.20
83 jmc 1.33 C === Local variables ===
84     LOGICAL calcAdvection
85    
86 heimbach 1.20 #ifdef ALLOW_AUTODIFF_TAMC
87     C-- only the kUp part of fverS is set in this subroutine
88     C-- the kDown is still required
89     fVerS(1,1,kDown) = fVerS(1,1,kDown)
90 adcroft 1.27 #endif
91 cnh 1.1
92 jmc 1.33 calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec
93 adcroft 1.30 CALL GAD_CALC_RHS(
94     I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown,
95 jmc 1.35 I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
96     I uVel, vVel, wVel,
97 adcroft 1.30 I diffKhS, diffK4S, KappaRS, Salt,
98 jmc 1.36 I GAD_SALINITY, saltAdvScheme, saltVertAdvScheme,
99 jmc 1.35 I calcAdvection, saltImplVertAdv,
100 adcroft 1.30 U fVerS, gS,
101 jmc 1.37 I myTime, myIter, myThid )
102 cnh 1.1
103 jmc 1.33 C-- External salinity forcing term(s) inside Adams-Bashforth:
104     IF ( saltForcing .AND. forcing_In_AB )
105     & CALL EXTERNAL_FORCING_S(
106 cnh 1.16 I iMin,iMax,jMin,jMax,bi,bj,k,
107 adcroft 1.31 I myTime,myThid)
108    
109 jmc 1.33 IF ( saltAdamsBashforth ) THEN
110 adcroft 1.31 CALL ADAMS_BASHFORTH2(
111     I bi, bj, K,
112     U gS, gSnm1,
113     I myIter, myThid )
114     ENDIF
115 jmc 1.33
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 adcroft 1.31
122     #ifdef NONLIN_FRSURF
123     IF (nonlinFreeSurf.GT.0) THEN
124     CALL FREESURF_RESCALE_G(
125     I bi, bj, K,
126     U gS,
127 jmc 1.34 I myThid )
128     IF ( saltAdamsBashforth )
129     & CALL FREESURF_RESCALE_G(
130     I bi, bj, K,
131     U gSnm1,
132 adcroft 1.31 I myThid )
133     ENDIF
134     #endif /* NONLIN_FRSURF */
135 cnh 1.1
136     RETURN
137     END

  ViewVC Help
Powered by ViewVC 1.1.22