/[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.197 - (show annotations) (download)
Mon Mar 12 23:41:15 2007 UTC (17 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58w_post, checkpoint58x_post
Changes since 1.196: +9 -1 lines
File MIME type: text/plain
add units conversion factor between rVel and vertical speed:
 rVel2wUnit & wUnit2rVel (used for Non-Hydrostatic in pressure).

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

  ViewVC Help
Powered by ViewVC 1.1.22