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 |
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 |
246 |
C momentum laterally ( m^2/s ) |
C momentum laterally ( m^2/s ) |
247 |
C viscAz - Eddy viscosity coeff. for mixing of |
C viscAz - Eddy viscosity coeff. for mixing of |
248 |
C momentum vertically ( m^2/s ) |
C momentum vertically ( m^2/s ) |
249 |
|
C viscAp - Eddy viscosity coeff. for mixing of |
250 |
|
C momentum vertically ( Pa^2/s ) |
251 |
C viscAr - Eddy viscosity coeff. for mixing of |
C viscAr - Eddy viscosity coeff. for mixing of |
252 |
C momentum vertically ( units of r^2/s ) |
C momentum vertically ( units of r^2/s ) |
253 |
C viscA4 - Biharmonic viscosity coeff. for mixing of |
C viscA4 - Biharmonic viscosity coeff. for mixing of |
256 |
C heat laterally ( m^2/s ) |
C heat laterally ( m^2/s ) |
257 |
C diffKzT - Laplacian diffusion coeff. for mixing of |
C diffKzT - Laplacian diffusion coeff. for mixing of |
258 |
C heat vertically ( m^2/s ) |
C heat vertically ( m^2/s ) |
259 |
|
C diffKpT - Laplacian diffusion coeff. for mixing of |
260 |
|
C heat vertically ( Pa^2/s ) |
261 |
C diffKrT - Laplacian diffusion coeff. for mixing of |
C diffKrT - Laplacian diffusion coeff. for mixing of |
262 |
C heat vertically ( units of r^2/s ) |
C heat vertically ( units of r^2/s ) |
263 |
C diffK4T - Biharmonic diffusion coeff. for mixing of |
C diffK4T - Biharmonic diffusion coeff. for mixing of |
266 |
C salt laterally ( m^2/s ) |
C salt laterally ( m^2/s ) |
267 |
C diffKzS - Laplacian diffusion coeff. for mixing of |
C diffKzS - Laplacian diffusion coeff. for mixing of |
268 |
C salt vertically ( m^2/s ) |
C salt vertically ( m^2/s ) |
269 |
|
C diffKpS - Laplacian diffusion coeff. for mixing of |
270 |
|
C salt vertically ( Pa^2/s ) |
271 |
C diffKrS - Laplacian diffusion coeff. for mixing of |
C diffKrS - Laplacian diffusion coeff. for mixing of |
272 |
C salt vertically ( units of r^2/s ) |
C salt vertically ( units of r^2/s ) |
273 |
C diffK4S - Biharmonic diffusion coeff. for mixing of |
C diffK4S - Biharmonic diffusion coeff. for mixing of |
286 |
C freesurfac = 0. uses rigid lid |
C freesurfac = 0. uses rigid lid |
287 |
C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) |
C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) |
288 |
C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) |
C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) |
289 |
|
C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
290 |
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) |
291 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
C tauCD - CD scheme coupling timescale ( 1/s ) |
292 |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
293 |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
294 |
C GMlength - Length to use in Visbeck et al. formula for K (m) |
C GMlength - Length to use in Visbeck et al. formula for K (m) |
295 |
C GMalpha - alpha to use in Visbeck et al. formula for K |
C GMalpha - alpha to use in Visbeck et al. formula for K |
296 |
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
297 |
C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s ) |
C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s ) |
298 |
C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s ) |
C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s ) |
299 |
C startTime - Starting time for this integration ( s ). |
C startTime - Starting time for this integration ( s ). |
310 |
C mtFacMom - Metric terms tracer parameter |
C mtFacMom - Metric terms tracer parameter |
311 |
C cAdjFreq - Frequency of convective adjustment |
C cAdjFreq - Frequency of convective adjustment |
312 |
C |
C |
313 |
C taveFreq - Frequency with which time-averaged model state is written to |
C taveFreq - Frequency with which time-averaged model state is written to |
314 |
C post-processing files ( s ). |
C post-processing files ( s ). |
315 |
C tauThetaClimRelax - Relaxation to climatology time scale ( s ). |
C tauThetaClimRelax - Relaxation to climatology time scale ( s ). |
316 |
C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ). |
C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ). |
317 |
C tauSaltClimRelax - Relaxation to climatology time scale ( s ). |
C tauSaltClimRelax - Relaxation to climatology time scale ( s ). |
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, theta_S, specVol_S, |
& 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, |
342 |
& cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, |
& cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, |
343 |
& tauSaltClimRelax, lambdaSaltClimRelax, |
& tauSaltClimRelax, lambdaSaltClimRelax, |
344 |
& externForcingCycle, externForcingPeriod |
& externForcingCycle, externForcingPeriod, |
345 |
|
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
346 |
|
& 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) |
367 |
_RL freeSurfFac |
_RL freeSurfFac |
368 |
_RL hFacMin |
_RL hFacMin |
369 |
_RL hFacMinDz |
_RL hFacMinDz |
370 |
|
_RL hFacMinDp |
371 |
|
_RL hFacMinDr |
372 |
_RL beta |
_RL beta |
373 |
_RL viscAh |
_RL viscAh |
374 |
_RL viscAz |
_RL viscAz |
375 |
|
_RL viscAp |
376 |
_RL viscAr |
_RL viscAr |
377 |
_RL viscA4 |
_RL viscA4 |
378 |
_RL diffKhT |
_RL diffKhT |
379 |
_RL diffKrT |
_RL diffKrT |
380 |
_RL diffKzT |
_RL diffKzT |
381 |
|
_RL diffKpT |
382 |
_RL diffK4T |
_RL diffK4T |
383 |
_RL diffKhS |
_RL diffKhS |
384 |
_RL diffKrS |
_RL diffKrS |
385 |
_RL diffKzS |
_RL diffKzS |
386 |
|
_RL diffKpS |
387 |
_RL diffK4S |
_RL diffK4S |
388 |
_RL delt |
_RL delt |
389 |
_RL tauCD |
_RL tauCD |
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 |