1 |
adcroft |
1.14 |
C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.13 1998/05/30 02:10:16 cnh Exp $ |
2 |
cnh |
1.1 |
C |
3 |
|
|
C /==========================================================\ |
4 |
|
|
C | PARAMS.h | |
5 |
|
|
C | o Header file defining model "parameters". | |
6 |
|
|
C |==========================================================| |
7 |
|
|
C | The values from the model's standard input file are | |
8 |
|
|
C | stored into the variables held here. Notes describing | |
9 |
|
|
C | the parameters can also be found here. | |
10 |
|
|
C \==========================================================/ |
11 |
cnh |
1.13 |
|
12 |
|
|
C Macros for special grid options |
13 |
|
|
#include "PARAMS_MACROS.h" |
14 |
cnh |
1.1 |
|
15 |
|
|
C-- Contants |
16 |
|
|
C Useful physical values |
17 |
|
|
Real*8 PI |
18 |
|
|
PARAMETER ( PI = 3.14159265358979323844D0 ) |
19 |
|
|
Real*8 deg2rad |
20 |
|
|
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
21 |
|
|
|
22 |
cnh |
1.7 |
C Symbolic values |
23 |
|
|
C precXXXX - Used to indicate what precision to use for |
24 |
|
|
C dumping model state. |
25 |
|
|
INTEGER precFloat32 |
26 |
|
|
PARAMETER ( precFloat32 = 0 ) |
27 |
|
|
INTEGER precFloat64 |
28 |
|
|
PARAMETER ( precFloat64 = 1 ) |
29 |
|
|
|
30 |
|
|
C Checkpoint data |
31 |
|
|
INTEGER maxNoChkptLev |
32 |
|
|
PARAMETER ( maxNoChkptLev = 2 ) |
33 |
|
|
|
34 |
cnh |
1.1 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
35 |
cnh |
1.7 |
C checkPtSuff - List of checkpoint file suffices |
36 |
|
|
COMMON /PARM_C/ checkPtSuff |
37 |
|
|
CHARACTER*(5) checkPtSuff(maxNoChkptLev) |
38 |
|
|
|
39 |
cnh |
1.1 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
40 |
|
|
C cg2dMaxIters - Maximum number of iterations in the |
41 |
|
|
C two-dimensional con. grad solver. |
42 |
|
|
C cg2dChkResFreq - Frequency with which to check residual |
43 |
|
|
C in con. grad solver. |
44 |
|
|
C nIter0 - Start time-step number of for this run |
45 |
|
|
C nTimeSteps - Number of timesteps to execute |
46 |
|
|
C numStepsPerPickup - For offline setup. Frequency of pickup |
47 |
|
|
C of flow fields. |
48 |
cnh |
1.7 |
C writeStatePrec - Precision used for writing model state. |
49 |
|
|
C writeBinaryPrec - Precision used for writing binary files |
50 |
|
|
C readBinaryPrec - Precision used for reading binary files |
51 |
|
|
C nCheckLev - Holds current checkpoint level |
52 |
cnh |
1.1 |
COMMON /PARM_I/ |
53 |
|
|
& cg2dMaxIters, |
54 |
|
|
& cg2dChkResFreq, |
55 |
|
|
& nIter0, nTimeSteps, |
56 |
cnh |
1.7 |
& numStepsPerPickup, |
57 |
|
|
& writeStatePrec, nCheckLev, |
58 |
|
|
& writeBinaryPrec, readBinaryPrec |
59 |
cnh |
1.1 |
INTEGER cg2dMaxIters |
60 |
|
|
INTEGER cg2dChkResFreq |
61 |
|
|
INTEGER nIter0 |
62 |
|
|
INTEGER nTimeSteps |
63 |
|
|
INTEGER numStepsPerPickup |
64 |
cnh |
1.7 |
INTEGER writeStatePrec |
65 |
|
|
INTEGER writeBinaryPrec |
66 |
|
|
INTEGER readBinaryPrec |
67 |
|
|
INTEGER nCheckLev |
68 |
cnh |
1.1 |
|
69 |
|
|
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
70 |
|
|
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
71 |
|
|
C coordinate frame. |
72 |
|
|
C usingSphericalPolarGrid - If TRUE grid generation will be in a |
73 |
|
|
C spherical polar frame. |
74 |
|
|
C momViscosity - Flag which turns momentum friction terms on and off. |
75 |
|
|
C momAdvection - Flag which turns advection of momentum on and off. |
76 |
|
|
C momForcing - Flag which turns external forcing of momentum on |
77 |
|
|
C and off. |
78 |
cnh |
1.9 |
C momPressureForcing - Flag which turns pressure term in momentum equation |
79 |
|
|
C on and off. |
80 |
cnh |
1.15 |
C metricTerms - Flag which turns metric terms on or off. |
81 |
|
|
C usingSphericalPolarMTerms - If TRUE use spherical polar metric terms. |
82 |
cnh |
1.1 |
C useCoriolis - Flag which turns the coriolis terms on and off. |
83 |
|
|
C tempDiffusion - Flag which turns diffusion of temperature on |
84 |
|
|
C and off. |
85 |
|
|
C tempAdvection - Flag which turns advection of temperature on |
86 |
|
|
C and off. |
87 |
|
|
C tempForcing - Flag which turns external forcing of temperature on |
88 |
|
|
C and off. |
89 |
|
|
C saltDiffusion - Flag which turns diffusion of salinit on |
90 |
|
|
C and off. |
91 |
|
|
C saltAdvection - Flag which turns advection of salinit on |
92 |
|
|
C and off. |
93 |
|
|
C saltForcing - Flag which turns external forcing of salinit on |
94 |
|
|
C and off. |
95 |
cnh |
1.8 |
C implicitFreeSurface - Set to true to use implcit free surface |
96 |
|
|
C rigidLid - Set to true to use rigid lid |
97 |
cnh |
1.10 |
C momStepping - Turns momentum equation time-stepping off |
98 |
cnh |
1.15 |
C tempStepping - Turns temperature equation time-stepping off |
99 |
|
|
C useConstantF - Coriolis parameter set to f0 |
100 |
|
|
C useBetaPlaneF - Coriolis parameter set to f0 + beta.y |
101 |
|
|
C useSphereF - Coriolis parameter set to 2.omega.sin(phi) |
102 |
adcroft |
1.14 |
C implicitDiffusion - Turns implicit vertical diffusion on |
103 |
cnh |
1.1 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
104 |
cnh |
1.9 |
& momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing, |
105 |
cnh |
1.1 |
& tempDiffusion, tempAdvection, tempForcing, |
106 |
cnh |
1.8 |
& saltDiffusion, saltAdvection, saltForcing, |
107 |
adcroft |
1.14 |
& implicitFreeSurface, rigidLid, momStepping, tempStepping, |
108 |
cnh |
1.15 |
& metricTerms, usingSphericalPolarMTerms, |
109 |
|
|
& useConstantF, useBetaPlaneF, useSphereF, |
110 |
adcroft |
1.14 |
& implicitDiffusion |
111 |
cnh |
1.1 |
LOGICAL usingCartesianGrid |
112 |
|
|
LOGICAL usingSphericalPolarGrid |
113 |
cnh |
1.15 |
LOGICAL usingSphericalPolarMTerms |
114 |
cnh |
1.1 |
LOGICAL momViscosity |
115 |
|
|
LOGICAL momAdvection |
116 |
|
|
LOGICAL momForcing |
117 |
cnh |
1.9 |
LOGICAL momPressureForcing |
118 |
cnh |
1.1 |
LOGICAL useCoriolis |
119 |
|
|
LOGICAL tempDiffusion |
120 |
|
|
LOGICAL tempAdvection |
121 |
|
|
LOGICAL tempForcing |
122 |
|
|
LOGICAL saltDiffusion |
123 |
|
|
LOGICAL saltAdvection |
124 |
|
|
LOGICAL saltForcing |
125 |
cnh |
1.8 |
LOGICAL implicitFreeSurface |
126 |
|
|
LOGICAL rigidLid |
127 |
cnh |
1.10 |
LOGICAL momStepping |
128 |
|
|
LOGICAL tempStepping |
129 |
cnh |
1.15 |
LOGICAL metricTerms |
130 |
|
|
LOGICAL useConstantF |
131 |
|
|
LOGICAL useBetaPlaneF |
132 |
|
|
LOGICAL useSphereF |
133 |
adcroft |
1.14 |
LOGICAL implicitDiffusion |
134 |
cnh |
1.1 |
|
135 |
|
|
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
136 |
|
|
C cg2dTargetResidual |
137 |
|
|
C - Target residual for cg2d solver. |
138 |
cnh |
1.7 |
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
139 |
|
|
C Note. 20th May 1998 |
140 |
|
|
C I made a weird discovery! In the model paper we argue |
141 |
|
|
C for the form of the preconditioner used here ( see |
142 |
|
|
C A Finite-volume, Incompressible Navier-Stokes Model |
143 |
|
|
C ...., Marshall et. al ). The algebra gives a simple |
144 |
|
|
C 0.5 factor for the averaging of ac and aCw to get a |
145 |
|
|
C symmettric pre-conditioner. By using a factor of 0.51 |
146 |
|
|
C i.e. scaling the off-diagonal terms in the |
147 |
|
|
C preconditioner down slightly I managed to get the |
148 |
|
|
C number of iterations for convergence in a test case to |
149 |
|
|
C drop form 192 -> 134! Need to investigate this further! |
150 |
|
|
C For now I have introduced a parameter cg2dpcOffDFac which |
151 |
|
|
C defaults to 0.51 but can be set at runtime. |
152 |
cnh |
1.3 |
C delZ - Vertical grid spacing ( m ) - delZ is the distance |
153 |
cnh |
1.1 |
C between "w" surfaces. |
154 |
|
|
C delX - Separation between cell faces (m) or (deg), depending |
155 |
|
|
C delY on input flags. |
156 |
|
|
C gravity - Accel. due to gravity ( m/s^2 ) |
157 |
cnh |
1.8 |
C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 ) |
158 |
cnh |
1.1 |
C ronil - Reference density |
159 |
cnh |
1.3 |
C startTime - Start time for model ( s ) |
160 |
cnh |
1.1 |
C phiMin - Latitude of southern most cell face. |
161 |
|
|
C thetaMin - Longitude of western most cell face (this |
162 |
|
|
C is an "inert" parameter but it is included |
163 |
|
|
C to make geographical references simple.) |
164 |
cnh |
1.3 |
C rSphere - Radius of sphere for a spherical polar grid ( m ). |
165 |
cnh |
1.15 |
C rRSphere - Reciprocal radius of sphere for a spherical polar grid ( m ). |
166 |
cnh |
1.1 |
C f0 - Reference coriolis parameter ( 1/s ) |
167 |
|
|
C ( Southern edge f for beta plane ) |
168 |
|
|
C beta - df/dy ( s^-1.m^-1 ) |
169 |
cnh |
1.15 |
C omega - Angular velocity ( rad/s ) |
170 |
cnh |
1.1 |
C viscAh - Eddy viscosity coeff. for mixing of |
171 |
|
|
C momentum laterally ( m^2/s ) |
172 |
|
|
C viscAz - Eddy viscosity coeff. for mixing of |
173 |
|
|
C momentum vertically ( m^2/s ) |
174 |
|
|
C viscA4 - Biharmonic viscosity coeff. for mixing of |
175 |
|
|
C momentum laterally ( m^4/s ) |
176 |
|
|
C diffKhT - Laplacian diffusion coeff. for mixing of |
177 |
|
|
C heat laterally ( m^2/s ) |
178 |
|
|
C diffKzT - Laplacian diffusion coeff. for mixing of |
179 |
|
|
C heat vertically ( m^2/s ) |
180 |
|
|
C diffK4T - Biharmonic diffusion coeff. for mixing of |
181 |
|
|
C heat laterally ( m^4/s ) |
182 |
|
|
C diffKhS - Laplacian diffusion coeff. for mixing of |
183 |
|
|
C salt laterally ( m^2/s ) |
184 |
|
|
C diffKzS - Laplacian diffusion coeff. for mixing of |
185 |
|
|
C salt vertically ( m^2/s ) |
186 |
|
|
C diffK4S - Biharmonic diffusion coeff. for mixing of |
187 |
|
|
C salt laterally ( m^4/s ) |
188 |
cnh |
1.3 |
C deltaT - Default timestep ( s ) |
189 |
cnh |
1.7 |
C deltaTClock - Timestep used as model "clock". This determines the |
190 |
|
|
C IO frequencies and is used in tagging output. It can |
191 |
|
|
C be totally different to the dynamical time. Typically |
192 |
|
|
C it will be the deep-water timestep for accelerated runs. |
193 |
|
|
C Frequency of checkpointing and dumping of the model state |
194 |
|
|
C are referenced to this clock. ( s ) |
195 |
cnh |
1.3 |
C deltaTMom - Timestep for momemtum equations ( s ) |
196 |
|
|
C deltaTtracer - Timestep for tracer equations ( s ) |
197 |
cnh |
1.8 |
C freesurfFac - Parameter to turn implicit free surface term on or off |
198 |
|
|
C freesurfac = 1. uses implicit free surface |
199 |
|
|
C freesurfac = 0. uses rigid lid |
200 |
cnh |
1.1 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
201 |
|
|
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
202 |
adcroft |
1.6 |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
203 |
cnh |
1.8 |
C GMlength - Length to use in Visbeck et al. formula for K (m) |
204 |
adcroft |
1.6 |
C GMalpha - alpha to use in Visbeck et al. formula for K |
205 |
|
|
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
206 |
cnh |
1.8 |
C GMkbackground - background value of GM/Redi coefficient |
207 |
cnh |
1.1 |
C startTime - Starting time for this integration ( s ). |
208 |
|
|
C endTime - Ending time for this integration ( s ). |
209 |
cnh |
1.7 |
C chkPtFreq - Frequency of rolling check pointing ( s ). |
210 |
|
|
C pChkPtFreq - Frequency of permanent check pointing ( s ). |
211 |
cnh |
1.1 |
C dumpFreq - Frequency with which model state is written to |
212 |
|
|
C post-processing files ( s ). |
213 |
cnh |
1.9 |
C afFacMom - Advection of momentum term scaling parameter |
214 |
|
|
C vfFacMom - Momentum viscosity scaling parameter |
215 |
|
|
C pfFacMom - Momentum pressure forcing parameter |
216 |
|
|
C cfFacMom - Coriolis term scaling parameter |
217 |
|
|
C foFacMom - Momentum forcing scaling parameter |
218 |
cnh |
1.15 |
C mtFacMom - Metric terms scaling parameter |
219 |
cnh |
1.9 |
C cAdjFreq - Frequency of convective adjustment |
220 |
cnh |
1.7 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY, |
221 |
|
|
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin, |
222 |
cnh |
1.15 |
& thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4, |
223 |
cnh |
1.7 |
& diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT, |
224 |
cnh |
1.8 |
& tauCD, rCD, freeSurfFac, |
225 |
adcroft |
1.6 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground, |
226 |
cnh |
1.8 |
& gravity, gBaro, rhonil, tRef, sRef, |
227 |
cnh |
1.9 |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, |
228 |
cnh |
1.15 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
229 |
|
|
& cAdjFreq, omega |
230 |
adcroft |
1.6 |
_RL cg2dTargetResidual |
231 |
cnh |
1.7 |
_RL cg2dpcOffDFac |
232 |
adcroft |
1.6 |
_RL delZ(Nz) |
233 |
|
|
_RL delX(Nx) |
234 |
|
|
_RL delY(Ny) |
235 |
|
|
_RL deltaT |
236 |
cnh |
1.7 |
_RL deltaTClock |
237 |
adcroft |
1.6 |
_RL deltaTmom |
238 |
|
|
_RL deltaTtracer |
239 |
|
|
_RL abeps |
240 |
|
|
_RL phiMin |
241 |
|
|
_RL thetaMin |
242 |
|
|
_RL rSphere |
243 |
cnh |
1.15 |
_RL rRSphere |
244 |
adcroft |
1.6 |
_RL f0 |
245 |
cnh |
1.8 |
_RL freeSurfFac |
246 |
adcroft |
1.6 |
_RL beta |
247 |
|
|
_RL viscAh |
248 |
|
|
_RL viscAz |
249 |
|
|
_RL viscA4 |
250 |
|
|
_RL diffKhT |
251 |
|
|
_RL diffKzT |
252 |
|
|
_RL diffK4T |
253 |
|
|
_RL diffKhS |
254 |
|
|
_RL diffKzS |
255 |
|
|
_RL diffK4S |
256 |
|
|
_RL delt |
257 |
|
|
_RL tauCD |
258 |
|
|
_RL rCD |
259 |
|
|
_RL GMmaxslope |
260 |
|
|
_RL GMlength |
261 |
|
|
_RL GMalpha |
262 |
|
|
_RL GMdepth |
263 |
|
|
_RL GMkbackground |
264 |
|
|
_RL gravity |
265 |
cnh |
1.8 |
_RL gBaro |
266 |
adcroft |
1.6 |
_RL rhonil |
267 |
|
|
_RL tRef(Nz) |
268 |
|
|
_RL sRef(Nz) |
269 |
cnh |
1.11 |
_RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
270 |
adcroft |
1.6 |
_RL startTime |
271 |
|
|
_RL endTime |
272 |
|
|
_RL chkPtFreq |
273 |
cnh |
1.7 |
_RL pChkPtFreq |
274 |
adcroft |
1.6 |
_RL dumpFreq |
275 |
cnh |
1.9 |
_RL afFacMom |
276 |
|
|
_RL vfFacMom |
277 |
|
|
_RL pfFacMom |
278 |
|
|
_RL cfFacMom |
279 |
|
|
_RL foFacMom |
280 |
cnh |
1.15 |
_RL mTFacMom |
281 |
cnh |
1.9 |
_RL cAdjFreq |
282 |
cnh |
1.15 |
_RL omega |
283 |
adcroft |
1.6 |
|
284 |
cnh |
1.1 |
COMMON /PARM_A/ HeatCapacity_Cp, |
285 |
|
|
& Lamba_theta |
286 |
adcroft |
1.6 |
_RL HeatCapacity_Cp |
287 |
|
|
_RL Lamba_theta |
288 |
adcroft |
1.5 |
|
289 |
|
|
C Equation of State (polynomial coeffients) |
290 |
|
|
COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
291 |
adcroft |
1.12 |
_RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1) |
292 |
adcroft |
1.5 |
C Linear equation of state |
293 |
|
|
C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ). |
294 |
|
|
C sBeta - Linear EOS haline contraction coefficient. |
295 |
adcroft |
1.12 |
COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType |
296 |
adcroft |
1.6 |
_RL tAlpha |
297 |
|
|
_RL sBeta |
298 |
adcroft |
1.12 |
character*(6) eosType |
299 |
cnh |
1.7 |
|