/[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.69 - (hide annotations) (download)
Mon Mar 4 17:26:40 2002 UTC (22 years, 2 months ago) by adcroft
Branch: MAIN
CVS Tags: checkpoint44f_post, checkpoint44g_post
Changes since 1.68: +4 -2 lines
File MIME type: text/plain
Added PTRACERS package

This allows an arbitrary number of passive tracers to be integrated
forward simultaneously with the dynamicaly model.
 + Implemented so far:
    - basic forward algorithm (time-stepping, advection, diffusion, convection)
    - I/O and checkpointing
    - GM/Redi  *but*  using the GM/Redi coefficient of Salt
 + Not implemented so far:
    - KPP
    - OBCS
 + No specific example supplied (yet) but global_ocean.90x40x15 has the
   necessary data.ptracer file. Simply use -enable=ptracers and uncomment
   line in data.pkg. PTRACER01 then reproduces Salt exactly.
 + This package is disabled by default since it increases storage.

1 adcroft 1.69 C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.68 2002/02/09 23:38:55 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 cnh 1.63 C saltDiffusion :: Flag which turns diffusion of salinit on
171 cnh 1.1 C and off.
172 cnh 1.63 C saltAdvection :: Flag which turns advection of salinit on
173 cnh 1.1 C and off.
174 cnh 1.63 C saltForcing :: Flag which turns external forcing of salinit on
175 cnh 1.1 C and off.
176 jmc 1.68 C useRealFreshWaterFlux :: if true (=Natural BCS), treats P+R-E flux
177     C as a real Fresh Water (=> changes the seal level)
178     C if false, converts P+R-E to virtual salt flux
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     C implicitDiffusion :: Turns implicit vertical diffusion on
192     C implicitViscosity :: Turns implicit vertical viscosity on
193     C doThetaClimRelax :: Set true if relaxation to temperature
194 cnh 1.18 C climatology is required.
195 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
196 cnh 1.18 C climatology is required.
197 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
198     C usingPCoords :: Set to indicate that we are working in pressure
199 cnh 1.29 C coords.
200 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
201 cnh 1.29 C coords.
202 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
203     C globalFiles :: Selects between "global" and "tiled" files
204     C allowFreezing :: Allows water to freeze and form ice
205     C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
206 adcroft 1.66 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
207 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
208 adcroft 1.52 & usingCurvilinearGrid,
209 adcroft 1.36 & no_slip_sides,no_slip_bottom,
210 adcroft 1.46 & staggerTimeStep,
211 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
212 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
213     & tempDiffusion, tempAdvection, tempForcing,
214 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
215 jmc 1.68 & useRealFreshWaterFlux,
216 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
217 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
218 cnh 1.15 & metricTerms, usingSphericalPolarMTerms,
219     & useConstantF, useBetaPlaneF, useSphereF,
220 adcroft 1.40 & implicitDiffusion, implicitViscosity,
221 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
222 adcroft 1.35 & periodicExternalForcing, usingPCoords, usingZCoords,
223 adcroft 1.46 & nonHydrostatic, globalFiles,
224 heimbach 1.51 & allowFreezing, groundAtK1,
225 heimbach 1.56 & usePickupBeforeC35, debugMode,
226 adcroft 1.61 & readPickupWithTracer, writePickupWithTracer,
227 adcroft 1.66 & multiDimAdvection, useEnergyConservingCoriolis,
228     & useJamartWetPoints
229 cnh 1.1 LOGICAL usingCartesianGrid
230     LOGICAL usingSphericalPolarGrid
231 adcroft 1.52 LOGICAL usingCurvilinearGrid
232 cnh 1.15 LOGICAL usingSphericalPolarMTerms
233 adcroft 1.36 LOGICAL no_slip_sides
234     LOGICAL no_slip_bottom
235 adcroft 1.46 LOGICAL staggerTimeStep
236 cnh 1.1 LOGICAL momViscosity
237     LOGICAL momAdvection
238     LOGICAL momForcing
239 cnh 1.9 LOGICAL momPressureForcing
240 cnh 1.1 LOGICAL useCoriolis
241 adcroft 1.58 LOGICAL vectorInvariantMomentum
242 cnh 1.1 LOGICAL tempDiffusion
243     LOGICAL tempAdvection
244     LOGICAL tempForcing
245     LOGICAL saltDiffusion
246     LOGICAL saltAdvection
247     LOGICAL saltForcing
248 jmc 1.68 LOGICAL useRealFreshWaterFlux
249 adcroft 1.52 LOGICAL rigidLid
250 cnh 1.8 LOGICAL implicitFreeSurface
251 adcroft 1.52 LOGICAL exactConserv
252 jmc 1.55 LOGICAL uniformLin_PhiSurf
253 cnh 1.10 LOGICAL momStepping
254     LOGICAL tempStepping
255 adcroft 1.17 LOGICAL saltStepping
256 heimbach 1.56 LOGICAL tr1Stepping
257 cnh 1.15 LOGICAL metricTerms
258     LOGICAL useConstantF
259     LOGICAL useBetaPlaneF
260     LOGICAL useSphereF
261 adcroft 1.14 LOGICAL implicitDiffusion
262 adcroft 1.40 LOGICAL implicitViscosity
263 cnh 1.18 LOGICAL doThetaClimRelax
264     LOGICAL doSaltClimRelax
265 heimbach 1.56 LOGICAL doTr1ClimRelax
266 adcroft 1.19 LOGICAL periodicExternalForcing
267 cnh 1.29 LOGICAL usingPCoords
268     LOGICAL usingZCoords
269 adcroft 1.37 LOGICAL nonHydrostatic
270 adcroft 1.38 LOGICAL globalFiles
271     LOGICAL allowFreezing
272 adcroft 1.46 LOGICAL groundAtK1
273 heimbach 1.51 LOGICAL usePickupBeforeC35
274 adcroft 1.54 LOGICAL debugMode
275 heimbach 1.56 LOGICAL readPickupWithTracer
276     LOGICAL writePickupWithTracer
277 adcroft 1.61 LOGICAL multiDimAdvection
278 adcroft 1.65 LOGICAL useEnergyConservingCoriolis
279 adcroft 1.66 LOGICAL useJamartWetPoints
280 cnh 1.1
281     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
282 adcroft 1.52 C gg2dTargetResidual
283 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
284 adcroft 1.52 C cg2dTargetResWunit
285 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
286 cnh 1.33 C cg3dTargetResidual
287 cnh 1.63 C :: Target residual for cg3d solver.
288     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
289 cnh 1.7 C Note. 20th May 1998
290     C I made a weird discovery! In the model paper we argue
291     C for the form of the preconditioner used here ( see
292     C A Finite-volume, Incompressible Navier-Stokes Model
293     C ...., Marshall et. al ). The algebra gives a simple
294     C 0.5 factor for the averaging of ac and aCw to get a
295     C symmettric pre-conditioner. By using a factor of 0.51
296     C i.e. scaling the off-diagonal terms in the
297     C preconditioner down slightly I managed to get the
298     C number of iterations for convergence in a test case to
299     C drop form 192 -> 134! Need to investigate this further!
300     C For now I have introduced a parameter cg2dpcOffDFac which
301     C defaults to 0.51 but can be set at runtime.
302 cnh 1.63 C delP :: Vertical grid spacing ( Pa ).
303     C delZ :: Vertical grid spacing ( m ).
304     C delR :: Vertical grid spacing ( units of r ).
305     C delX :: Separation between cell faces (m) or (deg), depending
306 cnh 1.1 C delY on input flags.
307 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
308 cnh 1.32 C recip_gravity and its inverse
309 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
310     C ronil :: Reference density
311     C rhoConst :: Vertically constant reference density
312     C startTime :: Start time for model ( s )
313     C phiMin :: Latitude of southern most cell face.
314     C thetaMin :: Longitude of western most cell face (this
315 cnh 1.1 C is an "inert" parameter but it is included
316     C to make geographical references simple.)
317 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
318     C recip_RSphere :: Reciprocal radius of sphere ( m ).
319     C f0 :: Reference coriolis parameter ( 1/s )
320 cnh 1.1 C ( Southern edge f for beta plane )
321 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
322     C omega :: Angular velocity ( rad/s )
323     C viscAh :: Eddy viscosity coeff. for mixing of
324 cnh 1.1 C momentum laterally ( m^2/s )
325 cnh 1.63 C viscAz :: Eddy viscosity coeff. for mixing of
326 cnh 1.1 C momentum vertically ( m^2/s )
327 cnh 1.63 C viscAp :: Eddy viscosity coeff. for mixing of
328 cnh 1.27 C momentum vertically ( Pa^2/s )
329 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
330 cnh 1.24 C momentum vertically ( units of r^2/s )
331 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
332 cnh 1.1 C momentum laterally ( m^4/s )
333 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
334 cnh 1.1 C heat laterally ( m^2/s )
335 cnh 1.63 C diffKzT :: Laplacian diffusion coeff. for mixing of
336 cnh 1.1 C heat vertically ( m^2/s )
337 cnh 1.63 C diffKpT :: Laplacian diffusion coeff. for mixing of
338 cnh 1.27 C heat vertically ( Pa^2/s )
339 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
340 cnh 1.24 C heat vertically ( units of r^2/s )
341 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
342 cnh 1.1 C heat laterally ( m^4/s )
343 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
344 cnh 1.1 C salt laterally ( m^2/s )
345 cnh 1.63 C diffKzS :: Laplacian diffusion coeff. for mixing of
346 cnh 1.1 C salt vertically ( m^2/s )
347 cnh 1.63 C diffKpS :: Laplacian diffusion coeff. for mixing of
348 cnh 1.27 C salt vertically ( Pa^2/s )
349 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
350 cnh 1.24 C salt vertically ( units of r^2/s )
351 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
352 cnh 1.1 C salt laterally ( m^4/s )
353 cnh 1.63 C deltaT :: Default timestep ( s )
354     C deltaTClock :: Timestep used as model "clock". This determines the
355 cnh 1.7 C IO frequencies and is used in tagging output. It can
356     C be totally different to the dynamical time. Typically
357     C it will be the deep-water timestep for accelerated runs.
358     C Frequency of checkpointing and dumping of the model state
359     C are referenced to this clock. ( s )
360 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
361     C deltaTtracer :: Timestep for tracer equations ( s )
362     C freesurfFac :: Parameter to turn implicit free surface term on or off
363 cnh 1.8 C freesurfac = 1. uses implicit free surface
364     C freesurfac = 0. uses rigid lid
365 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
366 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
367 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
368 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
369 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
370     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
371     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
372     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
373     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
374 adcroft 1.52 C hFacSup that control vanishing and creating levels
375 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
376     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
377     C startTime :: Starting time for this integration ( s ).
378     C endTime :: Ending time for this integration ( s ).
379     C chkPtFreq :: Frequency of rolling check pointing ( s ).
380     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
381     C dumpFreq :: Frequency with which model state is written to
382 cnh 1.24 C post-processing files ( s ).
383 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
384 adcroft 1.59 C of intermediate quantities.
385 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
386     C vfFacMom :: Momentum viscosity tracer parameter
387     C pfFacMom :: Momentum pressure forcing tracer parameter
388     C cfFacMom :: Coriolis term tracer parameter
389     C foFacMom :: Momentum forcing tracer parameter
390     C mtFacMom :: Metric terms tracer parameter
391     C cosPower :: Power of cosine of latitude to multiply viscosity
392     C cAdjFreq :: Frequency of convective adjustment
393 cnh 1.24 C
394 cnh 1.63 C taveFreq :: Frequency with which time-averaged model state is written to
395 cnh 1.27 C post-processing files ( s ).
396 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
397     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
398     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
399     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
400     C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
401     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
402 adcroft 1.19 C (note: externForcingCycle must be an integer
403     C number times externForcingPeriod)
404 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
405     C (use model surface (local) value if set to -1)
406     C temp_EvPrRn :: temperature of Rain & Evap.
407     C salt_EvPrRn :: salinity of Rain & Evap.
408     C trac_EvPrRn :: tracer concentration in Rain & Evap.
409     C (notes: a) tracer content of Rain/Evap only used if both
410     C NonLin_FrSurf & useRealFreshWater are set.
411     C b) use model surface (local) value if set to UNSET_RL)
412 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
413 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
414 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
415 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
416 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
417 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
418 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
419 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
420     & cg2dpcOffDFac, cg3dTargetResidual,
421 cnh 1.24 & delP, delZ, delR, delX, delY,
422 cnh 1.33 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
423 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
424     & fCori, fCoriG,
425 adcroft 1.60 & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension,
426 cnh 1.24 & diffKhT, diffKzT, diffK4T, diffKrT,
427 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
428 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
429 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
430 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
431 cnh 1.27 & recip_rhoConst, rhoConst, tRef, sRef,
432 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
433     & diagFreq, taveFreq, monitorFreq,
434 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
435 heimbach 1.56 & cosPower, cAdjFreq, omega,
436     & tauThetaClimRelax, lambdaThetaClimRelax,
437 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
438 heimbach 1.56 & tauTr1ClimRelax, lambdaTr1ClimRelax,
439 cnh 1.27 & externForcingCycle, externForcingPeriod,
440 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
441 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
442 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
443 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
444 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
445 cnh 1.27
446 adcroft 1.6 _RL cg2dTargetResidual
447 adcroft 1.52 _RL cg2dTargetResWunit
448 cnh 1.33 _RL cg3dTargetResidual
449 cnh 1.7 _RL cg2dpcOffDFac
450 cnh 1.25 _RL delZ(Nr)
451     _RL delP(Nr)
452     _RL delR(Nr)
453 adcroft 1.6 _RL delX(Nx)
454     _RL delY(Ny)
455     _RL deltaT
456 cnh 1.7 _RL deltaTClock
457 adcroft 1.6 _RL deltaTmom
458     _RL deltaTtracer
459     _RL abeps
460     _RL phiMin
461     _RL thetaMin
462     _RL rSphere
463 cnh 1.25 _RL recip_RSphere
464 adcroft 1.6 _RL f0
465 cnh 1.8 _RL freeSurfFac
466 jmc 1.48 _RL implicSurfPress
467     _RL implicDiv2Dflow
468 adcroft 1.22 _RL hFacMin
469     _RL hFacMinDz
470 cnh 1.28 _RL hFacMinDp
471 cnh 1.27 _RL hFacMinDr
472 adcroft 1.52 _RL hFacInf
473     _RL hFacSup
474 adcroft 1.6 _RL beta
475     _RL viscAh
476 adcroft 1.60 _RL viscAstrain
477     _RL viscAtension
478 adcroft 1.6 _RL viscAz
479 cnh 1.27 _RL viscAp
480 cnh 1.25 _RL viscAr
481 adcroft 1.6 _RL viscA4
482     _RL diffKhT
483 cnh 1.25 _RL diffKrT
484 adcroft 1.6 _RL diffKzT
485 cnh 1.27 _RL diffKpT
486 adcroft 1.6 _RL diffK4T
487     _RL diffKhS
488 cnh 1.25 _RL diffKrS
489 adcroft 1.6 _RL diffKzS
490 cnh 1.27 _RL diffKpS
491 adcroft 1.6 _RL diffK4S
492     _RL delt
493     _RL tauCD
494     _RL rCD
495     _RL gravity
496 cnh 1.32 _RL recip_gravity
497 cnh 1.8 _RL gBaro
498 adcroft 1.6 _RL rhonil
499 cnh 1.25 _RL recip_rhonil
500     _RL rhoConst
501 cnh 1.26 _RL recip_rhoConst
502 cnh 1.25 _RL tRef(Nr)
503     _RL sRef(Nr)
504 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
505     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
506 adcroft 1.6 _RL startTime
507     _RL endTime
508     _RL chkPtFreq
509 cnh 1.7 _RL pChkPtFreq
510 adcroft 1.6 _RL dumpFreq
511 adcroft 1.59 _RL diagFreq
512 adcroft 1.20 _RL taveFreq
513 adcroft 1.53 _RL monitorFreq
514 cnh 1.9 _RL afFacMom
515     _RL vfFacMom
516     _RL pfFacMom
517     _RL cfFacMom
518     _RL foFacMom
519 cnh 1.15 _RL mTFacMom
520 adcroft 1.39 _RL cosPower
521 cnh 1.9 _RL cAdjFreq
522 cnh 1.15 _RL omega
523 cnh 1.18 _RL tauThetaClimRelax
524     _RL lambdaThetaClimRelax
525     _RL tauSaltClimRelax
526     _RL lambdaSaltClimRelax
527 heimbach 1.56 _RL tauTr1ClimRelax
528     _RL lambdaTr1ClimRelax
529 adcroft 1.19 _RL externForcingCycle
530     _RL externForcingPeriod
531 jmc 1.68 _RL convertFW2Salt
532     _RL temp_EvPrRn
533     _RL salt_EvPrRn
534     _RL trac_EvPrRn
535 cnh 1.30 _RL horiVertRatio
536 cnh 1.31 _RL recip_horiVertRatio
537 adcroft 1.41 _RL ivdc_kappa
538 adcroft 1.46 _RL Ro_SeaLevel
539     _RL bottomDragLinear
540     _RL bottomDragQuadratic
541 adcroft 1.6
542 adcroft 1.36 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
543 cnh 1.1 & Lamba_theta
544 adcroft 1.6 _RL HeatCapacity_Cp
545     _RL Lamba_theta
546 adcroft 1.36 _RL recip_Cp
547 adcroft 1.5
548     C Equation of State (polynomial coeffients)
549     COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
550 cnh 1.25 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
551 adcroft 1.5 C Linear equation of state
552 cnh 1.63 C tAlpha :: Linear EOS thermal expansion coefficient ( 1/degree ).
553     C sBeta :: Linear EOS haline contraction coefficient.
554 adcroft 1.12 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
555 adcroft 1.6 _RL tAlpha
556     _RL sBeta
557 adcroft 1.12 character*(6) eosType
558 jmc 1.55
559     C Atmospheric physical parameters (Ideal Gas EOS, ...)
560 cnh 1.63 C atm_po :: standard reference pressure
561     C atm_cp :: specific heat (Cp) of the (dry) air at constant pressure
562     C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
563     C Integr_GeoPot :: option to select the way we integrate the geopotential
564 jmc 1.55 C (still a subject of discussions ...)
565     COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
566     & Integr_GeoPot
567     _RL atm_cp, atm_kappa, atm_po
568     INTEGER Integr_GeoPot
569 cnh 1.7
570 adcroft 1.44 C Logical flags for selecting packages
571 heimbach 1.45 LOGICAL useKPP
572     LOGICAL useGMRedi
573 adcroft 1.46 LOGICAL useOBCS
574 jmc 1.49 LOGICAL useAIM
575 heimbach 1.56 LOGICAL useGrdchk
576 heimbach 1.45 LOGICAL useECCO
577 adcroft 1.52 LOGICAL useSHAP_FILT
578 jmc 1.67 LOGICAL useZONAL_FILT
579 adcroft 1.62 LOGICAL useFLT
580 adcroft 1.69 LOGICAL usePTRACERS
581 adcroft 1.44 COMMON /PARM_PACKAGES/
582 heimbach 1.56 & useKPP, useGMRedi, useOBCS, useAIM, useECCO,
583 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
584     & usePTRACERS
585 jmc 1.49

  ViewVC Help
Powered by ViewVC 1.1.22