/[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.284 - (hide annotations) (download)
Mon Nov 28 22:47:42 2016 UTC (7 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint66e, checkpoint66d, checkpoint66c, checkpoint66b
Changes since 1.283: +12 -8 lines
File MIME type: text/plain
add new parameter "selectImplicitDrag" for implicit treatment of bottom drag.

1 jmc 1.284 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.283 2016/04/04 21:29:42 jmc Exp $
2 mlosch 1.74 C $Name: $
3 cnh 1.1 C
4 edhill 1.124
5 cnh 1.63 CBOP
6 edhill 1.124 C !ROUTINE: PARAMS.h
7     C !INTERFACE:
8     C #include PARAMS.h
9    
10     C !DESCRIPTION:
11     C Header file defining model "parameters". The values from the
12     C model standard input file are stored into the variables held
13     C here. Notes describing the parameters can also be found here.
14    
15 cnh 1.63 CEOP
16 cnh 1.13
17 cnh 1.1 C-- Contants
18     C Useful physical values
19     Real*8 PI
20     PARAMETER ( PI = 3.14159265358979323844D0 )
21     Real*8 deg2rad
22     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
23    
24     C-- COMMON /PARM_C/ Character valued parameters used by the model.
25 jmc 1.205 C buoyancyRelation :: Flag used to indicate which relation to use to
26     C get buoyancy.
27     C eosType :: choose the equation of state:
28     C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
29     C pickupSuff :: force to start from pickup files (even if nIter0=0)
30     C and read pickup files with this suffix (max 10 Char.)
31     C mdsioLocalDir :: read-write tiled file from/to this directory name
32     C (+ 4 digits Processor-Rank) instead of current dir.
33 jmc 1.246 C adTapeDir :: read-write checkpointing tape files from/to this
34 mlosch 1.245 C directory name instead of current dir. Conflicts
35     C mdsioLocalDir, so only one of the two can be set.
36     C In contrast to mdsioLocalDir, if specified adTapeDir
37     C must exist before the model starts.
38 jmc 1.191 C tRefFile :: File containing reference Potential Temperat. tRef (1.D)
39     C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D)
40     C rhoRefFile :: File containing reference density profile rhoRef (1.D)
41 jmc 1.282 C gravityFile :: File containing gravity vertical profile (1.D)
42 jmc 1.191 C delRFile :: File containing vertical grid spacing delR (1.D array)
43     C delRcFile :: File containing vertical grid spacing delRc (1.D array)
44 jmc 1.239 C hybSigmFile :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
45 jmc 1.162 C delXFile :: File containing X-spacing grid definition (1.D array)
46     C delYFile :: File containing Y-spacing grid definition (1.D array)
47 jmc 1.191 C horizGridFile :: File containing horizontal-grid definition
48 jmc 1.162 C (only when using curvilinear_grid)
49 jmc 1.205 C bathyFile :: File containing bathymetry. If not defined bathymetry
50     C is taken from inline function.
51     C topoFile :: File containing the topography of the surface (unit=m)
52     C (mainly used for the atmosphere = ground height).
53 jmc 1.273 C addWwallFile :: File containing 2-D additional Western cell-edge wall
54     C addSwallFile :: File containing 2-D additional Southern cell-edge wall
55     C (e.g., to add "thin-wall" where it is =1)
56 jmc 1.205 C hydrogThetaFile :: File containing initial hydrographic data (3-D)
57     C for potential temperature.
58     C hydrogSaltFile :: File containing initial hydrographic data (3-D)
59     C for salinity.
60 dimitri 1.199 C diffKrFile :: File containing 3D specification of vertical diffusivity
61 gforget 1.236 C viscAhDfile :: File containing 3D specification of horizontal viscosity
62     C viscAhZfile :: File containing 3D specification of horizontal viscosity
63     C viscA4Dfile :: File containing 3D specification of horizontal viscosity
64     C viscA4Zfile :: File containing 3D specification of horizontal viscosity
65 cnh 1.63 C zonalWindFile :: File containing zonal wind data
66     C meridWindFile :: File containing meridional wind data
67 jmc 1.205 C thetaClimFile :: File containing surface theta climataology used
68 jmc 1.260 C in relaxation term -lambda(theta-theta*)
69 jmc 1.205 C saltClimFile :: File containing surface salt climataology used
70 jmc 1.260 C in relaxation term -lambda(salt-salt*)
71 jmc 1.120 C surfQfile :: File containing surface heat flux, excluding SW
72     C (old version, kept for backward compatibility)
73     C surfQnetFile :: File containing surface net heat flux
74     C surfQswFile :: File containing surface shortwave radiation
75 cnh 1.63 C EmPmRfile :: File containing surface fresh water flux
76 dimitri 1.210 C NOTE: for backward compatibility EmPmRfile is specified in
77     C m/s when using external_fields_load.F. It is converted
78     C to kg/m2/s by multiplying by rhoConstFresh.
79 jmc 1.141 C saltFluxFile :: File containing surface salt flux
80 mlosch 1.73 C pLoadFile :: File containing pressure loading
81 jmc 1.266 C addMassFile :: File containing source/sink of fluid in the interior
82 gforget 1.217 C eddyPsiXFile :: File containing zonal Eddy streamfunction data
83     C eddyPsiYFile :: File containing meridional Eddy streamfunction data
84 edhill 1.124 C the_run_name :: string identifying the name of the model "run"
85 jmc 1.205 COMMON /PARM_C/
86     & buoyancyRelation, eosType,
87 mlosch 1.245 & pickupSuff, mdsioLocalDir, adTapeDir,
88 jmc 1.282 & tRefFile, sRefFile, rhoRefFile, gravityFile,
89 jmc 1.239 & delRFile, delRcFile, hybSigmFile,
90 jmc 1.162 & delXFile, delYFile, horizGridFile,
91 jmc 1.273 & bathyFile, topoFile, addWwallFile, addSwallFile,
92 jmc 1.238 & viscAhDfile, viscAhZfile,
93     & viscA4Dfile, viscA4Zfile,
94 dimitri 1.199 & hydrogThetaFile, hydrogSaltFile, diffKrFile,
95 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
96 jmc 1.205 & saltClimFile,
97 jmc 1.141 & EmPmRfile, saltFluxFile,
98     & surfQfile, surfQnetFile, surfQswFile,
99 heimbach 1.151 & lambdaThetaFile, lambdaSaltFile,
100 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
101 jmc 1.268 & pLoadFile, addMassFile,
102 heimbach 1.276 & eddyPsiXFile, eddyPsiYFile, geothermalFile,
103 edhill 1.124 & the_run_name
104 jmc 1.205 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
105     CHARACTER*(6) eosType
106     CHARACTER*(10) pickupSuff
107     CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
108 mlosch 1.245 CHARACTER*(MAX_LEN_FNAM) adTapeDir
109 jmc 1.191 CHARACTER*(MAX_LEN_FNAM) tRefFile
110     CHARACTER*(MAX_LEN_FNAM) sRefFile
111     CHARACTER*(MAX_LEN_FNAM) rhoRefFile
112 jmc 1.282 CHARACTER*(MAX_LEN_FNAM) gravityFile
113 jmc 1.191 CHARACTER*(MAX_LEN_FNAM) delRFile
114     CHARACTER*(MAX_LEN_FNAM) delRcFile
115 jmc 1.239 CHARACTER*(MAX_LEN_FNAM) hybSigmFile
116 jmc 1.162 CHARACTER*(MAX_LEN_FNAM) delXFile
117     CHARACTER*(MAX_LEN_FNAM) delYFile
118     CHARACTER*(MAX_LEN_FNAM) horizGridFile
119 mlosch 1.224 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
120 jmc 1.273 CHARACTER*(MAX_LEN_FNAM) addWwallFile, addSwallFile
121 dimitri 1.198 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
122 dimitri 1.199 CHARACTER*(MAX_LEN_FNAM) diffKrFile
123 gforget 1.236 CHARACTER*(MAX_LEN_FNAM) viscAhDfile
124     CHARACTER*(MAX_LEN_FNAM) viscAhZfile
125     CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
126     CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
127 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) zonalWindFile
128     CHARACTER*(MAX_LEN_FNAM) meridWindFile
129 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
130     CHARACTER*(MAX_LEN_FNAM) saltClimFile
131 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
132 jmc 1.120 CHARACTER*(MAX_LEN_FNAM) surfQnetFile
133     CHARACTER*(MAX_LEN_FNAM) surfQswFile
134 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
135 jmc 1.141 CHARACTER*(MAX_LEN_FNAM) saltFluxFile
136 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
137     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
138 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
139 jmc 1.266 CHARACTER*(MAX_LEN_FNAM) pLoadFile
140     CHARACTER*(MAX_LEN_FNAM) addMassFile
141 gforget 1.217 CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
142     CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
143 heimbach 1.276 CHARACTER*(MAX_LEN_FNAM) geothermalFile
144 heimbach 1.151 CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
145     CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
146 jmc 1.193 CHARACTER*(MAX_LEN_PREC/2) the_run_name
147 cnh 1.7
148 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
149 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
150 jmc 1.260 C two-dimensional con. grad solver.
151 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
152 jmc 1.260 C in con. grad solver.
153 jmc 1.119 C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner
154     C (non-linear free-surf.)
155 jmc 1.267 C cg2dUseMinResSol :: =0 : use last-iteration/converged solution
156     C =1 : use solver minimum-residual solution
157 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
158 jmc 1.260 C three-dimensional con. grad solver.
159 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
160 jmc 1.260 C in con. grad solver.
161 jmc 1.252 C printResidualFreq :: Frequency for printing residual in CG iterations
162 cnh 1.63 C nIter0 :: Start time-step number of for this run
163     C nTimeSteps :: Number of timesteps to execute
164 heimbach 1.280 C nTimeSteps_l2 :: Number of inner timesteps to execute per timestep
165 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
166     C writeBinaryPrec :: Precision used for writing binary files
167     C readBinaryPrec :: Precision used for reading binary files
168 jmc 1.243 C selectCoriMap :: select setting of Coriolis parameter map:
169     C =0 f-Plane (Constant Coriolis, = f0)
170     C =1 Beta-Plane Coriolis (= f0 + beta.y)
171     C =2 Spherical Coriolis (= 2.omega.sin(phi))
172     C =3 Read Coriolis 2-d fields from files.
173     C selectSigmaCoord :: option related to sigma vertical coordinate
174 cnh 1.63 C nonlinFreeSurf :: option related to non-linear free surface
175 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
176 jmc 1.84 C select_rStar :: option related to r* vertical coordinate
177     C =0 (default) use r coord. ; > 0 use r*
178 jmc 1.234 C selectNHfreeSurf :: option for Non-Hydrostatic (free-)Surface formulation:
179     C =0 (default) hydrostatic surf. ; > 0 add NH effects.
180 jmc 1.282 C selectP_inEOS_Zc :: select which pressure to use in EOS (for z-coords)
181     C =0: simply: -g*rhoConst*z
182     C =1: use pRef = integral{-g*rho(Tref,Sref,pRef)*dz}
183     C =2: use hydrostatic dynamical pressure
184     C =3: use full (Hyd+NH) dynamical pressure
185 jmc 1.222 C selectAddFluid :: option to add mass source/sink of fluid in the interior
186     C (3-D generalisation of oceanic real-fresh water flux)
187     C =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
188 jmc 1.284 C selectImplicitDrag :: select Implicit treatment of bottom/top drag
189     C = 0: fully explicit
190     C = 1: implicit on provisional velocity
191     C (i.e., before grad.Eta increment)
192     C = 2: fully implicit (combined with Impl Surf.Press)
193 jmc 1.180 C momForcingOutAB :: =1: take momentum forcing contribution
194 jmc 1.260 C out of (=0: in) Adams-Bashforth time stepping.
195 jmc 1.180 C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
196 jmc 1.260 C out of (=0: in) Adams-Bashforth time stepping.
197 jmc 1.115 C tempAdvScheme :: Temp. Horiz.Advection scheme selector
198 jmc 1.168 C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
199 jmc 1.115 C saltAdvScheme :: Salt. Horiz.advection scheme selector
200     C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
201 jmc 1.168 C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
202 jmc 1.214 C selectVortScheme :: Scheme selector for Vorticity term (Vector Inv.)
203 jmc 1.278 C selectBotDragQuadr :: quadratic bottom drag discretisation option:
204     C =0: average KE from grid center to U & V location
205     C =1: use local velocity norm @ U & V location
206     C =2: same with wet-point averaging of other component
207 jmc 1.211 C monitorSelect :: select group of variables to monitor
208     C =1 : dynvars ; =2 : + vort ; =3 : + surface
209 jmc 1.244 C- debugLevel :: controls printing of algorithm intermediate results
210     C and statistics ; higher -> more writing
211 cnh 1.34
212 cnh 1.1 COMMON /PARM_I/
213 jmc 1.267 & cg2dMaxIters, cg2dChkResFreq,
214     & cg2dPreCondFreq, cg2dUseMinResSol,
215 jmc 1.252 & cg3dMaxIters, cg3dChkResFreq,
216     & printResidualFreq,
217 heimbach 1.280 & nIter0, nTimeSteps, nTimeSteps_l2, nEndIter,
218 jmc 1.205 & writeStatePrec,
219 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
220 jmc 1.243 & selectCoriMap,
221     & selectSigmaCoord,
222 jmc 1.84 & nonlinFreeSurf, select_rStar,
223 jmc 1.282 & selectNHfreeSurf, selectP_inEOS_Zc,
224 jmc 1.284 & selectAddFluid, selectImplicitDrag,
225 jmc 1.180 & momForcingOutAB, tracForcingOutAB,
226 jmc 1.115 & tempAdvScheme, tempVertAdvScheme,
227     & saltAdvScheme, saltVertAdvScheme,
228 jmc 1.214 & selectKEscheme, selectVortScheme,
229 jmc 1.278 & selectBotDragQuadr,
230 jmc 1.211 & monitorSelect, debugLevel
231 cnh 1.1 INTEGER cg2dMaxIters
232     INTEGER cg2dChkResFreq
233 jmc 1.119 INTEGER cg2dPreCondFreq
234 jmc 1.267 INTEGER cg2dUseMinResSol
235 cnh 1.33 INTEGER cg3dMaxIters
236     INTEGER cg3dChkResFreq
237 jmc 1.252 INTEGER printResidualFreq
238 cnh 1.1 INTEGER nIter0
239     INTEGER nTimeSteps
240 heimbach 1.280 INTEGER nTimeSteps_l2
241 adcroft 1.41 INTEGER nEndIter
242 cnh 1.7 INTEGER writeStatePrec
243     INTEGER writeBinaryPrec
244     INTEGER readBinaryPrec
245 jmc 1.243 INTEGER selectCoriMap
246     INTEGER selectSigmaCoord
247 jmc 1.55 INTEGER nonlinFreeSurf
248 jmc 1.84 INTEGER select_rStar
249 jmc 1.234 INTEGER selectNHfreeSurf
250 jmc 1.282 INTEGER selectP_inEOS_Zc
251 jmc 1.222 INTEGER selectAddFluid
252 jmc 1.284 INTEGER selectImplicitDrag
253 jmc 1.180 INTEGER momForcingOutAB, tracForcingOutAB
254 jmc 1.115 INTEGER tempAdvScheme, tempVertAdvScheme
255     INTEGER saltAdvScheme, saltVertAdvScheme
256 jmc 1.183 INTEGER selectKEscheme
257 jmc 1.214 INTEGER selectVortScheme
258 jmc 1.278 INTEGER selectBotDragQuadr
259 jmc 1.211 INTEGER monitorSelect
260 heimbach 1.92 INTEGER debugLevel
261    
262 cnh 1.1 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
263 jmc 1.215 C- Coordinate + Grid params:
264     C fluidIsAir :: Set to indicate that the fluid major constituent
265 jmc 1.260 C is air
266 jmc 1.215 C fluidIsWater :: Set to indicate that the fluid major constituent
267 jmc 1.260 C is water
268 jmc 1.215 C usingPCoords :: Set to indicate that we are working in a pressure
269 jmc 1.260 C type coordinate (p or p*).
270 jmc 1.215 C usingZCoords :: Set to indicate that we are working in a height
271 jmc 1.260 C type coordinate (z or z*)
272 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
273 jmc 1.260 C coordinate frame.
274 jmc 1.206 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
275 jmc 1.260 C spherical polar frame.
276 jmc 1.215 C rotateGrid :: rotate grid coordinates to geographical coordinates
277     C according to Euler angles phiEuler, thetaEuler, psiEuler
278 jmc 1.265 C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
279 jmc 1.215 C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
280 jmc 1.265 C hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
281 jmc 1.192 C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
282 jmc 1.215 C setInterFDr :: set Interface depth (put cell-Center at the middle)
283     C setCenterDr :: set cell-Center depth (put Interface at the middle)
284     C- Momentum params:
285     C no_slip_sides :: Impose "no-slip" at lateral boundaries.
286 cnh 1.63 C no_slip_bottom :: Impose "no-slip" at bottom boundary.
287 jmc 1.278 C bottomVisc_pCell :: account for partial-cell in bottom visc. (no-slip BC)
288 jmc 1.270 C useSmag3D :: Use isotropic 3-D Smagorinsky
289 jmc 1.215 C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
290     C on irregular grids)
291     C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
292     C useAreaViscLength :: Set to true to use old scaling for viscous lengths,
293     C e.g., L2=Raz. May be preferable for cube sphere.
294 cnh 1.63 C momViscosity :: Flag which turns momentum friction terms on and off.
295     C momAdvection :: Flag which turns advection of momentum on and off.
296     C momForcing :: Flag which turns external forcing of momentum on
297 jmc 1.215 C and off.
298 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
299 cnh 1.9 C on and off.
300 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
301 jmc 1.182 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
302 cnh 1.63 C useCoriolis :: Flag which turns the coriolis terms on and off.
303 jmc 1.215 C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
304     C useCDscheme :: use CD-scheme to calculate Coriolis terms.
305     C vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
306     C (default = F = use mom_fluxform package)
307     C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
308     C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
309     C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
310     C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
311     C useAbsVorticity :: work with f+zeta in Coriolis terms
312 jmc 1.281 C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
313 jmc 1.215 C momStepping :: Turns momentum equation time-stepping off
314 jmc 1.281 C calc_wVelocity :: Turns vertical velocity calculation off
315 jmc 1.215 C- Temp. & Salt params:
316 jmc 1.266 C tempStepping :: Turns temperature equation time-stepping on/off
317     C saltStepping :: Turns salinity equation time-stepping on/off
318     C addFrictionHeating :: account for frictional heating
319 jmc 1.215 C tempAdvection :: Flag which turns advection of temperature on and off.
320 jmc 1.261 C tempVertDiff4 :: use vertical bi-harmonic diffusion for temperature
321 jmc 1.215 C tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
322 jmc 1.266 C tempForcing :: Flag which turns external forcing of temperature on/off
323 jmc 1.215 C saltAdvection :: Flag which turns advection of salinity on and off.
324 jmc 1.261 C saltVertDiff4 :: use vertical bi-harmonic diffusion for salinity
325 jmc 1.215 C saltIsActiveTr :: Salinity is a dynamically active tracer
326 jmc 1.266 C saltForcing :: Flag which turns external forcing of salinity on/off
327 jmc 1.230 C maskIniTemp :: apply mask to initial Pot.Temp.
328     C maskIniSalt :: apply mask to initial salinity
329     C checkIniTemp :: check for points with identically zero initial Pot.Temp.
330     C checkIniSalt :: check for points with identically zero initial salinity
331 mlosch 1.232 C- Pressure solver related parameters (PARM02)
332     C useSRCGSolver :: Set to true to use conjugate gradient
333     C solver with single reduction (only one call of
334     C s/r mpi_allreduce), default is false
335 jmc 1.260 C- Time-stepping & free-surface params:
336 cnh 1.63 C rigidLid :: Set to true to use rigid lid
337 jmc 1.173 C implicitFreeSurface :: Set to true to use implicit free surface
338 jmc 1.260 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
339     C linear relation Phi_surf = Bo_surf*eta
340     C uniformFreeSurfLev :: TRUE if free-surface level-index is uniform (=1)
341 cnh 1.63 C exactConserv :: Set to true to conserve exactly the total Volume
342 dfer 1.194 C linFSConserveTr :: Set to true to correct source/sink of tracer
343 jmc 1.206 C at the surface due to Linear Free Surface
344 jmc 1.260 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
345     C as a real Fresh Water (=> changes the Sea Level)
346     C if F, converts P+R-E to salt flux (no SL effect)
347 jmc 1.282 C storePhiHyd4Phys :: store hydrostatic potential for use in Physics/EOS
348     C this requires specific code for restart & exchange
349 jmc 1.215 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
350     C nonHydrostatic :: Using non-hydrostatic algorithm
351     C use3Dsolver :: set to true to use 3-D pressure solver
352 jmc 1.173 C implicitIntGravWave :: treat Internal Gravity Wave implicitly
353 jmc 1.215 C staggerTimeStep :: enable a Stagger time stepping U,V (& W) then T,S
354 jmc 1.281 C applyExchUV_early :: Apply EXCH to U,V earlier, just before integr_continuity
355 jmc 1.255 C doResetHFactors :: Do reset thickness factors @ beginning of each time-step
356 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
357     C implicitViscosity :: Turns implicit vertical viscosity on
358 jmc 1.278 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
359     C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
360     C momImplVertAdv :: Turns on implicit vertical advection for Momentum
361 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
362 jmc 1.118 C useMultiDimAdvec :: True if multi-dim advection is used at least once
363 jmc 1.180 C momDissip_In_AB :: if False, put Dissipation tendency contribution
364 jmc 1.170 C out off Adams-Bashforth time stepping.
365     C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
366 jmc 1.195 C apply AB on tracer tendencies (rather than on Tracer)
367 jmc 1.215 C- Other forcing params -
368     C balanceEmPmR :: substract global mean of EmPmR at every time step
369     C balanceQnet :: substract global mean of Qnet at every time step
370     C balancePrintMean:: print substracted global means to STDOUT
371 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
372 cnh 1.18 C climatology is required.
373 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
374 cnh 1.18 C climatology is required.
375 gforget 1.263 C balanceThetaClimRelax :: substract global mean effect at every time step
376     C balanceSaltClimRelax :: substract global mean effect at every time step
377 jmc 1.215 C allowFreezing :: Allows surface water to freeze and form ice
378 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
379 jmc 1.215 C- I/O parameters -
380 jmc 1.238 C globalFiles :: Selects between "global" and "tiled" files.
381     C On some platforms with MPI, option globalFiles is either
382     C slow or does not work. Use useSingleCpuIO instead.
383     C useSingleCpuIO :: moved to EEPARAMS.h
384 jmc 1.215 C pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
385     C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
386     C usePickupBeforeC54 :: start from old-pickup files, generated with code from
387     C before checkpoint-54a, Jul 06, 2004.
388 edhill 1.124 C pickup_write_mdsio :: use mdsio to write pickups
389     C pickup_read_mdsio :: use mdsio to read pickups
390     C pickup_write_immed :: echo the pickup immediately (for conversion)
391 mlosch 1.213 C writePickupAtEnd :: write pickup at the last timestep
392 edhill 1.124 C timeave_mdsio :: use mdsio for timeave output
393     C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
394 edhill 1.125 C monitor_stdio :: use stdio for monitor output
395 jmc 1.206 C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
396 jmc 1.164 C & Last iteration, in addition multiple of dumpFreq iter.
397 jmc 1.246 C printDomain :: controls printing of domain fields (bathy, hFac ...).
398 mlosch 1.177
399 jmc 1.215 COMMON /PARM_L/
400     & fluidIsAir, fluidIsWater,
401 jmc 1.282 & usingPCoords, usingZCoords,
402 jmc 1.215 & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
403 jmc 1.265 & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
404 jmc 1.192 & deepAtmosphere, setInterFDr, setCenterDr,
405 jmc 1.278 & no_slip_sides, no_slip_bottom, bottomVisc_pCell, useSmag3D,
406 jmc 1.215 & useFullLeith, useStrainTensionVisc, useAreaViscLength,
407     & momViscosity, momAdvection, momForcing,
408     & momPressureForcing, metricTerms, useNHMTerms,
409     & useCoriolis, use3dCoriolis,
410     & useCDscheme, vectorInvariantMomentum,
411     & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
412     & upwindVorticity, highOrderVorticity,
413     & useAbsVorticity, upwindShear,
414 jmc 1.254 & momStepping, calc_wVelocity, tempStepping, saltStepping,
415 jmc 1.266 & addFrictionHeating,
416 jmc 1.261 & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
417     & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
418 jmc 1.230 & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
419 jmc 1.260 & useSRCGSolver,
420     & rigidLid, implicitFreeSurface,
421     & uniformLin_PhiSurf, uniformFreeSurfLev,
422     & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
423 jmc 1.282 & storePhiHyd4Phys, quasiHydrostatic, nonHydrostatic,
424     & use3Dsolver, implicitIntGravWave, staggerTimeStep,
425 jmc 1.281 & applyExchUV_early, doResetHFactors,
426 jmc 1.284 & implicitDiffusion, implicitViscosity,
427 jmc 1.100 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
428 jmc 1.183 & multiDimAdvection, useMultiDimAdvec,
429 jmc 1.180 & momDissip_In_AB, doAB_onGtGs,
430 jmc 1.215 & balanceEmPmR, balanceQnet, balancePrintMean,
431 gforget 1.263 & balanceThetaClimRelax, balanceSaltClimRelax,
432 jmc 1.215 & doThetaClimRelax, doSaltClimRelax,
433 jmc 1.272 & allowFreezing,
434 jmc 1.183 & periodicExternalForcing,
435 jmc 1.238 & globalFiles,
436 jmc 1.206 & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
437 edhill 1.124 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
438 mlosch 1.213 & writePickupAtEnd,
439 edhill 1.155 & timeave_mdsio, snapshot_mdsio, monitor_stdio,
440 jmc 1.246 & outputTypesInclusive, dumpInitAndLast,
441 jmc 1.264 & printDomain
442 edhill 1.131
443 jmc 1.215 LOGICAL fluidIsAir
444     LOGICAL fluidIsWater
445     LOGICAL usingPCoords
446     LOGICAL usingZCoords
447 cnh 1.1 LOGICAL usingCartesianGrid
448 jmc 1.215 LOGICAL usingSphericalPolarGrid, rotateGrid
449 afe 1.114 LOGICAL usingCylindricalGrid
450 jmc 1.265 LOGICAL usingCurvilinearGrid, hasWetCSCorners
451 jmc 1.192 LOGICAL deepAtmosphere
452 jmc 1.191 LOGICAL setInterFDr
453     LOGICAL setCenterDr
454 jmc 1.266
455 adcroft 1.36 LOGICAL no_slip_sides
456     LOGICAL no_slip_bottom
457 jmc 1.278 LOGICAL bottomVisc_pCell
458 jmc 1.270 LOGICAL useSmag3D
459 jmc 1.246 LOGICAL useFullLeith
460     LOGICAL useStrainTensionVisc
461     LOGICAL useAreaViscLength
462 cnh 1.1 LOGICAL momViscosity
463     LOGICAL momAdvection
464     LOGICAL momForcing
465 cnh 1.9 LOGICAL momPressureForcing
466 jmc 1.266 LOGICAL metricTerms
467     LOGICAL useNHMTerms
468    
469 cnh 1.1 LOGICAL useCoriolis
470 jmc 1.266 LOGICAL use3dCoriolis
471     LOGICAL useCDscheme
472 adcroft 1.58 LOGICAL vectorInvariantMomentum
473 jmc 1.266 LOGICAL useEnergyConservingCoriolis
474     LOGICAL useJamartWetPoints
475     LOGICAL useJamartMomAdv
476     LOGICAL upwindVorticity
477     LOGICAL highOrderVorticity
478     LOGICAL useAbsVorticity
479     LOGICAL upwindShear
480     LOGICAL momStepping
481     LOGICAL calc_wVelocity
482     LOGICAL tempStepping
483     LOGICAL saltStepping
484     LOGICAL addFrictionHeating
485 cnh 1.1 LOGICAL tempAdvection
486 jmc 1.261 LOGICAL tempVertDiff4
487 jmc 1.216 LOGICAL tempIsActiveTr
488 cnh 1.1 LOGICAL tempForcing
489     LOGICAL saltAdvection
490 jmc 1.261 LOGICAL saltVertDiff4
491 jmc 1.216 LOGICAL saltIsActiveTr
492 cnh 1.1 LOGICAL saltForcing
493 jmc 1.230 LOGICAL maskIniTemp
494     LOGICAL maskIniSalt
495     LOGICAL checkIniTemp
496     LOGICAL checkIniSalt
497 jmc 1.246 LOGICAL useSRCGSolver
498 adcroft 1.52 LOGICAL rigidLid
499 cnh 1.8 LOGICAL implicitFreeSurface
500 jmc 1.260 LOGICAL uniformLin_PhiSurf
501     LOGICAL uniformFreeSurfLev
502 adcroft 1.52 LOGICAL exactConserv
503 dfer 1.194 LOGICAL linFSConserveTr
504 jmc 1.260 LOGICAL useRealFreshWaterFlux
505 jmc 1.282 LOGICAL storePhiHyd4Phys
506 jmc 1.215 LOGICAL quasiHydrostatic
507     LOGICAL nonHydrostatic
508 jmc 1.178 LOGICAL use3Dsolver
509 jmc 1.173 LOGICAL implicitIntGravWave
510     LOGICAL staggerTimeStep
511 jmc 1.281 LOGICAL applyExchUV_early
512 jmc 1.255 LOGICAL doResetHFactors
513 adcroft 1.14 LOGICAL implicitDiffusion
514 adcroft 1.40 LOGICAL implicitViscosity
515 jmc 1.183 LOGICAL tempImplVertAdv
516     LOGICAL saltImplVertAdv
517 jmc 1.100 LOGICAL momImplVertAdv
518 jmc 1.71 LOGICAL multiDimAdvection
519 jmc 1.118 LOGICAL useMultiDimAdvec
520 jmc 1.180 LOGICAL momDissip_In_AB
521 jmc 1.170 LOGICAL doAB_onGtGs
522 jmc 1.215 LOGICAL balanceEmPmR
523     LOGICAL balanceQnet
524     LOGICAL balancePrintMean
525 cnh 1.18 LOGICAL doThetaClimRelax
526     LOGICAL doSaltClimRelax
527 gforget 1.263 LOGICAL balanceThetaClimRelax
528     LOGICAL balanceSaltClimRelax
529 jmc 1.215 LOGICAL allowFreezing
530 adcroft 1.19 LOGICAL periodicExternalForcing
531 adcroft 1.38 LOGICAL globalFiles
532 jmc 1.206 LOGICAL pickupStrictlyMatch
533 jmc 1.117 LOGICAL usePickupBeforeC54
534 jmc 1.154 LOGICAL startFromPickupAB2
535 edhill 1.124 LOGICAL pickup_read_mdsio, pickup_write_mdsio
536 mlosch 1.213 LOGICAL pickup_write_immed, writePickupAtEnd
537 edhill 1.125 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
538 edhill 1.133 LOGICAL outputTypesInclusive
539 jmc 1.215 LOGICAL dumpInitAndLast
540 jmc 1.251 LOGICAL printDomain
541 cnh 1.1
542     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
543 jmc 1.119 C cg2dTargetResidual
544 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
545 adcroft 1.52 C cg2dTargetResWunit
546 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
547 cnh 1.33 C cg3dTargetResidual
548 cnh 1.63 C :: Target residual for cg3d solver.
549     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
550 cnh 1.7 C Note. 20th May 1998
551     C I made a weird discovery! In the model paper we argue
552     C for the form of the preconditioner used here ( see
553     C A Finite-volume, Incompressible Navier-Stokes Model
554     C ...., Marshall et. al ). The algebra gives a simple
555     C 0.5 factor for the averaging of ac and aCw to get a
556     C symmettric pre-conditioner. By using a factor of 0.51
557     C i.e. scaling the off-diagonal terms in the
558     C preconditioner down slightly I managed to get the
559     C number of iterations for convergence in a test case to
560     C drop form 192 -> 134! Need to investigate this further!
561     C For now I have introduced a parameter cg2dpcOffDFac which
562     C defaults to 0.51 but can be set at runtime.
563 cnh 1.63 C delR :: Vertical grid spacing ( units of r ).
564 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
565 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
566 jmc 1.256 C delY on input flags. Note: moved to header file SET_GRID.h
567 jmc 1.247 C xgOrigin :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
568     C :: most cell face (Lat-Lon grid) (Note: this is an "inert"
569     C :: parameter but it makes geographical references simple.)
570     C ygOrigin :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
571     C :: most face (Lat-Lon grid).
572 jmc 1.283 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
573     C recip_rSphere :: Reciprocal radius of sphere ( m^-1 ).
574     C radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
575     C seaLev_Z :: the reference height of sea-level (usually zero)
576     C top_Pres :: pressure (P-Coords) or reference pressure (Z-Coords) at the top
577 jmc 1.282 C rSigmaBnd :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
578     C gravity :: Acceleration due to constant gravity ( m/s^2 )
579     C recip_gravity :: Reciprocal gravity acceleration ( s^2/m )
580 jmc 1.274 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
581 jmc 1.282 C gravFacC :: gravity factor (vs surf. gravity) vert. profile at cell-Center
582     C gravFacF :: gravity factor (vs surf. gravity) vert. profile at cell-interF
583 jmc 1.274 C rhoNil :: Reference density for the linear equation of state
584     C rhoConst :: Vertically constant reference density (Boussinesq)
585 jmc 1.282 C rho1Ref :: reference vertical profile for density (anelastic)
586 jmc 1.274 C rhoFacC :: normalized (by rhoConst) reference density at cell-Center
587     C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace
588 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
589 jmc 1.282 C thetaConst :: Constant reference for potential temperature
590 jmc 1.274 C tRef :: reference vertical profile for potential temperature
591     C sRef :: reference vertical profile for salinity/specific humidity
592 jmc 1.282 C pRef4EOS :: reference pressure used in EOS (case selectP_inEOS_Zc=1)
593     C phiRef :: reference potential (press/rho, geopot) profile (m^2/s^2)
594 jmc 1.274 C dBdrRef :: vertical gradient of reference buoyancy [(m/s/r)^2]:
595     C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
596     C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2]
597 jmc 1.197 C rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
598     C :: from r-coordinate vertical velocity to vertical velocity [m/s].
599     C :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
600     C wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
601     C :: from vertical velocity [m/s] to r-coordinate vertical velocity.
602     C :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
603 jmc 1.203 C mass2rUnit :: units conversion factor (surface forcing),
604     C :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
605     C :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
606     C :: p-coord: = gravity ( [kg/m2] * g = [Pa] ) ;
607     C rUnit2mass :: units conversion factor (surface forcing),
608     C :: from vertical r-coordinate unit to mass per unit area [kg/m2].
609     C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ;
610     C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ;
611 jmc 1.227 C f0 :: Reference coriolis parameter ( 1/s )
612     C ( Southern edge f for beta plane )
613     C beta :: df/dy ( s^-1.m^-1 )
614 jmc 1.243 C fPrime :: Second Coriolis parameter ( 1/s ), related to Y-component
615     C of rotation (reference value = 2.Omega.Cos(Phi))
616 jmc 1.227 C omega :: Angular velocity ( rad/s )
617 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
618 jmc 1.229 C viscArNr :: vertical profile of Eddy viscosity coeff.
619     C for vertical mixing of momentum ( units of r^2/s )
620 jmc 1.227 C viscAh :: Eddy viscosity coeff. for mixing of
621     C momentum laterally ( m^2/s )
622     C viscAhW :: Eddy viscosity coeff. for mixing of vertical
623     C momentum laterally, no effect for hydrostatic
624 jmc 1.270 C model, defaults to viscAhD if unset ( m^2/s )
625 jmc 1.227 C Not used if variable horiz. viscosity is used.
626     C viscA4 :: Biharmonic viscosity coeff. for mixing of
627     C momentum laterally ( m^4/s )
628     C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
629     C momentum laterally, no effect for hydrostatic
630 jmc 1.270 C model, defaults to viscA4D if unset ( m^2/s )
631 jmc 1.227 C Not used if variable horiz. viscosity is used.
632     C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
633     C (act on Divergence part) ( m^2/s )
634     C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
635     C (act on Vorticity part) ( m^2/s )
636     C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
637     C (act on Divergence part) ( m^4/s )
638     C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
639     C (act on Vorticity part) ( m^4/s )
640 jmc 1.270 C smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
641 jmc 1.214 C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
642 baylor 1.166 C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
643 jmc 1.214 C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
644     C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
645     C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic)
646     C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic)
647     C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
648     C momentum laterally ( m^2/s )
649     C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
650     C coeff. for mixing of momentum laterally (non-dim)
651     C viscAhGrid :: non-dimensional grid-size dependent viscosity
652 baylor 1.146 C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
653 baylor 1.166 C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc.
654 jmc 1.214 C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
655     C momentum laterally ( m^4/s )
656     C viscA4ReMax :: Maximum Gridscale Reynolds number for
657     C biharmonic viscosity coeff. momentum laterally (non-dim)
658     C viscA4Grid :: non-dimensional grid-size dependent bi-harmonic viscosity
659 dimitri 1.136 C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
660     C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
661 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
662 cnh 1.1 C heat laterally ( m^2/s )
663 jmc 1.261 C diffK4T :: Biharmonic diffusion coeff. for mixing of
664     C heat laterally ( m^4/s )
665 jmc 1.214 C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
666 jmc 1.132 C for mixing of heat vertically ( units of r^2/s )
667 jmc 1.261 C diffKr4T :: vertical profile of Biharmonic diffusion coeff.
668     C for mixing of heat vertically ( units of r^4/s )
669 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
670 cnh 1.1 C salt laterally ( m^2/s )
671 jmc 1.261 C diffK4S :: Biharmonic diffusion coeff. for mixing of
672     C salt laterally ( m^4/s )
673 jmc 1.214 C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
674     C for mixing of salt vertically ( units of r^2/s ),
675 jmc 1.261 C diffKr4S :: vertical profile of Biharmonic diffusion coeff.
676     C for mixing of salt vertically ( units of r^4/s )
677 adcroft 1.112 C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
678     C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
679     C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
680     C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
681 dimitri 1.201 C BL79LatVary :: polarwise of this latitude diffKrBL79 is applied with
682     C gradual transition to diffKrBLEQ towards Equator
683     C diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
684     C diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
685     C diffKrBLEQscl :: same as diffKrBL79scl but at Equator
686     C diffKrBLEQHo :: same as diffKrBL79Ho but at Equator
687 cnh 1.63 C deltaT :: Default timestep ( s )
688     C deltaTClock :: Timestep used as model "clock". This determines the
689 cnh 1.7 C IO frequencies and is used in tagging output. It can
690     C be totally different to the dynamical time. Typically
691     C it will be the deep-water timestep for accelerated runs.
692     C Frequency of checkpointing and dumping of the model state
693     C are referenced to this clock. ( s )
694 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
695 jmc 1.139 C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
696 jmc 1.266 C deltaTFreeSurf :: Timestep for free-surface equation ( s )
697 jmc 1.260 C freeSurfFac :: Parameter to turn implicit free surface term on or off
698     C freeSurFac = 1. uses implicit free surface
699     C freeSurFac = 0. uses rigid lid
700 jmc 1.154 C abEps :: Adams-Bashforth-2 stabilizing weight
701     C alph_AB :: Adams-Bashforth-3 primary factor
702     C beta_AB :: Adams-Bashforth-3 secondary factor
703 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
704 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
705 jmc 1.284 C implicDiv2DFlow :: parameter of the Crank-Nickelson time stepping :
706 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
707 jmc 1.233 C implicitNHPress :: parameter of the Crank-Nickelson time stepping :
708     C Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
709 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
710 jmc 1.231 C hFacMinDz :: Minimum dimensional size of a cell (affects hFacC etc..., m)
711     C hFacMinDp :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
712     C hFacMinDr :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
713 cnh 1.63 C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
714 jmc 1.231 C hFacSup that control vanishing and creating levels
715     C tauCD :: CD scheme coupling timescale ( s )
716     C rCD :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
717     C epsAB_CD :: Adams-Bashforth-2 stabilizing weight used in CD scheme
718 jmc 1.150 C baseTime :: model base time (time origin) = time @ iteration zero
719 cnh 1.63 C startTime :: Starting time for this integration ( s ).
720     C endTime :: Ending time for this integration ( s ).
721     C chkPtFreq :: Frequency of rolling check pointing ( s ).
722     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
723     C dumpFreq :: Frequency with which model state is written to
724 jmc 1.260 C post-processing files ( s ).
725 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
726 jmc 1.260 C of intermediate quantities.
727 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
728     C vfFacMom :: Momentum viscosity tracer parameter
729     C pfFacMom :: Momentum pressure forcing tracer parameter
730     C cfFacMom :: Coriolis term tracer parameter
731     C foFacMom :: Momentum forcing tracer parameter
732     C mtFacMom :: Metric terms tracer parameter
733     C cosPower :: Power of cosine of latitude to multiply viscosity
734     C cAdjFreq :: Frequency of convective adjustment
735 cnh 1.24 C
736 jmc 1.214 C taveFreq :: Frequency with which time-averaged model state
737 jmc 1.76 C is written to post-processing files ( s ).
738 jmc 1.214 C tave_lastIter :: (for state variable only) fraction of the last time
739     C step (of each taveFreq period) put in the time average.
740 jmc 1.76 C (fraction for 1rst iter = 1 - tave_lastIter)
741 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
742     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
743 jmc 1.95 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
744     C i.e. where |yC| <= latBandClimRelax
745 cnh 1.63 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
746     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
747 adcroft 1.19 C (note: externForcingCycle must be an integer
748     C number times externForcingPeriod)
749 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
750     C (use model surface (local) value if set to -1)
751 jmc 1.214 C temp_EvPrRn :: temperature of Rain & Evap.
752 jmc 1.68 C salt_EvPrRn :: salinity of Rain & Evap.
753 dimitri 1.237 C temp_addMass :: temperature of addMass array
754     C salt_addMass :: salinity of addMass array
755 jmc 1.214 C (notes: a) tracer content of Rain/Evap only used if both
756 jmc 1.68 C NonLin_FrSurf & useRealFreshWater are set.
757     C b) use model surface (local) value if set to UNSET_RL)
758 dfer 1.225 C hMixCriteria:: criteria for mixed-layer diagnostic
759     C dRhoSmall :: parameter for mixed-layer diagnostic
760 dfer 1.226 C hMixSmooth :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
761 jmc 1.202 C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s]
762 jmc 1.214 C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides)
763 jmc 1.169 C (default=2: full drag ; =1: gives half-slip BC)
764 jmc 1.184 C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s)
765     C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
766     C (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
767 heimbach 1.185 C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
768     C is to be replace by a smoother function
769     C (affects myabs, mymin, mymax)
770 jmc 1.169 C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales
771     C (i.e. allows convection at different Rayleigh numbers)
772 jmc 1.266 C tCylIn :: Temperature of the cylinder inner boundary
773     C tCylOut :: Temperature of the cylinder outer boundary
774 mlosch 1.212 C phiEuler :: Euler angle, rotation about original z-axis
775     C thetaEuler :: Euler angle, rotation about new x-axis
776     C psiEuler :: Euler angle, rotation about new z-axis
777 jmc 1.183 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
778 adcroft 1.52 & cg2dpcOffDFac, cg3dTargetResidual,
779 jmc 1.283 & delR, delRc, xgOrigin, ygOrigin, rSphere, recip_rSphere,
780     & radius_fromHorizGrid, seaLev_Z, top_Pres, rSigmaBnd,
781 jmc 1.266 & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
782 jmc 1.154 & abEps, alph_AB, beta_AB,
783 jmc 1.243 & f0, beta, fPrime, omega, rotationPeriod,
784 jmc 1.270 & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
785     & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
786 baylor 1.146 & viscC2leith, viscC2leithD,
787 baylor 1.165 & viscC2smag, viscC4smag,
788 jmc 1.135 & viscAhD, viscAhZ, viscA4D, viscA4Z,
789 jmc 1.214 & viscA4, viscA4W, viscA4Max,
790     & viscA4Grid, viscA4GridMax, viscA4GridMin,
791     & viscAhReMax, viscA4ReMax,
792 jmc 1.229 & viscC4leith, viscC4leithD, viscArNr,
793 jmc 1.261 & diffKhT, diffK4T, diffKrNrT, diffKr4T,
794     & diffKhS, diffK4S, diffKrNrS, diffKr4S,
795 adcroft 1.112 & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
796 dimitri 1.201 & BL79LatVary,
797 dimitri 1.200 & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
798 jmc 1.231 & tauCD, rCD, epsAB_CD,
799 jmc 1.284 & freeSurfFac, implicSurfPress, implicDiv2DFlow, implicitNHPress,
800 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
801 jmc 1.203 & gravity, recip_gravity, gBaro,
802 jmc 1.282 & gravFacC, recip_gravFacC, gravFacF, recip_gravFacF,
803     & rhoNil, rhoConst, recip_rhoConst, rho1Ref,
804     & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF, rhoConstFresh,
805 jmc 1.283 & thetaConst, tRef, sRef, pRef4EOS, phiRef, dBdrRef,
806 jmc 1.203 & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
807 jmc 1.183 & baseTime, startTime, endTime,
808     & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
809 heimbach 1.143 & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
810 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
811 jmc 1.243 & cosPower, cAdjFreq,
812 jmc 1.215 & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
813 cnh 1.27 & externForcingCycle, externForcingPeriod,
814 jmc 1.137 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
815 dimitri 1.237 & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
816 jmc 1.239 & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
817 jmc 1.169 & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
818 jmc 1.191 & smoothAbsFuncRange,
819 mlosch 1.212 & tCylIn, tCylOut,
820     & phiEuler, thetaEuler, psiEuler
821 cnh 1.27
822 adcroft 1.6 _RL cg2dTargetResidual
823 adcroft 1.52 _RL cg2dTargetResWunit
824 cnh 1.33 _RL cg3dTargetResidual
825 cnh 1.7 _RL cg2dpcOffDFac
826 cnh 1.25 _RL delR(Nr)
827 jmc 1.70 _RL delRc(Nr+1)
828 jmc 1.247 _RL xgOrigin
829     _RL ygOrigin
830 jmc 1.283 _RL rSphere
831     _RL recip_rSphere
832     _RL radius_fromHorizGrid
833     _RL seaLev_Z
834     _RL top_Pres
835 jmc 1.282 _RL rSigmaBnd
836 adcroft 1.6 _RL deltaT
837 cnh 1.7 _RL deltaTClock
838 jmc 1.266 _RL deltaTMom
839 jmc 1.139 _RL dTtracerLev(Nr)
840 jmc 1.266 _RL deltaTFreeSurf
841 jmc 1.154 _RL abEps, alph_AB, beta_AB
842 adcroft 1.6 _RL f0
843 jmc 1.243 _RL beta
844     _RL fPrime
845     _RL omega
846     _RL rotationPeriod
847 cnh 1.8 _RL freeSurfFac
848 jmc 1.48 _RL implicSurfPress
849 jmc 1.284 _RL implicDiv2DFlow
850 jmc 1.233 _RL implicitNHPress
851 adcroft 1.22 _RL hFacMin
852     _RL hFacMinDz
853 cnh 1.28 _RL hFacMinDp
854 cnh 1.27 _RL hFacMinDr
855 adcroft 1.52 _RL hFacInf
856     _RL hFacSup
857 jmc 1.229 _RL viscArNr(Nr)
858 heimbach 1.241 _RL viscFacAdj
859 adcroft 1.6 _RL viscAh
860 mlosch 1.128 _RL viscAhW
861 jmc 1.135 _RL viscAhD
862     _RL viscAhZ
863 jmc 1.270 _RL smag3D_coeff
864 adcroft 1.102 _RL viscAhMax
865 baylor 1.166 _RL viscAhReMax
866 jmc 1.214 _RL viscAhGrid, viscAhGridMax, viscAhGridMin
867 adcroft 1.110 _RL viscC2leith
868 baylor 1.146 _RL viscC2leithD
869 baylor 1.147 _RL viscC2smag
870 jmc 1.183 _RL viscA4
871 mlosch 1.140 _RL viscA4W
872 jmc 1.135 _RL viscA4D
873     _RL viscA4Z
874 adcroft 1.102 _RL viscA4Max
875 baylor 1.166 _RL viscA4ReMax
876 dimitri 1.136 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
877 adcroft 1.110 _RL viscC4leith
878 baylor 1.146 _RL viscC4leithD
879 jmc 1.214 _RL viscC4smag
880 jmc 1.183 _RL diffKhT
881 jmc 1.261 _RL diffK4T
882 jmc 1.132 _RL diffKrNrT(Nr)
883 jmc 1.261 _RL diffKr4T(Nr)
884 jmc 1.183 _RL diffKhS
885 jmc 1.261 _RL diffK4S
886 jmc 1.132 _RL diffKrNrS(Nr)
887 jmc 1.261 _RL diffKr4S(Nr)
888 adcroft 1.112 _RL diffKrBL79surf
889     _RL diffKrBL79deep
890     _RL diffKrBL79scl
891     _RL diffKrBL79Ho
892 dimitri 1.201 _RL BL79LatVary
893 dimitri 1.200 _RL diffKrBLEQsurf
894     _RL diffKrBLEQdeep
895     _RL diffKrBLEQscl
896     _RL diffKrBLEQHo
897 jmc 1.231 _RL tauCD, rCD, epsAB_CD
898 jmc 1.282 _RL gravity, recip_gravity
899 cnh 1.8 _RL gBaro
900 jmc 1.282 _RL gravFacC(Nr), recip_gravFacC(Nr)
901     _RL gravFacF(Nr+1), recip_gravFacF(Nr+1)
902 jmc 1.257 _RL rhoNil
903 jmc 1.191 _RL rhoConst, recip_rhoConst
904 jmc 1.282 _RL rho1Ref(Nr)
905 jmc 1.191 _RL rhoFacC(Nr), recip_rhoFacC(Nr)
906     _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
907 mlosch 1.75 _RL rhoConstFresh
908 jmc 1.282 _RL thetaConst
909 cnh 1.25 _RL tRef(Nr)
910     _RL sRef(Nr)
911 jmc 1.282 _RL pRef4EOS(Nr)
912 jmc 1.171 _RL phiRef(2*Nr+1)
913 jmc 1.173 _RL dBdrRef(Nr)
914 jmc 1.197 _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
915 jmc 1.203 _RL mass2rUnit, rUnit2mass
916 jmc 1.150 _RL baseTime
917 adcroft 1.6 _RL startTime
918     _RL endTime
919     _RL chkPtFreq
920 cnh 1.7 _RL pChkPtFreq
921 adcroft 1.6 _RL dumpFreq
922 heimbach 1.103 _RL adjDumpFreq
923 adcroft 1.59 _RL diagFreq
924 adcroft 1.20 _RL taveFreq
925 jmc 1.76 _RL tave_lastIter
926 adcroft 1.53 _RL monitorFreq
927 heimbach 1.143 _RL adjMonitorFreq
928 cnh 1.9 _RL afFacMom
929     _RL vfFacMom
930     _RL pfFacMom
931     _RL cfFacMom
932     _RL foFacMom
933 jmc 1.182 _RL mtFacMom
934 adcroft 1.39 _RL cosPower
935 cnh 1.9 _RL cAdjFreq
936 cnh 1.18 _RL tauThetaClimRelax
937     _RL tauSaltClimRelax
938 jmc 1.95 _RL latBandClimRelax
939 adcroft 1.19 _RL externForcingCycle
940     _RL externForcingPeriod
941 jmc 1.68 _RL convertFW2Salt
942     _RL temp_EvPrRn
943     _RL salt_EvPrRn
944 dimitri 1.237 _RL temp_addMass
945     _RL salt_addMass
946 adcroft 1.41 _RL ivdc_kappa
947 jmc 1.202 _RL hMixCriteria
948 dfer 1.225 _RL dRhoSmall
949 dfer 1.226 _RL hMixSmooth
950 jmc 1.169 _RL sideDragFactor
951 adcroft 1.46 _RL bottomDragLinear
952     _RL bottomDragQuadratic
953 heimbach 1.185 _RL smoothAbsFuncRange
954 jmc 1.169 _RL nh_Am2
955 jmc 1.266 _RL tCylIn, tCylOut
956 mlosch 1.212 _RL phiEuler, thetaEuler, psiEuler
957 adcroft 1.6
958 jmc 1.91 C-- COMMON /PARM_A/ Thermodynamics constants ?
959 jmc 1.274 COMMON /PARM_A/ HeatCapacity_Cp
960 adcroft 1.6 _RL HeatCapacity_Cp
961 jmc 1.55
962 jmc 1.91 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
963     C celsius2K :: convert centigrade (Celsius) degree to Kelvin
964 jmc 1.83 C atm_Po :: standard reference pressure
965     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
966     C atm_Rd :: gas constant for dry air
967 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
968 jmc 1.94 C atm_Rq :: water vapour specific volume anomaly relative to dry air
969     C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
970 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
971 jmc 1.214 C (still a subject of discussions ...)
972 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
973     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
974 jmc 1.183 COMMON /PARM_ATM/
975 jmc 1.91 & celsius2K,
976 jmc 1.94 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
977 jmc 1.91 & integr_GeoPot, selectFindRoSurf
978     _RL celsius2K
979 jmc 1.94 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
980 jmc 1.83 INTEGER integr_GeoPot, selectFindRoSurf
981 cnh 1.7
982 adcroft 1.44 C Logical flags for selecting packages
983 jmc 1.220 LOGICAL useGAD
984     LOGICAL useOBCS
985     LOGICAL useSHAP_FILT
986     LOGICAL useZONAL_FILT
987 mlosch 1.126 LOGICAL useOPPS
988 mlosch 1.121 LOGICAL usePP81
989 jmc 1.275 LOGICAL useKL10
990 mlosch 1.121 LOGICAL useMY82
991 mlosch 1.126 LOGICAL useGGL90
992 heimbach 1.45 LOGICAL useKPP
993     LOGICAL useGMRedi
994 jmc 1.220 LOGICAL useDOWN_SLOPE
995 dimitri 1.253 LOGICAL useBBL
996 jmc 1.183 LOGICAL useCAL
997     LOGICAL useEXF
998 jmc 1.220 LOGICAL useBulkForce
999 jmc 1.183 LOGICAL useEBM
1000 jmc 1.220 LOGICAL useCheapAML
1001 gforget 1.279 LOGICAL useAUTODIFF
1002 heimbach 1.56 LOGICAL useGrdchk
1003 jmc 1.231 LOGICAL useSMOOTH
1004 gforget 1.262 LOGICAL usePROFILES
1005 heimbach 1.45 LOGICAL useECCO
1006 gforget 1.277 LOGICAL useCTRL
1007 jmc 1.220 LOGICAL useSBO
1008 adcroft 1.62 LOGICAL useFLT
1009 adcroft 1.69 LOGICAL usePTRACERS
1010 mlosch 1.138 LOGICAL useGCHEM
1011 stephd 1.172 LOGICAL useRBCS
1012 jmc 1.181 LOGICAL useOffLine
1013 jmc 1.183 LOGICAL useMATRIX
1014 dimitri 1.259 LOGICAL useFRAZIL
1015 heimbach 1.80 LOGICAL useSEAICE
1016 jmc 1.220 LOGICAL useSALT_PLUME
1017 mlosch 1.176 LOGICAL useShelfIce
1018 heimbach 1.258 LOGICAL useStreamIce
1019 dimitri 1.235 LOGICAL useICEFRONT
1020 jmc 1.183 LOGICAL useThSIce
1021 jmc 1.269 LOGICAL useLand
1022 jscott 1.190 LOGICAL useATM2d
1023 jmc 1.220 LOGICAL useAIM
1024 jmc 1.269 LOGICAL useAtm_Phys
1025 jmc 1.220 LOGICAL useFizhi
1026     LOGICAL useGridAlt
1027 jmc 1.179 LOGICAL useDiagnostics
1028 jmc 1.220 LOGICAL useREGRID
1029 rpa 1.228 LOGICAL useLayers
1030 edhill 1.130 LOGICAL useMNC
1031 adcroft 1.158 LOGICAL useRunClock
1032 edhill 1.175 LOGICAL useEMBED_FILES
1033 heimbach 1.187 LOGICAL useMYPACKAGE
1034 adcroft 1.44 COMMON /PARM_PACKAGES/
1035 jmc 1.220 & useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
1036 jmc 1.275 & useOPPS, usePP81, useKL10, useMY82, useGGL90, useKPP,
1037 jmc 1.278 & useGMRedi, useBBL, useDOWN_SLOPE,
1038 jmc 1.220 & useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
1039 jmc 1.278 & useGrdchk, useSMOOTH, usePROFILES, useECCO, useCTRL,
1040 gforget 1.279 & useSBO, useFLT, useAUTODIFF,
1041 jmc 1.183 & usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
1042 dimitri 1.259 & useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
1043 jmc 1.269 & useStreamIce, useICEFRONT, useThSIce, useLand,
1044     & useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt,
1045 rpa 1.228 & useDiagnostics, useREGRID, useLayers, useMNC,
1046 jmc 1.220 & useRunClock, useEMBED_FILES,
1047 jmc 1.219 & useMYPACKAGE
1048 mlosch 1.245
1049 edhill 1.105 CEH3 ;;; Local Variables: ***
1050     CEH3 ;;; mode:fortran ***
1051     CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22