4 |
C | PARAMS.h | |
C | PARAMS.h | |
5 |
C | o Header file defining model "parameters". | |
C | o Header file defining model "parameters". | |
6 |
C |==========================================================| |
C |==========================================================| |
7 |
C | The values from the model's standard input file are | |
C | The values from the model standard input file are | |
8 |
C | stored into the variables held here. Notes describing | |
C | stored into the variables held here. Notes describing | |
9 |
C | the parameters can also be found here. | |
C | the parameters can also be found here. | |
10 |
C \==========================================================/ |
C \==========================================================/ |
26 |
PARAMETER ( precFloat32 = 0 ) |
PARAMETER ( precFloat32 = 0 ) |
27 |
INTEGER precFloat64 |
INTEGER precFloat64 |
28 |
PARAMETER ( precFloat64 = 1 ) |
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 |
C Checkpoint data |
42 |
INTEGER maxNoChkptLev |
INTEGER maxNoChkptLev |
76 |
C two-dimensional con. grad solver. |
C two-dimensional con. grad solver. |
77 |
C cg2dChkResFreq - Frequency with which to check residual |
C cg2dChkResFreq - Frequency with which to check residual |
78 |
C in con. grad solver. |
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 |
C nIter0 - Start time-step number of for this run |
84 |
C nTimeSteps - Number of timesteps to execute |
C nTimeSteps - Number of timesteps to execute |
85 |
C numStepsPerPickup - For offline setup. Frequency of pickup |
C numStepsPerPickup - For offline setup. Frequency of pickup |
91 |
COMMON /PARM_I/ |
COMMON /PARM_I/ |
92 |
& cg2dMaxIters, |
& cg2dMaxIters, |
93 |
& cg2dChkResFreq, |
& cg2dChkResFreq, |
94 |
|
& cg3dMaxIters, |
95 |
|
& cg3dChkResFreq, |
96 |
& nIter0, nTimeSteps, |
& nIter0, nTimeSteps, |
97 |
& numStepsPerPickup, |
& numStepsPerPickup, |
98 |
& writeStatePrec, nCheckLev, |
& writeStatePrec, nCheckLev, |
99 |
& writeBinaryPrec, readBinaryPrec |
& writeBinaryPrec, readBinaryPrec |
100 |
INTEGER cg2dMaxIters |
INTEGER cg2dMaxIters |
101 |
INTEGER cg2dChkResFreq |
INTEGER cg2dChkResFreq |
102 |
|
INTEGER cg3dMaxIters |
103 |
|
INTEGER cg3dChkResFreq |
104 |
INTEGER nIter0 |
INTEGER nIter0 |
105 |
INTEGER nTimeSteps |
INTEGER nTimeSteps |
106 |
INTEGER numStepsPerPickup |
INTEGER numStepsPerPickup |
149 |
C doSaltClimRelax - Set true if relaxation to salinity |
C doSaltClimRelax - Set true if relaxation to salinity |
150 |
C climatology is required. |
C climatology is required. |
151 |
C periodicExternalForcing - Set true if forcing is time-dependant |
C periodicExternalForcing - Set true if forcing is time-dependant |
152 |
|
C usingPCoords - Set to indicate that we are working in pressure |
153 |
|
C coords. |
154 |
|
C usingZCoords - Set to indicate that we are working in height |
155 |
|
C coords. |
156 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
157 |
& momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing, |
& momViscosity, momAdvection, momForcing, useCoriolis, |
158 |
& tempDiffusion, tempAdvection, tempForcing, |
& momPressureForcing,tempDiffusion, tempAdvection, tempForcing, |
159 |
& saltDiffusion, saltAdvection, saltForcing, |
& saltDiffusion, saltAdvection, saltForcing, |
160 |
& implicitFreeSurface, rigidLid, |
& implicitFreeSurface, rigidLid, |
161 |
& momStepping, tempStepping, saltStepping, |
& momStepping, tempStepping, saltStepping, |
162 |
& metricTerms, usingSphericalPolarMTerms, |
& metricTerms, usingSphericalPolarMTerms, |
163 |
& useConstantF, useBetaPlaneF, useSphereF, |
& useConstantF, useBetaPlaneF, useSphereF, |
164 |
& implicitDiffusion, doThetaClimRelax, doSaltClimRelax, |
& implicitDiffusion, doThetaClimRelax, doSaltClimRelax, |
165 |
& periodicExternalForcing |
& periodicExternalForcing, usingPCoords, usingZCoords |
166 |
LOGICAL usingCartesianGrid |
LOGICAL usingCartesianGrid |
167 |
LOGICAL usingSphericalPolarGrid |
LOGICAL usingSphericalPolarGrid |
168 |
LOGICAL usingSphericalPolarMTerms |
LOGICAL usingSphericalPolarMTerms |
190 |
LOGICAL doThetaClimRelax |
LOGICAL doThetaClimRelax |
191 |
LOGICAL doSaltClimRelax |
LOGICAL doSaltClimRelax |
192 |
LOGICAL periodicExternalForcing |
LOGICAL periodicExternalForcing |
193 |
|
LOGICAL usingPCoords |
194 |
|
LOGICAL usingZCoords |
195 |
|
|
196 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
197 |
C cg2dTargetResidual |
C cg2dTargetResidual |
198 |
C - Target residual for cg2d solver. |
C - Target residual for cg2d solver. |
199 |
|
C cg3dTargetResidual |
200 |
|
C - Target residual for cg3d solver. |
201 |
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
202 |
C Note. 20th May 1998 |
C Note. 20th May 1998 |
203 |
C I made a weird discovery! In the model paper we argue |
C I made a weird discovery! In the model paper we argue |
218 |
C delX - Separation between cell faces (m) or (deg), depending |
C delX - Separation between cell faces (m) or (deg), depending |
219 |
C delY on input flags. |
C delY on input flags. |
220 |
C gravity - Accel. due to gravity ( m/s^2 ) |
C gravity - Accel. due to gravity ( m/s^2 ) |
221 |
|
C recip_gravity and its inverse |
222 |
C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 ) |
C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 ) |
223 |
C ronil - Reference density |
C ronil - Reference density |
224 |
C rhoConst - Vertically constant reference density |
C rhoConst - Vertically constant reference density |
277 |
C freesurfac = 0. uses rigid lid |
C freesurfac = 0. uses rigid lid |
278 |
C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) |
C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) |
279 |
C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) |
C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) |
280 |
|
C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
281 |
C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
282 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
C tauCD - CD scheme coupling timescale ( 1/s ) |
283 |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
311 |
C externForcingCycle - Is the repeat time of the forcing (eg. 1 year) |
C externForcingCycle - Is the repeat time of the forcing (eg. 1 year) |
312 |
C (note: externForcingCycle must be an integer |
C (note: externForcingCycle must be an integer |
313 |
C number times externForcingPeriod) |
C number times externForcingPeriod) |
314 |
|
C horiVertRatio - Ratio on units in vertical to units in horizontal. |
315 |
|
C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). |
316 |
|
C ( g*rho if horiz in m and vertical in Pa ). |
317 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, |
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, |
318 |
|
& cg3dTargetResidual, |
319 |
& delP, delZ, delR, delX, delY, |
& delP, delZ, delR, delX, delY, |
320 |
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin, |
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, |
321 |
& thetaMin, rSphere, recip_RSphere, f0, fCori, beta, |
& phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta, |
322 |
& viscAh, viscAz, viscA4, viscAr, |
& viscAh, viscAz, viscA4, viscAr, |
323 |
& diffKhT, diffKzT, diffK4T, diffKrT, |
& diffKhT, diffKzT, diffK4T, diffKrT, |
324 |
& diffKhS, diffKzS, diffK4S, diffKrS, |
& diffKhS, diffKzS, diffK4S, diffKrS, |
325 |
& delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, |
& delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, |
326 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, |
327 |
& gravity, gBaro, rhonil, recip_rhonil, |
& gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, |
328 |
& recip_rhoConst, rhoConst, tRef, sRef, |
& recip_rhoConst, rhoConst, tRef, sRef, |
329 |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, |
330 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
331 |
& cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, |
& cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, |
332 |
& tauSaltClimRelax, lambdaSaltClimRelax, |
& tauSaltClimRelax, lambdaSaltClimRelax, |
333 |
& externForcingCycle, externForcingPeriod, |
& externForcingCycle, externForcingPeriod, |
334 |
& viscAp, diffKpT, diffKpS, hFacMinDr, |
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
335 |
& theta_S, specVol_S |
& theta_S, specVol_S, horiVertRatio, recip_horiVertRatio |
336 |
|
|
337 |
_RL cg2dTargetResidual |
_RL cg2dTargetResidual |
338 |
|
_RL cg3dTargetResidual |
339 |
_RL cg2dpcOffDFac |
_RL cg2dpcOffDFac |
340 |
_RL delZ(Nr) |
_RL delZ(Nr) |
341 |
_RL delP(Nr) |
_RL delP(Nr) |
355 |
_RL freeSurfFac |
_RL freeSurfFac |
356 |
_RL hFacMin |
_RL hFacMin |
357 |
_RL hFacMinDz |
_RL hFacMinDz |
358 |
|
_RL hFacMinDp |
359 |
_RL hFacMinDr |
_RL hFacMinDr |
360 |
_RL beta |
_RL beta |
361 |
_RL viscAh |
_RL viscAh |
383 |
_RL GMkbackground |
_RL GMkbackground |
384 |
_RL GMmaxval |
_RL GMmaxval |
385 |
_RL gravity |
_RL gravity |
386 |
|
_RL recip_gravity |
387 |
_RL gBaro |
_RL gBaro |
388 |
_RL rhonil |
_RL rhonil |
389 |
_RL recip_rhonil |
_RL recip_rhonil |
414 |
_RL lambdaSaltClimRelax |
_RL lambdaSaltClimRelax |
415 |
_RL externForcingCycle |
_RL externForcingCycle |
416 |
_RL externForcingPeriod |
_RL externForcingPeriod |
417 |
|
_RL horiVertRatio |
418 |
|
_RL recip_horiVertRatio |
419 |
|
|
420 |
COMMON /PARM_A/ HeatCapacity_Cp, |
COMMON /PARM_A/ HeatCapacity_Cp, |
421 |
& Lamba_theta |
& Lamba_theta |