/[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.146 - (show annotations) (download)
Thu Mar 10 02:39:55 2005 UTC (19 years, 2 months ago) by baylor
Branch: MAIN
Changes since 1.145: +18 -4 lines
File MIME type: text/plain
Expanded Leith viscosity to follow Ahgridmin and Ahgridmax, and select between 'full' and approximate form.  Also added leith-like viscosity that is proportional to grad(div.v_h).

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

  ViewVC Help
Powered by ViewVC 1.1.22