1 |
cheisey |
1.82 |
C $Header: /u/u0/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.81 2002/11/15 19:58:21 cheisey Exp $ |
2 |
mlosch |
1.74 |
C $Name: $ |
3 |
cnh |
1.1 |
C |
4 |
cnh |
1.63 |
CBOP |
5 |
|
|
C !ROUTINE: PARAMS.h |
6 |
|
|
C !INTERFACE: |
7 |
|
|
C include PARAMS.h |
8 |
|
|
C !DESCRIPTION: \bv |
9 |
|
|
C *==========================================================* |
10 |
|
|
C | PARAMS.h |
11 |
|
|
C | o Header file defining model "parameters". |
12 |
|
|
C *==========================================================* |
13 |
|
|
C | The values from the model standard input file are |
14 |
|
|
C | stored into the variables held here. Notes describing |
15 |
|
|
C | the parameters can also be found here. |
16 |
|
|
C *==========================================================* |
17 |
|
|
C \ev |
18 |
|
|
CEOP |
19 |
cnh |
1.13 |
|
20 |
|
|
C Macros for special grid options |
21 |
|
|
#include "PARAMS_MACROS.h" |
22 |
cnh |
1.1 |
|
23 |
|
|
C-- Contants |
24 |
|
|
C Useful physical values |
25 |
|
|
Real*8 PI |
26 |
|
|
PARAMETER ( PI = 3.14159265358979323844D0 ) |
27 |
|
|
Real*8 deg2rad |
28 |
|
|
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
29 |
|
|
|
30 |
cnh |
1.7 |
C Symbolic values |
31 |
cnh |
1.63 |
C precXXXX :: Used to indicate what precision to use for |
32 |
cnh |
1.7 |
C dumping model state. |
33 |
|
|
INTEGER precFloat32 |
34 |
adcroft |
1.36 |
PARAMETER ( precFloat32 = 32 ) |
35 |
cnh |
1.7 |
INTEGER precFloat64 |
36 |
adcroft |
1.36 |
PARAMETER ( precFloat64 = 64 ) |
37 |
cnh |
1.63 |
C UNSET_xxx :: Used to indicate variables that have not been given a value |
38 |
cnh |
1.28 |
Real*8 UNSET_FLOAT8 |
39 |
|
|
PARAMETER ( UNSET_FLOAT8 = 1.234567D5 ) |
40 |
|
|
Real*4 UNSET_FLOAT4 |
41 |
|
|
PARAMETER ( UNSET_FLOAT4 = 1.234567E5 ) |
42 |
|
|
_RL UNSET_RL |
43 |
|
|
PARAMETER ( UNSET_RL = 1.234567D5 ) |
44 |
|
|
_RS UNSET_RS |
45 |
|
|
PARAMETER ( UNSET_RS = 1.234567E5 ) |
46 |
|
|
INTEGER UNSET_I |
47 |
|
|
PARAMETER ( UNSET_I = 123456789 ) |
48 |
cnh |
1.7 |
|
49 |
|
|
C Checkpoint data |
50 |
|
|
INTEGER maxNoChkptLev |
51 |
|
|
PARAMETER ( maxNoChkptLev = 2 ) |
52 |
|
|
|
53 |
cnh |
1.1 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
54 |
cnh |
1.63 |
C checkPtSuff :: List of checkpoint file suffices |
55 |
|
|
C bathyFile :: File containing bathymetry. If not defined bathymetry |
56 |
cnh |
1.16 |
C is taken from inline function. |
57 |
cnh |
1.63 |
C topoFile :: File containing the topography of the surface (unit=m) |
58 |
jmc |
1.55 |
C (mainly used for the atmosphere = ground height). |
59 |
cnh |
1.63 |
C hydrogThetaFile :: File containing initial hydrographic data for potential |
60 |
cnh |
1.16 |
C temperature. |
61 |
cnh |
1.63 |
C hydrogSaltFile :: File containing initial hydrographic data for salinity. |
62 |
|
|
C zonalWindFile :: File containing zonal wind data |
63 |
|
|
C meridWindFile :: File containing meridional wind data |
64 |
|
|
C thetaClimFile :: File containing theta climataology used |
65 |
cnh |
1.18 |
C in relaxation term -lambda(theta-theta*) |
66 |
cnh |
1.63 |
C saltClimFile :: File containing salt climataology used |
67 |
cnh |
1.18 |
C in relaxation term -lambda(salt-salt*) |
68 |
cnh |
1.63 |
C surfQfile :: File containing surface heat flux |
69 |
|
|
C surfQswfile :: File containing surface shortwave radiation |
70 |
|
|
C dQdTfile :: File containing thermal relaxation coefficient |
71 |
|
|
C EmPmRfile :: File containing surface fresh water flux |
72 |
mlosch |
1.73 |
C pLoadFile :: File containing pressure loading |
73 |
cnh |
1.63 |
C buoyancyRelation :: Flag used to indicate which relation to use to |
74 |
cnh |
1.26 |
C get buoyancy. |
75 |
mlosch |
1.74 |
C eosType :: choose the equation of state: |
76 |
|
|
C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P |
77 |
cnh |
1.16 |
COMMON /PARM_C/ checkPtSuff, |
78 |
jmc |
1.55 |
& bathyFile, topoFile, |
79 |
|
|
& hydrogThetaFile, hydrogSaltFile, |
80 |
cnh |
1.18 |
& zonalWindFile, meridWindFile, thetaClimFile, |
81 |
adcroft |
1.37 |
& saltClimFile, buoyancyRelation, |
82 |
heimbach |
1.45 |
& EmPmRfile, surfQfile, surfQswfile, |
83 |
heimbach |
1.50 |
& uVelInitFile, vVelInitFile, pSurfInitFile, |
84 |
mlosch |
1.74 |
& dQdTfile, ploadFile, |
85 |
|
|
& eosType |
86 |
cnh |
1.7 |
CHARACTER*(5) checkPtSuff(maxNoChkptLev) |
87 |
jmc |
1.55 |
CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile |
88 |
cnh |
1.16 |
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile |
89 |
|
|
CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile |
90 |
|
|
CHARACTER*(MAX_LEN_FNAM) zonalWindFile |
91 |
|
|
CHARACTER*(MAX_LEN_FNAM) meridWindFile |
92 |
cnh |
1.18 |
CHARACTER*(MAX_LEN_FNAM) thetaClimFile |
93 |
|
|
CHARACTER*(MAX_LEN_FNAM) saltClimFile |
94 |
adcroft |
1.37 |
CHARACTER*(MAX_LEN_FNAM) surfQfile |
95 |
heimbach |
1.45 |
CHARACTER*(MAX_LEN_FNAM) surfQswfile |
96 |
adcroft |
1.37 |
CHARACTER*(MAX_LEN_FNAM) EmPmRfile |
97 |
cnh |
1.26 |
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation |
98 |
adcroft |
1.42 |
CHARACTER*(MAX_LEN_FNAM) uVelInitFile |
99 |
|
|
CHARACTER*(MAX_LEN_FNAM) vVelInitFile |
100 |
adcroft |
1.43 |
CHARACTER*(MAX_LEN_FNAM) pSurfInitFile |
101 |
heimbach |
1.50 |
CHARACTER*(MAX_LEN_FNAM) dQdTfile |
102 |
mlosch |
1.73 |
CHARACTER*(MAX_LEN_FNAM) ploadFile |
103 |
mlosch |
1.74 |
CHARACTER*(6) eosType |
104 |
cnh |
1.7 |
|
105 |
cnh |
1.1 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
106 |
cnh |
1.63 |
C cg2dMaxIters :: Maximum number of iterations in the |
107 |
cnh |
1.1 |
C two-dimensional con. grad solver. |
108 |
cnh |
1.63 |
C cg2dChkResFreq :: Frequency with which to check residual |
109 |
cnh |
1.1 |
C in con. grad solver. |
110 |
cnh |
1.63 |
C cg3dMaxIters :: Maximum number of iterations in the |
111 |
cnh |
1.33 |
C three-dimensional con. grad solver. |
112 |
cnh |
1.63 |
C cg3dChkResFreq :: Frequency with which to check residual |
113 |
cnh |
1.33 |
C in con. grad solver. |
114 |
cnh |
1.63 |
C nIter0 :: Start time-step number of for this run |
115 |
|
|
C nTimeSteps :: Number of timesteps to execute |
116 |
|
|
C numStepsPerPickup :: For offline setup. Frequency of pickup |
117 |
cnh |
1.1 |
C of flow fields. |
118 |
cnh |
1.63 |
C writeStatePrec :: Precision used for writing model state. |
119 |
|
|
C writeBinaryPrec :: Precision used for writing binary files |
120 |
|
|
C readBinaryPrec :: Precision used for reading binary files |
121 |
|
|
C nCheckLev :: Holds current checkpoint level |
122 |
|
|
C nonlinFreeSurf :: option related to non-linear free surface |
123 |
jmc |
1.55 |
C =0 Linear free surface ; >0 Non-linear |
124 |
cnh |
1.34 |
|
125 |
cnh |
1.1 |
COMMON /PARM_I/ |
126 |
|
|
& cg2dMaxIters, |
127 |
|
|
& cg2dChkResFreq, |
128 |
cnh |
1.33 |
& cg3dMaxIters, |
129 |
|
|
& cg3dChkResFreq, |
130 |
adcroft |
1.41 |
& nIter0, nTimeSteps, nEndIter, |
131 |
cnh |
1.7 |
& numStepsPerPickup, |
132 |
|
|
& writeStatePrec, nCheckLev, |
133 |
cnh |
1.34 |
& writeBinaryPrec, readBinaryPrec, |
134 |
jmc |
1.55 |
& nonlinFreeSurf, |
135 |
adcroft |
1.57 |
& tempAdvScheme, saltAdvScheme, tracerAdvScheme |
136 |
cnh |
1.1 |
INTEGER cg2dMaxIters |
137 |
|
|
INTEGER cg2dChkResFreq |
138 |
cnh |
1.33 |
INTEGER cg3dMaxIters |
139 |
|
|
INTEGER cg3dChkResFreq |
140 |
cnh |
1.1 |
INTEGER nIter0 |
141 |
|
|
INTEGER nTimeSteps |
142 |
adcroft |
1.41 |
INTEGER nEndIter |
143 |
cnh |
1.1 |
INTEGER numStepsPerPickup |
144 |
cnh |
1.7 |
INTEGER writeStatePrec |
145 |
|
|
INTEGER writeBinaryPrec |
146 |
|
|
INTEGER readBinaryPrec |
147 |
|
|
INTEGER nCheckLev |
148 |
jmc |
1.55 |
INTEGER nonlinFreeSurf |
149 |
adcroft |
1.57 |
INTEGER tempAdvScheme |
150 |
|
|
INTEGER saltAdvScheme |
151 |
|
|
INTEGER tracerAdvScheme |
152 |
cnh |
1.1 |
|
153 |
|
|
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
154 |
cnh |
1.63 |
C usingCartesianGrid :: If TRUE grid generation will be in a cartesian |
155 |
cnh |
1.1 |
C coordinate frame. |
156 |
cnh |
1.63 |
C usingSphericalPolarGrid :: If TRUE grid generation will be in a |
157 |
cnh |
1.1 |
C spherical polar frame. |
158 |
cnh |
1.63 |
C no_slip_sides :: Impose "no-slip" at lateral boundaries. |
159 |
|
|
C no_slip_bottom :: Impose "no-slip" at bottom boundary. |
160 |
|
|
C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V |
161 |
|
|
C momViscosity :: Flag which turns momentum friction terms on and off. |
162 |
|
|
C momAdvection :: Flag which turns advection of momentum on and off. |
163 |
|
|
C momForcing :: Flag which turns external forcing of momentum on |
164 |
cnh |
1.1 |
C and off. |
165 |
cnh |
1.63 |
C momPressureForcing :: Flag which turns pressure term in momentum equation |
166 |
cnh |
1.9 |
C on and off. |
167 |
cnh |
1.63 |
C metricTerms :: Flag which turns metric terms on or off. |
168 |
|
|
C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms. |
169 |
adcroft |
1.77 |
C useNHMTerms :: If TRUE use non-hydrostatic metric terms. |
170 |
cnh |
1.63 |
C useCoriolis :: Flag which turns the coriolis terms on and off. |
171 |
|
|
C tempDiffusion :: Flag which turns diffusion of temperature on |
172 |
cnh |
1.1 |
C and off. |
173 |
cnh |
1.63 |
C tempAdvection :: Flag which turns advection of temperature on |
174 |
cnh |
1.1 |
C and off. |
175 |
cnh |
1.63 |
C tempForcing :: Flag which turns external forcing of temperature on |
176 |
cnh |
1.1 |
C and off. |
177 |
jmc |
1.71 |
C saltDiffusion :: Flag which turns diffusion of salinity on |
178 |
cnh |
1.1 |
C and off. |
179 |
jmc |
1.71 |
C saltAdvection :: Flag which turns advection of salinity on |
180 |
cnh |
1.1 |
C and off. |
181 |
jmc |
1.71 |
C saltForcing :: Flag which turns external forcing of salinity on |
182 |
cnh |
1.1 |
C and off. |
183 |
jmc |
1.71 |
C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux |
184 |
|
|
C as a real Fresh Water (=> changes the Sea Level) |
185 |
|
|
C if F, converts P+R-E to salt flux (no SL effect) |
186 |
cnh |
1.63 |
C rigidLid :: Set to true to use rigid lid |
187 |
|
|
C implicitFreeSurface :: Set to true to use implcit free surface |
188 |
|
|
C exactConserv :: Set to true to conserve exactly the total Volume |
189 |
|
|
C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the |
190 |
jmc |
1.55 |
C linear relation Phi_surf = Bo_surf*eta |
191 |
cnh |
1.63 |
C momStepping :: Turns momentum equation time-stepping off |
192 |
|
|
C tempStepping :: Turns temperature equation time-stepping off |
193 |
|
|
C saltStepping :: Turns salinity equation time-stepping off |
194 |
|
|
C tr1Stepping :: Turns passive tracer 1 time-stepping on/off |
195 |
|
|
C useConstantF :: Coriolis parameter set to f0 |
196 |
|
|
C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y |
197 |
|
|
C useSphereF :: Coriolis parameter set to 2.omega.sin(phi) |
198 |
jmc |
1.71 |
C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986) |
199 |
cnh |
1.63 |
C implicitDiffusion :: Turns implicit vertical diffusion on |
200 |
|
|
C implicitViscosity :: Turns implicit vertical viscosity on |
201 |
jmc |
1.71 |
C multiDimAdvection :: Flag that enable multi-dimension advection |
202 |
|
|
C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution |
203 |
|
|
C out off Adams-Bashforth time stepping. |
204 |
cnh |
1.63 |
C doThetaClimRelax :: Set true if relaxation to temperature |
205 |
cnh |
1.18 |
C climatology is required. |
206 |
cnh |
1.63 |
C doSaltClimRelax :: Set true if relaxation to salinity |
207 |
cnh |
1.18 |
C climatology is required. |
208 |
cnh |
1.63 |
C periodicExternalForcing :: Set true if forcing is time-dependant |
209 |
|
|
C usingPCoords :: Set to indicate that we are working in pressure |
210 |
cnh |
1.29 |
C coords. |
211 |
cnh |
1.63 |
C usingZCoords :: Set to indicate that we are working in height |
212 |
cnh |
1.29 |
C coords. |
213 |
jmc |
1.70 |
C setCenterDr :: set cell Center depth and put Interface at the middle |
214 |
cnh |
1.63 |
C nonHydrostatic :: Using non-hydrostatic terms |
215 |
adcroft |
1.79 |
C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm |
216 |
cnh |
1.63 |
C globalFiles :: Selects between "global" and "tiled" files |
217 |
|
|
C allowFreezing :: Allows water to freeze and form ice |
218 |
|
|
C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground) |
219 |
cnh |
1.1 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
220 |
adcroft |
1.52 |
& usingCurvilinearGrid, |
221 |
adcroft |
1.36 |
& no_slip_sides,no_slip_bottom, |
222 |
adcroft |
1.46 |
& staggerTimeStep, |
223 |
cnh |
1.33 |
& momViscosity, momAdvection, momForcing, useCoriolis, |
224 |
adcroft |
1.58 |
& momPressureForcing, vectorInvariantMomentum, |
225 |
|
|
& tempDiffusion, tempAdvection, tempForcing, |
226 |
cnh |
1.8 |
& saltDiffusion, saltAdvection, saltForcing, |
227 |
jmc |
1.68 |
& useRealFreshWaterFlux, |
228 |
jmc |
1.55 |
& rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf, |
229 |
heimbach |
1.56 |
& momStepping, tempStepping, saltStepping, tr1Stepping, |
230 |
adcroft |
1.77 |
& metricTerms, usingSphericalPolarMTerms, useNHMTerms, |
231 |
cnh |
1.15 |
& useConstantF, useBetaPlaneF, useSphereF, |
232 |
jmc |
1.71 |
& useEnergyConservingCoriolis, useJamartWetPoints, |
233 |
adcroft |
1.40 |
& implicitDiffusion, implicitViscosity, |
234 |
jmc |
1.71 |
& multiDimAdvection, forcing_In_AB, |
235 |
heimbach |
1.56 |
& doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax, |
236 |
jmc |
1.70 |
& periodicExternalForcing, |
237 |
|
|
& usingPCoords, usingZCoords, setCenterDr, |
238 |
adcroft |
1.79 |
& nonHydrostatic, quasiHydrostatic, globalFiles, |
239 |
heimbach |
1.51 |
& allowFreezing, groundAtK1, |
240 |
heimbach |
1.56 |
& usePickupBeforeC35, debugMode, |
241 |
jmc |
1.71 |
& readPickupWithTracer, writePickupWithTracer |
242 |
cnh |
1.1 |
LOGICAL usingCartesianGrid |
243 |
|
|
LOGICAL usingSphericalPolarGrid |
244 |
adcroft |
1.52 |
LOGICAL usingCurvilinearGrid |
245 |
cnh |
1.15 |
LOGICAL usingSphericalPolarMTerms |
246 |
adcroft |
1.77 |
LOGICAL useNHMTerms |
247 |
adcroft |
1.36 |
LOGICAL no_slip_sides |
248 |
|
|
LOGICAL no_slip_bottom |
249 |
adcroft |
1.46 |
LOGICAL staggerTimeStep |
250 |
cnh |
1.1 |
LOGICAL momViscosity |
251 |
|
|
LOGICAL momAdvection |
252 |
|
|
LOGICAL momForcing |
253 |
cnh |
1.9 |
LOGICAL momPressureForcing |
254 |
cnh |
1.1 |
LOGICAL useCoriolis |
255 |
adcroft |
1.58 |
LOGICAL vectorInvariantMomentum |
256 |
cnh |
1.1 |
LOGICAL tempDiffusion |
257 |
|
|
LOGICAL tempAdvection |
258 |
|
|
LOGICAL tempForcing |
259 |
|
|
LOGICAL saltDiffusion |
260 |
|
|
LOGICAL saltAdvection |
261 |
|
|
LOGICAL saltForcing |
262 |
jmc |
1.68 |
LOGICAL useRealFreshWaterFlux |
263 |
adcroft |
1.52 |
LOGICAL rigidLid |
264 |
cnh |
1.8 |
LOGICAL implicitFreeSurface |
265 |
adcroft |
1.52 |
LOGICAL exactConserv |
266 |
jmc |
1.55 |
LOGICAL uniformLin_PhiSurf |
267 |
cnh |
1.10 |
LOGICAL momStepping |
268 |
|
|
LOGICAL tempStepping |
269 |
adcroft |
1.17 |
LOGICAL saltStepping |
270 |
heimbach |
1.56 |
LOGICAL tr1Stepping |
271 |
cnh |
1.15 |
LOGICAL metricTerms |
272 |
|
|
LOGICAL useConstantF |
273 |
|
|
LOGICAL useBetaPlaneF |
274 |
|
|
LOGICAL useSphereF |
275 |
jmc |
1.71 |
LOGICAL useEnergyConservingCoriolis |
276 |
|
|
LOGICAL useJamartWetPoints |
277 |
adcroft |
1.14 |
LOGICAL implicitDiffusion |
278 |
adcroft |
1.40 |
LOGICAL implicitViscosity |
279 |
jmc |
1.71 |
LOGICAL multiDimAdvection |
280 |
|
|
LOGICAL forcing_In_AB |
281 |
cnh |
1.18 |
LOGICAL doThetaClimRelax |
282 |
|
|
LOGICAL doSaltClimRelax |
283 |
heimbach |
1.56 |
LOGICAL doTr1ClimRelax |
284 |
adcroft |
1.19 |
LOGICAL periodicExternalForcing |
285 |
cnh |
1.29 |
LOGICAL usingPCoords |
286 |
|
|
LOGICAL usingZCoords |
287 |
jmc |
1.70 |
LOGICAL setCenterDr |
288 |
adcroft |
1.37 |
LOGICAL nonHydrostatic |
289 |
adcroft |
1.79 |
LOGICAL quasiHydrostatic |
290 |
adcroft |
1.38 |
LOGICAL globalFiles |
291 |
|
|
LOGICAL allowFreezing |
292 |
adcroft |
1.46 |
LOGICAL groundAtK1 |
293 |
heimbach |
1.51 |
LOGICAL usePickupBeforeC35 |
294 |
adcroft |
1.54 |
LOGICAL debugMode |
295 |
heimbach |
1.56 |
LOGICAL readPickupWithTracer |
296 |
|
|
LOGICAL writePickupWithTracer |
297 |
cnh |
1.1 |
|
298 |
|
|
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
299 |
adcroft |
1.52 |
C gg2dTargetResidual |
300 |
cnh |
1.63 |
C :: Target residual for cg2d solver; no unit (RHS normalisation) |
301 |
adcroft |
1.52 |
C cg2dTargetResWunit |
302 |
cnh |
1.63 |
C :: Target residual for cg2d solver; W unit (No RHS normalisation) |
303 |
cnh |
1.33 |
C cg3dTargetResidual |
304 |
cnh |
1.63 |
C :: Target residual for cg3d solver. |
305 |
|
|
C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal. |
306 |
cnh |
1.7 |
C Note. 20th May 1998 |
307 |
|
|
C I made a weird discovery! In the model paper we argue |
308 |
|
|
C for the form of the preconditioner used here ( see |
309 |
|
|
C A Finite-volume, Incompressible Navier-Stokes Model |
310 |
|
|
C ...., Marshall et. al ). The algebra gives a simple |
311 |
|
|
C 0.5 factor for the averaging of ac and aCw to get a |
312 |
|
|
C symmettric pre-conditioner. By using a factor of 0.51 |
313 |
|
|
C i.e. scaling the off-diagonal terms in the |
314 |
|
|
C preconditioner down slightly I managed to get the |
315 |
|
|
C number of iterations for convergence in a test case to |
316 |
|
|
C drop form 192 -> 134! Need to investigate this further! |
317 |
|
|
C For now I have introduced a parameter cg2dpcOffDFac which |
318 |
|
|
C defaults to 0.51 but can be set at runtime. |
319 |
cnh |
1.63 |
C delP :: Vertical grid spacing ( Pa ). |
320 |
|
|
C delZ :: Vertical grid spacing ( m ). |
321 |
|
|
C delR :: Vertical grid spacing ( units of r ). |
322 |
jmc |
1.70 |
C delRc :: Vertical grid spacing between cell centers (r unit). |
323 |
cnh |
1.63 |
C delX :: Separation between cell faces (m) or (deg), depending |
324 |
cnh |
1.1 |
C delY on input flags. |
325 |
cnh |
1.63 |
C gravity :: Accel. due to gravity ( m/s^2 ) |
326 |
cnh |
1.32 |
C recip_gravity and its inverse |
327 |
cnh |
1.63 |
C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 ) |
328 |
mlosch |
1.75 |
C rhoNil :: Reference density for the linear equation of state |
329 |
cnh |
1.63 |
C rhoConst :: Vertically constant reference density |
330 |
mlosch |
1.75 |
C rhoConstFresh :: Constant reference density for fresh water (rain) |
331 |
cnh |
1.63 |
C startTime :: Start time for model ( s ) |
332 |
|
|
C phiMin :: Latitude of southern most cell face. |
333 |
|
|
C thetaMin :: Longitude of western most cell face (this |
334 |
cnh |
1.1 |
C is an "inert" parameter but it is included |
335 |
|
|
C to make geographical references simple.) |
336 |
cnh |
1.63 |
C rSphere :: Radius of sphere for a spherical polar grid ( m ). |
337 |
|
|
C recip_RSphere :: Reciprocal radius of sphere ( m ). |
338 |
|
|
C f0 :: Reference coriolis parameter ( 1/s ) |
339 |
cnh |
1.1 |
C ( Southern edge f for beta plane ) |
340 |
cnh |
1.63 |
C beta :: df/dy ( s^-1.m^-1 ) |
341 |
|
|
C omega :: Angular velocity ( rad/s ) |
342 |
|
|
C viscAh :: Eddy viscosity coeff. for mixing of |
343 |
cnh |
1.1 |
C momentum laterally ( m^2/s ) |
344 |
cnh |
1.63 |
C viscAz :: Eddy viscosity coeff. for mixing of |
345 |
cnh |
1.1 |
C momentum vertically ( m^2/s ) |
346 |
cnh |
1.63 |
C viscAp :: Eddy viscosity coeff. for mixing of |
347 |
cnh |
1.27 |
C momentum vertically ( Pa^2/s ) |
348 |
cnh |
1.63 |
C viscAr :: Eddy viscosity coeff. for mixing of |
349 |
cnh |
1.24 |
C momentum vertically ( units of r^2/s ) |
350 |
cnh |
1.63 |
C viscA4 :: Biharmonic viscosity coeff. for mixing of |
351 |
cnh |
1.1 |
C momentum laterally ( m^4/s ) |
352 |
cnh |
1.63 |
C diffKhT :: Laplacian diffusion coeff. for mixing of |
353 |
cnh |
1.1 |
C heat laterally ( m^2/s ) |
354 |
cnh |
1.63 |
C diffKzT :: Laplacian diffusion coeff. for mixing of |
355 |
cnh |
1.1 |
C heat vertically ( m^2/s ) |
356 |
cnh |
1.63 |
C diffKpT :: Laplacian diffusion coeff. for mixing of |
357 |
cnh |
1.27 |
C heat vertically ( Pa^2/s ) |
358 |
cnh |
1.63 |
C diffKrT :: Laplacian diffusion coeff. for mixing of |
359 |
cnh |
1.24 |
C heat vertically ( units of r^2/s ) |
360 |
cnh |
1.63 |
C diffK4T :: Biharmonic diffusion coeff. for mixing of |
361 |
cnh |
1.1 |
C heat laterally ( m^4/s ) |
362 |
cnh |
1.63 |
C diffKhS :: Laplacian diffusion coeff. for mixing of |
363 |
cnh |
1.1 |
C salt laterally ( m^2/s ) |
364 |
cnh |
1.63 |
C diffKzS :: Laplacian diffusion coeff. for mixing of |
365 |
cnh |
1.1 |
C salt vertically ( m^2/s ) |
366 |
cnh |
1.63 |
C diffKpS :: Laplacian diffusion coeff. for mixing of |
367 |
cnh |
1.27 |
C salt vertically ( Pa^2/s ) |
368 |
cnh |
1.63 |
C diffKrS :: Laplacian diffusion coeff. for mixing of |
369 |
cnh |
1.24 |
C salt vertically ( units of r^2/s ) |
370 |
cnh |
1.63 |
C diffK4S :: Biharmonic diffusion coeff. for mixing of |
371 |
cnh |
1.1 |
C salt laterally ( m^4/s ) |
372 |
cnh |
1.63 |
C deltaT :: Default timestep ( s ) |
373 |
|
|
C deltaTClock :: Timestep used as model "clock". This determines the |
374 |
cnh |
1.7 |
C IO frequencies and is used in tagging output. It can |
375 |
|
|
C be totally different to the dynamical time. Typically |
376 |
|
|
C it will be the deep-water timestep for accelerated runs. |
377 |
|
|
C Frequency of checkpointing and dumping of the model state |
378 |
|
|
C are referenced to this clock. ( s ) |
379 |
cnh |
1.63 |
C deltaTMom :: Timestep for momemtum equations ( s ) |
380 |
|
|
C deltaTtracer :: Timestep for tracer equations ( s ) |
381 |
adcroft |
1.72 |
C deltaTfreesurf :: Timestep for free-surface equation ( s ) |
382 |
cnh |
1.63 |
C freesurfFac :: Parameter to turn implicit free surface term on or off |
383 |
cnh |
1.8 |
C freesurfac = 1. uses implicit free surface |
384 |
|
|
C freesurfac = 0. uses rigid lid |
385 |
cnh |
1.63 |
C implicSurfPress :: parameter of the Crank-Nickelson time stepping : |
386 |
jmc |
1.48 |
C Implicit part of Surface Pressure Gradient ( 0-1 ) |
387 |
cnh |
1.63 |
C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping : |
388 |
jmc |
1.48 |
C Implicit part of barotropic flow Divergence ( 0-1 ) |
389 |
cnh |
1.63 |
C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...) |
390 |
|
|
C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m) |
391 |
|
|
C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
392 |
|
|
C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
393 |
|
|
C hFacInf :: Threshold (inf and sup) for fraction size of surface cell |
394 |
adcroft |
1.52 |
C hFacSup that control vanishing and creating levels |
395 |
cnh |
1.63 |
C tauCD :: CD scheme coupling timescale ( 1/s ) |
396 |
|
|
C rCD :: CD scheme normalised coupling parameter ( 0-1 ) |
397 |
|
|
C startTime :: Starting time for this integration ( s ). |
398 |
|
|
C endTime :: Ending time for this integration ( s ). |
399 |
|
|
C chkPtFreq :: Frequency of rolling check pointing ( s ). |
400 |
|
|
C pChkPtFreq :: Frequency of permanent check pointing ( s ). |
401 |
|
|
C dumpFreq :: Frequency with which model state is written to |
402 |
cnh |
1.24 |
C post-processing files ( s ). |
403 |
cnh |
1.63 |
C diagFreq :: Frequency with which model writes diagnostic output |
404 |
adcroft |
1.59 |
C of intermediate quantities. |
405 |
cnh |
1.63 |
C afFacMom :: Advection of momentum term tracer parameter |
406 |
|
|
C vfFacMom :: Momentum viscosity tracer parameter |
407 |
|
|
C pfFacMom :: Momentum pressure forcing tracer parameter |
408 |
|
|
C cfFacMom :: Coriolis term tracer parameter |
409 |
|
|
C foFacMom :: Momentum forcing tracer parameter |
410 |
|
|
C mtFacMom :: Metric terms tracer parameter |
411 |
|
|
C cosPower :: Power of cosine of latitude to multiply viscosity |
412 |
|
|
C cAdjFreq :: Frequency of convective adjustment |
413 |
cnh |
1.24 |
C |
414 |
jmc |
1.76 |
C taveFreq :: Frequency with which time-averaged model state |
415 |
|
|
C is written to post-processing files ( s ). |
416 |
|
|
C tave_lastIter :: (for state variable only) fraction of the last time |
417 |
|
|
C step (of each taveFreq period) put in the time average. |
418 |
|
|
C (fraction for 1rst iter = 1 - tave_lastIter) |
419 |
cnh |
1.63 |
C tauThetaClimRelax :: Relaxation to climatology time scale ( s ). |
420 |
|
|
C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ). |
421 |
|
|
C tauSaltClimRelax :: Relaxation to climatology time scale ( s ). |
422 |
|
|
C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ). |
423 |
|
|
C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month) |
424 |
|
|
C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year) |
425 |
adcroft |
1.19 |
C (note: externForcingCycle must be an integer |
426 |
|
|
C number times externForcingPeriod) |
427 |
jmc |
1.68 |
C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux |
428 |
|
|
C (use model surface (local) value if set to -1) |
429 |
|
|
C temp_EvPrRn :: temperature of Rain & Evap. |
430 |
|
|
C salt_EvPrRn :: salinity of Rain & Evap. |
431 |
|
|
C trac_EvPrRn :: tracer concentration in Rain & Evap. |
432 |
|
|
C (notes: a) tracer content of Rain/Evap only used if both |
433 |
|
|
C NonLin_FrSurf & useRealFreshWater are set. |
434 |
|
|
C b) use model surface (local) value if set to UNSET_RL) |
435 |
cnh |
1.63 |
C horiVertRatio :: Ratio on units in vertical to units in horizontal. |
436 |
cnh |
1.31 |
C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). |
437 |
cnh |
1.30 |
C ( g*rho if horiz in m and vertical in Pa ). |
438 |
cnh |
1.63 |
C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as |
439 |
adcroft |
1.46 |
C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel) |
440 |
cnh |
1.63 |
C bottomDragLinear :: Drag coefficient built in to core dynamics |
441 |
adcroft |
1.64 |
C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m ) |
442 |
adcroft |
1.52 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit, |
443 |
|
|
& cg2dpcOffDFac, cg3dTargetResidual, |
444 |
jmc |
1.70 |
& delP, delZ, delR, delRc, delX, delY, |
445 |
adcroft |
1.72 |
& deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock, |
446 |
|
|
& abeps, startTime, |
447 |
adcroft |
1.52 |
& phiMin, thetaMin, rSphere, recip_RSphere, f0, beta, |
448 |
adcroft |
1.78 |
& fCori, fCoriG, fCoriCos, |
449 |
adcroft |
1.60 |
& viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension, |
450 |
cnh |
1.24 |
& diffKhT, diffKzT, diffK4T, diffKrT, |
451 |
cnh |
1.25 |
& diffKhS, diffKzS, diffK4S, diffKrS, |
452 |
jmc |
1.48 |
& delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow, |
453 |
adcroft |
1.52 |
& hFacMin, hFacMinDz, hFacInf, hFacSup, |
454 |
cnh |
1.32 |
& gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, |
455 |
mlosch |
1.75 |
& recip_rhoConst, rhoConst, |
456 |
jmc |
1.76 |
& rhoConstFresh, convertEmP2rUnit, tRef, sRef, |
457 |
adcroft |
1.59 |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, |
458 |
jmc |
1.76 |
& diagFreq, taveFreq, tave_lastIter, monitorFreq, |
459 |
cnh |
1.15 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
460 |
heimbach |
1.56 |
& cosPower, cAdjFreq, omega, |
461 |
|
|
& tauThetaClimRelax, lambdaThetaClimRelax, |
462 |
adcroft |
1.19 |
& tauSaltClimRelax, lambdaSaltClimRelax, |
463 |
heimbach |
1.56 |
& tauTr1ClimRelax, lambdaTr1ClimRelax, |
464 |
cnh |
1.27 |
& externForcingCycle, externForcingPeriod, |
465 |
jmc |
1.68 |
& convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn, |
466 |
cnh |
1.28 |
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
467 |
jmc |
1.68 |
& horiVertRatio, recip_horiVertRatio, |
468 |
jmc |
1.67 |
& ivdc_kappa, Ro_SeaLevel, |
469 |
adcroft |
1.46 |
& bottomDragLinear,bottomDragQuadratic |
470 |
cnh |
1.27 |
|
471 |
adcroft |
1.6 |
_RL cg2dTargetResidual |
472 |
adcroft |
1.52 |
_RL cg2dTargetResWunit |
473 |
cnh |
1.33 |
_RL cg3dTargetResidual |
474 |
cnh |
1.7 |
_RL cg2dpcOffDFac |
475 |
cnh |
1.25 |
_RL delZ(Nr) |
476 |
|
|
_RL delP(Nr) |
477 |
|
|
_RL delR(Nr) |
478 |
jmc |
1.70 |
_RL delRc(Nr+1) |
479 |
adcroft |
1.6 |
_RL delX(Nx) |
480 |
|
|
_RL delY(Ny) |
481 |
|
|
_RL deltaT |
482 |
cnh |
1.7 |
_RL deltaTClock |
483 |
adcroft |
1.6 |
_RL deltaTmom |
484 |
|
|
_RL deltaTtracer |
485 |
adcroft |
1.72 |
_RL deltaTfreesurf |
486 |
adcroft |
1.6 |
_RL abeps |
487 |
|
|
_RL phiMin |
488 |
|
|
_RL thetaMin |
489 |
|
|
_RL rSphere |
490 |
cnh |
1.25 |
_RL recip_RSphere |
491 |
adcroft |
1.6 |
_RL f0 |
492 |
cnh |
1.8 |
_RL freeSurfFac |
493 |
jmc |
1.48 |
_RL implicSurfPress |
494 |
|
|
_RL implicDiv2Dflow |
495 |
adcroft |
1.22 |
_RL hFacMin |
496 |
|
|
_RL hFacMinDz |
497 |
cnh |
1.28 |
_RL hFacMinDp |
498 |
cnh |
1.27 |
_RL hFacMinDr |
499 |
adcroft |
1.52 |
_RL hFacInf |
500 |
|
|
_RL hFacSup |
501 |
adcroft |
1.6 |
_RL beta |
502 |
|
|
_RL viscAh |
503 |
adcroft |
1.60 |
_RL viscAstrain |
504 |
|
|
_RL viscAtension |
505 |
adcroft |
1.6 |
_RL viscAz |
506 |
cnh |
1.27 |
_RL viscAp |
507 |
cnh |
1.25 |
_RL viscAr |
508 |
adcroft |
1.6 |
_RL viscA4 |
509 |
|
|
_RL diffKhT |
510 |
cnh |
1.25 |
_RL diffKrT |
511 |
adcroft |
1.6 |
_RL diffKzT |
512 |
cnh |
1.27 |
_RL diffKpT |
513 |
adcroft |
1.6 |
_RL diffK4T |
514 |
|
|
_RL diffKhS |
515 |
cnh |
1.25 |
_RL diffKrS |
516 |
adcroft |
1.6 |
_RL diffKzS |
517 |
cnh |
1.27 |
_RL diffKpS |
518 |
adcroft |
1.6 |
_RL diffK4S |
519 |
|
|
_RL delt |
520 |
|
|
_RL tauCD |
521 |
|
|
_RL rCD |
522 |
|
|
_RL gravity |
523 |
cnh |
1.32 |
_RL recip_gravity |
524 |
cnh |
1.8 |
_RL gBaro |
525 |
adcroft |
1.6 |
_RL rhonil |
526 |
cnh |
1.25 |
_RL recip_rhonil |
527 |
|
|
_RL rhoConst |
528 |
cnh |
1.26 |
_RL recip_rhoConst |
529 |
mlosch |
1.75 |
_RL rhoConstFresh |
530 |
jmc |
1.76 |
_RL convertEmP2rUnit |
531 |
cnh |
1.25 |
_RL tRef(Nr) |
532 |
|
|
_RL sRef(Nr) |
533 |
adcroft |
1.52 |
_RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
534 |
|
|
_RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
535 |
adcroft |
1.78 |
_RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
536 |
adcroft |
1.6 |
_RL startTime |
537 |
|
|
_RL endTime |
538 |
|
|
_RL chkPtFreq |
539 |
cnh |
1.7 |
_RL pChkPtFreq |
540 |
adcroft |
1.6 |
_RL dumpFreq |
541 |
adcroft |
1.59 |
_RL diagFreq |
542 |
adcroft |
1.20 |
_RL taveFreq |
543 |
jmc |
1.76 |
_RL tave_lastIter |
544 |
adcroft |
1.53 |
_RL monitorFreq |
545 |
cnh |
1.9 |
_RL afFacMom |
546 |
|
|
_RL vfFacMom |
547 |
|
|
_RL pfFacMom |
548 |
|
|
_RL cfFacMom |
549 |
|
|
_RL foFacMom |
550 |
cnh |
1.15 |
_RL mTFacMom |
551 |
adcroft |
1.39 |
_RL cosPower |
552 |
cnh |
1.9 |
_RL cAdjFreq |
553 |
cnh |
1.15 |
_RL omega |
554 |
cnh |
1.18 |
_RL tauThetaClimRelax |
555 |
|
|
_RL lambdaThetaClimRelax |
556 |
|
|
_RL tauSaltClimRelax |
557 |
|
|
_RL lambdaSaltClimRelax |
558 |
heimbach |
1.56 |
_RL tauTr1ClimRelax |
559 |
|
|
_RL lambdaTr1ClimRelax |
560 |
adcroft |
1.19 |
_RL externForcingCycle |
561 |
|
|
_RL externForcingPeriod |
562 |
jmc |
1.68 |
_RL convertFW2Salt |
563 |
|
|
_RL temp_EvPrRn |
564 |
|
|
_RL salt_EvPrRn |
565 |
|
|
_RL trac_EvPrRn |
566 |
cnh |
1.30 |
_RL horiVertRatio |
567 |
cnh |
1.31 |
_RL recip_horiVertRatio |
568 |
adcroft |
1.41 |
_RL ivdc_kappa |
569 |
adcroft |
1.46 |
_RL Ro_SeaLevel |
570 |
|
|
_RL bottomDragLinear |
571 |
|
|
_RL bottomDragQuadratic |
572 |
adcroft |
1.6 |
|
573 |
adcroft |
1.36 |
COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp, |
574 |
cnh |
1.1 |
& Lamba_theta |
575 |
adcroft |
1.6 |
_RL HeatCapacity_Cp |
576 |
|
|
_RL Lamba_theta |
577 |
adcroft |
1.36 |
_RL recip_Cp |
578 |
adcroft |
1.5 |
|
579 |
mlosch |
1.74 |
CmlC Equation of State (polynomial coeffients) |
580 |
|
|
Cml COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
581 |
|
|
Cml _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1) |
582 |
|
|
CmlC Linear equation of state |
583 |
|
|
CmlC tAlpha :: Linear EOS thermal expansion coefficient ( 1/degree ). |
584 |
|
|
CmlC sBeta :: Linear EOS haline contraction coefficient. |
585 |
|
|
Cml COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType |
586 |
|
|
Cml _RL tAlpha |
587 |
|
|
Cml _RL sBeta |
588 |
jmc |
1.55 |
|
589 |
|
|
C Atmospheric physical parameters (Ideal Gas EOS, ...) |
590 |
cnh |
1.63 |
C atm_po :: standard reference pressure |
591 |
|
|
C atm_cp :: specific heat (Cp) of the (dry) air at constant pressure |
592 |
|
|
C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS) |
593 |
|
|
C Integr_GeoPot :: option to select the way we integrate the geopotential |
594 |
jmc |
1.55 |
C (still a subject of discussions ...) |
595 |
|
|
COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po, |
596 |
|
|
& Integr_GeoPot |
597 |
|
|
_RL atm_cp, atm_kappa, atm_po |
598 |
|
|
INTEGER Integr_GeoPot |
599 |
cnh |
1.7 |
|
600 |
adcroft |
1.44 |
C Logical flags for selecting packages |
601 |
heimbach |
1.45 |
LOGICAL useKPP |
602 |
|
|
LOGICAL useGMRedi |
603 |
adcroft |
1.46 |
LOGICAL useOBCS |
604 |
jmc |
1.49 |
LOGICAL useAIM |
605 |
heimbach |
1.56 |
LOGICAL useGrdchk |
606 |
heimbach |
1.45 |
LOGICAL useECCO |
607 |
adcroft |
1.52 |
LOGICAL useSHAP_FILT |
608 |
jmc |
1.67 |
LOGICAL useZONAL_FILT |
609 |
adcroft |
1.62 |
LOGICAL useFLT |
610 |
adcroft |
1.69 |
LOGICAL usePTRACERS |
611 |
heimbach |
1.80 |
LOGICAL useSEAICE |
612 |
cheisey |
1.81 |
cswdblk -- add --- |
613 |
cheisey |
1.82 |
LOGICAL useBulkforce |
614 |
|
|
LOGICAL useThermSEAICE |
615 |
cheisey |
1.81 |
cswdblk --- end add --- |
616 |
adcroft |
1.44 |
COMMON /PARM_PACKAGES/ |
617 |
heimbach |
1.56 |
& useKPP, useGMRedi, useOBCS, useAIM, useECCO, |
618 |
adcroft |
1.69 |
& useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT, |
619 |
cheisey |
1.81 |
& usePTRACERS, useSEAICE, |
620 |
|
|
cswdblk -- add --- |
621 |
cheisey |
1.82 |
& useThermSEAICE, useBulkforce |
622 |
cheisey |
1.81 |
cswdblk --- end add --- |