/[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.174 - (show annotations) (download)
Tue Dec 13 19:45:19 2005 UTC (18 years, 5 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint57z_post
Changes since 1.173: +5 -3 lines
File MIME type: text/plain
Adding unfinished 3-dim relaxation code.

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

  ViewVC Help
Powered by ViewVC 1.1.22