/[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.77 - (hide annotations) (download)
Tue Nov 5 18:48:46 2002 UTC (21 years, 6 months ago) by adcroft
Branch: MAIN
Changes since 1.76: +4 -2 lines
File MIME type: text/plain
Added new flag "useNHMTerms" which controls appearance of non-hydrostatic metric
terms:
 - defaults to TRUE but is set to false when metricTerms is false.
   This means no output is currently affected since N-H metric terms have
   always been associated with spherical metric terms to date.
 - note that N-H metric terms are both incomplete and disctetized incorrectly
   and are not fixed as yet.
 - turning off useNHMTerms affects these experiments
    adjustment.128x64x1, aim.5l_Equatorial_Channel, exp1, exp2, global_ocean.90x40x1,
    hs94.128x64x5, hs94.1x64x5, natl_box
   which means they all have non-hydrostatic metric terms in them.

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

  ViewVC Help
Powered by ViewVC 1.1.22