/[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.99 - (hide annotations) (download)
Mon Dec 15 23:00:43 2003 UTC (20 years, 4 months ago) by molod
Branch: MAIN
CVS Tags: checkpoint52e_pre, checkpoint52d_post
Changes since 1.98: +4 -2 lines
File MIME type: text/plain
 o added some infrastructure to call fizhi and gridalt routines
 o added package dependencies for fizhi

1 molod 1.99 C $Header: /u/u3/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.98 2003/11/23 01:25:55 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 heimbach 1.92 & eosType, pickupSuff,
86     & mdsioLocalDir
87 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
88 jmc 1.55 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
89 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
90     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
91     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
92     CHARACTER*(MAX_LEN_FNAM) meridWindFile
93 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
94     CHARACTER*(MAX_LEN_FNAM) saltClimFile
95 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
96 heimbach 1.45 CHARACTER*(MAX_LEN_FNAM) surfQswfile
97 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
98 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
99 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
100     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
101 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
102 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
103 mlosch 1.73 CHARACTER*(MAX_LEN_FNAM) ploadFile
104 heimbach 1.92 CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
105 mlosch 1.74 CHARACTER*(6) eosType
106 adcroft 1.90 CHARACTER*(10) pickupSuff
107 cnh 1.7
108 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
109 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
110 cnh 1.1 C two-dimensional con. grad solver.
111 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
112 cnh 1.1 C in con. grad solver.
113 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
114 cnh 1.33 C three-dimensional con. grad solver.
115 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
116 cnh 1.33 C in con. grad solver.
117 cnh 1.63 C nIter0 :: Start time-step number of for this run
118     C nTimeSteps :: Number of timesteps to execute
119     C numStepsPerPickup :: For offline setup. Frequency of pickup
120 cnh 1.1 C of flow fields.
121 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
122     C writeBinaryPrec :: Precision used for writing binary files
123     C readBinaryPrec :: Precision used for reading binary files
124     C nCheckLev :: Holds current checkpoint level
125     C nonlinFreeSurf :: option related to non-linear free surface
126 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
127 jmc 1.84 C select_rStar :: option related to r* vertical coordinate
128     C =0 (default) use r coord. ; > 0 use r*
129 cnh 1.34
130 cnh 1.1 COMMON /PARM_I/
131     & cg2dMaxIters,
132     & cg2dChkResFreq,
133 cnh 1.33 & cg3dMaxIters,
134     & cg3dChkResFreq,
135 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
136 cnh 1.7 & numStepsPerPickup,
137     & writeStatePrec, nCheckLev,
138 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
139 jmc 1.84 & nonlinFreeSurf, select_rStar,
140 heimbach 1.92 & tempAdvScheme, saltAdvScheme, tracerAdvScheme,
141     & debugLevel
142 cnh 1.1 INTEGER cg2dMaxIters
143     INTEGER cg2dChkResFreq
144 cnh 1.33 INTEGER cg3dMaxIters
145     INTEGER cg3dChkResFreq
146 cnh 1.1 INTEGER nIter0
147     INTEGER nTimeSteps
148 adcroft 1.41 INTEGER nEndIter
149 cnh 1.1 INTEGER numStepsPerPickup
150 cnh 1.7 INTEGER writeStatePrec
151     INTEGER writeBinaryPrec
152     INTEGER readBinaryPrec
153     INTEGER nCheckLev
154 jmc 1.55 INTEGER nonlinFreeSurf
155 jmc 1.84 INTEGER select_rStar
156 adcroft 1.57 INTEGER tempAdvScheme
157     INTEGER saltAdvScheme
158     INTEGER tracerAdvScheme
159 heimbach 1.92 INTEGER debugLevel
160    
161     C
162     INTEGER debLevZero
163     PARAMETER(debLevZero=0)
164     INTEGER debLevA
165     PARAMETER(debLevA=1)
166     INTEGER debLevB
167     PARAMETER(debLevB=2)
168 cnh 1.1
169     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
170 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
171 cnh 1.1 C coordinate frame.
172 cnh 1.63 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
173 cnh 1.1 C spherical polar frame.
174 cnh 1.63 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
175     C no_slip_bottom :: Impose "no-slip" at bottom boundary.
176     C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
177     C momViscosity :: Flag which turns momentum friction terms on and off.
178     C momAdvection :: Flag which turns advection of momentum on and off.
179     C momForcing :: Flag which turns external forcing of momentum on
180 cnh 1.1 C and off.
181 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
182 cnh 1.9 C on and off.
183 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
184     C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
185 adcroft 1.77 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
186 cnh 1.63 C useCoriolis :: Flag which turns the coriolis terms on and off.
187     C tempDiffusion :: Flag which turns diffusion of temperature on
188 cnh 1.1 C and off.
189 cnh 1.63 C tempAdvection :: Flag which turns advection of temperature on
190 cnh 1.1 C and off.
191 cnh 1.63 C tempForcing :: Flag which turns external forcing of temperature on
192 cnh 1.1 C and off.
193 jmc 1.71 C saltDiffusion :: Flag which turns diffusion of salinity on
194 cnh 1.1 C and off.
195 jmc 1.71 C saltAdvection :: Flag which turns advection of salinity on
196 cnh 1.1 C and off.
197 jmc 1.71 C saltForcing :: Flag which turns external forcing of salinity on
198 cnh 1.1 C and off.
199 jmc 1.71 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
200     C as a real Fresh Water (=> changes the Sea Level)
201     C if F, converts P+R-E to salt flux (no SL effect)
202 cnh 1.63 C rigidLid :: Set to true to use rigid lid
203     C implicitFreeSurface :: Set to true to use implcit free surface
204     C exactConserv :: Set to true to conserve exactly the total Volume
205     C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
206 jmc 1.55 C linear relation Phi_surf = Bo_surf*eta
207 cnh 1.63 C momStepping :: Turns momentum equation time-stepping off
208     C tempStepping :: Turns temperature equation time-stepping off
209     C saltStepping :: Turns salinity equation time-stepping off
210     C tr1Stepping :: Turns passive tracer 1 time-stepping on/off
211     C useConstantF :: Coriolis parameter set to f0
212     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
213     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
214 jmc 1.89 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
215 jmc 1.71 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
216 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
217     C implicitViscosity :: Turns implicit vertical viscosity on
218 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
219     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
220     C out off Adams-Bashforth time stepping.
221 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
222 cnh 1.18 C climatology is required.
223 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
224 cnh 1.18 C climatology is required.
225 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
226     C usingPCoords :: Set to indicate that we are working in pressure
227 jmc 1.87 C coords. (jmc: is it still used ?)
228 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
229 jmc 1.87 C coords. (jmc: is it still used ?)
230     C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
231     C this requires specific code for restart & exchange
232 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
233 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
234 adcroft 1.79 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
235 cnh 1.63 C globalFiles :: Selects between "global" and "tiled" files
236 dimitri 1.85 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
237     C slow (f77) or does not work (f90). When
238     C useSingleCpuIO is set, mdsio_writefield.F
239     C outputs from master mpi process only.
240 jmc 1.97 C allowFreezing :: Allows surface water to freeze and form ice
241     C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
242 cnh 1.63 C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
243 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
244 adcroft 1.52 & usingCurvilinearGrid,
245 adcroft 1.36 & no_slip_sides,no_slip_bottom,
246 adcroft 1.46 & staggerTimeStep,
247 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
248 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
249     & tempDiffusion, tempAdvection, tempForcing,
250 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
251 jmc 1.68 & useRealFreshWaterFlux,
252 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
253 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
254 adcroft 1.77 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
255 cnh 1.15 & useConstantF, useBetaPlaneF, useSphereF,
256 jmc 1.89 & useCDscheme,
257 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
258 adcroft 1.40 & implicitDiffusion, implicitViscosity,
259 jmc 1.71 & multiDimAdvection, forcing_In_AB,
260 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
261 jmc 1.70 & periodicExternalForcing,
262 jmc 1.87 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
263 dimitri 1.85 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
264 jmc 1.97 & allowFreezing, useOldFreezing, groundAtK1,
265 heimbach 1.56 & usePickupBeforeC35, debugMode,
266 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
267 cnh 1.1 LOGICAL usingCartesianGrid
268     LOGICAL usingSphericalPolarGrid
269 adcroft 1.52 LOGICAL usingCurvilinearGrid
270 cnh 1.15 LOGICAL usingSphericalPolarMTerms
271 adcroft 1.77 LOGICAL useNHMTerms
272 adcroft 1.36 LOGICAL no_slip_sides
273     LOGICAL no_slip_bottom
274 adcroft 1.46 LOGICAL staggerTimeStep
275 cnh 1.1 LOGICAL momViscosity
276     LOGICAL momAdvection
277     LOGICAL momForcing
278 cnh 1.9 LOGICAL momPressureForcing
279 cnh 1.1 LOGICAL useCoriolis
280 adcroft 1.58 LOGICAL vectorInvariantMomentum
281 cnh 1.1 LOGICAL tempDiffusion
282     LOGICAL tempAdvection
283     LOGICAL tempForcing
284     LOGICAL saltDiffusion
285     LOGICAL saltAdvection
286     LOGICAL saltForcing
287 jmc 1.68 LOGICAL useRealFreshWaterFlux
288 adcroft 1.52 LOGICAL rigidLid
289 cnh 1.8 LOGICAL implicitFreeSurface
290 adcroft 1.52 LOGICAL exactConserv
291 jmc 1.55 LOGICAL uniformLin_PhiSurf
292 cnh 1.10 LOGICAL momStepping
293     LOGICAL tempStepping
294 adcroft 1.17 LOGICAL saltStepping
295 heimbach 1.56 LOGICAL tr1Stepping
296 cnh 1.15 LOGICAL metricTerms
297     LOGICAL useConstantF
298     LOGICAL useBetaPlaneF
299     LOGICAL useSphereF
300 jmc 1.89 LOGICAL useCDscheme
301 jmc 1.71 LOGICAL useEnergyConservingCoriolis
302     LOGICAL useJamartWetPoints
303 adcroft 1.14 LOGICAL implicitDiffusion
304 adcroft 1.40 LOGICAL implicitViscosity
305 jmc 1.71 LOGICAL multiDimAdvection
306     LOGICAL forcing_In_AB
307 cnh 1.18 LOGICAL doThetaClimRelax
308     LOGICAL doSaltClimRelax
309 heimbach 1.56 LOGICAL doTr1ClimRelax
310 adcroft 1.19 LOGICAL periodicExternalForcing
311 cnh 1.29 LOGICAL usingPCoords
312     LOGICAL usingZCoords
313 jmc 1.87 LOGICAL useDynP_inEos_Zc
314 jmc 1.70 LOGICAL setCenterDr
315 adcroft 1.37 LOGICAL nonHydrostatic
316 adcroft 1.79 LOGICAL quasiHydrostatic
317 adcroft 1.38 LOGICAL globalFiles
318 dimitri 1.85 LOGICAL useSingleCpuIO
319 adcroft 1.38 LOGICAL allowFreezing
320 jmc 1.97 LOGICAL useOldFreezing
321 adcroft 1.46 LOGICAL groundAtK1
322 heimbach 1.51 LOGICAL usePickupBeforeC35
323 adcroft 1.54 LOGICAL debugMode
324 heimbach 1.56 LOGICAL readPickupWithTracer
325     LOGICAL writePickupWithTracer
326 cnh 1.1
327     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
328 adcroft 1.52 C gg2dTargetResidual
329 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
330 adcroft 1.52 C cg2dTargetResWunit
331 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
332 cnh 1.33 C cg3dTargetResidual
333 cnh 1.63 C :: Target residual for cg3d solver.
334     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
335 cnh 1.7 C Note. 20th May 1998
336     C I made a weird discovery! In the model paper we argue
337     C for the form of the preconditioner used here ( see
338     C A Finite-volume, Incompressible Navier-Stokes Model
339     C ...., Marshall et. al ). The algebra gives a simple
340     C 0.5 factor for the averaging of ac and aCw to get a
341     C symmettric pre-conditioner. By using a factor of 0.51
342     C i.e. scaling the off-diagonal terms in the
343     C preconditioner down slightly I managed to get the
344     C number of iterations for convergence in a test case to
345     C drop form 192 -> 134! Need to investigate this further!
346     C For now I have introduced a parameter cg2dpcOffDFac which
347     C defaults to 0.51 but can be set at runtime.
348 cnh 1.63 C delR :: Vertical grid spacing ( units of r ).
349 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
350 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
351 cnh 1.1 C delY on input flags.
352 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
353 cnh 1.32 C recip_gravity and its inverse
354 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
355 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
356 cnh 1.63 C rhoConst :: Vertically constant reference density
357 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
358 cnh 1.63 C startTime :: Start time for model ( s )
359     C phiMin :: Latitude of southern most cell face.
360     C thetaMin :: Longitude of western most cell face (this
361 cnh 1.1 C is an "inert" parameter but it is included
362     C to make geographical references simple.)
363 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
364     C recip_RSphere :: Reciprocal radius of sphere ( m ).
365     C f0 :: Reference coriolis parameter ( 1/s )
366 cnh 1.1 C ( Southern edge f for beta plane )
367 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
368     C omega :: Angular velocity ( rad/s )
369 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
370 cnh 1.63 C viscAh :: Eddy viscosity coeff. for mixing of
371 cnh 1.1 C momentum laterally ( m^2/s )
372 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
373 cnh 1.24 C momentum vertically ( units of r^2/s )
374 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
375 cnh 1.1 C momentum laterally ( m^4/s )
376 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
377 cnh 1.1 C heat laterally ( m^2/s )
378 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
379 cnh 1.24 C heat vertically ( units of r^2/s )
380 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
381 cnh 1.1 C heat laterally ( m^4/s )
382 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
383 cnh 1.1 C salt laterally ( m^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 jmc 1.95 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
440     C i.e. where |yC| <= latBandClimRelax
441 cnh 1.63 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
442     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
443 adcroft 1.19 C (note: externForcingCycle must be an integer
444     C number times externForcingPeriod)
445 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
446     C (use model surface (local) value if set to -1)
447     C temp_EvPrRn :: temperature of Rain & Evap.
448     C salt_EvPrRn :: salinity of Rain & Evap.
449     C trac_EvPrRn :: tracer concentration in Rain & Evap.
450     C (notes: a) tracer content of Rain/Evap only used if both
451     C NonLin_FrSurf & useRealFreshWater are set.
452     C b) use model surface (local) value if set to UNSET_RL)
453 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
454 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
455 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
456 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
457 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
458 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
459 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
460 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
461     & cg2dpcOffDFac, cg3dTargetResidual,
462 jmc 1.96 & delR, delRc, delX, delY,
463 adcroft 1.72 & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
464     & abeps, startTime,
465 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
466 adcroft 1.78 & fCori, fCoriG, fCoriCos,
467 jmc 1.96 & viscAh, viscA4, viscAr, viscAstrain, viscAtension,
468     & diffKhT, diffK4T, diffKrT,
469     & diffKhS, diffK4S, diffKrS,
470 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
471 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
472 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
473 mlosch 1.75 & recip_rhoConst, rhoConst,
474 jmc 1.76 & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
475 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
476 jmc 1.76 & diagFreq, taveFreq, tave_lastIter, monitorFreq,
477 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
478 jmc 1.88 & cosPower, cAdjFreq, omega, rotationPeriod,
479 heimbach 1.56 & tauThetaClimRelax, lambdaThetaClimRelax,
480 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
481 jmc 1.95 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
482 cnh 1.27 & externForcingCycle, externForcingPeriod,
483 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
484 jmc 1.96 & hFacMinDr, hFacMinDp,
485 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
486 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
487 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
488 cnh 1.27
489 adcroft 1.6 _RL cg2dTargetResidual
490 adcroft 1.52 _RL cg2dTargetResWunit
491 cnh 1.33 _RL cg3dTargetResidual
492 cnh 1.7 _RL cg2dpcOffDFac
493 cnh 1.25 _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 cnh 1.25 _RL viscAr
522 adcroft 1.6 _RL viscA4
523     _RL diffKhT
524 cnh 1.25 _RL diffKrT
525 adcroft 1.6 _RL diffK4T
526     _RL diffKhS
527 cnh 1.25 _RL diffKrS
528 adcroft 1.6 _RL diffK4S
529     _RL delt
530     _RL tauCD
531     _RL rCD
532     _RL gravity
533 cnh 1.32 _RL recip_gravity
534 cnh 1.8 _RL gBaro
535 adcroft 1.6 _RL rhonil
536 cnh 1.25 _RL recip_rhonil
537     _RL rhoConst
538 cnh 1.26 _RL recip_rhoConst
539 mlosch 1.75 _RL rhoConstFresh
540 jmc 1.76 _RL convertEmP2rUnit
541 cnh 1.25 _RL tRef(Nr)
542     _RL sRef(Nr)
543 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
544     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
545 adcroft 1.78 _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
546 adcroft 1.6 _RL startTime
547     _RL endTime
548     _RL chkPtFreq
549 cnh 1.7 _RL pChkPtFreq
550 adcroft 1.6 _RL dumpFreq
551 adcroft 1.59 _RL diagFreq
552 adcroft 1.20 _RL taveFreq
553 jmc 1.76 _RL tave_lastIter
554 adcroft 1.53 _RL monitorFreq
555 cnh 1.9 _RL afFacMom
556     _RL vfFacMom
557     _RL pfFacMom
558     _RL cfFacMom
559     _RL foFacMom
560 cnh 1.15 _RL mTFacMom
561 adcroft 1.39 _RL cosPower
562 cnh 1.9 _RL cAdjFreq
563 cnh 1.15 _RL omega
564 jmc 1.88 _RL rotationPeriod
565 cnh 1.18 _RL tauThetaClimRelax
566     _RL lambdaThetaClimRelax
567     _RL tauSaltClimRelax
568     _RL lambdaSaltClimRelax
569 heimbach 1.56 _RL tauTr1ClimRelax
570     _RL lambdaTr1ClimRelax
571 jmc 1.95 _RL latBandClimRelax
572 adcroft 1.19 _RL externForcingCycle
573     _RL externForcingPeriod
574 jmc 1.68 _RL convertFW2Salt
575     _RL temp_EvPrRn
576     _RL salt_EvPrRn
577     _RL trac_EvPrRn
578 cnh 1.30 _RL horiVertRatio
579 cnh 1.31 _RL recip_horiVertRatio
580 adcroft 1.41 _RL ivdc_kappa
581 adcroft 1.46 _RL Ro_SeaLevel
582     _RL bottomDragLinear
583     _RL bottomDragQuadratic
584 adcroft 1.6
585 jmc 1.91 C-- COMMON /PARM_A/ Thermodynamics constants ?
586     COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
587 adcroft 1.6 _RL HeatCapacity_Cp
588 adcroft 1.36 _RL recip_Cp
589 jmc 1.55
590 jmc 1.91 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
591     C celsius2K :: convert centigrade (Celsius) degree to Kelvin
592 jmc 1.83 C atm_Po :: standard reference pressure
593     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
594     C atm_Rd :: gas constant for dry air
595 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
596 jmc 1.94 C atm_Rq :: water vapour specific volume anomaly relative to dry air
597     C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
598 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
599 jmc 1.55 C (still a subject of discussions ...)
600 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
601     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
602 jmc 1.91 COMMON /PARM_ATM/
603     & celsius2K,
604 jmc 1.94 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
605 jmc 1.91 & integr_GeoPot, selectFindRoSurf
606     _RL celsius2K
607 jmc 1.94 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
608 jmc 1.83 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 jmc 1.91 LOGICAL useLand
616 heimbach 1.56 LOGICAL useGrdchk
617 heimbach 1.45 LOGICAL useECCO
618 adcroft 1.52 LOGICAL useSHAP_FILT
619 jmc 1.67 LOGICAL useZONAL_FILT
620 adcroft 1.62 LOGICAL useFLT
621 adcroft 1.69 LOGICAL usePTRACERS
622 dimitri 1.86 LOGICAL useSBO
623 heimbach 1.80 LOGICAL useSEAICE
624 jmc 1.98 LOGICAL useBulkForce
625     LOGICAL useThSIce
626 molod 1.99 LOGICAL usefizhi
627     LOGICAL usegridalt
628 adcroft 1.44 COMMON /PARM_PACKAGES/
629 jmc 1.91 & useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
630 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
631 dimitri 1.86 & usePTRACERS, useSBO, useSEAICE,
632 molod 1.99 & useThSIce, useBulkForce, usefizhi, usegridalt

  ViewVC Help
Powered by ViewVC 1.1.22