/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Contents of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.171 - (show annotations) (download)
Mon Dec 5 14:31:19 2005 UTC (18 years, 5 months ago) by jmc
Branch: MAIN
Changes since 1.170: +4 -2 lines
File MIME type: text/plain
store geopotential profile (computed from tRef) at center & interface level.

1 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.170 2005/10/24 22:38:49 jmc Exp $
2 C $Name: $
3 C
4
5 CBOP
6 C !ROUTINE: PARAMS.h
7 C !INTERFACE:
8 C #include PARAMS.h
9
10 C !DESCRIPTION:
11 C Header file defining model "parameters". The values from the
12 C model standard input file are stored into the variables held
13 C here. Notes describing the parameters can also be found here.
14
15 CEOP
16
17 C Macros for special grid options
18 #include "PARAMS_MACROS.h"
19
20 C-- Contants
21 C Useful physical values
22 Real*8 PI
23 PARAMETER ( PI = 3.14159265358979323844D0 )
24 Real*8 deg2rad
25 PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
26
27 C Symbolic values
28 C precXXXX :: Used to indicate what precision to use for
29 C dumping model state.
30 INTEGER precFloat32
31 PARAMETER ( precFloat32 = 32 )
32 INTEGER precFloat64
33 PARAMETER ( precFloat64 = 64 )
34 C UNSET_xxx :: Used to indicate variables that have not been given a value
35 Real*8 UNSET_FLOAT8
36 PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
37 Real*4 UNSET_FLOAT4
38 PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
39 _RL UNSET_RL
40 PARAMETER ( UNSET_RL = 1.234567D5 )
41 _RS UNSET_RS
42 PARAMETER ( UNSET_RS = 1.234567E5 )
43 INTEGER UNSET_I
44 PARAMETER ( UNSET_I = 123456789 )
45
46 C Checkpoint data
47 INTEGER maxNoChkptLev
48 PARAMETER ( maxNoChkptLev = 2 )
49
50 C-- COMMON /PARM_C/ Character valued parameters used by the model.
51 C checkPtSuff :: List of checkpoint file suffices
52 C delXFile :: File containing X-spacing grid definition (1.D array)
53 C delYFile :: File containing Y-spacing grid definition (1.D array)
54 C horizGridFile :: File containing horizontal-grid definition
55 C (only when using curvilinear_grid)
56 C bathyFile :: File containing bathymetry. If not defined bathymetry
57 C is taken from inline function.
58 C topoFile :: File containing the topography of the surface (unit=m)
59 C (mainly used for the atmosphere = ground height).
60 C hydrogThetaFile :: File containing initial hydrographic data for potential
61 C temperature.
62 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
63 C zonalWindFile :: File containing zonal wind data
64 C meridWindFile :: File containing meridional wind data
65 C thetaClimFile :: File containing theta climataology used
66 C in relaxation term -lambda(theta-theta*)
67 C saltClimFile :: File containing salt climataology used
68 C in relaxation term -lambda(salt-salt*)
69 C surfQfile :: File containing surface heat flux, excluding SW
70 C (old version, kept for backward compatibility)
71 C surfQnetFile :: File containing surface net heat flux
72 C surfQswFile :: File containing surface shortwave radiation
73 C dQdTfile :: File containing thermal relaxation coefficient
74 C EmPmRfile :: File containing surface fresh water flux
75 C saltFluxFile :: File containing surface salt flux
76 C pLoadFile :: File containing pressure loading
77 C eddyTauxFile :: File containing zonal Eddy stress data
78 C eddyTauyFile :: File containing meridional Eddy stress data
79 C buoyancyRelation :: Flag used to indicate which relation to use to
80 C get buoyancy.
81 C eosType :: choose the equation of state:
82 C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
83 C the_run_name :: string identifying the name of the model "run"
84 COMMON /PARM_C/ checkPtSuff,
85 & delXFile, delYFile, horizGridFile,
86 & bathyFile, topoFile,
87 & hydrogThetaFile, hydrogSaltFile,
88 & zonalWindFile, meridWindFile, thetaClimFile,
89 & saltClimFile, buoyancyRelation,
90 & EmPmRfile, saltFluxFile,
91 & surfQfile, surfQnetFile, surfQswFile,
92 & lambdaThetaFile, lambdaSaltFile,
93 & uVelInitFile, vVelInitFile, pSurfInitFile,
94 & dQdTfile, ploadFile,
95 & eddyTauxFile, eddyTauyFile,
96 & eosType, pickupSuff,
97 & mdsioLocalDir,
98 & the_run_name
99 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
100 CHARACTER*(MAX_LEN_FNAM) delXFile
101 CHARACTER*(MAX_LEN_FNAM) delYFile
102 CHARACTER*(MAX_LEN_FNAM) horizGridFile
103 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
105 CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
106 CHARACTER*(MAX_LEN_FNAM) zonalWindFile
107 CHARACTER*(MAX_LEN_FNAM) meridWindFile
108 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
109 CHARACTER*(MAX_LEN_FNAM) saltClimFile
110 CHARACTER*(MAX_LEN_FNAM) surfQfile
111 CHARACTER*(MAX_LEN_FNAM) surfQnetFile
112 CHARACTER*(MAX_LEN_FNAM) surfQswFile
113 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
114 CHARACTER*(MAX_LEN_FNAM) saltFluxFile
115 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
116 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
117 CHARACTER*(MAX_LEN_FNAM) vVelInitFile
118 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
119 CHARACTER*(MAX_LEN_FNAM) dQdTfile
120 CHARACTER*(MAX_LEN_FNAM) ploadFile
121 CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
122 CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
123 CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
124 CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
125 CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
126 CHARACTER*(MAX_LEN_FNAM) the_run_name
127 CHARACTER*(6) eosType
128 CHARACTER*(10) pickupSuff
129
130 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
131 C cg2dMaxIters :: Maximum number of iterations in the
132 C two-dimensional con. grad solver.
133 C cg2dChkResFreq :: Frequency with which to check residual
134 C in con. grad solver.
135 C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner
136 C (non-linear free-surf.)
137 C cg3dMaxIters :: Maximum number of iterations in the
138 C three-dimensional con. grad solver.
139 C cg3dChkResFreq :: Frequency with which to check residual
140 C in con. grad solver.
141 C nIter0 :: Start time-step number of for this run
142 C nTimeSteps :: Number of timesteps to execute
143 C numStepsPerPickup :: For offline setup. Frequency of pickup
144 C of flow fields.
145 C writeStatePrec :: Precision used for writing model state.
146 C writeBinaryPrec :: Precision used for writing binary files
147 C readBinaryPrec :: Precision used for reading binary files
148 C nCheckLev :: Holds current checkpoint level
149 C nonlinFreeSurf :: option related to non-linear free surface
150 C =0 Linear free surface ; >0 Non-linear
151 C select_rStar :: option related to r* vertical coordinate
152 C =0 (default) use r coord. ; > 0 use r*
153 C tempAdvScheme :: Temp. Horiz.Advection scheme selector
154 C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
155 C saltAdvScheme :: Salt. Horiz.advection scheme selector
156 C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
157 C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
158 C debugLevel :: debug level selector: higher -> more writing
159
160 COMMON /PARM_I/
161 & cg2dMaxIters,
162 & cg2dChkResFreq, cg2dPreCondFreq,
163 & cg3dMaxIters,
164 & cg3dChkResFreq,
165 & nIter0, nTimeSteps, nEndIter,
166 & numStepsPerPickup,
167 & writeStatePrec, nCheckLev,
168 & writeBinaryPrec, readBinaryPrec,
169 & nonlinFreeSurf, select_rStar,
170 & tempAdvScheme, tempVertAdvScheme,
171 & saltAdvScheme, saltVertAdvScheme,
172 & selectKEscheme,
173 & debugLevel
174 INTEGER cg2dMaxIters
175 INTEGER cg2dChkResFreq
176 INTEGER cg2dPreCondFreq
177 INTEGER cg3dMaxIters
178 INTEGER cg3dChkResFreq
179 INTEGER nIter0
180 INTEGER nTimeSteps
181 INTEGER nEndIter
182 INTEGER numStepsPerPickup
183 INTEGER writeStatePrec
184 INTEGER writeBinaryPrec
185 INTEGER readBinaryPrec
186 INTEGER nCheckLev
187 INTEGER nonlinFreeSurf
188 INTEGER select_rStar
189 INTEGER tempAdvScheme, tempVertAdvScheme
190 INTEGER saltAdvScheme, saltVertAdvScheme
191 INTEGER selectKEscheme
192 INTEGER debugLevel
193
194 C
195 INTEGER debLevZero
196 PARAMETER(debLevZero=0)
197 INTEGER debLevA
198 PARAMETER(debLevA=1)
199 INTEGER debLevB
200 PARAMETER(debLevB=2)
201
202 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
203 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
204 C coordinate frame.
205 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
206 C spherical polar frame.
207 C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
208 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
209 C no_slip_bottom :: Impose "no-slip" at bottom boundary.
210 C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
211 C momViscosity :: Flag which turns momentum friction terms on and off.
212 C momAdvection :: Flag which turns advection of momentum on and off.
213 C momForcing :: Flag which turns external forcing of momentum on
214 C and off.
215 C momPressureForcing :: Flag which turns pressure term in momentum equation
216 C on and off.
217 C metricTerms :: Flag which turns metric terms on or off.
218 C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
219 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
220 C useCoriolis :: Flag which turns the coriolis terms on and off.
221 C tempAdvection :: Flag which turns advection of temperature on
222 C and off.
223 C tempForcing :: Flag which turns external forcing of temperature on
224 C and off.
225 C saltAdvection :: Flag which turns advection of salinity on
226 C and off.
227 C saltForcing :: Flag which turns external forcing of salinity on
228 C and off.
229 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
230 C as a real Fresh Water (=> changes the Sea Level)
231 C if F, converts P+R-E to salt flux (no SL effect)
232 C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
233 C on irregular grids)
234 C useAreaViscLength :: Set to true to use old scaling for viscous
235 C lengths, e.g., L2=Raz. May be preferable for cube sphere.
236 C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
237 C rigidLid :: Set to true to use rigid lid
238 C implicitFreeSurface :: Set to true to use implcit free surface
239 C exactConserv :: Set to true to conserve exactly the total Volume
240 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
241 C linear relation Phi_surf = Bo_surf*eta
242 C momStepping :: Turns momentum equation time-stepping off
243 C tempStepping :: Turns temperature equation time-stepping off
244 C saltStepping :: Turns salinity equation time-stepping off
245 C useConstantF :: Coriolis parameter set to f0
246 C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
247 C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
248 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
249 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
250 C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
251 C SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
252 C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
253 C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
254 C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
255 C useAbsVorticity :: work with f+zeta in Coriolis terms
256 C implicitDiffusion :: Turns implicit vertical diffusion on
257 C implicitViscosity :: Turns implicit vertical viscosity on
258 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
259 C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
260 C momImplVertAdv :: Turns on implicit vertical advection for Momentum
261 C multiDimAdvection :: Flag that enable multi-dimension advection
262 C useMultiDimAdvec :: True if multi-dim advection is used at least once
263 C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
264 C out off Adams-Bashforth time stepping.
265 C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
266 C apply AB on tracer tendencies (rather than on Tracer)
267 C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
268 C doThetaClimRelax :: Set true if relaxation to temperature
269 C climatology is required.
270 C doSaltClimRelax :: Set true if relaxation to salinity
271 C climatology is required.
272 C periodicExternalForcing :: Set true if forcing is time-dependant
273 C usingPCoords :: Set to indicate that we are working in a pressure
274 C type coordinate (p or p*).
275 C usingZCoords :: Set to indicate that we are working in a height
276 C type coordinate (z or z*)
277 C fluidIsAir :: Set to indicate that the fluid major constituent
278 C is air
279 C fluidIsWater :: Set to indicate that the fluid major constituent
280 C is water
281 C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
282 C this requires specific code for restart & exchange
283 C setCenterDr :: set cell Center depth and put Interface at the middle
284 C nonHydrostatic :: Using non-hydrostatic terms
285 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
286 C globalFiles :: Selects between "global" and "tiled" files
287 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
288 C slow (f77) or does not work (f90). When
289 C useSingleCpuIO is set, mdsio_writefield.F
290 C outputs from master mpi process only.
291 C allowFreezing :: Allows surface water to freeze and form ice
292 C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
293 C pickup_write_mdsio :: use mdsio to write pickups
294 C pickup_read_mdsio :: use mdsio to read pickups
295 C pickup_write_immed :: echo the pickup immediately (for conversion)
296 C timeave_mdsio :: use mdsio for timeave output
297 C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
298 C monitor_stdio :: use stdio for monitor output
299 C calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
300 C for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
301 C KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
302 C calendar months and years. Requires pkg/cal.
303 C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
304 C & Last iteration, in addition multiple of dumpFreq iter.
305 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
306 & usingCurvilinearGrid, usingCylindricalGrid,
307 & no_slip_sides,no_slip_bottom,
308 & staggerTimeStep,
309 & momViscosity, momAdvection, momForcing, useCoriolis,
310 & momPressureForcing, vectorInvariantMomentum,
311 & tempAdvection, tempForcing,
312 & saltAdvection, saltForcing,
313 & useRealFreshWaterFlux,
314 & useFullLeith, useStrainTensionVisc,
315 & useAreaViscLength,
316 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
317 & momStepping, tempStepping, saltStepping,
318 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
319 & useConstantF, useBetaPlaneF, useSphereF,
320 & useCDscheme,
321 & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
322 & SadournyCoriolis, upwindVorticity, highOrderVorticity,
323 & useAbsVorticity, upwindShear,
324 & implicitDiffusion, implicitViscosity,
325 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
326 & multiDimAdvection, useMultiDimAdvec,
327 & forcing_In_AB, doAB_onGtGs,
328 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
329 & periodicExternalForcing,
330 & fluidIsAir, fluidIsWater,
331 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
332 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
333 & allowFreezing, useOldFreezing,
334 & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
335 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
336 & timeave_mdsio, snapshot_mdsio, monitor_stdio,
337 & outputTypesInclusive, dumpInitAndLast, debugMode,
338 & inAdMode, inAdTrue, inAdFalse, inAdExact,
339 & calendarDumps
340
341 LOGICAL usingCartesianGrid
342 LOGICAL usingSphericalPolarGrid
343 LOGICAL usingCylindricalGrid
344 LOGICAL usingCurvilinearGrid
345 LOGICAL usingSphericalPolarMTerms
346 LOGICAL useNHMTerms
347 LOGICAL no_slip_sides
348 LOGICAL no_slip_bottom
349 LOGICAL staggerTimeStep
350 LOGICAL momViscosity
351 LOGICAL momAdvection
352 LOGICAL momForcing
353 LOGICAL momPressureForcing
354 LOGICAL useCoriolis
355 LOGICAL vectorInvariantMomentum
356 LOGICAL tempAdvection
357 LOGICAL tempForcing
358 LOGICAL saltAdvection
359 LOGICAL saltForcing
360 LOGICAL useRealFreshWaterFlux
361 LOGICAL useFullLeith
362 LOGICAL useStrainTensionVisc
363 LOGICAL useAreaViscLength
364 LOGICAL rigidLid
365 LOGICAL implicitFreeSurface
366 LOGICAL exactConserv
367 LOGICAL uniformLin_PhiSurf
368 LOGICAL momStepping
369 LOGICAL tempStepping
370 LOGICAL saltStepping
371 LOGICAL metricTerms
372 LOGICAL useConstantF
373 LOGICAL useBetaPlaneF
374 LOGICAL useSphereF
375 LOGICAL useCDscheme
376 LOGICAL useEnergyConservingCoriolis
377 LOGICAL useJamartWetPoints
378 LOGICAL useJamartMomAdv
379 LOGICAL SadournyCoriolis
380 LOGICAL upwindVorticity
381 LOGICAL highOrderVorticity
382 LOGICAL useAbsVorticity
383 LOGICAL upwindShear
384 LOGICAL implicitDiffusion
385 LOGICAL implicitViscosity
386 LOGICAL tempImplVertAdv
387 LOGICAL saltImplVertAdv
388 LOGICAL momImplVertAdv
389 LOGICAL multiDimAdvection
390 LOGICAL useMultiDimAdvec
391 LOGICAL forcing_In_AB
392 LOGICAL doAB_onGtGs
393 LOGICAL doThetaClimRelax
394 LOGICAL doSaltClimRelax
395 LOGICAL doTr1ClimRelax
396 LOGICAL periodicExternalForcing
397 LOGICAL fluidIsAir
398 LOGICAL fluidIsWater
399 LOGICAL usingPCoords
400 LOGICAL usingZCoords
401 LOGICAL useDynP_inEos_Zc
402 LOGICAL setCenterDr
403 LOGICAL nonHydrostatic
404 LOGICAL quasiHydrostatic
405 LOGICAL globalFiles
406 LOGICAL useSingleCpuIO
407 LOGICAL allowFreezing
408 LOGICAL useOldFreezing
409 LOGICAL usePickupBeforeC35
410 LOGICAL usePickupBeforeC54
411 LOGICAL startFromPickupAB2
412 LOGICAL dumpInitAndLast
413 LOGICAL debugMode
414 LOGICAL pickup_read_mdsio, pickup_write_mdsio
415 LOGICAL pickup_write_immed
416 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
417 LOGICAL outputTypesInclusive
418 LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
419 LOGICAL calendarDumps
420
421 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
422 C cg2dTargetResidual
423 C :: Target residual for cg2d solver; no unit (RHS normalisation)
424 C cg2dTargetResWunit
425 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
426 C cg3dTargetResidual
427 C :: Target residual for cg3d solver.
428 C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
429 C Note. 20th May 1998
430 C I made a weird discovery! In the model paper we argue
431 C for the form of the preconditioner used here ( see
432 C A Finite-volume, Incompressible Navier-Stokes Model
433 C ...., Marshall et. al ). The algebra gives a simple
434 C 0.5 factor for the averaging of ac and aCw to get a
435 C symmettric pre-conditioner. By using a factor of 0.51
436 C i.e. scaling the off-diagonal terms in the
437 C preconditioner down slightly I managed to get the
438 C number of iterations for convergence in a test case to
439 C drop form 192 -> 134! Need to investigate this further!
440 C For now I have introduced a parameter cg2dpcOffDFac which
441 C defaults to 0.51 but can be set at runtime.
442 C delR :: Vertical grid spacing ( units of r ).
443 C delRc :: Vertical grid spacing between cell centers (r unit).
444 C delX :: Separation between cell faces (m) or (deg), depending
445 C delY on input flags.
446 C gravity :: Accel. due to gravity ( m/s^2 )
447 C recip_gravity and its inverse
448 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
449 C rhoNil :: Reference density for the linear equation of state
450 C rhoConst :: Vertically constant reference density
451 C rhoConstFresh :: Constant reference density for fresh water (rain)
452 C tRef :: reference vertical profile for potential temperature
453 C sRef :: reference vertical profile for salinity/specific humidity
454 C phiRef :: reference potential (pressure/rho, geopotential) profile
455 C phiMin :: Latitude of southern most cell face.
456 C thetaMin :: Longitude of western most cell face (this
457 C is an "inert" parameter but it is included
458 C to make geographical references simple.)
459 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
460 C recip_RSphere :: Reciprocal radius of sphere ( m ).
461 C f0 :: Reference coriolis parameter ( 1/s )
462 C ( Southern edge f for beta plane )
463 C beta :: df/dy ( s^-1.m^-1 )
464 C omega :: Angular velocity ( rad/s )
465 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
466 C viscAh :: Eddy viscosity coeff. for mixing of
467 C momentum laterally ( m^2/s )
468 C viscAhW :: Eddy viscosity coeff. for mixing of vertical
469 C momentum laterally, no effect for hydrostatic
470 C model, defaults to viscAh if unset ( m^2/s )
471 C viscAr :: Eddy viscosity coeff. for mixing of
472 C momentum vertically ( units of r^2/s )
473 C viscA4 :: Biharmonic viscosity coeff. for mixing of
474 C momentum laterally ( m^4/s )
475 C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
476 C momentum laterally, no effect for hydrostatic
477 C model, defaults to viscA4 if unset ( m^2/s )
478 C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
479 C (act on Divergence part) ( m^2/s )
480 C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
481 C (act on Vorticity part) ( m^2/s )
482 C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
483 C (act on Divergence part) ( m^4/s )
484 C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
485 C (act on Vorticity part) ( m^4/s )
486 C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
487 C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
488 C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic)
489 C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic)
490 C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
491 C momentum laterally ( m^2/s )
492 C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
493 C coeff. for mixing of momentum laterally (non-dim)
494 C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
495 C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc.
496 C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
497 C momentum laterally ( m^4/s )
498 C viscA4ReMax :: Maximum Gridscale Reynolds number for
499 C biharmonic viscosity coeff. momentum laterally (non-dim)
500 C viscAhGrid:: non-dimensional grid-size dependent viscosity
501 C viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
502 C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
503 C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
504 C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
505 C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
506 C diffKhT :: Laplacian diffusion coeff. for mixing of
507 C heat laterally ( m^2/s )
508 C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
509 C for mixing of heat vertically ( units of r^2/s )
510 C diffK4T :: Biharmonic diffusion coeff. for mixing of
511 C heat laterally ( m^4/s )
512 C diffKhS :: Laplacian diffusion coeff. for mixing of
513 C salt laterally ( m^2/s )
514 C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
515 C for mixing of salt vertically ( units of r^2/s ),
516 C diffK4S :: Biharmonic diffusion coeff. for mixing of
517 C salt laterally ( m^4/s )
518 C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
519 C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
520 C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
521 C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
522 C deltaT :: Default timestep ( s )
523 C deltaTClock :: Timestep used as model "clock". This determines the
524 C IO frequencies and is used in tagging output. It can
525 C be totally different to the dynamical time. Typically
526 C it will be the deep-water timestep for accelerated runs.
527 C Frequency of checkpointing and dumping of the model state
528 C are referenced to this clock. ( s )
529 C deltaTMom :: Timestep for momemtum equations ( s )
530 C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
531 C deltaTfreesurf :: Timestep for free-surface equation ( s )
532 C freesurfFac :: Parameter to turn implicit free surface term on or off
533 C freesurfac = 1. uses implicit free surface
534 C freesurfac = 0. uses rigid lid
535 C abEps :: Adams-Bashforth-2 stabilizing weight
536 C alph_AB :: Adams-Bashforth-3 primary factor
537 C beta_AB :: Adams-Bashforth-3 secondary factor
538 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
539 C Implicit part of Surface Pressure Gradient ( 0-1 )
540 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
541 C Implicit part of barotropic flow Divergence ( 0-1 )
542 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
543 C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
544 C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
545 C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
546 C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
547 C hFacSup that control vanishing and creating levels
548 C tauCD :: CD scheme coupling timescale ( 1/s )
549 C rCD :: CD scheme normalised coupling parameter ( 0-1 )
550 C baseTime :: model base time (time origin) = time @ iteration zero
551 C startTime :: Starting time for this integration ( s ).
552 C endTime :: Ending time for this integration ( s ).
553 C chkPtFreq :: Frequency of rolling check pointing ( s ).
554 C pChkPtFreq :: Frequency of permanent check pointing ( s ).
555 C dumpFreq :: Frequency with which model state is written to
556 C post-processing files ( s ).
557 C diagFreq :: Frequency with which model writes diagnostic output
558 C of intermediate quantities.
559 C afFacMom :: Advection of momentum term tracer parameter
560 C vfFacMom :: Momentum viscosity tracer parameter
561 C pfFacMom :: Momentum pressure forcing tracer parameter
562 C cfFacMom :: Coriolis term tracer parameter
563 C foFacMom :: Momentum forcing tracer parameter
564 C mtFacMom :: Metric terms tracer parameter
565 C cosPower :: Power of cosine of latitude to multiply viscosity
566 C cAdjFreq :: Frequency of convective adjustment
567 C
568 C taveFreq :: Frequency with which time-averaged model state
569 C is written to post-processing files ( s ).
570 C tave_lastIter :: (for state variable only) fraction of the last time
571 C step (of each taveFreq period) put in the time average.
572 C (fraction for 1rst iter = 1 - tave_lastIter)
573 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
574 C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
575 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
576 C i.e. where |yC| <= latBandClimRelax
577 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
578 C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
579 C (note: externForcingCycle must be an integer
580 C number times externForcingPeriod)
581 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
582 C (use model surface (local) value if set to -1)
583 C temp_EvPrRn :: temperature of Rain & Evap.
584 C salt_EvPrRn :: salinity of Rain & Evap.
585 C (notes: a) tracer content of Rain/Evap only used if both
586 C NonLin_FrSurf & useRealFreshWater are set.
587 C b) use model surface (local) value if set to UNSET_RL)
588 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
589 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
590 C ( g*rho if horiz in m and vertical in Pa ).
591 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
592 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
593 C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides)
594 C (default=2: full drag ; =1: gives half-slip BC)
595 C bottomDragLinear :: Drag coefficient built in to core dynamics
596 C bottomDragQuadratic ( linear: 1/s, quadratic: 1/m )
597 C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales
598 C (i.e. allows convection at different Rayleigh numbers)
599 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
600 & cg2dpcOffDFac, cg3dTargetResidual,
601 & delR, delRc, delX, delY,
602 & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
603 & abEps, alph_AB, beta_AB,
604 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
605 & viscAh, viscAhW, viscAhMax,
606 & viscAhGrid, viscAhGridMax, viscAhGridMin,
607 & viscC2leith, viscC2leithD,
608 & viscC2smag, viscC4smag,
609 & viscAhD, viscAhZ, viscA4D, viscA4Z,
610 & viscA4, viscA4W,
611 & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
612 & viscAhRemax, viscA4Remax,
613 & viscC4leith, viscC4leithD, viscAr,
614 & diffKhT, diffK4T, diffKrNrT,
615 & diffKhS, diffK4S, diffKrNrS,
616 & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
617 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
618 & hFacMin, hFacMinDz, hFacInf, hFacSup,
619 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
620 & recip_rhoConst, rhoConst,
621 & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef,
622 & baseTime, startTime, endTime,
623 & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
624 & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
625 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
626 & cosPower, cAdjFreq, omega, rotationPeriod,
627 & tauThetaClimRelax,
628 & tauSaltClimRelax,
629 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
630 & externForcingCycle, externForcingPeriod,
631 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
632 & hFacMinDr, hFacMinDp,
633 & horiVertRatio, recip_horiVertRatio,
634 & ivdc_kappa, Ro_SeaLevel,
635 & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
636 & tCylIn, tCylOut
637
638 _RL cg2dTargetResidual
639 _RL cg2dTargetResWunit
640 _RL cg3dTargetResidual
641 _RL cg2dpcOffDFac
642 _RL delR(Nr)
643 _RL delRc(Nr+1)
644 _RL delX(Nx)
645 _RL delY(Ny)
646 _RL deltaT
647 _RL deltaTClock
648 _RL deltaTmom
649 _RL dTtracerLev(Nr)
650 _RL deltaTfreesurf
651 _RL abEps, alph_AB, beta_AB
652 _RL phiMin
653 _RL thetaMin
654 _RL rSphere
655 _RL recip_RSphere
656 _RL f0
657 _RL freeSurfFac
658 _RL implicSurfPress
659 _RL implicDiv2Dflow
660 _RL hFacMin
661 _RL hFacMinDz
662 _RL hFacMinDp
663 _RL hFacMinDr
664 _RL hFacInf
665 _RL hFacSup
666 _RL beta
667 _RL viscAh
668 _RL viscAhW
669 _RL viscAhD
670 _RL viscAhZ
671 _RL viscAhMax
672 _RL viscAhReMax
673 _RL viscAhGrid
674 _RL viscAhGridMax
675 _RL viscAhGridMin
676 _RL viscC2leith
677 _RL viscC2leithD
678 _RL viscC2smag
679 _RL viscC4smag
680 _RL viscAr
681 _RL viscA4
682 _RL viscA4W
683 _RL viscA4D
684 _RL viscA4Z
685 _RL viscA4Max
686 _RL viscA4ReMax
687 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
688 _RL viscC4leith
689 _RL viscC4leithD
690 _RL diffKhT
691 _RL diffKrNrT(Nr)
692 _RL diffK4T
693 _RL diffKhS
694 _RL diffKrNrS(Nr)
695 _RL diffK4S
696 _RL diffKrBL79surf
697 _RL diffKrBL79deep
698 _RL diffKrBL79scl
699 _RL diffKrBL79Ho
700 _RL delt
701 _RL tauCD
702 _RL rCD
703 _RL gravity
704 _RL recip_gravity
705 _RL gBaro
706 _RL rhonil
707 _RL recip_rhonil
708 _RL rhoConst
709 _RL recip_rhoConst
710 _RL rhoConstFresh
711 _RL convertEmP2rUnit
712 _RL tRef(Nr)
713 _RL sRef(Nr)
714 _RL phiRef(2*Nr+1)
715 _RL baseTime
716 _RL startTime
717 _RL endTime
718 _RL chkPtFreq
719 _RL pChkPtFreq
720 _RL dumpFreq
721 _RL adjDumpFreq
722 _RL diagFreq
723 _RL taveFreq
724 _RL tave_lastIter
725 _RL monitorFreq
726 _RL adjMonitorFreq
727 _RL afFacMom
728 _RL vfFacMom
729 _RL pfFacMom
730 _RL cfFacMom
731 _RL foFacMom
732 _RL mTFacMom
733 _RL cosPower
734 _RL cAdjFreq
735 _RL omega
736 _RL rotationPeriod
737 _RL tauThetaClimRelax
738 _RL tauSaltClimRelax
739 _RL tauTr1ClimRelax
740 _RL lambdaTr1ClimRelax
741 _RL latBandClimRelax
742 _RL externForcingCycle
743 _RL externForcingPeriod
744 _RL convertFW2Salt
745 _RL temp_EvPrRn
746 _RL salt_EvPrRn
747 _RL horiVertRatio
748 _RL recip_horiVertRatio
749 _RL ivdc_kappa
750 _RL Ro_SeaLevel
751 _RL sideDragFactor
752 _RL bottomDragLinear
753 _RL bottomDragQuadratic
754 _RL nh_Am2
755 _RL tCylIn
756 _RL tCylOut
757
758 C-- COMMON /PARM_A/ Thermodynamics constants ?
759 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
760 _RL HeatCapacity_Cp
761 _RL recip_Cp
762
763 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
764 C celsius2K :: convert centigrade (Celsius) degree to Kelvin
765 C atm_Po :: standard reference pressure
766 C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
767 C atm_Rd :: gas constant for dry air
768 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
769 C atm_Rq :: water vapour specific volume anomaly relative to dry air
770 C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
771 C integr_GeoPot :: option to select the way we integrate the geopotential
772 C (still a subject of discussions ...)
773 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
774 C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
775 COMMON /PARM_ATM/
776 & celsius2K,
777 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
778 & integr_GeoPot, selectFindRoSurf
779 _RL celsius2K
780 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
781 INTEGER integr_GeoPot, selectFindRoSurf
782
783 C Logical flags for selecting packages
784 LOGICAL useOPPS
785 LOGICAL usePP81
786 LOGICAL useMY82
787 LOGICAL useGGL90
788 LOGICAL useKPP
789 LOGICAL useGMRedi
790 LOGICAL useOBCS
791 LOGICAL useAIM
792 LOGICAL useLand
793 LOGICAL useGrdchk
794 LOGICAL useECCO
795 LOGICAL useSHAP_FILT
796 LOGICAL useZONAL_FILT
797 LOGICAL useFLT
798 LOGICAL usePTRACERS
799 LOGICAL useGCHEM
800 LOGICAL useSBO
801 LOGICAL useSEAICE
802 LOGICAL useBulkForce
803 LOGICAL useThSIce
804 LOGICAL usefizhi
805 LOGICAL usegridalt
806 LOGICAL usediagnostics
807 LOGICAL useEBM
808 LOGICAL useMNC
809 LOGICAL useMATRIX
810 LOGICAL useRunClock
811 COMMON /PARM_PACKAGES/
812 & useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
813 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
814 & usePTRACERS, useGCHEM,
815 & useSBO, useSEAICE, useThSIce, useBulkForce,
816 & usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
817 & usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
818 & useRunClock
819
820 CEH3 ;;; Local Variables: ***
821 CEH3 ;;; mode:fortran ***
822 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22