/[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.188 - (show annotations) (download)
Thu Jul 13 02:48:18 2006 UTC (17 years, 10 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58m_post, checkpoint58n_post
Changes since 1.187: +4 -2 lines
File MIME type: text/plain
add flag "use3dCoriolis" for Coriolis term in omega.cos_Phi (3-D Cor.)

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

  ViewVC Help
Powered by ViewVC 1.1.22