/[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.233 - (hide annotations) (download)
Sun Nov 29 03:06:25 2009 UTC (14 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint61z
Changes since 1.232: +5 -2 lines
File MIME type: text/plain
new parameter "implicitNHPress" (similar to implicSurfPress but for
 Non-Hydrostatic pressure gradient)

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

  ViewVC Help
Powered by ViewVC 1.1.22