/[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.70 - (hide annotations) (download)
Thu Mar 7 14:05:05 2002 UTC (22 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint44h_pre, checkpoint45a_post, checkpoint45b_post, checkpoint45c_post, checkpoint44h_post, checkpoint45
Changes since 1.69: +8 -3 lines
File MIME type: text/plain
o define cell Center vertical spacing and then put Interface at the middle

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

  ViewVC Help
Powered by ViewVC 1.1.22