/[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.158 - (show annotations) (download)
Tue May 31 18:24:27 2005 UTC (18 years, 11 months ago) by adcroft
Branch: MAIN
Changes since 1.157: +4 -2 lines
File MIME type: text/plain
New package for controlling termination of the model based on the wall clock:
This is handy for those of us who keep losing 5000 cpuhours because the model
took 5 minutes longer than it did the day before.

To use:
 In package.conf, add   runclock
 In data.pkg, add       useRunClock=.TRUE.
 Add data.runclock to read
    &RUNCLOCK
    RC_maxtime_hr=2,
    RC_maxtime_mi=30,
    RC_maxtime_sc=0,
    &

The package also write the delta Wall Clock between each model step.
Who can explain a 30% slow down after 60 iterations? Who even knew about it?
Now you can find out lots of dark secrets about the EM EYE TEE GEE SEE EM...

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

  ViewVC Help
Powered by ViewVC 1.1.22