/[MITgcm]/MITgcm_contrib/ksnow/press_release/code/PARAMS.h
ViewVC logotype

Annotation of /MITgcm_contrib/ksnow/press_release/code/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.4 - (hide annotations) (download)
Tue Jul 11 13:41:37 2017 UTC (8 years ago) by dgoldberg
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +21 -17 lines
File MIME type: text/plain
new rwSuffixType

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

  ViewVC Help
Powered by ViewVC 1.1.22