/[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.71 - (hide annotations) (download)
Sat Jun 15 03:26:30 2002 UTC (21 years, 11 months ago) by jmc
Branch: MAIN
Changes since 1.70: +18 -14 lines
File MIME type: text/plain
 new flag to move  T,S forcing outside Adams-Bashforh

1 jmc 1.71 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.70 2002/03/07 14:05:05 jmc Exp $
2 heimbach 1.51 C $Name: $
3 cnh 1.1 C
4 cnh 1.63 CBOP
5     C !ROUTINE: PARAMS.h
6     C !INTERFACE:
7     C include PARAMS.h
8     C !DESCRIPTION: \bv
9     C *==========================================================*
10     C | PARAMS.h
11     C | o Header file defining model "parameters".
12     C *==========================================================*
13     C | The values from the model standard input file are
14     C | stored into the variables held here. Notes describing
15     C | the parameters can also be found here.
16     C *==========================================================*
17     C \ev
18     CEOP
19 cnh 1.13
20     C Macros for special grid options
21     #include "PARAMS_MACROS.h"
22 cnh 1.1
23     C-- Contants
24     C Useful physical values
25     Real*8 PI
26     PARAMETER ( PI = 3.14159265358979323844D0 )
27     Real*8 deg2rad
28     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
29    
30 cnh 1.7 C Symbolic values
31 cnh 1.63 C precXXXX :: Used to indicate what precision to use for
32 cnh 1.7 C dumping model state.
33     INTEGER precFloat32
34 adcroft 1.36 PARAMETER ( precFloat32 = 32 )
35 cnh 1.7 INTEGER precFloat64
36 adcroft 1.36 PARAMETER ( precFloat64 = 64 )
37 cnh 1.63 C UNSET_xxx :: Used to indicate variables that have not been given a value
38 cnh 1.28 Real*8 UNSET_FLOAT8
39     PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40     Real*4 UNSET_FLOAT4
41     PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42     _RL UNSET_RL
43     PARAMETER ( UNSET_RL = 1.234567D5 )
44     _RS UNSET_RS
45     PARAMETER ( UNSET_RS = 1.234567E5 )
46     INTEGER UNSET_I
47     PARAMETER ( UNSET_I = 123456789 )
48 cnh 1.7
49     C Checkpoint data
50     INTEGER maxNoChkptLev
51     PARAMETER ( maxNoChkptLev = 2 )
52    
53 cnh 1.1 C-- COMMON /PARM_C/ Character valued parameters used by the model.
54 cnh 1.63 C checkPtSuff :: List of checkpoint file suffices
55     C bathyFile :: File containing bathymetry. If not defined bathymetry
56 cnh 1.16 C is taken from inline function.
57 cnh 1.63 C topoFile :: File containing the topography of the surface (unit=m)
58 jmc 1.55 C (mainly used for the atmosphere = ground height).
59 cnh 1.63 C hydrogThetaFile :: File containing initial hydrographic data for potential
60 cnh 1.16 C temperature.
61 cnh 1.63 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
62     C zonalWindFile :: File containing zonal wind data
63     C meridWindFile :: File containing meridional wind data
64     C thetaClimFile :: File containing theta climataology used
65 cnh 1.18 C in relaxation term -lambda(theta-theta*)
66 cnh 1.63 C saltClimFile :: File containing salt climataology used
67 cnh 1.18 C in relaxation term -lambda(salt-salt*)
68 cnh 1.63 C surfQfile :: File containing surface heat flux
69     C surfQswfile :: File containing surface shortwave radiation
70     C dQdTfile :: File containing thermal relaxation coefficient
71     C EmPmRfile :: File containing surface fresh water flux
72     C buoyancyRelation :: Flag used to indicate which relation to use to
73 cnh 1.26 C get buoyancy.
74 cnh 1.16 COMMON /PARM_C/ checkPtSuff,
75 jmc 1.55 & bathyFile, topoFile,
76     & hydrogThetaFile, hydrogSaltFile,
77 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
78 adcroft 1.37 & saltClimFile, buoyancyRelation,
79 heimbach 1.45 & EmPmRfile, surfQfile, surfQswfile,
80 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
81     & dQdTfile
82 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
83 jmc 1.55 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
84 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
85     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
86     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
87     CHARACTER*(MAX_LEN_FNAM) meridWindFile
88 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
89     CHARACTER*(MAX_LEN_FNAM) saltClimFile
90 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
91 heimbach 1.45 CHARACTER*(MAX_LEN_FNAM) surfQswfile
92 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
93 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
94 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
95     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
96 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
97 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
98 cnh 1.7
99 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
100 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
101 cnh 1.1 C two-dimensional con. grad solver.
102 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
103 cnh 1.1 C in con. grad solver.
104 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
105 cnh 1.33 C three-dimensional con. grad solver.
106 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
107 cnh 1.33 C in con. grad solver.
108 cnh 1.63 C nIter0 :: Start time-step number of for this run
109     C nTimeSteps :: Number of timesteps to execute
110     C numStepsPerPickup :: For offline setup. Frequency of pickup
111 cnh 1.1 C of flow fields.
112 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
113     C writeBinaryPrec :: Precision used for writing binary files
114     C readBinaryPrec :: Precision used for reading binary files
115     C nCheckLev :: Holds current checkpoint level
116     C nonlinFreeSurf :: option related to non-linear free surface
117 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
118 cnh 1.34
119 cnh 1.1 COMMON /PARM_I/
120     & cg2dMaxIters,
121     & cg2dChkResFreq,
122 cnh 1.33 & cg3dMaxIters,
123     & cg3dChkResFreq,
124 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
125 cnh 1.7 & numStepsPerPickup,
126     & writeStatePrec, nCheckLev,
127 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
128 jmc 1.55 & nonlinFreeSurf,
129 adcroft 1.57 & tempAdvScheme, saltAdvScheme, tracerAdvScheme
130 cnh 1.1 INTEGER cg2dMaxIters
131     INTEGER cg2dChkResFreq
132 cnh 1.33 INTEGER cg3dMaxIters
133     INTEGER cg3dChkResFreq
134 cnh 1.1 INTEGER nIter0
135     INTEGER nTimeSteps
136 adcroft 1.41 INTEGER nEndIter
137 cnh 1.1 INTEGER numStepsPerPickup
138 cnh 1.7 INTEGER writeStatePrec
139     INTEGER writeBinaryPrec
140     INTEGER readBinaryPrec
141     INTEGER nCheckLev
142 jmc 1.55 INTEGER nonlinFreeSurf
143 adcroft 1.57 INTEGER tempAdvScheme
144     INTEGER saltAdvScheme
145     INTEGER tracerAdvScheme
146 cnh 1.1
147     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
148 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
149 cnh 1.1 C coordinate frame.
150 cnh 1.63 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
151 cnh 1.1 C spherical polar frame.
152 cnh 1.63 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
153     C no_slip_bottom :: Impose "no-slip" at bottom boundary.
154     C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
155     C momViscosity :: Flag which turns momentum friction terms on and off.
156     C momAdvection :: Flag which turns advection of momentum on and off.
157     C momForcing :: Flag which turns external forcing of momentum on
158 cnh 1.1 C and off.
159 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
160 cnh 1.9 C on and off.
161 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
162     C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
163     C useCoriolis :: Flag which turns the coriolis terms on and off.
164     C tempDiffusion :: Flag which turns diffusion of temperature on
165 cnh 1.1 C and off.
166 cnh 1.63 C tempAdvection :: Flag which turns advection of temperature on
167 cnh 1.1 C and off.
168 cnh 1.63 C tempForcing :: Flag which turns external forcing of temperature on
169 cnh 1.1 C and off.
170 jmc 1.71 C saltDiffusion :: Flag which turns diffusion of salinity on
171 cnh 1.1 C and off.
172 jmc 1.71 C saltAdvection :: Flag which turns advection of salinity on
173 cnh 1.1 C and off.
174 jmc 1.71 C saltForcing :: Flag which turns external forcing of salinity on
175 cnh 1.1 C and off.
176 jmc 1.71 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
177     C as a real Fresh Water (=> changes the Sea Level)
178     C if F, converts P+R-E to salt flux (no SL effect)
179 cnh 1.63 C rigidLid :: Set to true to use rigid lid
180     C implicitFreeSurface :: Set to true to use implcit free surface
181     C exactConserv :: Set to true to conserve exactly the total Volume
182     C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
183 jmc 1.55 C linear relation Phi_surf = Bo_surf*eta
184 cnh 1.63 C momStepping :: Turns momentum equation time-stepping off
185     C tempStepping :: Turns temperature equation time-stepping off
186     C saltStepping :: Turns salinity equation time-stepping off
187     C tr1Stepping :: Turns passive tracer 1 time-stepping on/off
188     C useConstantF :: Coriolis parameter set to f0
189     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
190     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
191 jmc 1.71 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
192 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
193     C implicitViscosity :: Turns implicit vertical viscosity on
194 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
195     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
196     C out off Adams-Bashforth time stepping.
197 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
198 cnh 1.18 C climatology is required.
199 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
200 cnh 1.18 C climatology is required.
201 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
202     C usingPCoords :: Set to indicate that we are working in pressure
203 cnh 1.29 C coords.
204 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
205 cnh 1.29 C coords.
206 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
207 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
208     C globalFiles :: Selects between "global" and "tiled" files
209     C allowFreezing :: Allows water to freeze and form ice
210     C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
211 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
212 adcroft 1.52 & usingCurvilinearGrid,
213 adcroft 1.36 & no_slip_sides,no_slip_bottom,
214 adcroft 1.46 & staggerTimeStep,
215 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
216 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
217     & tempDiffusion, tempAdvection, tempForcing,
218 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
219 jmc 1.68 & useRealFreshWaterFlux,
220 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
221 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
222 cnh 1.15 & metricTerms, usingSphericalPolarMTerms,
223     & useConstantF, useBetaPlaneF, useSphereF,
224 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
225 adcroft 1.40 & implicitDiffusion, implicitViscosity,
226 jmc 1.71 & multiDimAdvection, forcing_In_AB,
227 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
228 jmc 1.70 & periodicExternalForcing,
229     & usingPCoords, usingZCoords, setCenterDr,
230 adcroft 1.46 & nonHydrostatic, globalFiles,
231 heimbach 1.51 & allowFreezing, groundAtK1,
232 heimbach 1.56 & usePickupBeforeC35, debugMode,
233 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
234 cnh 1.1 LOGICAL usingCartesianGrid
235     LOGICAL usingSphericalPolarGrid
236 adcroft 1.52 LOGICAL usingCurvilinearGrid
237 cnh 1.15 LOGICAL usingSphericalPolarMTerms
238 adcroft 1.36 LOGICAL no_slip_sides
239     LOGICAL no_slip_bottom
240 adcroft 1.46 LOGICAL staggerTimeStep
241 cnh 1.1 LOGICAL momViscosity
242     LOGICAL momAdvection
243     LOGICAL momForcing
244 cnh 1.9 LOGICAL momPressureForcing
245 cnh 1.1 LOGICAL useCoriolis
246 adcroft 1.58 LOGICAL vectorInvariantMomentum
247 cnh 1.1 LOGICAL tempDiffusion
248     LOGICAL tempAdvection
249     LOGICAL tempForcing
250     LOGICAL saltDiffusion
251     LOGICAL saltAdvection
252     LOGICAL saltForcing
253 jmc 1.68 LOGICAL useRealFreshWaterFlux
254 adcroft 1.52 LOGICAL rigidLid
255 cnh 1.8 LOGICAL implicitFreeSurface
256 adcroft 1.52 LOGICAL exactConserv
257 jmc 1.55 LOGICAL uniformLin_PhiSurf
258 cnh 1.10 LOGICAL momStepping
259     LOGICAL tempStepping
260 adcroft 1.17 LOGICAL saltStepping
261 heimbach 1.56 LOGICAL tr1Stepping
262 cnh 1.15 LOGICAL metricTerms
263     LOGICAL useConstantF
264     LOGICAL useBetaPlaneF
265     LOGICAL useSphereF
266 jmc 1.71 LOGICAL useEnergyConservingCoriolis
267     LOGICAL useJamartWetPoints
268 adcroft 1.14 LOGICAL implicitDiffusion
269 adcroft 1.40 LOGICAL implicitViscosity
270 jmc 1.71 LOGICAL multiDimAdvection
271     LOGICAL forcing_In_AB
272 cnh 1.18 LOGICAL doThetaClimRelax
273     LOGICAL doSaltClimRelax
274 heimbach 1.56 LOGICAL doTr1ClimRelax
275 adcroft 1.19 LOGICAL periodicExternalForcing
276 cnh 1.29 LOGICAL usingPCoords
277     LOGICAL usingZCoords
278 jmc 1.70 LOGICAL setCenterDr
279 adcroft 1.37 LOGICAL nonHydrostatic
280 adcroft 1.38 LOGICAL globalFiles
281     LOGICAL allowFreezing
282 adcroft 1.46 LOGICAL groundAtK1
283 heimbach 1.51 LOGICAL usePickupBeforeC35
284 adcroft 1.54 LOGICAL debugMode
285 heimbach 1.56 LOGICAL readPickupWithTracer
286     LOGICAL writePickupWithTracer
287 cnh 1.1
288     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
289 adcroft 1.52 C gg2dTargetResidual
290 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
291 adcroft 1.52 C cg2dTargetResWunit
292 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
293 cnh 1.33 C cg3dTargetResidual
294 cnh 1.63 C :: Target residual for cg3d solver.
295     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
296 cnh 1.7 C Note. 20th May 1998
297     C I made a weird discovery! In the model paper we argue
298     C for the form of the preconditioner used here ( see
299     C A Finite-volume, Incompressible Navier-Stokes Model
300     C ...., Marshall et. al ). The algebra gives a simple
301     C 0.5 factor for the averaging of ac and aCw to get a
302     C symmettric pre-conditioner. By using a factor of 0.51
303     C i.e. scaling the off-diagonal terms in the
304     C preconditioner down slightly I managed to get the
305     C number of iterations for convergence in a test case to
306     C drop form 192 -> 134! Need to investigate this further!
307     C For now I have introduced a parameter cg2dpcOffDFac which
308     C defaults to 0.51 but can be set at runtime.
309 cnh 1.63 C delP :: Vertical grid spacing ( Pa ).
310     C delZ :: Vertical grid spacing ( m ).
311     C delR :: Vertical grid spacing ( units of r ).
312 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
313 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
314 cnh 1.1 C delY on input flags.
315 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
316 cnh 1.32 C recip_gravity and its inverse
317 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
318     C ronil :: Reference density
319     C rhoConst :: Vertically constant reference density
320     C startTime :: Start time for model ( s )
321     C phiMin :: Latitude of southern most cell face.
322     C thetaMin :: Longitude of western most cell face (this
323 cnh 1.1 C is an "inert" parameter but it is included
324     C to make geographical references simple.)
325 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
326     C recip_RSphere :: Reciprocal radius of sphere ( m ).
327     C f0 :: Reference coriolis parameter ( 1/s )
328 cnh 1.1 C ( Southern edge f for beta plane )
329 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
330     C omega :: Angular velocity ( rad/s )
331     C viscAh :: Eddy viscosity coeff. for mixing of
332 cnh 1.1 C momentum laterally ( m^2/s )
333 cnh 1.63 C viscAz :: Eddy viscosity coeff. for mixing of
334 cnh 1.1 C momentum vertically ( m^2/s )
335 cnh 1.63 C viscAp :: Eddy viscosity coeff. for mixing of
336 cnh 1.27 C momentum vertically ( Pa^2/s )
337 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
338 cnh 1.24 C momentum vertically ( units of r^2/s )
339 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
340 cnh 1.1 C momentum laterally ( m^4/s )
341 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
342 cnh 1.1 C heat laterally ( m^2/s )
343 cnh 1.63 C diffKzT :: Laplacian diffusion coeff. for mixing of
344 cnh 1.1 C heat vertically ( m^2/s )
345 cnh 1.63 C diffKpT :: Laplacian diffusion coeff. for mixing of
346 cnh 1.27 C heat vertically ( Pa^2/s )
347 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
348 cnh 1.24 C heat vertically ( units of r^2/s )
349 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
350 cnh 1.1 C heat laterally ( m^4/s )
351 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
352 cnh 1.1 C salt laterally ( m^2/s )
353 cnh 1.63 C diffKzS :: Laplacian diffusion coeff. for mixing of
354 cnh 1.1 C salt vertically ( m^2/s )
355 cnh 1.63 C diffKpS :: Laplacian diffusion coeff. for mixing of
356 cnh 1.27 C salt vertically ( Pa^2/s )
357 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
358 cnh 1.24 C salt vertically ( units of r^2/s )
359 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
360 cnh 1.1 C salt laterally ( m^4/s )
361 cnh 1.63 C deltaT :: Default timestep ( s )
362     C deltaTClock :: Timestep used as model "clock". This determines the
363 cnh 1.7 C IO frequencies and is used in tagging output. It can
364     C be totally different to the dynamical time. Typically
365     C it will be the deep-water timestep for accelerated runs.
366     C Frequency of checkpointing and dumping of the model state
367     C are referenced to this clock. ( s )
368 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
369     C deltaTtracer :: Timestep for tracer equations ( s )
370     C freesurfFac :: Parameter to turn implicit free surface term on or off
371 cnh 1.8 C freesurfac = 1. uses implicit free surface
372     C freesurfac = 0. uses rigid lid
373 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
374 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
375 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
376 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
377 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
378     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
379     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
380     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
381     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
382 adcroft 1.52 C hFacSup that control vanishing and creating levels
383 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
384     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
385     C startTime :: Starting time for this integration ( s ).
386     C endTime :: Ending time for this integration ( s ).
387     C chkPtFreq :: Frequency of rolling check pointing ( s ).
388     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
389     C dumpFreq :: Frequency with which model state is written to
390 cnh 1.24 C post-processing files ( s ).
391 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
392 adcroft 1.59 C of intermediate quantities.
393 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
394     C vfFacMom :: Momentum viscosity tracer parameter
395     C pfFacMom :: Momentum pressure forcing tracer parameter
396     C cfFacMom :: Coriolis term tracer parameter
397     C foFacMom :: Momentum forcing tracer parameter
398     C mtFacMom :: Metric terms tracer parameter
399     C cosPower :: Power of cosine of latitude to multiply viscosity
400     C cAdjFreq :: Frequency of convective adjustment
401 cnh 1.24 C
402 cnh 1.63 C taveFreq :: Frequency with which time-averaged model state is written to
403 cnh 1.27 C post-processing files ( s ).
404 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
405     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
406     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
407     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
408     C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
409     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
410 adcroft 1.19 C (note: externForcingCycle must be an integer
411     C number times externForcingPeriod)
412 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
413     C (use model surface (local) value if set to -1)
414     C temp_EvPrRn :: temperature of Rain & Evap.
415     C salt_EvPrRn :: salinity of Rain & Evap.
416     C trac_EvPrRn :: tracer concentration in Rain & Evap.
417     C (notes: a) tracer content of Rain/Evap only used if both
418     C NonLin_FrSurf & useRealFreshWater are set.
419     C b) use model surface (local) value if set to UNSET_RL)
420 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
421 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
422 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
423 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
424 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
425 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
426 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
427 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
428     & cg2dpcOffDFac, cg3dTargetResidual,
429 jmc 1.70 & delP, delZ, delR, delRc, delX, delY,
430 cnh 1.33 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
431 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
432     & fCori, fCoriG,
433 adcroft 1.60 & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension,
434 cnh 1.24 & diffKhT, diffKzT, diffK4T, diffKrT,
435 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
436 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
437 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
438 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
439 cnh 1.27 & recip_rhoConst, rhoConst, tRef, sRef,
440 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
441     & diagFreq, taveFreq, monitorFreq,
442 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
443 heimbach 1.56 & cosPower, cAdjFreq, omega,
444     & tauThetaClimRelax, lambdaThetaClimRelax,
445 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
446 heimbach 1.56 & tauTr1ClimRelax, lambdaTr1ClimRelax,
447 cnh 1.27 & externForcingCycle, externForcingPeriod,
448 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
449 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
450 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
451 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
452 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
453 cnh 1.27
454 adcroft 1.6 _RL cg2dTargetResidual
455 adcroft 1.52 _RL cg2dTargetResWunit
456 cnh 1.33 _RL cg3dTargetResidual
457 cnh 1.7 _RL cg2dpcOffDFac
458 cnh 1.25 _RL delZ(Nr)
459     _RL delP(Nr)
460     _RL delR(Nr)
461 jmc 1.70 _RL delRc(Nr+1)
462 adcroft 1.6 _RL delX(Nx)
463     _RL delY(Ny)
464     _RL deltaT
465 cnh 1.7 _RL deltaTClock
466 adcroft 1.6 _RL deltaTmom
467     _RL deltaTtracer
468     _RL abeps
469     _RL phiMin
470     _RL thetaMin
471     _RL rSphere
472 cnh 1.25 _RL recip_RSphere
473 adcroft 1.6 _RL f0
474 cnh 1.8 _RL freeSurfFac
475 jmc 1.48 _RL implicSurfPress
476     _RL implicDiv2Dflow
477 adcroft 1.22 _RL hFacMin
478     _RL hFacMinDz
479 cnh 1.28 _RL hFacMinDp
480 cnh 1.27 _RL hFacMinDr
481 adcroft 1.52 _RL hFacInf
482     _RL hFacSup
483 adcroft 1.6 _RL beta
484     _RL viscAh
485 adcroft 1.60 _RL viscAstrain
486     _RL viscAtension
487 adcroft 1.6 _RL viscAz
488 cnh 1.27 _RL viscAp
489 cnh 1.25 _RL viscAr
490 adcroft 1.6 _RL viscA4
491     _RL diffKhT
492 cnh 1.25 _RL diffKrT
493 adcroft 1.6 _RL diffKzT
494 cnh 1.27 _RL diffKpT
495 adcroft 1.6 _RL diffK4T
496     _RL diffKhS
497 cnh 1.25 _RL diffKrS
498 adcroft 1.6 _RL diffKzS
499 cnh 1.27 _RL diffKpS
500 adcroft 1.6 _RL diffK4S
501     _RL delt
502     _RL tauCD
503     _RL rCD
504     _RL gravity
505 cnh 1.32 _RL recip_gravity
506 cnh 1.8 _RL gBaro
507 adcroft 1.6 _RL rhonil
508 cnh 1.25 _RL recip_rhonil
509     _RL rhoConst
510 cnh 1.26 _RL recip_rhoConst
511 cnh 1.25 _RL tRef(Nr)
512     _RL sRef(Nr)
513 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
514     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
515 adcroft 1.6 _RL startTime
516     _RL endTime
517     _RL chkPtFreq
518 cnh 1.7 _RL pChkPtFreq
519 adcroft 1.6 _RL dumpFreq
520 adcroft 1.59 _RL diagFreq
521 adcroft 1.20 _RL taveFreq
522 adcroft 1.53 _RL monitorFreq
523 cnh 1.9 _RL afFacMom
524     _RL vfFacMom
525     _RL pfFacMom
526     _RL cfFacMom
527     _RL foFacMom
528 cnh 1.15 _RL mTFacMom
529 adcroft 1.39 _RL cosPower
530 cnh 1.9 _RL cAdjFreq
531 cnh 1.15 _RL omega
532 cnh 1.18 _RL tauThetaClimRelax
533     _RL lambdaThetaClimRelax
534     _RL tauSaltClimRelax
535     _RL lambdaSaltClimRelax
536 heimbach 1.56 _RL tauTr1ClimRelax
537     _RL lambdaTr1ClimRelax
538 adcroft 1.19 _RL externForcingCycle
539     _RL externForcingPeriod
540 jmc 1.68 _RL convertFW2Salt
541     _RL temp_EvPrRn
542     _RL salt_EvPrRn
543     _RL trac_EvPrRn
544 cnh 1.30 _RL horiVertRatio
545 cnh 1.31 _RL recip_horiVertRatio
546 adcroft 1.41 _RL ivdc_kappa
547 adcroft 1.46 _RL Ro_SeaLevel
548     _RL bottomDragLinear
549     _RL bottomDragQuadratic
550 adcroft 1.6
551 adcroft 1.36 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
552 cnh 1.1 & Lamba_theta
553 adcroft 1.6 _RL HeatCapacity_Cp
554     _RL Lamba_theta
555 adcroft 1.36 _RL recip_Cp
556 adcroft 1.5
557     C Equation of State (polynomial coeffients)
558     COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
559 cnh 1.25 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
560 adcroft 1.5 C Linear equation of state
561 cnh 1.63 C tAlpha :: Linear EOS thermal expansion coefficient ( 1/degree ).
562     C sBeta :: Linear EOS haline contraction coefficient.
563 adcroft 1.12 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
564 adcroft 1.6 _RL tAlpha
565     _RL sBeta
566 adcroft 1.12 character*(6) eosType
567 jmc 1.55
568     C Atmospheric physical parameters (Ideal Gas EOS, ...)
569 cnh 1.63 C atm_po :: standard reference pressure
570     C atm_cp :: specific heat (Cp) of the (dry) air at constant pressure
571     C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
572     C Integr_GeoPot :: option to select the way we integrate the geopotential
573 jmc 1.55 C (still a subject of discussions ...)
574     COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
575     & Integr_GeoPot
576     _RL atm_cp, atm_kappa, atm_po
577     INTEGER Integr_GeoPot
578 cnh 1.7
579 adcroft 1.44 C Logical flags for selecting packages
580 heimbach 1.45 LOGICAL useKPP
581     LOGICAL useGMRedi
582 adcroft 1.46 LOGICAL useOBCS
583 jmc 1.49 LOGICAL useAIM
584 heimbach 1.56 LOGICAL useGrdchk
585 heimbach 1.45 LOGICAL useECCO
586 adcroft 1.52 LOGICAL useSHAP_FILT
587 jmc 1.67 LOGICAL useZONAL_FILT
588 adcroft 1.62 LOGICAL useFLT
589 adcroft 1.69 LOGICAL usePTRACERS
590 adcroft 1.44 COMMON /PARM_PACKAGES/
591 heimbach 1.56 & useKPP, useGMRedi, useOBCS, useAIM, useECCO,
592 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
593     & usePTRACERS
594 jmc 1.49

  ViewVC Help
Powered by ViewVC 1.1.22