/[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.271 - (hide annotations) (download)
Sun Aug 11 14:27:37 2013 UTC (10 years, 9 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint64q, checkpoint64p, checkpoint64m, checkpoint64o, checkpoint64n
Changes since 1.270: +1 -4 lines
File MIME type: text/plain
move FCORI_MACROS.h from PARAMS(_MACROS).h to GRID_MACROS.h (left from 8 yrs
 ago modif when Coriolis arrays were moved from PARAMS.h to GRID.h)

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

  ViewVC Help
Powered by ViewVC 1.1.22