/[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.163 - (show annotations) (download)
Mon Aug 15 23:05:28 2005 UTC (18 years, 9 months ago) by molod
Branch: MAIN
CVS Tags: checkpoint57q_post
Changes since 1.162: +4 -2 lines
File MIME type: text/plain
Add new flag in PARM03 namelist called nodumps - true to turn off all dumps, indep of freq

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

  ViewVC Help
Powered by ViewVC 1.1.22