/[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.243 - (hide annotations) (download)
Fri Nov 12 03:15:54 2010 UTC (13 years, 6 months ago) by jmc
Branch: MAIN
Changes since 1.242: +20 -16 lines
File MIME type: text/plain
- remove useConstantF, useBetaPlaneF, useSphereF and replace them
  with integer parameter "selectCoriMap" (=0,1,2).
- add parameter "fPrime" for constant second Coriolis coeff (default=0).

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

  ViewVC Help
Powered by ViewVC 1.1.22