/[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.88 - (hide annotations) (download)
Mon Mar 17 16:59:38 2003 UTC (21 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint50b_pre, checkpoint50a_post
Changes since 1.87: +4 -2 lines
File MIME type: text/plain
set the Earth rotation either directly (omega) or from the rotation period

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

  ViewVC Help
Powered by ViewVC 1.1.22