/[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.183 - (show annotations) (download)
Mon Mar 20 15:10:24 2006 UTC (18 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58c_post
Changes since 1.182: +33 -36 lines
File MIME type: text/plain
move calendarDumps from "data" to "data.cal" and clean-up the code
 with a simple call to pkg/cal S/R: CAL_TIME2WRITE
 (the former piece of code started to spread over newly checked-in S/R)
add useEXF & useCAL flags (for now, set in hard-coded way)

1 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.182 2006/03/17 23:29:37 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 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 momForcingOutAB :: =1: take momentum forcing contribution
156 C out of (=0: in) Adams-Bashforth time stepping.
157 C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
158 C out of (=0: in) Adams-Bashforth time stepping.
159 C tempAdvScheme :: Temp. Horiz.Advection scheme selector
160 C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
161 C saltAdvScheme :: Salt. Horiz.advection scheme selector
162 C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
163 C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
164 C debugLevel :: debug level selector: higher -> more writing
165
166 COMMON /PARM_I/
167 & cg2dMaxIters,
168 & cg2dChkResFreq, cg2dPreCondFreq,
169 & cg3dMaxIters,
170 & cg3dChkResFreq,
171 & nIter0, nTimeSteps, nEndIter,
172 & numStepsPerPickup,
173 & writeStatePrec, nCheckLev,
174 & writeBinaryPrec, readBinaryPrec,
175 & nonlinFreeSurf, select_rStar,
176 & momForcingOutAB, tracForcingOutAB,
177 & tempAdvScheme, tempVertAdvScheme,
178 & saltAdvScheme, saltVertAdvScheme,
179 & selectKEscheme,
180 & debugLevel
181 INTEGER cg2dMaxIters
182 INTEGER cg2dChkResFreq
183 INTEGER cg2dPreCondFreq
184 INTEGER cg3dMaxIters
185 INTEGER cg3dChkResFreq
186 INTEGER nIter0
187 INTEGER nTimeSteps
188 INTEGER nEndIter
189 INTEGER numStepsPerPickup
190 INTEGER writeStatePrec
191 INTEGER writeBinaryPrec
192 INTEGER readBinaryPrec
193 INTEGER nCheckLev
194 INTEGER nonlinFreeSurf
195 INTEGER select_rStar
196 INTEGER momForcingOutAB, tracForcingOutAB
197 INTEGER tempAdvScheme, tempVertAdvScheme
198 INTEGER saltAdvScheme, saltVertAdvScheme
199 INTEGER selectKEscheme
200 INTEGER debugLevel
201
202 C
203 INTEGER debLevZero
204 PARAMETER(debLevZero=0)
205 INTEGER debLevA
206 PARAMETER(debLevA=1)
207 INTEGER debLevB
208 PARAMETER(debLevB=2)
209
210 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
211 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
212 C coordinate frame.
213 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
214 C spherical polar frame.
215 C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
216 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
217 C no_slip_bottom :: Impose "no-slip" at bottom boundary.
218 C momViscosity :: Flag which turns momentum friction terms on and off.
219 C momAdvection :: Flag which turns advection of momentum on and off.
220 C momForcing :: Flag which turns external forcing of momentum on
221 C and off.
222 C momPressureForcing :: Flag which turns pressure term in momentum equation
223 C on and off.
224 C metricTerms :: Flag which turns metric terms on or off.
225 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
226 C useCoriolis :: Flag which turns the coriolis terms on and off.
227 C tempAdvection :: Flag which turns advection of temperature on
228 C and off.
229 C tempForcing :: Flag which turns external forcing of temperature on
230 C and off.
231 C saltAdvection :: Flag which turns advection of salinity on
232 C and off.
233 C saltForcing :: Flag which turns external forcing of salinity on
234 C and off.
235 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
236 C as a real Fresh Water (=> changes the Sea Level)
237 C if F, converts P+R-E to salt flux (no SL effect)
238 C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
239 C on irregular grids)
240 C useAreaViscLength :: Set to true to use old scaling for viscous
241 C lengths, e.g., L2=Raz. May be preferable for cube sphere.
242 C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
243 C rigidLid :: Set to true to use rigid lid
244 C implicitFreeSurface :: Set to true to use implicit free surface
245 C exactConserv :: Set to true to conserve exactly the total Volume
246 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
247 C linear relation Phi_surf = Bo_surf*eta
248 C use3Dsolver :: set to true to use 3-D pressure solver
249 C implicitIntGravWave :: treat Internal Gravity Wave implicitly
250 C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
251 C momStepping :: Turns momentum equation time-stepping off
252 C tempStepping :: Turns temperature equation time-stepping off
253 C saltStepping :: Turns salinity equation time-stepping off
254 C useConstantF :: Coriolis parameter set to f0
255 C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
256 C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
257 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
258 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
259 C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
260 C SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
261 C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
262 C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
263 C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
264 C useAbsVorticity :: work with f+zeta in Coriolis terms
265 C implicitDiffusion :: Turns implicit vertical diffusion on
266 C implicitViscosity :: Turns implicit vertical viscosity on
267 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
268 C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
269 C momImplVertAdv :: Turns on implicit vertical advection for Momentum
270 C multiDimAdvection :: Flag that enable multi-dimension advection
271 C useMultiDimAdvec :: True if multi-dim advection is used at least once
272 C momDissip_In_AB :: if False, put Dissipation tendency contribution
273 C out off Adams-Bashforth time stepping.
274 C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
275 C apply AB on tracer tendencies (rather than on Tracer)
276 C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
277 C doThetaClimRelax :: Set true if relaxation to temperature
278 C climatology is required.
279 C doSaltClimRelax :: Set true if relaxation to salinity
280 C climatology is required.
281 C periodicExternalForcing :: Set true if forcing is time-dependant
282 C usingPCoords :: Set to indicate that we are working in a pressure
283 C type coordinate (p or p*).
284 C usingZCoords :: Set to indicate that we are working in a height
285 C type coordinate (z or z*)
286 C fluidIsAir :: Set to indicate that the fluid major constituent
287 C is air
288 C fluidIsWater :: Set to indicate that the fluid major constituent
289 C is water
290 C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
291 C this requires specific code for restart & exchange
292 C setCenterDr :: set cell Center depth and put Interface at the middle
293 C nonHydrostatic :: Using non-hydrostatic terms
294 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
295 C globalFiles :: Selects between "global" and "tiled" files
296 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
297 C slow (f77) or does not work (f90). When
298 C useSingleCpuIO is set, mdsio_writefield.F
299 C outputs from master mpi process only.
300 C allowFreezing :: Allows surface water to freeze and form ice
301 C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
302 C pickup_write_mdsio :: use mdsio to write pickups
303 C pickup_read_mdsio :: use mdsio to read pickups
304 C pickup_write_immed :: echo the pickup immediately (for conversion)
305 C timeave_mdsio :: use mdsio for timeave output
306 C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
307 C monitor_stdio :: use stdio for monitor output
308 C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
309 C & Last iteration, in addition multiple of dumpFreq iter.
310 C balanceEmPmR :: substract global mean of EmPmR at every time step
311 C balanceQnet :: substract global mean of Qnet at every time step
312 C balancePrintMean:: print substracted global means to STDOUT
313
314 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
315 & usingCurvilinearGrid, usingCylindricalGrid,
316 & no_slip_sides,no_slip_bottom,
317 & momViscosity, momAdvection, momForcing, useCoriolis,
318 & momPressureForcing, vectorInvariantMomentum,
319 & tempAdvection, tempForcing,
320 & saltAdvection, saltForcing,
321 & useRealFreshWaterFlux,
322 & useFullLeith, useStrainTensionVisc,
323 & useAreaViscLength,
324 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
325 & use3Dsolver, implicitIntGravWave, staggerTimeStep,
326 & momStepping, tempStepping, saltStepping,
327 & metricTerms, useNHMTerms,
328 & useConstantF, useBetaPlaneF, useSphereF,
329 & useCDscheme,
330 & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
331 & SadournyCoriolis, upwindVorticity, highOrderVorticity,
332 & useAbsVorticity, upwindShear,
333 & implicitDiffusion, implicitViscosity,
334 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
335 & multiDimAdvection, useMultiDimAdvec,
336 & momDissip_In_AB, doAB_onGtGs,
337 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
338 & periodicExternalForcing,
339 & fluidIsAir, fluidIsWater,
340 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
341 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
342 & allowFreezing, useOldFreezing,
343 & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
344 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
345 & timeave_mdsio, snapshot_mdsio, monitor_stdio,
346 & outputTypesInclusive, dumpInitAndLast, debugMode,
347 & inAdMode, inAdTrue, inAdFalse, inAdExact,
348 & balanceEmPmR, balanceQnet, balancePrintMean
349
350 LOGICAL usingCartesianGrid
351 LOGICAL usingSphericalPolarGrid
352 LOGICAL usingCylindricalGrid
353 LOGICAL usingCurvilinearGrid
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 use3Dsolver
376 LOGICAL implicitIntGravWave
377 LOGICAL staggerTimeStep
378 LOGICAL momStepping
379 LOGICAL tempStepping
380 LOGICAL saltStepping
381 LOGICAL metricTerms
382 LOGICAL useConstantF
383 LOGICAL useBetaPlaneF
384 LOGICAL useSphereF
385 LOGICAL useCDscheme
386 LOGICAL useEnergyConservingCoriolis
387 LOGICAL useJamartWetPoints
388 LOGICAL useJamartMomAdv
389 LOGICAL SadournyCoriolis
390 LOGICAL upwindVorticity
391 LOGICAL highOrderVorticity
392 LOGICAL useAbsVorticity
393 LOGICAL upwindShear
394 LOGICAL implicitDiffusion
395 LOGICAL implicitViscosity
396 LOGICAL tempImplVertAdv
397 LOGICAL saltImplVertAdv
398 LOGICAL momImplVertAdv
399 LOGICAL multiDimAdvection
400 LOGICAL useMultiDimAdvec
401 LOGICAL momDissip_In_AB
402 LOGICAL doAB_onGtGs
403 LOGICAL doThetaClimRelax
404 LOGICAL doSaltClimRelax
405 LOGICAL doTr1ClimRelax
406 LOGICAL periodicExternalForcing
407 LOGICAL fluidIsAir
408 LOGICAL fluidIsWater
409 LOGICAL usingPCoords
410 LOGICAL usingZCoords
411 LOGICAL useDynP_inEos_Zc
412 LOGICAL setCenterDr
413 LOGICAL nonHydrostatic
414 LOGICAL quasiHydrostatic
415 LOGICAL globalFiles
416 LOGICAL useSingleCpuIO
417 LOGICAL allowFreezing
418 LOGICAL useOldFreezing
419 LOGICAL usePickupBeforeC35
420 LOGICAL usePickupBeforeC54
421 LOGICAL startFromPickupAB2
422 LOGICAL dumpInitAndLast
423 LOGICAL debugMode
424 LOGICAL pickup_read_mdsio, pickup_write_mdsio
425 LOGICAL pickup_write_immed
426 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
427 LOGICAL outputTypesInclusive
428 LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
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, tauSaltClimRelax,
644 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
645 & externForcingCycle, externForcingPeriod,
646 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
647 & hFacMinDr, hFacMinDp,
648 & horiVertRatio, recip_horiVertRatio,
649 & ivdc_kappa, Ro_SeaLevel,
650 & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
651 & tCylIn, tCylOut
652
653 _RL cg2dTargetResidual
654 _RL cg2dTargetResWunit
655 _RL cg3dTargetResidual
656 _RL cg2dpcOffDFac
657 _RL delR(Nr)
658 _RL delRc(Nr+1)
659 _RL delX(Nx)
660 _RL delY(Ny)
661 _RL deltaT
662 _RL deltaTClock
663 _RL deltaTmom
664 _RL dTtracerLev(Nr)
665 _RL deltaTfreesurf
666 _RL abEps, alph_AB, beta_AB
667 _RL phiMin
668 _RL thetaMin
669 _RL rSphere
670 _RL recip_RSphere
671 _RL f0
672 _RL freeSurfFac
673 _RL implicSurfPress
674 _RL implicDiv2Dflow
675 _RL hFacMin
676 _RL hFacMinDz
677 _RL hFacMinDp
678 _RL hFacMinDr
679 _RL hFacInf
680 _RL hFacSup
681 _RL beta
682 _RL viscAh
683 _RL viscAhW
684 _RL viscAhD
685 _RL viscAhZ
686 _RL viscAhMax
687 _RL viscAhReMax
688 _RL viscAhGrid
689 _RL viscAhGridMax
690 _RL viscAhGridMin
691 _RL viscC2leith
692 _RL viscC2leithD
693 _RL viscC2smag
694 _RL viscC4smag
695 _RL viscAr
696 _RL viscA4
697 _RL viscA4W
698 _RL viscA4D
699 _RL viscA4Z
700 _RL viscA4Max
701 _RL viscA4ReMax
702 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
703 _RL viscC4leith
704 _RL viscC4leithD
705 _RL diffKhT
706 _RL diffKrNrT(Nr)
707 _RL diffK4T
708 _RL diffKhS
709 _RL diffKrNrS(Nr)
710 _RL diffK4S
711 _RL diffKrBL79surf
712 _RL diffKrBL79deep
713 _RL diffKrBL79scl
714 _RL diffKrBL79Ho
715 _RL delt
716 _RL tauCD
717 _RL rCD
718 _RL gravity
719 _RL recip_gravity
720 _RL gBaro
721 _RL rhonil
722 _RL recip_rhonil
723 _RL rhoConst
724 _RL recip_rhoConst
725 _RL rhoConstFresh
726 _RL convertEmP2rUnit
727 _RL tRef(Nr)
728 _RL sRef(Nr)
729 _RL phiRef(2*Nr+1)
730 _RL dBdrRef(Nr)
731 _RL baseTime
732 _RL startTime
733 _RL endTime
734 _RL chkPtFreq
735 _RL pChkPtFreq
736 _RL dumpFreq
737 _RL adjDumpFreq
738 _RL diagFreq
739 _RL taveFreq
740 _RL tave_lastIter
741 _RL monitorFreq
742 _RL adjMonitorFreq
743 _RL afFacMom
744 _RL vfFacMom
745 _RL pfFacMom
746 _RL cfFacMom
747 _RL foFacMom
748 _RL mtFacMom
749 _RL cosPower
750 _RL cAdjFreq
751 _RL omega
752 _RL rotationPeriod
753 _RL tauThetaClimRelax
754 _RL tauSaltClimRelax
755 _RL tauTr1ClimRelax
756 _RL lambdaTr1ClimRelax
757 _RL latBandClimRelax
758 _RL externForcingCycle
759 _RL externForcingPeriod
760 _RL convertFW2Salt
761 _RL temp_EvPrRn
762 _RL salt_EvPrRn
763 _RL horiVertRatio
764 _RL recip_horiVertRatio
765 _RL ivdc_kappa
766 _RL Ro_SeaLevel
767 _RL sideDragFactor
768 _RL bottomDragLinear
769 _RL bottomDragQuadratic
770 _RL nh_Am2
771 _RL tCylIn
772 _RL tCylOut
773
774 C-- COMMON /PARM_A/ Thermodynamics constants ?
775 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
776 _RL HeatCapacity_Cp
777 _RL recip_Cp
778
779 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
780 C celsius2K :: convert centigrade (Celsius) degree to Kelvin
781 C atm_Po :: standard reference pressure
782 C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
783 C atm_Rd :: gas constant for dry air
784 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
785 C atm_Rq :: water vapour specific volume anomaly relative to dry air
786 C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
787 C integr_GeoPot :: option to select the way we integrate the geopotential
788 C (still a subject of discussions ...)
789 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
790 C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
791 COMMON /PARM_ATM/
792 & celsius2K,
793 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
794 & integr_GeoPot, selectFindRoSurf
795 _RL celsius2K
796 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
797 INTEGER integr_GeoPot, selectFindRoSurf
798
799 C Logical flags for selecting packages
800 LOGICAL useOPPS
801 LOGICAL usePP81
802 LOGICAL useMY82
803 LOGICAL useGGL90
804 LOGICAL useKPP
805 LOGICAL useGMRedi
806 LOGICAL useOBCS
807 LOGICAL useAIM
808 LOGICAL useLand
809 LOGICAL useCAL
810 LOGICAL useEXF
811 LOGICAL useEBM
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 useOffLine
821 LOGICAL useMATRIX
822 LOGICAL useSBO
823 LOGICAL useSEAICE
824 LOGICAL useShelfIce
825 LOGICAL useThSIce
826 LOGICAL useBulkForce
827 LOGICAL usefizhi
828 LOGICAL usegridalt
829 LOGICAL useDiagnostics
830 LOGICAL useMNC
831 LOGICAL useRunClock
832 LOGICAL useEMBED_FILES
833 COMMON /PARM_PACKAGES/
834 & useOPPS, usePP81, useMY82, useGGL90, useKPP,
835 & useGMRedi, useOBCS, useAIM, useLand,
836 & useCAL, useEXF, useEBM, useGrdchk, useECCO,
837 & useSHAP_FILT, useZONAL_FILT, useFLT,
838 & usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
839 & useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
840 & usefizhi, usegridalt, useDiagnostics, useMNC,
841 & useRunClock, useEMBED_FILES
842
843 CEH3 ;;; Local Variables: ***
844 CEH3 ;;; mode:fortran ***
845 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22