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 \==========================================================/ |
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 |
88 |
C writeBinaryPrec - Precision used for writing binary files |
C writeBinaryPrec - Precision used for writing binary files |
89 |
C readBinaryPrec - Precision used for reading binary files |
C readBinaryPrec - Precision used for reading binary files |
90 |
C nCheckLev - Holds current checkpoint level |
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/ |
COMMON /PARM_I/ |
99 |
& cg2dMaxIters, |
& cg2dMaxIters, |
100 |
& cg2dChkResFreq, |
& cg2dChkResFreq, |
101 |
|
& cg3dMaxIters, |
102 |
|
& cg3dChkResFreq, |
103 |
& nIter0, nTimeSteps, |
& nIter0, nTimeSteps, |
104 |
& numStepsPerPickup, |
& numStepsPerPickup, |
105 |
& writeStatePrec, nCheckLev, |
& writeStatePrec, nCheckLev, |
106 |
& writeBinaryPrec, readBinaryPrec |
& writeBinaryPrec, readBinaryPrec, |
107 |
|
& nShap |
108 |
INTEGER cg2dMaxIters |
INTEGER cg2dMaxIters |
109 |
INTEGER cg2dChkResFreq |
INTEGER cg2dChkResFreq |
110 |
|
INTEGER cg3dMaxIters |
111 |
|
INTEGER cg3dChkResFreq |
112 |
INTEGER nIter0 |
INTEGER nIter0 |
113 |
INTEGER nTimeSteps |
INTEGER nTimeSteps |
114 |
INTEGER numStepsPerPickup |
INTEGER numStepsPerPickup |
116 |
INTEGER writeBinaryPrec |
INTEGER writeBinaryPrec |
117 |
INTEGER readBinaryPrec |
INTEGER readBinaryPrec |
118 |
INTEGER nCheckLev |
INTEGER nCheckLev |
119 |
|
INTEGER nShap |
120 |
|
|
121 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
122 |
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
158 |
C doSaltClimRelax - Set true if relaxation to salinity |
C doSaltClimRelax - Set true if relaxation to salinity |
159 |
C climatology is required. |
C climatology is required. |
160 |
C periodicExternalForcing - Set true if forcing is time-dependant |
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 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
166 |
& momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing, |
& momViscosity, momAdvection, momForcing, useCoriolis, |
167 |
& tempDiffusion, tempAdvection, tempForcing, |
& momPressureForcing,tempDiffusion, tempAdvection, tempForcing, |
168 |
& saltDiffusion, saltAdvection, saltForcing, |
& saltDiffusion, saltAdvection, saltForcing, |
169 |
& implicitFreeSurface, rigidLid, |
& implicitFreeSurface, rigidLid, |
170 |
& momStepping, tempStepping, saltStepping, |
& momStepping, tempStepping, saltStepping, |
171 |
& metricTerms, usingSphericalPolarMTerms, |
& metricTerms, usingSphericalPolarMTerms, |
172 |
& useConstantF, useBetaPlaneF, useSphereF, |
& useConstantF, useBetaPlaneF, useSphereF, |
173 |
& implicitDiffusion, doThetaClimRelax, doSaltClimRelax, |
& implicitDiffusion, doThetaClimRelax, doSaltClimRelax, |
174 |
& periodicExternalForcing |
& periodicExternalForcing, usingPCoords, usingZCoords |
175 |
LOGICAL usingCartesianGrid |
LOGICAL usingCartesianGrid |
176 |
LOGICAL usingSphericalPolarGrid |
LOGICAL usingSphericalPolarGrid |
177 |
LOGICAL usingSphericalPolarMTerms |
LOGICAL usingSphericalPolarMTerms |
199 |
LOGICAL doThetaClimRelax |
LOGICAL doThetaClimRelax |
200 |
LOGICAL doSaltClimRelax |
LOGICAL doSaltClimRelax |
201 |
LOGICAL periodicExternalForcing |
LOGICAL periodicExternalForcing |
202 |
|
LOGICAL usingPCoords |
203 |
|
LOGICAL usingZCoords |
204 |
|
|
205 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
206 |
C cg2dTargetResidual |
C cg2dTargetResidual |
207 |
C - Target residual for cg2d solver. |
C - Target residual for cg2d solver. |
208 |
|
C cg3dTargetResidual |
209 |
|
C - Target residual for cg3d solver. |
210 |
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
211 |
C Note. 20th May 1998 |
C Note. 20th May 1998 |
212 |
C I made a weird discovery! In the model paper we argue |
C I made a weird discovery! In the model paper we argue |
227 |
C delX - Separation between cell faces (m) or (deg), depending |
C delX - Separation between cell faces (m) or (deg), depending |
228 |
C delY on input flags. |
C delY on input flags. |
229 |
C gravity - Accel. due to gravity ( m/s^2 ) |
C gravity - Accel. due to gravity ( m/s^2 ) |
230 |
|
C recip_gravity and its inverse |
231 |
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 ) |
232 |
C ronil - Reference density |
C ronil - Reference density |
233 |
C rhoConst - Vertically constant reference density |
C rhoConst - Vertically constant reference density |
320 |
C externForcingCycle - Is the repeat time of the forcing (eg. 1 year) |
C externForcingCycle - Is the repeat time of the forcing (eg. 1 year) |
321 |
C (note: externForcingCycle must be an integer |
C (note: externForcingCycle must be an integer |
322 |
C number times externForcingPeriod) |
C number times externForcingPeriod) |
323 |
|
C horiVertRatio - Ratio on units in vertical to units in horizontal. |
324 |
|
C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). |
325 |
|
C ( g*rho if horiz in m and vertical in Pa ). |
326 |
|
C latFFTFiltLo - Low latitude for FFT filtering of latitude |
327 |
|
C circles ( see filter*.F ) |
328 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, |
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, |
329 |
|
& cg3dTargetResidual, |
330 |
& delP, delZ, delR, delX, delY, |
& delP, delZ, delR, delX, delY, |
331 |
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin, |
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, |
332 |
& thetaMin, rSphere, recip_RSphere, f0, fCori, beta, |
& phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta, |
333 |
& viscAh, viscAz, viscA4, viscAr, |
& viscAh, viscAz, viscA4, viscAr, |
334 |
& diffKhT, diffKzT, diffK4T, diffKrT, |
& diffKhT, diffKzT, diffK4T, diffKrT, |
335 |
& diffKhS, diffKzS, diffK4S, diffKrS, |
& diffKhS, diffKzS, diffK4S, diffKrS, |
336 |
& delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, |
& delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, |
337 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, |
338 |
& gravity, gBaro, rhonil, recip_rhonil, |
& gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, |
339 |
& recip_rhoConst, rhoConst, tRef, sRef, |
& recip_rhoConst, rhoConst, tRef, sRef, |
340 |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, |
341 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
343 |
& tauSaltClimRelax, lambdaSaltClimRelax, |
& tauSaltClimRelax, lambdaSaltClimRelax, |
344 |
& externForcingCycle, externForcingPeriod, |
& externForcingCycle, externForcingPeriod, |
345 |
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
346 |
& theta_S, specVol_S |
& theta_S, specVol_S, horiVertRatio, recip_horiVertRatio, |
347 |
|
& latFFTFiltLo |
348 |
|
|
349 |
_RL cg2dTargetResidual |
_RL cg2dTargetResidual |
350 |
|
_RL cg3dTargetResidual |
351 |
_RL cg2dpcOffDFac |
_RL cg2dpcOffDFac |
352 |
_RL delZ(Nr) |
_RL delZ(Nr) |
353 |
_RL delP(Nr) |
_RL delP(Nr) |
395 |
_RL GMkbackground |
_RL GMkbackground |
396 |
_RL GMmaxval |
_RL GMmaxval |
397 |
_RL gravity |
_RL gravity |
398 |
|
_RL recip_gravity |
399 |
_RL gBaro |
_RL gBaro |
400 |
_RL rhonil |
_RL rhonil |
401 |
_RL recip_rhonil |
_RL recip_rhonil |
426 |
_RL lambdaSaltClimRelax |
_RL lambdaSaltClimRelax |
427 |
_RL externForcingCycle |
_RL externForcingCycle |
428 |
_RL externForcingPeriod |
_RL externForcingPeriod |
429 |
|
_RL horiVertRatio |
430 |
|
_RL recip_horiVertRatio |
431 |
|
_RL latFFTFiltLo |
432 |
|
|
433 |
COMMON /PARM_A/ HeatCapacity_Cp, |
COMMON /PARM_A/ HeatCapacity_Cp, |
434 |
& Lamba_theta |
& Lamba_theta |