/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Contents of /MITgcm/model/inc/PARAMS.h

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


Revision 1.35 - (show annotations) (download)
Tue Dec 8 19:44:28 1998 UTC (25 years, 5 months ago) by adcroft
Branch: MAIN
Changes since 1.34: +32 -2 lines
File MIME type: text/plain
Implementation of Open Boundaries:
 o new source code: ini_obcs.F set_obcs.F apply_obcs1.F apply_obcs2.F
                    OBCS.h
 o modified code at a few points, key changes are in
    dynamcis.F the_model_main.F and ini_cg2d.F
 o documentation in OBCS.h and doc/OpenBound.*

1 C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.34 1998/11/06 22:44:43 cnh Exp $
2 C
3 C /==========================================================\
4 C | PARAMS.h |
5 C | o Header file defining model "parameters". |
6 C |==========================================================|
7 C | The values from the model 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
12 C Macros for special grid options
13 #include "PARAMS_MACROS.h"
14
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 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 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
41 C Checkpoint data
42 INTEGER maxNoChkptLev
43 PARAMETER ( maxNoChkptLev = 2 )
44
45 C-- COMMON /PARM_C/ Character valued parameters used by the model.
46 C checkPtSuff - List of checkpoint file suffices
47 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 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 C buoyancyRelation - Flag used to indicate which relation to use to
59 C get buoyancy.
60 COMMON /PARM_C/ checkPtSuff,
61 & bathyFile, hydrogThetaFile, hydrogSaltFile,
62 & zonalWindFile, meridWindFile, thetaClimFile,
63 & saltClimFile, buoyancyRelation
64 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
65 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 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
71 CHARACTER*(MAX_LEN_FNAM) saltClimFile
72 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
73
74 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 cg3dMaxIters - Maximum number of iterations in the
80 C three-dimensional con. grad solver.
81 C cg3dChkResFreq - Frequency with which to check residual
82 C in con. grad solver.
83 C nIter0 - Start time-step number of for this run
84 C nTimeSteps - Number of timesteps to execute
85 C numStepsPerPickup - For offline setup. Frequency of pickup
86 C of flow fields.
87 C writeStatePrec - Precision used for writing model state.
88 C writeBinaryPrec - Precision used for writing binary files
89 C readBinaryPrec - Precision used for reading binary files
90 C nCheckLev - Holds current checkpoint level
91 C nShap - "Order" of shapiro filter to apply to
92 C model prognositic fields.
93 C nShap == 1 => del2
94 C nShap == 2 => del4
95 C nShap == 3 => del6
96 C etc...
97
98 COMMON /PARM_I/
99 & cg2dMaxIters,
100 & cg2dChkResFreq,
101 & cg3dMaxIters,
102 & cg3dChkResFreq,
103 & nIter0, nTimeSteps,
104 & numStepsPerPickup,
105 & writeStatePrec, nCheckLev,
106 & writeBinaryPrec, readBinaryPrec,
107 & nShap
108 INTEGER cg2dMaxIters
109 INTEGER cg2dChkResFreq
110 INTEGER cg3dMaxIters
111 INTEGER cg3dChkResFreq
112 INTEGER nIter0
113 INTEGER nTimeSteps
114 INTEGER numStepsPerPickup
115 INTEGER writeStatePrec
116 INTEGER writeBinaryPrec
117 INTEGER readBinaryPrec
118 INTEGER nCheckLev
119 INTEGER nShap
120
121 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
122 C usingCartesianGrid - If TRUE grid generation will be in a cartesian
123 C coordinate frame.
124 C usingSphericalPolarGrid - If TRUE grid generation will be in a
125 C spherical polar frame.
126 C momViscosity - Flag which turns momentum friction terms on and off.
127 C momAdvection - Flag which turns advection of momentum on and off.
128 C momForcing - Flag which turns external forcing of momentum on
129 C and off.
130 C momPressureForcing - Flag which turns pressure term in momentum equation
131 C on and off.
132 C metricTerms - Flag which turns metric terms on or off.
133 C usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
134 C useCoriolis - Flag which turns the coriolis terms on and off.
135 C tempDiffusion - Flag which turns diffusion of temperature on
136 C and off.
137 C tempAdvection - Flag which turns advection of temperature on
138 C and off.
139 C tempForcing - Flag which turns external forcing of temperature on
140 C and off.
141 C saltDiffusion - Flag which turns diffusion of salinit on
142 C and off.
143 C saltAdvection - Flag which turns advection of salinit on
144 C and off.
145 C saltForcing - Flag which turns external forcing of salinit on
146 C and off.
147 C implicitFreeSurface - Set to true to use implcit free surface
148 C rigidLid - Set to true to use rigid lid
149 C momStepping - Turns momentum equation time-stepping off
150 C tempStepping - Turns temperature equation time-stepping off
151 C saltStepping - Turns salinity equation time-stepping off
152 C useConstantF - Coriolis parameter set to f0
153 C useBetaPlaneF - Coriolis parameter set to f0 + beta.y
154 C useSphereF - Coriolis parameter set to 2.omega.sin(phi)
155 C implicitDiffusion - Turns implicit vertical diffusion on
156 C doThetaClimRelax - Set true if relaxation to temperature
157 C climatology is required.
158 C doSaltClimRelax - Set true if relaxation to salinity
159 C climatology is required.
160 C periodicExternalForcing - Set true if forcing is time-dependant
161 C usingPCoords - Set to indicate that we are working in pressure
162 C coords.
163 C usingZCoords - Set to indicate that we are working in height
164 C coords.
165 C openBoundaries - Using open-boundaries
166 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
167 & momViscosity, momAdvection, momForcing, useCoriolis,
168 & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
169 & saltDiffusion, saltAdvection, saltForcing,
170 & implicitFreeSurface, rigidLid,
171 & momStepping, tempStepping, saltStepping,
172 & metricTerms, usingSphericalPolarMTerms,
173 & useConstantF, useBetaPlaneF, useSphereF,
174 & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
175 & periodicExternalForcing, usingPCoords, usingZCoords,
176 & openBoundaries
177 LOGICAL usingCartesianGrid
178 LOGICAL usingSphericalPolarGrid
179 LOGICAL usingSphericalPolarMTerms
180 LOGICAL momViscosity
181 LOGICAL momAdvection
182 LOGICAL momForcing
183 LOGICAL momPressureForcing
184 LOGICAL useCoriolis
185 LOGICAL tempDiffusion
186 LOGICAL tempAdvection
187 LOGICAL tempForcing
188 LOGICAL saltDiffusion
189 LOGICAL saltAdvection
190 LOGICAL saltForcing
191 LOGICAL implicitFreeSurface
192 LOGICAL rigidLid
193 LOGICAL momStepping
194 LOGICAL tempStepping
195 LOGICAL saltStepping
196 LOGICAL metricTerms
197 LOGICAL useConstantF
198 LOGICAL useBetaPlaneF
199 LOGICAL useSphereF
200 LOGICAL implicitDiffusion
201 LOGICAL doThetaClimRelax
202 LOGICAL doSaltClimRelax
203 LOGICAL periodicExternalForcing
204 LOGICAL usingPCoords
205 LOGICAL usingZCoords
206 LOGICAL openBoundaries
207
208 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
209 C cg2dTargetResidual
210 C - Target residual for cg2d solver.
211 C cg3dTargetResidual
212 C - Target residual for cg3d solver.
213 C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
214 C Note. 20th May 1998
215 C I made a weird discovery! In the model paper we argue
216 C for the form of the preconditioner used here ( see
217 C A Finite-volume, Incompressible Navier-Stokes Model
218 C ...., Marshall et. al ). The algebra gives a simple
219 C 0.5 factor for the averaging of ac and aCw to get a
220 C symmettric pre-conditioner. By using a factor of 0.51
221 C i.e. scaling the off-diagonal terms in the
222 C preconditioner down slightly I managed to get the
223 C number of iterations for convergence in a test case to
224 C drop form 192 -> 134! Need to investigate this further!
225 C For now I have introduced a parameter cg2dpcOffDFac which
226 C defaults to 0.51 but can be set at runtime.
227 C delP - Vertical grid spacing ( Pa ).
228 C delZ - Vertical grid spacing ( m ).
229 C delR - Vertical grid spacing ( units of r ).
230 C delX - Separation between cell faces (m) or (deg), depending
231 C delY on input flags.
232 C gravity - Accel. due to gravity ( m/s^2 )
233 C recip_gravity and its inverse
234 C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 )
235 C ronil - Reference density
236 C rhoConst - Vertically constant reference density
237 C startTime - Start time for model ( s )
238 C phiMin - Latitude of southern most cell face.
239 C thetaMin - Longitude of western most cell face (this
240 C is an "inert" parameter but it is included
241 C to make geographical references simple.)
242 C rSphere - Radius of sphere for a spherical polar grid ( m ).
243 C recip_RSphere - Reciprocal radius of sphere ( m ).
244 C f0 - Reference coriolis parameter ( 1/s )
245 C ( Southern edge f for beta plane )
246 C beta - df/dy ( s^-1.m^-1 )
247 C omega - Angular velocity ( rad/s )
248 C viscAh - Eddy viscosity coeff. for mixing of
249 C momentum laterally ( m^2/s )
250 C viscAz - Eddy viscosity coeff. for mixing of
251 C momentum vertically ( m^2/s )
252 C viscAp - Eddy viscosity coeff. for mixing of
253 C momentum vertically ( Pa^2/s )
254 C viscAr - Eddy viscosity coeff. for mixing of
255 C momentum vertically ( units of r^2/s )
256 C viscA4 - Biharmonic viscosity coeff. for mixing of
257 C momentum laterally ( m^4/s )
258 C diffKhT - Laplacian diffusion coeff. for mixing of
259 C heat laterally ( m^2/s )
260 C diffKzT - Laplacian diffusion coeff. for mixing of
261 C heat vertically ( m^2/s )
262 C diffKpT - Laplacian diffusion coeff. for mixing of
263 C heat vertically ( Pa^2/s )
264 C diffKrT - Laplacian diffusion coeff. for mixing of
265 C heat vertically ( units of r^2/s )
266 C diffK4T - Biharmonic diffusion coeff. for mixing of
267 C heat laterally ( m^4/s )
268 C diffKhS - Laplacian diffusion coeff. for mixing of
269 C salt laterally ( m^2/s )
270 C diffKzS - Laplacian diffusion coeff. for mixing of
271 C salt vertically ( m^2/s )
272 C diffKpS - Laplacian diffusion coeff. for mixing of
273 C salt vertically ( Pa^2/s )
274 C diffKrS - Laplacian diffusion coeff. for mixing of
275 C salt vertically ( units of r^2/s )
276 C diffK4S - Biharmonic diffusion coeff. for mixing of
277 C salt laterally ( m^4/s )
278 C deltaT - Default timestep ( s )
279 C deltaTClock - Timestep used as model "clock". This determines the
280 C IO frequencies and is used in tagging output. It can
281 C be totally different to the dynamical time. Typically
282 C it will be the deep-water timestep for accelerated runs.
283 C Frequency of checkpointing and dumping of the model state
284 C are referenced to this clock. ( s )
285 C deltaTMom - Timestep for momemtum equations ( s )
286 C deltaTtracer - Timestep for tracer equations ( s )
287 C freesurfFac - Parameter to turn implicit free surface term on or off
288 C freesurfac = 1. uses implicit free surface
289 C freesurfac = 0. uses rigid lid
290 C hFacMin - Minimum fraction size of a cell (affects hFacC etc...)
291 C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m)
292 C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
293 C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
294 C tauCD - CD scheme coupling timescale ( 1/s )
295 C rCD - CD scheme normalised coupling parameter ( 0-1 )
296 C GMmaxslope - max. slope allowed in GM/Redi tensor
297 C GMlength - Length to use in Visbeck et al. formula for K (m)
298 C GMalpha - alpha to use in Visbeck et al. formula for K
299 C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.)
300 C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
301 C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
302 C startTime - Starting time for this integration ( s ).
303 C endTime - Ending time for this integration ( s ).
304 C chkPtFreq - Frequency of rolling check pointing ( s ).
305 C pChkPtFreq - Frequency of permanent check pointing ( s ).
306 C dumpFreq - Frequency with which model state is written to
307 C post-processing files ( s ).
308 C afFacMom - Advection of momentum term tracer parameter
309 C vfFacMom - Momentum viscosity tracer parameter
310 C pfFacMom - Momentum pressure forcing tracer parameter
311 C cfFacMom - Coriolis term tracer parameter
312 C foFacMom - Momentum forcing tracer parameter
313 C mtFacMom - Metric terms tracer parameter
314 C cAdjFreq - Frequency of convective adjustment
315 C
316 C taveFreq - Frequency with which time-averaged model state is written to
317 C post-processing files ( s ).
318 C tauThetaClimRelax - Relaxation to climatology time scale ( s ).
319 C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
320 C tauSaltClimRelax - Relaxation to climatology time scale ( s ).
321 C lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
322 C externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
323 C externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
324 C (note: externForcingCycle must be an integer
325 C number times externForcingPeriod)
326 C horiVertRatio - Ratio on units in vertical to units in horizontal.
327 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
328 C ( g*rho if horiz in m and vertical in Pa ).
329 C latFFTFiltLo - Low latitude for FFT filtering of latitude
330 C circles ( see filter*.F )
331 COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
332 & cg3dTargetResidual,
333 & delP, delZ, delR, delX, delY,
334 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
335 & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
336 & viscAh, viscAz, viscA4, viscAr,
337 & diffKhT, diffKzT, diffK4T, diffKrT,
338 & diffKhS, diffKzS, diffK4S, diffKrS,
339 & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
340 & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
341 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
342 & recip_rhoConst, rhoConst, tRef, sRef,
343 & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
344 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
345 & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
346 & tauSaltClimRelax, lambdaSaltClimRelax,
347 & externForcingCycle, externForcingPeriod,
348 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
349 & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
350 & latFFTFiltLo
351
352 _RL cg2dTargetResidual
353 _RL cg3dTargetResidual
354 _RL cg2dpcOffDFac
355 _RL delZ(Nr)
356 _RL delP(Nr)
357 _RL delR(Nr)
358 _RL delX(Nx)
359 _RL delY(Ny)
360 _RL deltaT
361 _RL deltaTClock
362 _RL deltaTmom
363 _RL deltaTtracer
364 _RL abeps
365 _RL phiMin
366 _RL thetaMin
367 _RL rSphere
368 _RL recip_RSphere
369 _RL f0
370 _RL freeSurfFac
371 _RL hFacMin
372 _RL hFacMinDz
373 _RL hFacMinDp
374 _RL hFacMinDr
375 _RL beta
376 _RL viscAh
377 _RL viscAz
378 _RL viscAp
379 _RL viscAr
380 _RL viscA4
381 _RL diffKhT
382 _RL diffKrT
383 _RL diffKzT
384 _RL diffKpT
385 _RL diffK4T
386 _RL diffKhS
387 _RL diffKrS
388 _RL diffKzS
389 _RL diffKpS
390 _RL diffK4S
391 _RL delt
392 _RL tauCD
393 _RL rCD
394 _RL GMmaxslope
395 _RL GMlength
396 _RL GMalpha
397 _RL GMdepth
398 _RL GMkbackground
399 _RL GMmaxval
400 _RL gravity
401 _RL recip_gravity
402 _RL gBaro
403 _RL rhonil
404 _RL recip_rhonil
405 _RL rhoConst
406 _RL recip_rhoConst
407 _RL specVol_S(Nr)
408 _RL tRef(Nr)
409 _RL theta_S(Nr)
410 _RL sRef(Nr)
411 _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
412 _RL startTime
413 _RL endTime
414 _RL chkPtFreq
415 _RL pChkPtFreq
416 _RL dumpFreq
417 _RL taveFreq
418 _RL afFacMom
419 _RL vfFacMom
420 _RL pfFacMom
421 _RL cfFacMom
422 _RL foFacMom
423 _RL mTFacMom
424 _RL cAdjFreq
425 _RL omega
426 _RL tauThetaClimRelax
427 _RL lambdaThetaClimRelax
428 _RL tauSaltClimRelax
429 _RL lambdaSaltClimRelax
430 _RL externForcingCycle
431 _RL externForcingPeriod
432 _RL horiVertRatio
433 _RL recip_horiVertRatio
434 _RL latFFTFiltLo
435
436 COMMON /PARM_A/ HeatCapacity_Cp,
437 & Lamba_theta
438 _RL HeatCapacity_Cp
439 _RL Lamba_theta
440
441 C Equation of State (polynomial coeffients)
442 COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
443 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
444 C Linear equation of state
445 C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ).
446 C sBeta - Linear EOS haline contraction coefficient.
447 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
448 _RL tAlpha
449 _RL sBeta
450 character*(6) eosType
451
452 C These are input arrays (of integers) that contain the *absolute*
453 C computational index of an open-boundary (OB) point.
454 C A zero (0) element means there is no corresponding OB in that column/row.
455 C The computational coordinate refers to "tracer" cells.
456 C For a northern/southern OB, the OB V point is to the south/north.
457 C For an eastern/western OB, the OB U point is to the west/east.
458 C eg.
459 C OB_Jnorth(3)=34 means that:
460 C T( 3 ,34) is a an OB point
461 C U(3:4,34) is a an OB point
462 C V( 4 ,34) is a an OB point
463 C while
464 C OB_Jsouth(3)=1 means that:
465 C T( 3 ,1) is a an OB point
466 C U(3:4,1) is a an OB point
467 C V( 4 ,2) is a an OB point
468 C
469 C For convenience, negative values for Jnorth/Ieast refer to
470 C points relative to the Northern/Eastern edges of the model
471 C eg. OB_Jnorth(3)=-1 means that the point (3,Ny-1) is a northern O-B.
472 C
473 COMMON /PARM_OB/
474 & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
475 INTEGER OB_Jnorth(Nx)
476 INTEGER OB_Jsouth(Nx)
477 INTEGER OB_Ieast(Ny)
478 INTEGER OB_Iwest(Ny)

  ViewVC Help
Powered by ViewVC 1.1.22