/[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.283 - (hide annotations) (download)
Mon Apr 4 21:29:42 2016 UTC (8 years, 1 month ago) by jmc
Branch: MAIN
CVS Tags: checkpoint65z, checkpoint65x, checkpoint65y, checkpoint65v, checkpoint65w, checkpoint66a
Changes since 1.282: +14 -15 lines
File MIME type: text/plain
- new parameters "top_Pres" & "seaLev_Z" (replacing Ro_SeaLevel and recently
  added phi0Ref) to set vertical axis origin and phiRef origin according to
  coordinate and fluid type.

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

  ViewVC Help
Powered by ViewVC 1.1.22