1 |
C $Header: /u/gcmpack/MITgcm/pkg/gmredi/GMREDI.h,v 1.27 2013/10/21 18:46:05 m_bates Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#ifdef ALLOW_GMREDI |
5 |
|
6 |
C--- GM/Redi package parameters |
7 |
|
8 |
C-- Numerical Constant |
9 |
_RL op5 |
10 |
_RL op25 |
11 |
PARAMETER( op5 = 0.5 _d 0 ) |
12 |
PARAMETER( op25 = 0.25 _d 0 ) |
13 |
|
14 |
C-- COMMON /GM_PARAMS_L/ GM/Redi Logical-type parameters |
15 |
C GM_AdvForm :: use Advective Form (instead of Skew-Flux form) |
16 |
C GM_AdvSeparate :: do separately advection by Eulerian and Bolus velocity |
17 |
C GM_useBVP :: use Boundary-Value-Problem method for Bolus transport |
18 |
C GM_useSubMeso :: use parameterization of mixed layer (Sub-Mesoscale) eddies |
19 |
C GM_ExtraDiag :: select extra diagnostics |
20 |
C GM_InMomAsStress :: apply GM as a stress in momentum Eq. |
21 |
C GM_MNC :: |
22 |
C GM_MDSIO :: |
23 |
C GM_useK3D :: use the 3 dimensional calculation for K |
24 |
C GM_K3D_beta_eq_0 :: Ignores the beta term when calculating grad(q) |
25 |
C GM_K3D_likeGM :: Makes the PV closure similar to the GM closure (for debugging only!) |
26 |
C GM_K3D_ThickSheet:: Use a thick PV sheet (should pretty much always be false) |
27 |
C GM_K3D_surfK :: Imposes a constant K in the surface layer |
28 |
C GM_K3D_constRedi :: Imposes a constant K for the Redi isoneutral diffusivity |
29 |
C GM_K3D_smooth :: Expand PV closure in terms of baroclinic modes (for debugging only!) |
30 |
LOGICAL GM_AdvForm |
31 |
LOGICAL GM_AdvSeparate |
32 |
LOGICAL GM_useBVP |
33 |
LOGICAL GM_useSubMeso |
34 |
LOGICAL GM_ExtraDiag |
35 |
LOGICAL GM_InMomAsStress |
36 |
LOGICAL GM_MNC |
37 |
LOGICAL GM_MDSIO |
38 |
LOGICAL GM_useK3D |
39 |
LOGICAL GM_K3D_likeGM |
40 |
LOGICAL GM_K3D_ThickSheet |
41 |
LOGICAL GM_K3D_surfK |
42 |
LOGICAL GM_K3D_constRedi |
43 |
LOGICAL GM_K3D_beta_eq_0 |
44 |
LOGICAL GM_K3D_smooth |
45 |
COMMON /GM_PARAMS_L/ |
46 |
& GM_AdvForm, GM_AdvSeparate, |
47 |
& GM_useBVP, GM_useSubMeso, |
48 |
& GM_ExtraDiag, GM_MNC, GM_MDSIO, |
49 |
& GM_InMomAsStress, |
50 |
& GM_useK3D, GM_K3D_likeGM, GM_K3D_smooth, |
51 |
& GM_K3D_beta_eq_0, GM_K3D_ThickSheet, |
52 |
& GM_K3D_surfK, GM_K3D_constRedi |
53 |
|
54 |
C-- GM/Redi Integer-type parameters |
55 |
C GM_BVP_modeNumber :: vertical mode number used for speed "c" in BVP transport |
56 |
C GM_K3D_NModes :: number of vertical modes used for calculating Xi in K3D |
57 |
INTEGER GM_BVP_modeNumber |
58 |
INTEGER GM_K3D_NModes |
59 |
PARAMETER (GM_K3D_NModes=6) |
60 |
COMMON /GM_PARAMS_I/ |
61 |
& GM_BVP_modeNumber |
62 |
|
63 |
C-- COMMON /GM_PARAMS_C/ GM/Redi Character-type parameters |
64 |
C GM_taper_scheme :: select which tapering/clipping scheme to use |
65 |
C GM_iso2dFile :: input file for 2.D horiz scaling of Isopycnal diffusivity |
66 |
C GM_iso1dFile :: input file for 1.D vert. scaling of Isopycnal diffusivity |
67 |
C GM_bol2dFile :: input file for 2.D horiz scaling of Thickness diffusivity |
68 |
C GM_bol1dFile :: input file for 1.D vert. scaling of Thickness diffusivity |
69 |
CHARACTER*(40) GM_taper_scheme |
70 |
CHARACTER*(MAX_LEN_FNAM) GM_iso2dFile |
71 |
CHARACTER*(MAX_LEN_FNAM) GM_iso1dFile |
72 |
CHARACTER*(MAX_LEN_FNAM) GM_bol2dFile |
73 |
CHARACTER*(MAX_LEN_FNAM) GM_bol1dFile |
74 |
COMMON /GM_PARAMS_C/ |
75 |
& GM_taper_scheme, |
76 |
& GM_iso2dFile, GM_iso1dFile, |
77 |
& GM_bol2dFile, GM_bol1dFile |
78 |
|
79 |
C-- COMMON /GM_PARAMS_R/ GM/Redi real-type parameters |
80 |
C GM_isopycK :: Isopycnal diffusivity [m^2/s] (Redi-tensor) |
81 |
C GM_background_K :: Thickness diffusivity [m^2/s] (GM bolus transport) |
82 |
C GM_maxSlope :: maximum slope (tapering/clipping) [-] |
83 |
C GM_Kmin_horiz :: minimum horizontal diffusivity [m^2/s] |
84 |
C GM_Small_Number :: epsilon used in computing the slope |
85 |
C GM_slopeSqCutoff :: slope^2 cut-off value |
86 |
C- Transition layer thickness definition: |
87 |
C GM_facTrL2dz :: minimum Trans. Layer Thick. as a factor of local dz |
88 |
C GM_facTrL2ML :: maximum Trans. Layer Thick. as a factor of Mix-Layer Depth |
89 |
C GM_maxTransLay :: maximum Trans. Layer Thick. [m] |
90 |
C- Boundary-Value-Problem method parameters: |
91 |
C GM_BVP_cMin :: minimum value for wave speed parameter "c" in BVP [m/s] |
92 |
C- mixed layer (Sub-Mesoscale) eddies parameterization: |
93 |
C subMeso_Ceff :: efficiency coefficient of Mixed-Layer Eddies [-] |
94 |
C subMeso_invTau :: inverse of mixing time-scale in sub-meso parameteriz. [s^-1] |
95 |
C subMeso_LfMin :: minimum value for length-scale "Lf" [m] |
96 |
C subMeso_Lmax :: maximum horizontal grid-scale length [m] |
97 |
C Variable K with PV diffusion parameters: |
98 |
C GM_K3D_gamma :: mixing efficiency for 3D eddy diffusivity [-] |
99 |
C GM_K3D_b1 :: an empirically determined constant of O(1) |
100 |
C GM_K3D_EadyMinDepth :: upper depth for Eady calculation |
101 |
C GM_K3D_EadyMaxDepth :: lower depth for Eady calculation |
102 |
C GM_maxK3D :: Upper bound on the diffusivity |
103 |
C GM_K3D_constK :: Constant diffusivity to use when GM_useK3D=.TRUE. and GM_K3D_likeGM=.TRUE. |
104 |
C GM_K3D_Rmax :: Upper bound on the length scale used for calculating urms |
105 |
C GM_K3D_Rmin :: Lower bound on the length scale used for calculating the eddy radius |
106 |
C GM_K3D_minCori :: minimum value for f (to stop things blowing up near the equator) |
107 |
C GM_K3D_minN2 :: minimum value for the square of the buoyancy frequency |
108 |
C GM_K3D_surfMinDepth :: minimum value for the depth of the surface layer |
109 |
C GM_K3D_vecFreq :: Frequency at which to update the baroclinic modes |
110 |
|
111 |
_RL GM_isopycK |
112 |
_RL GM_background_K |
113 |
_RL GM_maxSlope |
114 |
_RL GM_Kmin_horiz |
115 |
_RL GM_Small_Number |
116 |
_RL GM_slopeSqCutoff |
117 |
_RL GM_Visbeck_alpha |
118 |
_RL GM_Visbeck_length |
119 |
_RL GM_Visbeck_depth |
120 |
_RL GM_Visbeck_minDepth |
121 |
_RL GM_Visbeck_maxSlope |
122 |
_RL GM_Visbeck_minVal_K |
123 |
_RL GM_Visbeck_maxVal_K |
124 |
_RL GM_K3D_gamma |
125 |
_RL GM_K3D_b1 |
126 |
_RL GM_K3D_EadyMinDepth |
127 |
_RL GM_K3D_EadyMaxDepth |
128 |
_RL GM_K3D_Lambda |
129 |
_RL GM_K3D_smallK |
130 |
_RL GM_K3D_maxC |
131 |
_RL GM_maxK3D |
132 |
_RL GM_K3D_constK |
133 |
_RL GM_K3D_Rmax |
134 |
_RL GM_K3D_Rmin |
135 |
_RL GM_K3D_minCori |
136 |
_RL GM_K3D_minN2 |
137 |
_RL GM_K3D_surfMinDepth |
138 |
_RL GM_K3D_vecFreq |
139 |
_RL GM_facTrL2dz |
140 |
_RL GM_facTrL2ML |
141 |
_RL GM_maxTransLay |
142 |
_RL GM_Scrit |
143 |
_RL GM_Sd |
144 |
_RL GM_BVP_cMin |
145 |
_RL subMeso_Ceff |
146 |
_RL subMeso_invTau |
147 |
_RL subMeso_LfMin |
148 |
_RS subMeso_Lmax |
149 |
COMMON /GM_PARAMS_RL/ |
150 |
& GM_isopycK, GM_background_K, |
151 |
& GM_maxSlope, |
152 |
& GM_Kmin_horiz, |
153 |
& GM_Small_Number, GM_slopeSqCutoff, |
154 |
& GM_Visbeck_alpha, GM_Visbeck_length, |
155 |
& GM_Visbeck_depth, |
156 |
& GM_Visbeck_minDepth, GM_Visbeck_maxSlope, |
157 |
& GM_Visbeck_minVal_K, GM_Visbeck_maxVal_K, |
158 |
& GM_K3D_gamma, GM_K3D_b1, GM_K3D_EadyMinDepth, |
159 |
& GM_K3D_EadyMaxDepth, GM_K3D_Lambda, |
160 |
& GM_K3D_smallK, GM_K3D_maxC, |
161 |
& GM_maxK3D, GM_K3D_minCori, GM_K3D_minN2, |
162 |
& GM_K3D_surfMinDepth, GM_K3D_Rmax, GM_K3D_Rmin, |
163 |
& GM_K3D_constK, GM_K3D_vecFreq, |
164 |
& GM_facTrL2dz, GM_facTrL2ML, GM_maxTransLay, |
165 |
& GM_Scrit, GM_Sd, GM_BVP_cMin, |
166 |
& subMeso_Ceff, subMeso_invTau, subMeso_LfMin |
167 |
COMMON /GM_PARAMS_RS/ |
168 |
& subMeso_Lmax |
169 |
|
170 |
C-- COMMON /GM_DERIVED_PAR/ other GM/Redi parameters |
171 |
C (derived from previous block and not directly user configured) |
172 |
_RL GM_rMaxSlope |
173 |
_RL GM_skewflx |
174 |
_RL GM_advect |
175 |
_RL GM_BVP_rModeNumber |
176 |
_RL GM_BVP_cHat2Min |
177 |
COMMON /GM_DERIVED_PAR/ |
178 |
& GM_rMaxSlope, |
179 |
& GM_skewflx, GM_advect, |
180 |
& GM_BVP_rModeNumber, GM_BVP_cHat2Min |
181 |
|
182 |
|
183 |
C-- COMMON /GM_COEFFICIENTS/ GM/Redi scaling coefficients |
184 |
C defined at grid-cell center (tracer location) |
185 |
C GM_isoFac2d :: 2.D horiz scaling factor [-] of Isopycnal diffusivity |
186 |
C GM_bolFac2d :: 2.D horiz scaling factor [-] of Thickness diffusivity |
187 |
C GM_isoFac1d :: 1.D vert. scaling factor [-] of Isopycnal diffusivity |
188 |
C GM_bolFac1d :: 1.D vert. scaling factor [-] of Thickness diffusivity |
189 |
_RS GM_isoFac2d(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
190 |
_RS GM_bolFac2d(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
191 |
_RS GM_isoFac1d(Nr) |
192 |
_RS GM_bolFac1d(Nr) |
193 |
COMMON /GM_COEFFICIENTS/ |
194 |
& GM_isoFac2d, GM_bolFac2d, GM_isoFac1d, GM_bolFac1d |
195 |
|
196 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
197 |
C--- GM/Redi tensor elements |
198 |
|
199 |
C Bottom row of tensor corresponds to W points |
200 |
C Kwx :: K_31 element of GM/Redi tensor, X direction at W point |
201 |
C Kwy :: K_32 element of GM/Redi tensor, Y direction at W point |
202 |
C Kwz :: K_33 element of GM/Redi tensor, Z direction at W point |
203 |
_RL Kwx(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
204 |
_RL Kwy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
205 |
_RL Kwz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
206 |
COMMON /GM_Wtensor/ Kwx,Kwy,Kwz |
207 |
|
208 |
#ifdef GM_NON_UNITY_DIAGONAL |
209 |
C Horizontal part of the tensor |
210 |
C Kux :: K_11 element of GM/Redi tensor, X direction at U point |
211 |
C Kvy :: K_22 element of GM/Redi tensor, Y direction at V point |
212 |
_RL Kux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
213 |
_RL Kvy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
214 |
COMMON /GM_HorTensor/ Kux,Kvy |
215 |
#else |
216 |
_RL Kux,Kvy |
217 |
PARAMETER(Kux=1.,Kvy=1.) |
218 |
#endif |
219 |
|
220 |
#ifdef GM_EXTRA_DIAGONAL |
221 |
C First/second rows of tensor corresponds to U/V points |
222 |
C Kuz :: K_13 element of GM/Redi tensor, Z direction at U point |
223 |
C Kvz :: K_23 element of GM/Redi tensor, Z direction at V point |
224 |
_RL Kuz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
225 |
_RL Kvz(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
226 |
COMMON /GM_UVtensor/ Kuz,Kvz |
227 |
#else |
228 |
_RL Kuz,Kvz |
229 |
PARAMETER(Kuz=1.,Kvz=1.) |
230 |
#endif |
231 |
|
232 |
#ifdef GM_BOLUS_ADVEC |
233 |
C GM advection formulation: bolus velocities are derived from 2 |
234 |
C streamfunctions PsiX and PsiY : |
235 |
_RL GM_PsiX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
236 |
_RL GM_PsiY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy) |
237 |
COMMON /GM_BOLUS/ GM_PsiX,GM_PsiY |
238 |
#endif |
239 |
|
240 |
#ifdef GM_VISBECK_VARIABLE_K |
241 |
C GM mixing/stirring coefficient (spatially variable in horizontal |
242 |
C for Visbeck et al. parameterization) |
243 |
_RL VisbeckK(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
244 |
COMMON /GM_Visbeck/ VisbeckK |
245 |
#endif |
246 |
|
247 |
#ifdef GM_K3D |
248 |
C K3D :: The three dimensional eddy mixing coeffixint [m**2/s] |
249 |
_RL K3D(1-Olx:sNx+Olx,1-Oly:sNy+Oly,1:Nr,nSx,nSy) |
250 |
_RL modesC(1,1-Olx:sNx+Olx,1-Oly:sNy+Oly,1:Nr,nSx,nSy) |
251 |
_RL modesW(GM_K3D_NModes,1-Olx:sNx+Olx, |
252 |
& 1-Oly:sNy+Oly,1:Nr,nSx,nSy) |
253 |
_RL modesS(GM_K3D_NModes,1-Olx:sNx+Olx, |
254 |
& 1-Oly:sNy+Oly,1:Nr,nSx,nSy) |
255 |
_RL Rdef(1-Olx:sNx+Olx,1-Oly:sNy+Oly,nSx,nSy) |
256 |
|
257 |
|
258 |
COMMON /GM_K3D/ K3D, modesC, modesW, modesS, Rdef |
259 |
#endif |
260 |
#endif /* ALLOW_GMREDI */ |
261 |
|
262 |
CEH3 ;;; Local Variables: *** |
263 |
CEH3 ;;; mode:fortran *** |
264 |
CEH3 ;;; End: *** |