/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Annotation of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.90 - (hide annotations) (download)
Thu Jun 5 16:03:05 2003 UTC (20 years, 11 months ago) by adcroft
Branch: MAIN
Changes since 1.89: +3 -2 lines
File MIME type: text/plain
New variable in PARM03: pickupSuff is a string that can be set to
indicate the suffix on pickup files. This allows us to avoid renaming
the temporary pickup files.

1 adcroft 1.90 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.89 2003/04/17 13:11:31 jmc Exp $
2 mlosch 1.74 C $Name: $
3 cnh 1.1 C
4 cnh 1.63 CBOP
5     C !ROUTINE: PARAMS.h
6     C !INTERFACE:
7     C include PARAMS.h
8     C !DESCRIPTION: \bv
9     C *==========================================================*
10     C | PARAMS.h
11     C | o Header file defining model "parameters".
12     C *==========================================================*
13     C | The values from the model standard input file are
14     C | stored into the variables held here. Notes describing
15     C | the parameters can also be found here.
16     C *==========================================================*
17     C \ev
18     CEOP
19 cnh 1.13
20     C Macros for special grid options
21     #include "PARAMS_MACROS.h"
22 cnh 1.1
23     C-- Contants
24     C Useful physical values
25     Real*8 PI
26     PARAMETER ( PI = 3.14159265358979323844D0 )
27     Real*8 deg2rad
28     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
29    
30 cnh 1.7 C Symbolic values
31 cnh 1.63 C precXXXX :: Used to indicate what precision to use for
32 cnh 1.7 C dumping model state.
33     INTEGER precFloat32
34 adcroft 1.36 PARAMETER ( precFloat32 = 32 )
35 cnh 1.7 INTEGER precFloat64
36 adcroft 1.36 PARAMETER ( precFloat64 = 64 )
37 cnh 1.63 C UNSET_xxx :: Used to indicate variables that have not been given a value
38 cnh 1.28 Real*8 UNSET_FLOAT8
39     PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40     Real*4 UNSET_FLOAT4
41     PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42     _RL UNSET_RL
43     PARAMETER ( UNSET_RL = 1.234567D5 )
44     _RS UNSET_RS
45     PARAMETER ( UNSET_RS = 1.234567E5 )
46     INTEGER UNSET_I
47     PARAMETER ( UNSET_I = 123456789 )
48 cnh 1.7
49     C Checkpoint data
50     INTEGER maxNoChkptLev
51     PARAMETER ( maxNoChkptLev = 2 )
52    
53 cnh 1.1 C-- COMMON /PARM_C/ Character valued parameters used by the model.
54 cnh 1.63 C checkPtSuff :: List of checkpoint file suffices
55     C bathyFile :: File containing bathymetry. If not defined bathymetry
56 cnh 1.16 C is taken from inline function.
57 cnh 1.63 C topoFile :: File containing the topography of the surface (unit=m)
58 jmc 1.55 C (mainly used for the atmosphere = ground height).
59 cnh 1.63 C hydrogThetaFile :: File containing initial hydrographic data for potential
60 cnh 1.16 C temperature.
61 cnh 1.63 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
62     C zonalWindFile :: File containing zonal wind data
63     C meridWindFile :: File containing meridional wind data
64     C thetaClimFile :: File containing theta climataology used
65 cnh 1.18 C in relaxation term -lambda(theta-theta*)
66 cnh 1.63 C saltClimFile :: File containing salt climataology used
67 cnh 1.18 C in relaxation term -lambda(salt-salt*)
68 cnh 1.63 C surfQfile :: File containing surface heat flux
69     C surfQswfile :: File containing surface shortwave radiation
70     C dQdTfile :: File containing thermal relaxation coefficient
71     C EmPmRfile :: File containing surface fresh water flux
72 mlosch 1.73 C pLoadFile :: File containing pressure loading
73 cnh 1.63 C buoyancyRelation :: Flag used to indicate which relation to use to
74 cnh 1.26 C get buoyancy.
75 mlosch 1.74 C eosType :: choose the equation of state:
76 jmc 1.87 C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77 cnh 1.16 COMMON /PARM_C/ checkPtSuff,
78 jmc 1.55 & bathyFile, topoFile,
79     & hydrogThetaFile, hydrogSaltFile,
80 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
81 adcroft 1.37 & saltClimFile, buoyancyRelation,
82 heimbach 1.45 & EmPmRfile, surfQfile, surfQswfile,
83 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
84 mlosch 1.74 & dQdTfile, ploadFile,
85 adcroft 1.90 & eosType, pickupSuff
86 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87 jmc 1.55 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
89     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
90     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
91     CHARACTER*(MAX_LEN_FNAM) meridWindFile
92 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
93     CHARACTER*(MAX_LEN_FNAM) saltClimFile
94 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
95 heimbach 1.45 CHARACTER*(MAX_LEN_FNAM) surfQswfile
96 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
97 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
99     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
100 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
102 mlosch 1.73 CHARACTER*(MAX_LEN_FNAM) ploadFile
103 mlosch 1.74 CHARACTER*(6) eosType
104 adcroft 1.90 CHARACTER*(10) pickupSuff
105 cnh 1.7
106 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
107 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
108 cnh 1.1 C two-dimensional con. grad solver.
109 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
110 cnh 1.1 C in con. grad solver.
111 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
112 cnh 1.33 C three-dimensional con. grad solver.
113 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
114 cnh 1.33 C in con. grad solver.
115 cnh 1.63 C nIter0 :: Start time-step number of for this run
116     C nTimeSteps :: Number of timesteps to execute
117     C numStepsPerPickup :: For offline setup. Frequency of pickup
118 cnh 1.1 C of flow fields.
119 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
120     C writeBinaryPrec :: Precision used for writing binary files
121     C readBinaryPrec :: Precision used for reading binary files
122     C nCheckLev :: Holds current checkpoint level
123     C nonlinFreeSurf :: option related to non-linear free surface
124 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
125 jmc 1.84 C select_rStar :: option related to r* vertical coordinate
126     C =0 (default) use r coord. ; > 0 use r*
127 cnh 1.34
128 cnh 1.1 COMMON /PARM_I/
129     & cg2dMaxIters,
130     & cg2dChkResFreq,
131 cnh 1.33 & cg3dMaxIters,
132     & cg3dChkResFreq,
133 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
134 cnh 1.7 & numStepsPerPickup,
135     & writeStatePrec, nCheckLev,
136 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
137 jmc 1.84 & nonlinFreeSurf, select_rStar,
138 adcroft 1.57 & tempAdvScheme, saltAdvScheme, tracerAdvScheme
139 cnh 1.1 INTEGER cg2dMaxIters
140     INTEGER cg2dChkResFreq
141 cnh 1.33 INTEGER cg3dMaxIters
142     INTEGER cg3dChkResFreq
143 cnh 1.1 INTEGER nIter0
144     INTEGER nTimeSteps
145 adcroft 1.41 INTEGER nEndIter
146 cnh 1.1 INTEGER numStepsPerPickup
147 cnh 1.7 INTEGER writeStatePrec
148     INTEGER writeBinaryPrec
149     INTEGER readBinaryPrec
150     INTEGER nCheckLev
151 jmc 1.55 INTEGER nonlinFreeSurf
152 jmc 1.84 INTEGER select_rStar
153 adcroft 1.57 INTEGER tempAdvScheme
154     INTEGER saltAdvScheme
155     INTEGER tracerAdvScheme
156 cnh 1.1
157     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
158 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
159 cnh 1.1 C coordinate frame.
160 cnh 1.63 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
161 cnh 1.1 C spherical polar frame.
162 cnh 1.63 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
163     C no_slip_bottom :: Impose "no-slip" at bottom boundary.
164     C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
165     C momViscosity :: Flag which turns momentum friction terms on and off.
166     C momAdvection :: Flag which turns advection of momentum on and off.
167     C momForcing :: Flag which turns external forcing of momentum on
168 cnh 1.1 C and off.
169 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
170 cnh 1.9 C on and off.
171 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
172     C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
173 adcroft 1.77 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
174 cnh 1.63 C useCoriolis :: Flag which turns the coriolis terms on and off.
175     C tempDiffusion :: Flag which turns diffusion of temperature on
176 cnh 1.1 C and off.
177 cnh 1.63 C tempAdvection :: Flag which turns advection of temperature on
178 cnh 1.1 C and off.
179 cnh 1.63 C tempForcing :: Flag which turns external forcing of temperature on
180 cnh 1.1 C and off.
181 jmc 1.71 C saltDiffusion :: Flag which turns diffusion of salinity on
182 cnh 1.1 C and off.
183 jmc 1.71 C saltAdvection :: Flag which turns advection of salinity on
184 cnh 1.1 C and off.
185 jmc 1.71 C saltForcing :: Flag which turns external forcing of salinity on
186 cnh 1.1 C and off.
187 jmc 1.71 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
188     C as a real Fresh Water (=> changes the Sea Level)
189     C if F, converts P+R-E to salt flux (no SL effect)
190 cnh 1.63 C rigidLid :: Set to true to use rigid lid
191     C implicitFreeSurface :: Set to true to use implcit free surface
192     C exactConserv :: Set to true to conserve exactly the total Volume
193     C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
194 jmc 1.55 C linear relation Phi_surf = Bo_surf*eta
195 cnh 1.63 C momStepping :: Turns momentum equation time-stepping off
196     C tempStepping :: Turns temperature equation time-stepping off
197     C saltStepping :: Turns salinity equation time-stepping off
198     C tr1Stepping :: Turns passive tracer 1 time-stepping on/off
199     C useConstantF :: Coriolis parameter set to f0
200     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
201     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
202 jmc 1.89 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
203 jmc 1.71 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
204 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
205     C implicitViscosity :: Turns implicit vertical viscosity on
206 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
207     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
208     C out off Adams-Bashforth time stepping.
209 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
210 cnh 1.18 C climatology is required.
211 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
212 cnh 1.18 C climatology is required.
213 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
214     C usingPCoords :: Set to indicate that we are working in pressure
215 jmc 1.87 C coords. (jmc: is it still used ?)
216 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
217 jmc 1.87 C coords. (jmc: is it still used ?)
218     C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
219     C this requires specific code for restart & exchange
220 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
221 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
222 adcroft 1.79 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
223 cnh 1.63 C globalFiles :: Selects between "global" and "tiled" files
224 dimitri 1.85 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
225     C slow (f77) or does not work (f90). When
226     C useSingleCpuIO is set, mdsio_writefield.F
227     C outputs from master mpi process only.
228 cnh 1.63 C allowFreezing :: Allows water to freeze and form ice
229     C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
230 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
231 adcroft 1.52 & usingCurvilinearGrid,
232 adcroft 1.36 & no_slip_sides,no_slip_bottom,
233 adcroft 1.46 & staggerTimeStep,
234 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
235 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
236     & tempDiffusion, tempAdvection, tempForcing,
237 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
238 jmc 1.68 & useRealFreshWaterFlux,
239 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
240 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
241 adcroft 1.77 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
242 cnh 1.15 & useConstantF, useBetaPlaneF, useSphereF,
243 jmc 1.89 & useCDscheme,
244 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
245 adcroft 1.40 & implicitDiffusion, implicitViscosity,
246 jmc 1.71 & multiDimAdvection, forcing_In_AB,
247 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
248 jmc 1.70 & periodicExternalForcing,
249 jmc 1.87 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
250 dimitri 1.85 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
251 heimbach 1.51 & allowFreezing, groundAtK1,
252 heimbach 1.56 & usePickupBeforeC35, debugMode,
253 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
254 cnh 1.1 LOGICAL usingCartesianGrid
255     LOGICAL usingSphericalPolarGrid
256 adcroft 1.52 LOGICAL usingCurvilinearGrid
257 cnh 1.15 LOGICAL usingSphericalPolarMTerms
258 adcroft 1.77 LOGICAL useNHMTerms
259 adcroft 1.36 LOGICAL no_slip_sides
260     LOGICAL no_slip_bottom
261 adcroft 1.46 LOGICAL staggerTimeStep
262 cnh 1.1 LOGICAL momViscosity
263     LOGICAL momAdvection
264     LOGICAL momForcing
265 cnh 1.9 LOGICAL momPressureForcing
266 cnh 1.1 LOGICAL useCoriolis
267 adcroft 1.58 LOGICAL vectorInvariantMomentum
268 cnh 1.1 LOGICAL tempDiffusion
269     LOGICAL tempAdvection
270     LOGICAL tempForcing
271     LOGICAL saltDiffusion
272     LOGICAL saltAdvection
273     LOGICAL saltForcing
274 jmc 1.68 LOGICAL useRealFreshWaterFlux
275 adcroft 1.52 LOGICAL rigidLid
276 cnh 1.8 LOGICAL implicitFreeSurface
277 adcroft 1.52 LOGICAL exactConserv
278 jmc 1.55 LOGICAL uniformLin_PhiSurf
279 cnh 1.10 LOGICAL momStepping
280     LOGICAL tempStepping
281 adcroft 1.17 LOGICAL saltStepping
282 heimbach 1.56 LOGICAL tr1Stepping
283 cnh 1.15 LOGICAL metricTerms
284     LOGICAL useConstantF
285     LOGICAL useBetaPlaneF
286     LOGICAL useSphereF
287 jmc 1.89 LOGICAL useCDscheme
288 jmc 1.71 LOGICAL useEnergyConservingCoriolis
289     LOGICAL useJamartWetPoints
290 adcroft 1.14 LOGICAL implicitDiffusion
291 adcroft 1.40 LOGICAL implicitViscosity
292 jmc 1.71 LOGICAL multiDimAdvection
293     LOGICAL forcing_In_AB
294 cnh 1.18 LOGICAL doThetaClimRelax
295     LOGICAL doSaltClimRelax
296 heimbach 1.56 LOGICAL doTr1ClimRelax
297 adcroft 1.19 LOGICAL periodicExternalForcing
298 cnh 1.29 LOGICAL usingPCoords
299     LOGICAL usingZCoords
300 jmc 1.87 LOGICAL useDynP_inEos_Zc
301 jmc 1.70 LOGICAL setCenterDr
302 adcroft 1.37 LOGICAL nonHydrostatic
303 adcroft 1.79 LOGICAL quasiHydrostatic
304 adcroft 1.38 LOGICAL globalFiles
305 dimitri 1.85 LOGICAL useSingleCpuIO
306 adcroft 1.38 LOGICAL allowFreezing
307 adcroft 1.46 LOGICAL groundAtK1
308 heimbach 1.51 LOGICAL usePickupBeforeC35
309 adcroft 1.54 LOGICAL debugMode
310 heimbach 1.56 LOGICAL readPickupWithTracer
311     LOGICAL writePickupWithTracer
312 cnh 1.1
313     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
314 adcroft 1.52 C gg2dTargetResidual
315 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
316 adcroft 1.52 C cg2dTargetResWunit
317 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
318 cnh 1.33 C cg3dTargetResidual
319 cnh 1.63 C :: Target residual for cg3d solver.
320     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
321 cnh 1.7 C Note. 20th May 1998
322     C I made a weird discovery! In the model paper we argue
323     C for the form of the preconditioner used here ( see
324     C A Finite-volume, Incompressible Navier-Stokes Model
325     C ...., Marshall et. al ). The algebra gives a simple
326     C 0.5 factor for the averaging of ac and aCw to get a
327     C symmettric pre-conditioner. By using a factor of 0.51
328     C i.e. scaling the off-diagonal terms in the
329     C preconditioner down slightly I managed to get the
330     C number of iterations for convergence in a test case to
331     C drop form 192 -> 134! Need to investigate this further!
332     C For now I have introduced a parameter cg2dpcOffDFac which
333     C defaults to 0.51 but can be set at runtime.
334 cnh 1.63 C delP :: Vertical grid spacing ( Pa ).
335     C delZ :: Vertical grid spacing ( m ).
336     C delR :: Vertical grid spacing ( units of r ).
337 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
338 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
339 cnh 1.1 C delY on input flags.
340 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
341 cnh 1.32 C recip_gravity and its inverse
342 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
343 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
344 cnh 1.63 C rhoConst :: Vertically constant reference density
345 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
346 cnh 1.63 C startTime :: Start time for model ( s )
347     C phiMin :: Latitude of southern most cell face.
348     C thetaMin :: Longitude of western most cell face (this
349 cnh 1.1 C is an "inert" parameter but it is included
350     C to make geographical references simple.)
351 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
352     C recip_RSphere :: Reciprocal radius of sphere ( m ).
353     C f0 :: Reference coriolis parameter ( 1/s )
354 cnh 1.1 C ( Southern edge f for beta plane )
355 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
356     C omega :: Angular velocity ( rad/s )
357 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
358 cnh 1.63 C viscAh :: Eddy viscosity coeff. for mixing of
359 cnh 1.1 C momentum laterally ( m^2/s )
360 cnh 1.63 C viscAz :: Eddy viscosity coeff. for mixing of
361 cnh 1.1 C momentum vertically ( m^2/s )
362 cnh 1.63 C viscAp :: Eddy viscosity coeff. for mixing of
363 cnh 1.27 C momentum vertically ( Pa^2/s )
364 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
365 cnh 1.24 C momentum vertically ( units of r^2/s )
366 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
367 cnh 1.1 C momentum laterally ( m^4/s )
368 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
369 cnh 1.1 C heat laterally ( m^2/s )
370 cnh 1.63 C diffKzT :: Laplacian diffusion coeff. for mixing of
371 cnh 1.1 C heat vertically ( m^2/s )
372 cnh 1.63 C diffKpT :: Laplacian diffusion coeff. for mixing of
373 cnh 1.27 C heat vertically ( Pa^2/s )
374 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
375 cnh 1.24 C heat vertically ( units of r^2/s )
376 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
377 cnh 1.1 C heat laterally ( m^4/s )
378 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
379 cnh 1.1 C salt laterally ( m^2/s )
380 cnh 1.63 C diffKzS :: Laplacian diffusion coeff. for mixing of
381 cnh 1.1 C salt vertically ( m^2/s )
382 cnh 1.63 C diffKpS :: Laplacian diffusion coeff. for mixing of
383 cnh 1.27 C salt vertically ( Pa^2/s )
384 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
385 cnh 1.24 C salt vertically ( units of r^2/s )
386 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
387 cnh 1.1 C salt laterally ( m^4/s )
388 cnh 1.63 C deltaT :: Default timestep ( s )
389     C deltaTClock :: Timestep used as model "clock". This determines the
390 cnh 1.7 C IO frequencies and is used in tagging output. It can
391     C be totally different to the dynamical time. Typically
392     C it will be the deep-water timestep for accelerated runs.
393     C Frequency of checkpointing and dumping of the model state
394     C are referenced to this clock. ( s )
395 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
396     C deltaTtracer :: Timestep for tracer equations ( s )
397 adcroft 1.72 C deltaTfreesurf :: Timestep for free-surface equation ( s )
398 cnh 1.63 C freesurfFac :: Parameter to turn implicit free surface term on or off
399 cnh 1.8 C freesurfac = 1. uses implicit free surface
400     C freesurfac = 0. uses rigid lid
401 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
402 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
403 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
404 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
405 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
406     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
407     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
408     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
409     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
410 adcroft 1.52 C hFacSup that control vanishing and creating levels
411 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
412     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
413     C startTime :: Starting time for this integration ( s ).
414     C endTime :: Ending time for this integration ( s ).
415     C chkPtFreq :: Frequency of rolling check pointing ( s ).
416     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
417     C dumpFreq :: Frequency with which model state is written to
418 cnh 1.24 C post-processing files ( s ).
419 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
420 adcroft 1.59 C of intermediate quantities.
421 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
422     C vfFacMom :: Momentum viscosity tracer parameter
423     C pfFacMom :: Momentum pressure forcing tracer parameter
424     C cfFacMom :: Coriolis term tracer parameter
425     C foFacMom :: Momentum forcing tracer parameter
426     C mtFacMom :: Metric terms tracer parameter
427     C cosPower :: Power of cosine of latitude to multiply viscosity
428     C cAdjFreq :: Frequency of convective adjustment
429 cnh 1.24 C
430 jmc 1.76 C taveFreq :: Frequency with which time-averaged model state
431     C is written to post-processing files ( s ).
432     C tave_lastIter :: (for state variable only) fraction of the last time
433     C step (of each taveFreq period) put in the time average.
434     C (fraction for 1rst iter = 1 - tave_lastIter)
435 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
436     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
437     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
438     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
439     C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
440     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
441 adcroft 1.19 C (note: externForcingCycle must be an integer
442     C number times externForcingPeriod)
443 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
444     C (use model surface (local) value if set to -1)
445     C temp_EvPrRn :: temperature of Rain & Evap.
446     C salt_EvPrRn :: salinity of Rain & Evap.
447     C trac_EvPrRn :: tracer concentration in Rain & Evap.
448     C (notes: a) tracer content of Rain/Evap only used if both
449     C NonLin_FrSurf & useRealFreshWater are set.
450     C b) use model surface (local) value if set to UNSET_RL)
451 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
452 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
453 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
454 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
455 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
456 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
457 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
458 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
459     & cg2dpcOffDFac, cg3dTargetResidual,
460 jmc 1.70 & delP, delZ, delR, delRc, delX, delY,
461 adcroft 1.72 & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
462     & abeps, startTime,
463 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
464 adcroft 1.78 & fCori, fCoriG, fCoriCos,
465 adcroft 1.60 & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension,
466 cnh 1.24 & diffKhT, diffKzT, diffK4T, diffKrT,
467 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
468 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
469 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
470 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
471 mlosch 1.75 & recip_rhoConst, rhoConst,
472 jmc 1.76 & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
473 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
474 jmc 1.76 & diagFreq, taveFreq, tave_lastIter, monitorFreq,
475 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
476 jmc 1.88 & cosPower, cAdjFreq, omega, rotationPeriod,
477 heimbach 1.56 & tauThetaClimRelax, lambdaThetaClimRelax,
478 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
479 heimbach 1.56 & tauTr1ClimRelax, lambdaTr1ClimRelax,
480 cnh 1.27 & externForcingCycle, externForcingPeriod,
481 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
482 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
483 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
484 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
485 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
486 cnh 1.27
487 adcroft 1.6 _RL cg2dTargetResidual
488 adcroft 1.52 _RL cg2dTargetResWunit
489 cnh 1.33 _RL cg3dTargetResidual
490 cnh 1.7 _RL cg2dpcOffDFac
491 cnh 1.25 _RL delZ(Nr)
492     _RL delP(Nr)
493     _RL delR(Nr)
494 jmc 1.70 _RL delRc(Nr+1)
495 adcroft 1.6 _RL delX(Nx)
496     _RL delY(Ny)
497     _RL deltaT
498 cnh 1.7 _RL deltaTClock
499 adcroft 1.6 _RL deltaTmom
500     _RL deltaTtracer
501 adcroft 1.72 _RL deltaTfreesurf
502 adcroft 1.6 _RL abeps
503     _RL phiMin
504     _RL thetaMin
505     _RL rSphere
506 cnh 1.25 _RL recip_RSphere
507 adcroft 1.6 _RL f0
508 cnh 1.8 _RL freeSurfFac
509 jmc 1.48 _RL implicSurfPress
510     _RL implicDiv2Dflow
511 adcroft 1.22 _RL hFacMin
512     _RL hFacMinDz
513 cnh 1.28 _RL hFacMinDp
514 cnh 1.27 _RL hFacMinDr
515 adcroft 1.52 _RL hFacInf
516     _RL hFacSup
517 adcroft 1.6 _RL beta
518     _RL viscAh
519 adcroft 1.60 _RL viscAstrain
520     _RL viscAtension
521 adcroft 1.6 _RL viscAz
522 cnh 1.27 _RL viscAp
523 cnh 1.25 _RL viscAr
524 adcroft 1.6 _RL viscA4
525     _RL diffKhT
526 cnh 1.25 _RL diffKrT
527 adcroft 1.6 _RL diffKzT
528 cnh 1.27 _RL diffKpT
529 adcroft 1.6 _RL diffK4T
530     _RL diffKhS
531 cnh 1.25 _RL diffKrS
532 adcroft 1.6 _RL diffKzS
533 cnh 1.27 _RL diffKpS
534 adcroft 1.6 _RL diffK4S
535     _RL delt
536     _RL tauCD
537     _RL rCD
538     _RL gravity
539 cnh 1.32 _RL recip_gravity
540 cnh 1.8 _RL gBaro
541 adcroft 1.6 _RL rhonil
542 cnh 1.25 _RL recip_rhonil
543     _RL rhoConst
544 cnh 1.26 _RL recip_rhoConst
545 mlosch 1.75 _RL rhoConstFresh
546 jmc 1.76 _RL convertEmP2rUnit
547 cnh 1.25 _RL tRef(Nr)
548     _RL sRef(Nr)
549 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
550     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
551 adcroft 1.78 _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
552 adcroft 1.6 _RL startTime
553     _RL endTime
554     _RL chkPtFreq
555 cnh 1.7 _RL pChkPtFreq
556 adcroft 1.6 _RL dumpFreq
557 adcroft 1.59 _RL diagFreq
558 adcroft 1.20 _RL taveFreq
559 jmc 1.76 _RL tave_lastIter
560 adcroft 1.53 _RL monitorFreq
561 cnh 1.9 _RL afFacMom
562     _RL vfFacMom
563     _RL pfFacMom
564     _RL cfFacMom
565     _RL foFacMom
566 cnh 1.15 _RL mTFacMom
567 adcroft 1.39 _RL cosPower
568 cnh 1.9 _RL cAdjFreq
569 cnh 1.15 _RL omega
570 jmc 1.88 _RL rotationPeriod
571 cnh 1.18 _RL tauThetaClimRelax
572     _RL lambdaThetaClimRelax
573     _RL tauSaltClimRelax
574     _RL lambdaSaltClimRelax
575 heimbach 1.56 _RL tauTr1ClimRelax
576     _RL lambdaTr1ClimRelax
577 adcroft 1.19 _RL externForcingCycle
578     _RL externForcingPeriod
579 jmc 1.68 _RL convertFW2Salt
580     _RL temp_EvPrRn
581     _RL salt_EvPrRn
582     _RL trac_EvPrRn
583 cnh 1.30 _RL horiVertRatio
584 cnh 1.31 _RL recip_horiVertRatio
585 adcroft 1.41 _RL ivdc_kappa
586 adcroft 1.46 _RL Ro_SeaLevel
587     _RL bottomDragLinear
588     _RL bottomDragQuadratic
589 adcroft 1.6
590 adcroft 1.36 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
591 cnh 1.1 & Lamba_theta
592 adcroft 1.6 _RL HeatCapacity_Cp
593     _RL Lamba_theta
594 adcroft 1.36 _RL recip_Cp
595 jmc 1.55
596     C Atmospheric physical parameters (Ideal Gas EOS, ...)
597 jmc 1.83 C atm_Po :: standard reference pressure
598     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
599     C atm_Rd :: gas constant for dry air
600 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
601 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
602 jmc 1.55 C (still a subject of discussions ...)
603 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
604     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
605     COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,
606     & integr_GeoPot, selectFindRoSurf
607     _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
608     INTEGER integr_GeoPot, selectFindRoSurf
609 cnh 1.7
610 adcroft 1.44 C Logical flags for selecting packages
611 heimbach 1.45 LOGICAL useKPP
612     LOGICAL useGMRedi
613 adcroft 1.46 LOGICAL useOBCS
614 jmc 1.49 LOGICAL useAIM
615 heimbach 1.56 LOGICAL useGrdchk
616 heimbach 1.45 LOGICAL useECCO
617 adcroft 1.52 LOGICAL useSHAP_FILT
618 jmc 1.67 LOGICAL useZONAL_FILT
619 adcroft 1.62 LOGICAL useFLT
620 adcroft 1.69 LOGICAL usePTRACERS
621 dimitri 1.86 LOGICAL useSBO
622 heimbach 1.80 LOGICAL useSEAICE
623 cheisey 1.81 cswdblk -- add ---
624 cheisey 1.82 LOGICAL useBulkforce
625     LOGICAL useThermSEAICE
626 cheisey 1.81 cswdblk --- end add ---
627 adcroft 1.44 COMMON /PARM_PACKAGES/
628 heimbach 1.56 & useKPP, useGMRedi, useOBCS, useAIM, useECCO,
629 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
630 dimitri 1.86 & usePTRACERS, useSBO, useSEAICE,
631 cheisey 1.81 cswdblk -- add ---
632 cheisey 1.82 & useThermSEAICE, useBulkforce
633 cheisey 1.81 cswdblk --- end add ---

  ViewVC Help
Powered by ViewVC 1.1.22