1 |
jmc |
1.33 |
C $Header: /u/gcmpack/MITgcm/model/src/calc_gs.F,v 1.32 2001/09/26 18:09:14 cnh 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 |
adcroft |
1.28 |
I xA,yA,uTrans,vTrans,rTrans,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 |
|
|
C rTrans :: Vertical volume transport through cell face |
62 |
|
|
C bi, bj, iMin, iMax, jMin, jMax :: Range of points for which calculation |
63 |
cnh |
1.1 |
C results will be set. |
64 |
cnh |
1.32 |
C myThid :: Instance number for this innvocation of CALC_GT |
65 |
cnh |
1.1 |
_RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
66 |
|
|
_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
67 |
|
|
_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
68 |
|
|
_RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
69 |
|
|
_RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
70 |
cnh |
1.12 |
_RL rTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
71 |
cnh |
1.1 |
_RS maskUp(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
72 |
cnh |
1.14 |
_RL KappaRS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
73 |
adcroft |
1.7 |
INTEGER k,kUp,kDown,kM1 |
74 |
cnh |
1.1 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
75 |
adcroft |
1.31 |
_RL myTime |
76 |
|
|
INTEGER myIter |
77 |
cnh |
1.1 |
INTEGER myThid |
78 |
|
|
|
79 |
cnh |
1.32 |
CEOP |
80 |
heimbach |
1.20 |
|
81 |
jmc |
1.33 |
C === Local variables === |
82 |
|
|
LOGICAL calcAdvection |
83 |
|
|
|
84 |
heimbach |
1.20 |
#ifdef ALLOW_AUTODIFF_TAMC |
85 |
|
|
C-- only the kUp part of fverS is set in this subroutine |
86 |
|
|
C-- the kDown is still required |
87 |
|
|
fVerS(1,1,kDown) = fVerS(1,1,kDown) |
88 |
adcroft |
1.27 |
#endif |
89 |
cnh |
1.1 |
|
90 |
jmc |
1.33 |
calcAdvection = saltAdvection .AND. .NOT.saltMultiDimAdvec |
91 |
adcroft |
1.30 |
CALL GAD_CALC_RHS( |
92 |
|
|
I bi,bj,iMin,iMax,jMin,jMax,k,kM1,kUp,kDown, |
93 |
|
|
I xA,yA,uTrans,vTrans,rTrans,maskUp, |
94 |
|
|
I diffKhS, diffK4S, KappaRS, Salt, |
95 |
jmc |
1.33 |
I GAD_SALINITY, saltAdvScheme, calcAdvection, |
96 |
adcroft |
1.30 |
U fVerS, gS, |
97 |
|
|
I myThid ) |
98 |
cnh |
1.1 |
|
99 |
jmc |
1.33 |
C-- External salinity forcing term(s) inside Adams-Bashforth: |
100 |
|
|
IF ( saltForcing .AND. forcing_In_AB ) |
101 |
|
|
& CALL EXTERNAL_FORCING_S( |
102 |
cnh |
1.16 |
I iMin,iMax,jMin,jMax,bi,bj,k, |
103 |
adcroft |
1.31 |
I myTime,myThid) |
104 |
|
|
|
105 |
jmc |
1.33 |
IF ( saltAdamsBashforth ) THEN |
106 |
adcroft |
1.31 |
CALL ADAMS_BASHFORTH2( |
107 |
|
|
I bi, bj, K, |
108 |
|
|
U gS, gSnm1, |
109 |
|
|
I myIter, myThid ) |
110 |
|
|
ENDIF |
111 |
jmc |
1.33 |
|
112 |
|
|
C-- External salinity forcing term(s) outside Adams-Bashforth: |
113 |
|
|
IF ( saltForcing .AND. .NOT.forcing_In_AB ) |
114 |
|
|
& CALL EXTERNAL_FORCING_S( |
115 |
|
|
I iMin,iMax,jMin,jMax,bi,bj,k, |
116 |
|
|
I myTime,myThid) |
117 |
adcroft |
1.31 |
|
118 |
|
|
#ifdef NONLIN_FRSURF |
119 |
|
|
IF (nonlinFreeSurf.GT.0) THEN |
120 |
|
|
CALL FREESURF_RESCALE_G( |
121 |
|
|
I bi, bj, K, |
122 |
|
|
U gS, |
123 |
|
|
I myThid ) |
124 |
|
|
ENDIF |
125 |
|
|
#endif /* NONLIN_FRSURF */ |
126 |
cnh |
1.1 |
|
127 |
|
|
RETURN |
128 |
|
|
END |