/[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.65 - (hide annotations) (download)
Fri Sep 28 03:25:15 2001 UTC (22 years, 7 months ago) by adcroft
Branch: MAIN
CVS Tags: release1_b1, checkpoint43, ecco-branch-mod1, release1_beta1
Branch point for: release1, ecco-branch, release1_coupled
Changes since 1.64: +3 -2 lines
File MIME type: text/plain
Added energy conserving discretization for Coriolis term.
 o don't panic - the default is off so you can continue not
   conserving energy just like you always have...
 o new flag: useEnergyConservingCoriolis defaults to .F.

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

  ViewVC Help
Powered by ViewVC 1.1.22