/[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.28 - (hide annotations) (download)
Sat Sep 5 17:52:13 1998 UTC (25 years, 8 months ago) by cnh
Branch: MAIN
Changes since 1.27: +15 -2 lines
File MIME type: text/plain
Consistent isomorphism changes

1 cnh 1.28 C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.27 1998/08/24 02:25:01 cnh Exp $
2 cnh 1.1 C
3     C /==========================================================\
4     C | PARAMS.h |
5     C | o Header file defining model "parameters". |
6     C |==========================================================|
7     C | The values from the model's standard input file are |
8     C | stored into the variables held here. Notes describing |
9     C | the parameters can also be found here. |
10     C \==========================================================/
11 cnh 1.13
12     C Macros for special grid options
13     #include "PARAMS_MACROS.h"
14 cnh 1.1
15     C-- Contants
16     C Useful physical values
17     Real*8 PI
18     PARAMETER ( PI = 3.14159265358979323844D0 )
19     Real*8 deg2rad
20     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
21    
22 cnh 1.7 C Symbolic values
23     C precXXXX - Used to indicate what precision to use for
24     C dumping model state.
25     INTEGER precFloat32
26     PARAMETER ( precFloat32 = 0 )
27     INTEGER precFloat64
28     PARAMETER ( precFloat64 = 1 )
29 cnh 1.28 C UNSET_xxx - Used to indicate variables that have not been given a value
30     Real*8 UNSET_FLOAT8
31     PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
32     Real*4 UNSET_FLOAT4
33     PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
34     _RL UNSET_RL
35     PARAMETER ( UNSET_RL = 1.234567D5 )
36     _RS UNSET_RS
37     PARAMETER ( UNSET_RS = 1.234567E5 )
38     INTEGER UNSET_I
39     PARAMETER ( UNSET_I = 123456789 )
40 cnh 1.7
41     C Checkpoint data
42     INTEGER maxNoChkptLev
43     PARAMETER ( maxNoChkptLev = 2 )
44    
45 cnh 1.1 C-- COMMON /PARM_C/ Character valued parameters used by the model.
46 cnh 1.7 C checkPtSuff - List of checkpoint file suffices
47 cnh 1.16 C bathyFile - File containing bathymetry. If not defined bathymetry
48     C is taken from inline function.
49     C hydrogThetaFile - File containing initial hydrographic data for potential
50     C temperature.
51     C hydrogSaltFile - File containing initial hydrographic data for salinity.
52     C zonalWindFile - File containing zonal wind data
53     C meridWindFile - File containing meridional wind data
54 cnh 1.18 C thetaClimFile - File containing theta climataology used
55     C in relaxation term -lambda(theta-theta*)
56     C saltClimFile - File containing salt climataology used
57     C in relaxation term -lambda(salt-salt*)
58 cnh 1.26 C buoyancyRelation - Flag used to indicate which relation to use to
59     C get buoyancy.
60 cnh 1.16 COMMON /PARM_C/ checkPtSuff,
61     & bathyFile, hydrogThetaFile, hydrogSaltFile,
62 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
63 cnh 1.26 & saltClimFile, buoyancyRelation
64 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
65 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) bathyFile
66     CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
67     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
68     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
69     CHARACTER*(MAX_LEN_FNAM) meridWindFile
70 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
71     CHARACTER*(MAX_LEN_FNAM) saltClimFile
72 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
73 cnh 1.7
74 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
75     C cg2dMaxIters - Maximum number of iterations in the
76     C two-dimensional con. grad solver.
77     C cg2dChkResFreq - Frequency with which to check residual
78     C in con. grad solver.
79     C nIter0 - Start time-step number of for this run
80     C nTimeSteps - Number of timesteps to execute
81     C numStepsPerPickup - For offline setup. Frequency of pickup
82     C of flow fields.
83 cnh 1.7 C writeStatePrec - Precision used for writing model state.
84     C writeBinaryPrec - Precision used for writing binary files
85     C readBinaryPrec - Precision used for reading binary files
86     C nCheckLev - Holds current checkpoint level
87 cnh 1.1 COMMON /PARM_I/
88     & cg2dMaxIters,
89     & cg2dChkResFreq,
90     & nIter0, nTimeSteps,
91 cnh 1.7 & numStepsPerPickup,
92     & writeStatePrec, nCheckLev,
93     & writeBinaryPrec, readBinaryPrec
94 cnh 1.1 INTEGER cg2dMaxIters
95     INTEGER cg2dChkResFreq
96     INTEGER nIter0
97     INTEGER nTimeSteps
98     INTEGER numStepsPerPickup
99 cnh 1.7 INTEGER writeStatePrec
100     INTEGER writeBinaryPrec
101     INTEGER readBinaryPrec
102     INTEGER nCheckLev
103 cnh 1.1
104     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
105     C usingCartesianGrid - If TRUE grid generation will be in a cartesian
106     C coordinate frame.
107     C usingSphericalPolarGrid - If TRUE grid generation will be in a
108     C spherical polar frame.
109     C momViscosity - Flag which turns momentum friction terms on and off.
110     C momAdvection - Flag which turns advection of momentum on and off.
111     C momForcing - Flag which turns external forcing of momentum on
112     C and off.
113 cnh 1.9 C momPressureForcing - Flag which turns pressure term in momentum equation
114     C on and off.
115 cnh 1.15 C metricTerms - Flag which turns metric terms on or off.
116     C usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
117 cnh 1.1 C useCoriolis - Flag which turns the coriolis terms on and off.
118     C tempDiffusion - Flag which turns diffusion of temperature on
119     C and off.
120     C tempAdvection - Flag which turns advection of temperature on
121     C and off.
122     C tempForcing - Flag which turns external forcing of temperature on
123     C and off.
124     C saltDiffusion - Flag which turns diffusion of salinit on
125     C and off.
126     C saltAdvection - Flag which turns advection of salinit on
127     C and off.
128     C saltForcing - Flag which turns external forcing of salinit on
129     C and off.
130 cnh 1.8 C implicitFreeSurface - Set to true to use implcit free surface
131     C rigidLid - Set to true to use rigid lid
132 cnh 1.10 C momStepping - Turns momentum equation time-stepping off
133 cnh 1.15 C tempStepping - Turns temperature equation time-stepping off
134 adcroft 1.17 C saltStepping - Turns salinity equation time-stepping off
135 cnh 1.15 C useConstantF - Coriolis parameter set to f0
136     C useBetaPlaneF - Coriolis parameter set to f0 + beta.y
137     C useSphereF - Coriolis parameter set to 2.omega.sin(phi)
138 adcroft 1.14 C implicitDiffusion - Turns implicit vertical diffusion on
139 cnh 1.18 C doThetaClimRelax - Set true if relaxation to temperature
140     C climatology is required.
141     C doSaltClimRelax - Set true if relaxation to salinity
142     C climatology is required.
143 adcroft 1.19 C periodicExternalForcing - Set true if forcing is time-dependant
144 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
145 cnh 1.9 & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
146 cnh 1.1 & tempDiffusion, tempAdvection, tempForcing,
147 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
148 adcroft 1.17 & implicitFreeSurface, rigidLid,
149     & momStepping, tempStepping, saltStepping,
150 cnh 1.15 & metricTerms, usingSphericalPolarMTerms,
151     & useConstantF, useBetaPlaneF, useSphereF,
152 adcroft 1.19 & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
153     & periodicExternalForcing
154 cnh 1.1 LOGICAL usingCartesianGrid
155     LOGICAL usingSphericalPolarGrid
156 cnh 1.15 LOGICAL usingSphericalPolarMTerms
157 cnh 1.1 LOGICAL momViscosity
158     LOGICAL momAdvection
159     LOGICAL momForcing
160 cnh 1.9 LOGICAL momPressureForcing
161 cnh 1.1 LOGICAL useCoriolis
162     LOGICAL tempDiffusion
163     LOGICAL tempAdvection
164     LOGICAL tempForcing
165     LOGICAL saltDiffusion
166     LOGICAL saltAdvection
167     LOGICAL saltForcing
168 cnh 1.8 LOGICAL implicitFreeSurface
169     LOGICAL rigidLid
170 cnh 1.10 LOGICAL momStepping
171     LOGICAL tempStepping
172 adcroft 1.17 LOGICAL saltStepping
173 cnh 1.15 LOGICAL metricTerms
174     LOGICAL useConstantF
175     LOGICAL useBetaPlaneF
176     LOGICAL useSphereF
177 adcroft 1.14 LOGICAL implicitDiffusion
178 cnh 1.18 LOGICAL doThetaClimRelax
179     LOGICAL doSaltClimRelax
180 adcroft 1.19 LOGICAL periodicExternalForcing
181 cnh 1.1
182     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
183     C cg2dTargetResidual
184     C - Target residual for cg2d solver.
185 cnh 1.7 C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
186     C Note. 20th May 1998
187     C I made a weird discovery! In the model paper we argue
188     C for the form of the preconditioner used here ( see
189     C A Finite-volume, Incompressible Navier-Stokes Model
190     C ...., Marshall et. al ). The algebra gives a simple
191     C 0.5 factor for the averaging of ac and aCw to get a
192     C symmettric pre-conditioner. By using a factor of 0.51
193     C i.e. scaling the off-diagonal terms in the
194     C preconditioner down slightly I managed to get the
195     C number of iterations for convergence in a test case to
196     C drop form 192 -> 134! Need to investigate this further!
197     C For now I have introduced a parameter cg2dpcOffDFac which
198     C defaults to 0.51 but can be set at runtime.
199 cnh 1.24 C delP - Vertical grid spacing ( Pa ).
200     C delZ - Vertical grid spacing ( m ).
201 cnh 1.23 C delR - Vertical grid spacing ( units of r ).
202 cnh 1.1 C delX - Separation between cell faces (m) or (deg), depending
203     C delY on input flags.
204     C gravity - Accel. due to gravity ( m/s^2 )
205 cnh 1.8 C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 )
206 cnh 1.1 C ronil - Reference density
207 cnh 1.24 C rhoConst - Vertically constant reference density
208 cnh 1.3 C startTime - Start time for model ( s )
209 cnh 1.1 C phiMin - Latitude of southern most cell face.
210     C thetaMin - Longitude of western most cell face (this
211     C is an "inert" parameter but it is included
212     C to make geographical references simple.)
213 cnh 1.3 C rSphere - Radius of sphere for a spherical polar grid ( m ).
214 cnh 1.25 C recip_RSphere - Reciprocal radius of sphere ( m ).
215 cnh 1.1 C f0 - Reference coriolis parameter ( 1/s )
216     C ( Southern edge f for beta plane )
217     C beta - df/dy ( s^-1.m^-1 )
218 cnh 1.15 C omega - Angular velocity ( rad/s )
219 cnh 1.1 C viscAh - Eddy viscosity coeff. for mixing of
220     C momentum laterally ( m^2/s )
221     C viscAz - Eddy viscosity coeff. for mixing of
222     C momentum vertically ( m^2/s )
223 cnh 1.27 C viscAp - Eddy viscosity coeff. for mixing of
224     C momentum vertically ( Pa^2/s )
225 cnh 1.24 C viscAr - Eddy viscosity coeff. for mixing of
226     C momentum vertically ( units of r^2/s )
227 cnh 1.1 C viscA4 - Biharmonic viscosity coeff. for mixing of
228     C momentum laterally ( m^4/s )
229     C diffKhT - Laplacian diffusion coeff. for mixing of
230     C heat laterally ( m^2/s )
231     C diffKzT - Laplacian diffusion coeff. for mixing of
232     C heat vertically ( m^2/s )
233 cnh 1.27 C diffKpT - Laplacian diffusion coeff. for mixing of
234     C heat vertically ( Pa^2/s )
235 cnh 1.24 C diffKrT - Laplacian diffusion coeff. for mixing of
236     C heat vertically ( units of r^2/s )
237 cnh 1.1 C diffK4T - Biharmonic diffusion coeff. for mixing of
238     C heat laterally ( m^4/s )
239     C diffKhS - Laplacian diffusion coeff. for mixing of
240     C salt laterally ( m^2/s )
241     C diffKzS - Laplacian diffusion coeff. for mixing of
242     C salt vertically ( m^2/s )
243 cnh 1.27 C diffKpS - Laplacian diffusion coeff. for mixing of
244     C salt vertically ( Pa^2/s )
245 cnh 1.24 C diffKrS - Laplacian diffusion coeff. for mixing of
246     C salt vertically ( units of r^2/s )
247 cnh 1.1 C diffK4S - Biharmonic diffusion coeff. for mixing of
248     C salt laterally ( m^4/s )
249 cnh 1.3 C deltaT - Default timestep ( s )
250 cnh 1.7 C deltaTClock - Timestep used as model "clock". This determines the
251     C IO frequencies and is used in tagging output. It can
252     C be totally different to the dynamical time. Typically
253     C it will be the deep-water timestep for accelerated runs.
254     C Frequency of checkpointing and dumping of the model state
255     C are referenced to this clock. ( s )
256 cnh 1.3 C deltaTMom - Timestep for momemtum equations ( s )
257     C deltaTtracer - Timestep for tracer equations ( s )
258 cnh 1.8 C freesurfFac - Parameter to turn implicit free surface term on or off
259     C freesurfac = 1. uses implicit free surface
260     C freesurfac = 0. uses rigid lid
261 cnh 1.24 C hFacMin - Minimum fraction size of a cell (affects hFacC etc...)
262     C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m)
263 cnh 1.28 C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
264 cnh 1.24 C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
265     C tauCD - CD scheme coupling timescale ( 1/s )
266     C rCD - CD scheme normalised coupling parameter ( 0-1 )
267 cnh 1.27 C GMmaxslope - max. slope allowed in GM/Redi tensor
268     C GMlength - Length to use in Visbeck et al. formula for K (m)
269     C GMalpha - alpha to use in Visbeck et al. formula for K
270     C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.)
271 cnh 1.24 C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
272     C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
273     C startTime - Starting time for this integration ( s ).
274     C endTime - Ending time for this integration ( s ).
275     C chkPtFreq - Frequency of rolling check pointing ( s ).
276     C pChkPtFreq - Frequency of permanent check pointing ( s ).
277     C dumpFreq - Frequency with which model state is written to
278     C post-processing files ( s ).
279     C afFacMom - Advection of momentum term tracer parameter
280     C vfFacMom - Momentum viscosity tracer parameter
281     C pfFacMom - Momentum pressure forcing tracer parameter
282     C cfFacMom - Coriolis term tracer parameter
283     C foFacMom - Momentum forcing tracer parameter
284     C mtFacMom - Metric terms tracer parameter
285     C cAdjFreq - Frequency of convective adjustment
286     C
287 cnh 1.27 C taveFreq - Frequency with which time-averaged model state is written to
288     C post-processing files ( s ).
289 cnh 1.18 C tauThetaClimRelax - Relaxation to climatology time scale ( s ).
290     C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
291     C tauSaltClimRelax - Relaxation to climatology time scale ( s ).
292     C lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
293 adcroft 1.19 C externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
294     C externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
295     C (note: externForcingCycle must be an integer
296     C number times externForcingPeriod)
297 cnh 1.24 COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
298     & delP, delZ, delR, delX, delY,
299 cnh 1.7 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
300 cnh 1.25 & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
301 cnh 1.24 & viscAh, viscAz, viscA4, viscAr,
302     & diffKhT, diffKzT, diffK4T, diffKrT,
303 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
304 cnh 1.27 & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
305 adcroft 1.21 & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
306 cnh 1.26 & gravity, gBaro, rhonil, recip_rhonil,
307 cnh 1.27 & recip_rhoConst, rhoConst, tRef, sRef,
308 adcroft 1.20 & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
309 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
310 cnh 1.18 & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
311 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
312 cnh 1.27 & externForcingCycle, externForcingPeriod,
313 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
314 cnh 1.27 & theta_S, specVol_S
315    
316 adcroft 1.6 _RL cg2dTargetResidual
317 cnh 1.7 _RL cg2dpcOffDFac
318 cnh 1.25 _RL delZ(Nr)
319     _RL delP(Nr)
320     _RL delR(Nr)
321 adcroft 1.6 _RL delX(Nx)
322     _RL delY(Ny)
323     _RL deltaT
324 cnh 1.7 _RL deltaTClock
325 adcroft 1.6 _RL deltaTmom
326     _RL deltaTtracer
327     _RL abeps
328     _RL phiMin
329     _RL thetaMin
330     _RL rSphere
331 cnh 1.25 _RL recip_RSphere
332 adcroft 1.6 _RL f0
333 cnh 1.8 _RL freeSurfFac
334 adcroft 1.22 _RL hFacMin
335     _RL hFacMinDz
336 cnh 1.28 _RL hFacMinDp
337 cnh 1.27 _RL hFacMinDr
338 adcroft 1.6 _RL beta
339     _RL viscAh
340     _RL viscAz
341 cnh 1.27 _RL viscAp
342 cnh 1.25 _RL viscAr
343 adcroft 1.6 _RL viscA4
344     _RL diffKhT
345 cnh 1.25 _RL diffKrT
346 adcroft 1.6 _RL diffKzT
347 cnh 1.27 _RL diffKpT
348 adcroft 1.6 _RL diffK4T
349     _RL diffKhS
350 cnh 1.25 _RL diffKrS
351 adcroft 1.6 _RL diffKzS
352 cnh 1.27 _RL diffKpS
353 adcroft 1.6 _RL diffK4S
354     _RL delt
355     _RL tauCD
356     _RL rCD
357     _RL GMmaxslope
358     _RL GMlength
359     _RL GMalpha
360     _RL GMdepth
361     _RL GMkbackground
362 adcroft 1.21 _RL GMmaxval
363 adcroft 1.6 _RL gravity
364 cnh 1.8 _RL gBaro
365 adcroft 1.6 _RL rhonil
366 cnh 1.25 _RL recip_rhonil
367     _RL rhoConst
368 cnh 1.26 _RL recip_rhoConst
369     _RL specVol_S(Nr)
370 cnh 1.25 _RL tRef(Nr)
371 cnh 1.26 _RL theta_S(Nr)
372 cnh 1.25 _RL sRef(Nr)
373 cnh 1.11 _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
374 adcroft 1.6 _RL startTime
375     _RL endTime
376     _RL chkPtFreq
377 cnh 1.7 _RL pChkPtFreq
378 adcroft 1.6 _RL dumpFreq
379 adcroft 1.20 _RL taveFreq
380 cnh 1.9 _RL afFacMom
381     _RL vfFacMom
382     _RL pfFacMom
383     _RL cfFacMom
384     _RL foFacMom
385 cnh 1.15 _RL mTFacMom
386 cnh 1.9 _RL cAdjFreq
387 cnh 1.15 _RL omega
388 cnh 1.18 _RL tauThetaClimRelax
389     _RL lambdaThetaClimRelax
390     _RL tauSaltClimRelax
391     _RL lambdaSaltClimRelax
392 adcroft 1.19 _RL externForcingCycle
393     _RL externForcingPeriod
394 adcroft 1.6
395 cnh 1.1 COMMON /PARM_A/ HeatCapacity_Cp,
396     & Lamba_theta
397 adcroft 1.6 _RL HeatCapacity_Cp
398     _RL Lamba_theta
399 adcroft 1.5
400     C Equation of State (polynomial coeffients)
401     COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
402 cnh 1.25 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
403 adcroft 1.5 C Linear equation of state
404     C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ).
405     C sBeta - Linear EOS haline contraction coefficient.
406 adcroft 1.12 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
407 adcroft 1.6 _RL tAlpha
408     _RL sBeta
409 adcroft 1.12 character*(6) eosType
410 cnh 1.7

  ViewVC Help
Powered by ViewVC 1.1.22