/[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.159 - (show annotations) (download)
Thu Jun 9 15:53:19 2005 UTC (18 years, 11 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint57i_post
Changes since 1.158: +5 -3 lines
File MIME type: text/plain
add flag for momentum vertical advection (upwindShear)

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

  ViewVC Help
Powered by ViewVC 1.1.22