/[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.178 - (show annotations) (download)
Fri Feb 10 22:54:11 2006 UTC (18 years, 3 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58a_post
Changes since 1.177: +4 -2 lines
File MIME type: text/plain
add internal parameter "use3Dsolver".

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

  ViewVC Help
Powered by ViewVC 1.1.22