/[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.177 - (show annotations) (download)
Fri Feb 10 07:50:37 2006 UTC (18 years, 3 months ago) by mlosch
Branch: MAIN
Changes since 1.176: +11 -2 lines
File MIME type: text/plain
o add run time parameters for balancing surface fluxes EmPmR and Qnet

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

  ViewVC Help
Powered by ViewVC 1.1.22