/[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.285 - (hide annotations) (download)
Fri Mar 24 21:55:35 2017 UTC (7 years, 1 month ago) by jmc
Branch: MAIN
Changes since 1.284: +14 -12 lines
File MIME type: text/plain
new input parameter "rwSuffixType" (Contribution from Jody Klymak)
 to select file suffix format

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

  ViewVC Help
Powered by ViewVC 1.1.22