/[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.73 - (hide annotations) (download)
Wed Jul 31 16:38:30 2002 UTC (21 years, 9 months ago) by mlosch
Branch: MAIN
CVS Tags: checkpoint46a_post, checkpoint46b_pre
Changes since 1.72: +5 -3 lines
File MIME type: text/plain
Added pressure loading term and experiment based on Wunsch and Stammer (1997)
o new field in FFIELDS.h, etc...
o new cpp flag ATMOSPHERIC_LOADING
o Changed hFacC to _hFacC in calc_phi_hyd.F
o Added SHORTWAVE_HEATING to some files for consistency

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

  ViewVC Help
Powered by ViewVC 1.1.22