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