| 1 |
C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.132 2004/10/17 23:03:08 jmc Exp $ |
| 2 |
C $Name: $ |
| 3 |
C |
| 4 |
|
| 5 |
CBOP |
| 6 |
C !ROUTINE: PARAMS.h |
| 7 |
C !INTERFACE: |
| 8 |
C #include PARAMS.h |
| 9 |
|
| 10 |
C !DESCRIPTION: |
| 11 |
C Header file defining model "parameters". The values from the |
| 12 |
C model standard input file are stored into the variables held |
| 13 |
C here. Notes describing the parameters can also be found here. |
| 14 |
|
| 15 |
CEOP |
| 16 |
|
| 17 |
C Macros for special grid options |
| 18 |
#include "PARAMS_MACROS.h" |
| 19 |
|
| 20 |
C-- Contants |
| 21 |
C Useful physical values |
| 22 |
Real*8 PI |
| 23 |
PARAMETER ( PI = 3.14159265358979323844D0 ) |
| 24 |
Real*8 deg2rad |
| 25 |
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
| 26 |
|
| 27 |
C Symbolic values |
| 28 |
C precXXXX :: Used to indicate what precision to use for |
| 29 |
C dumping model state. |
| 30 |
INTEGER precFloat32 |
| 31 |
PARAMETER ( precFloat32 = 32 ) |
| 32 |
INTEGER precFloat64 |
| 33 |
PARAMETER ( precFloat64 = 64 ) |
| 34 |
C UNSET_xxx :: Used to indicate variables that have not been given a value |
| 35 |
Real*8 UNSET_FLOAT8 |
| 36 |
PARAMETER ( UNSET_FLOAT8 = 1.234567D5 ) |
| 37 |
Real*4 UNSET_FLOAT4 |
| 38 |
PARAMETER ( UNSET_FLOAT4 = 1.234567E5 ) |
| 39 |
_RL UNSET_RL |
| 40 |
PARAMETER ( UNSET_RL = 1.234567D5 ) |
| 41 |
_RS UNSET_RS |
| 42 |
PARAMETER ( UNSET_RS = 1.234567E5 ) |
| 43 |
INTEGER UNSET_I |
| 44 |
PARAMETER ( UNSET_I = 123456789 ) |
| 45 |
|
| 46 |
C Checkpoint data |
| 47 |
INTEGER maxNoChkptLev |
| 48 |
PARAMETER ( maxNoChkptLev = 2 ) |
| 49 |
|
| 50 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
| 51 |
C checkPtSuff :: List of checkpoint file suffices |
| 52 |
C bathyFile :: File containing bathymetry. If not defined bathymetry |
| 53 |
C is taken from inline function. |
| 54 |
C topoFile :: File containing the topography of the surface (unit=m) |
| 55 |
C (mainly used for the atmosphere = ground height). |
| 56 |
C hydrogThetaFile :: File containing initial hydrographic data for potential |
| 57 |
C temperature. |
| 58 |
C hydrogSaltFile :: File containing initial hydrographic data for salinity. |
| 59 |
C zonalWindFile :: File containing zonal wind data |
| 60 |
C meridWindFile :: File containing meridional wind data |
| 61 |
C thetaClimFile :: File containing theta climataology used |
| 62 |
C in relaxation term -lambda(theta-theta*) |
| 63 |
C saltClimFile :: File containing salt climataology used |
| 64 |
C in relaxation term -lambda(salt-salt*) |
| 65 |
C surfQfile :: File containing surface heat flux, excluding SW |
| 66 |
C (old version, kept for backward compatibility) |
| 67 |
C surfQnetFile :: File containing surface net heat flux |
| 68 |
C surfQswFile :: File containing surface shortwave radiation |
| 69 |
C dQdTfile :: File containing thermal relaxation coefficient |
| 70 |
C EmPmRfile :: File containing surface fresh water flux |
| 71 |
C pLoadFile :: File containing pressure loading |
| 72 |
C buoyancyRelation :: Flag used to indicate which relation to use to |
| 73 |
C get buoyancy. |
| 74 |
C eosType :: choose the equation of state: |
| 75 |
C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS |
| 76 |
C the_run_name :: string identifying the name of the model "run" |
| 77 |
COMMON /PARM_C/ checkPtSuff, |
| 78 |
& bathyFile, topoFile, |
| 79 |
& hydrogThetaFile, hydrogSaltFile, |
| 80 |
& zonalWindFile, meridWindFile, thetaClimFile, |
| 81 |
& saltClimFile, buoyancyRelation, |
| 82 |
& EmPmRfile, surfQfile, surfQnetFile, surfQswFile, |
| 83 |
& uVelInitFile, vVelInitFile, pSurfInitFile, |
| 84 |
& dQdTfile, ploadFile, |
| 85 |
& eosType, pickupSuff, |
| 86 |
& mdsioLocalDir, |
| 87 |
& the_run_name |
| 88 |
CHARACTER*(5) checkPtSuff(maxNoChkptLev) |
| 89 |
CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile |
| 90 |
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile |
| 91 |
CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile |
| 92 |
CHARACTER*(MAX_LEN_FNAM) zonalWindFile |
| 93 |
CHARACTER*(MAX_LEN_FNAM) meridWindFile |
| 94 |
CHARACTER*(MAX_LEN_FNAM) thetaClimFile |
| 95 |
CHARACTER*(MAX_LEN_FNAM) saltClimFile |
| 96 |
CHARACTER*(MAX_LEN_FNAM) surfQfile |
| 97 |
CHARACTER*(MAX_LEN_FNAM) surfQnetFile |
| 98 |
CHARACTER*(MAX_LEN_FNAM) surfQswFile |
| 99 |
CHARACTER*(MAX_LEN_FNAM) EmPmRfile |
| 100 |
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation |
| 101 |
CHARACTER*(MAX_LEN_FNAM) uVelInitFile |
| 102 |
CHARACTER*(MAX_LEN_FNAM) vVelInitFile |
| 103 |
CHARACTER*(MAX_LEN_FNAM) pSurfInitFile |
| 104 |
CHARACTER*(MAX_LEN_FNAM) dQdTfile |
| 105 |
CHARACTER*(MAX_LEN_FNAM) ploadFile |
| 106 |
CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir |
| 107 |
CHARACTER*(MAX_LEN_FNAM) the_run_name |
| 108 |
CHARACTER*(6) eosType |
| 109 |
CHARACTER*(10) pickupSuff |
| 110 |
|
| 111 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
| 112 |
C cg2dMaxIters :: Maximum number of iterations in the |
| 113 |
C two-dimensional con. grad solver. |
| 114 |
C cg2dChkResFreq :: Frequency with which to check residual |
| 115 |
C in con. grad solver. |
| 116 |
C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner |
| 117 |
C (non-linear free-surf.) |
| 118 |
C cg3dMaxIters :: Maximum number of iterations in the |
| 119 |
C three-dimensional con. grad solver. |
| 120 |
C cg3dChkResFreq :: Frequency with which to check residual |
| 121 |
C in con. grad solver. |
| 122 |
C nIter0 :: Start time-step number of for this run |
| 123 |
C nTimeSteps :: Number of timesteps to execute |
| 124 |
C numStepsPerPickup :: For offline setup. Frequency of pickup |
| 125 |
C of flow fields. |
| 126 |
C writeStatePrec :: Precision used for writing model state. |
| 127 |
C writeBinaryPrec :: Precision used for writing binary files |
| 128 |
C readBinaryPrec :: Precision used for reading binary files |
| 129 |
C nCheckLev :: Holds current checkpoint level |
| 130 |
C nonlinFreeSurf :: option related to non-linear free surface |
| 131 |
C =0 Linear free surface ; >0 Non-linear |
| 132 |
C select_rStar :: option related to r* vertical coordinate |
| 133 |
C =0 (default) use r coord. ; > 0 use r* |
| 134 |
C tempAdvScheme :: Temp. Horiz.Advection scheme selector |
| 135 |
C tempVertAdvScheme :: Temp. Vert. Advection scheme selector |
| 136 |
C saltAdvScheme :: Salt. Horiz.advection scheme selector |
| 137 |
C saltVertAdvScheme :: Salt. Vert. Advection scheme selector |
| 138 |
C debugLevel :: debug level selector: higher -> more writing |
| 139 |
|
| 140 |
COMMON /PARM_I/ |
| 141 |
& cg2dMaxIters, |
| 142 |
& cg2dChkResFreq, cg2dPreCondFreq, |
| 143 |
& cg3dMaxIters, |
| 144 |
& cg3dChkResFreq, |
| 145 |
& nIter0, nTimeSteps, nEndIter, |
| 146 |
& numStepsPerPickup, |
| 147 |
& writeStatePrec, nCheckLev, |
| 148 |
& writeBinaryPrec, readBinaryPrec, |
| 149 |
& nonlinFreeSurf, select_rStar, |
| 150 |
& tempAdvScheme, tempVertAdvScheme, |
| 151 |
& saltAdvScheme, saltVertAdvScheme, |
| 152 |
& tracerAdvScheme, |
| 153 |
& debugLevel |
| 154 |
INTEGER cg2dMaxIters |
| 155 |
INTEGER cg2dChkResFreq |
| 156 |
INTEGER cg2dPreCondFreq |
| 157 |
INTEGER cg3dMaxIters |
| 158 |
INTEGER cg3dChkResFreq |
| 159 |
INTEGER nIter0 |
| 160 |
INTEGER nTimeSteps |
| 161 |
INTEGER nEndIter |
| 162 |
INTEGER numStepsPerPickup |
| 163 |
INTEGER writeStatePrec |
| 164 |
INTEGER writeBinaryPrec |
| 165 |
INTEGER readBinaryPrec |
| 166 |
INTEGER nCheckLev |
| 167 |
INTEGER nonlinFreeSurf |
| 168 |
INTEGER select_rStar |
| 169 |
INTEGER tempAdvScheme, tempVertAdvScheme |
| 170 |
INTEGER saltAdvScheme, saltVertAdvScheme |
| 171 |
INTEGER tracerAdvScheme |
| 172 |
INTEGER debugLevel |
| 173 |
|
| 174 |
C |
| 175 |
INTEGER debLevZero |
| 176 |
PARAMETER(debLevZero=0) |
| 177 |
INTEGER debLevA |
| 178 |
PARAMETER(debLevA=1) |
| 179 |
INTEGER debLevB |
| 180 |
PARAMETER(debLevB=2) |
| 181 |
|
| 182 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
| 183 |
C usingCartesianGrid :: If TRUE grid generation will be in a cartesian |
| 184 |
C coordinate frame. |
| 185 |
C usingSphericalPolarGrid :: If TRUE grid generation will be in a |
| 186 |
C spherical polar frame. |
| 187 |
C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical |
| 188 |
C no_slip_sides :: Impose "no-slip" at lateral boundaries. |
| 189 |
C no_slip_bottom :: Impose "no-slip" at bottom boundary. |
| 190 |
C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V |
| 191 |
C momViscosity :: Flag which turns momentum friction terms on and off. |
| 192 |
C momAdvection :: Flag which turns advection of momentum on and off. |
| 193 |
C momForcing :: Flag which turns external forcing of momentum on |
| 194 |
C and off. |
| 195 |
C momPressureForcing :: Flag which turns pressure term in momentum equation |
| 196 |
C on and off. |
| 197 |
C metricTerms :: Flag which turns metric terms on or off. |
| 198 |
C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms. |
| 199 |
C useNHMTerms :: If TRUE use non-hydrostatic metric terms. |
| 200 |
C useCoriolis :: Flag which turns the coriolis terms on and off. |
| 201 |
C tempDiffusion :: Flag which turns diffusion of temperature on |
| 202 |
C and off. |
| 203 |
C tempAdvection :: Flag which turns advection of temperature on |
| 204 |
C and off. |
| 205 |
C tempForcing :: Flag which turns external forcing of temperature on |
| 206 |
C and off. |
| 207 |
C saltDiffusion :: Flag which turns diffusion of salinity on |
| 208 |
C and off. |
| 209 |
C saltAdvection :: Flag which turns advection of salinity on |
| 210 |
C and off. |
| 211 |
C saltForcing :: Flag which turns external forcing of salinity on |
| 212 |
C and off. |
| 213 |
C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux |
| 214 |
C as a real Fresh Water (=> changes the Sea Level) |
| 215 |
C if F, converts P+R-E to salt flux (no SL effect) |
| 216 |
C rigidLid :: Set to true to use rigid lid |
| 217 |
C implicitFreeSurface :: Set to true to use implcit free surface |
| 218 |
C exactConserv :: Set to true to conserve exactly the total Volume |
| 219 |
C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the |
| 220 |
C linear relation Phi_surf = Bo_surf*eta |
| 221 |
C momStepping :: Turns momentum equation time-stepping off |
| 222 |
C tempStepping :: Turns temperature equation time-stepping off |
| 223 |
C saltStepping :: Turns salinity equation time-stepping off |
| 224 |
C useConstantF :: Coriolis parameter set to f0 |
| 225 |
C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y |
| 226 |
C useSphereF :: Coriolis parameter set to 2.omega.sin(phi) |
| 227 |
C useCDscheme :: use CD-scheme to calculate Coriolis terms. |
| 228 |
C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986) |
| 229 |
C useJamartMomAdv :: Use wet-point method for V.I. non-linear term |
| 230 |
C SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny |
| 231 |
C upwindVorticity :: bias interpolation of vorticity in the Coriolis term |
| 232 |
C highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis |
| 233 |
C useAbsVorticity :: work with f+zeta in Coriolis terms |
| 234 |
C implicitDiffusion :: Turns implicit vertical diffusion on |
| 235 |
C implicitViscosity :: Turns implicit vertical viscosity on |
| 236 |
C tempImplVertAdv :: Turns on implicit vertical advection for Temperature |
| 237 |
C saltImplVertAdv :: Turns on implicit vertical advection for Salinity |
| 238 |
C momImplVertAdv :: Turns on implicit vertical advection for Momentum |
| 239 |
C multiDimAdvection :: Flag that enable multi-dimension advection |
| 240 |
C useMultiDimAdvec :: True if multi-dim advection is used at least once |
| 241 |
C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution |
| 242 |
C out off Adams-Bashforth time stepping. |
| 243 |
C doThetaClimRelax :: Set true if relaxation to temperature |
| 244 |
C climatology is required. |
| 245 |
C doSaltClimRelax :: Set true if relaxation to salinity |
| 246 |
C climatology is required. |
| 247 |
C periodicExternalForcing :: Set true if forcing is time-dependant |
| 248 |
C usingPCoords :: Set to indicate that we are working in pressure |
| 249 |
C coords. (jmc: is it still used ?) |
| 250 |
C usingZCoords :: Set to indicate that we are working in height |
| 251 |
C coords. (jmc: is it still used ?) |
| 252 |
C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.) |
| 253 |
C this requires specific code for restart & exchange |
| 254 |
C setCenterDr :: set cell Center depth and put Interface at the middle |
| 255 |
C nonHydrostatic :: Using non-hydrostatic terms |
| 256 |
C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm |
| 257 |
C globalFiles :: Selects between "global" and "tiled" files |
| 258 |
C useSingleCpuIO :: On SGI platforms, option globalFiles is either |
| 259 |
C slow (f77) or does not work (f90). When |
| 260 |
C useSingleCpuIO is set, mdsio_writefield.F |
| 261 |
C outputs from master mpi process only. |
| 262 |
C allowFreezing :: Allows surface water to freeze and form ice |
| 263 |
C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12) |
| 264 |
C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground) |
| 265 |
C pickup_write_mdsio :: use mdsio to write pickups |
| 266 |
C pickup_read_mdsio :: use mdsio to read pickups |
| 267 |
C pickup_write_immed :: echo the pickup immediately (for conversion) |
| 268 |
C timeave_mdsio :: use mdsio for timeave output |
| 269 |
C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output |
| 270 |
C monitor_stdio :: use stdio for monitor output |
| 271 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
| 272 |
& usingCurvilinearGrid, usingCylindricalGrid, |
| 273 |
& no_slip_sides,no_slip_bottom, |
| 274 |
& staggerTimeStep, |
| 275 |
& momViscosity, momAdvection, momForcing, useCoriolis, |
| 276 |
& momPressureForcing, vectorInvariantMomentum, |
| 277 |
& tempDiffusion, tempAdvection, tempForcing, |
| 278 |
& saltDiffusion, saltAdvection, saltForcing, |
| 279 |
& useRealFreshWaterFlux, |
| 280 |
& rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf, |
| 281 |
& momStepping, tempStepping, saltStepping, |
| 282 |
& metricTerms, usingSphericalPolarMTerms, useNHMTerms, |
| 283 |
& useConstantF, useBetaPlaneF, useSphereF, |
| 284 |
& useCDscheme, |
| 285 |
& useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv, |
| 286 |
& SadournyCoriolis, upwindVorticity, highOrderVorticity, |
| 287 |
& useAbsVorticity, |
| 288 |
& implicitDiffusion, implicitViscosity, |
| 289 |
& tempImplVertAdv, saltImplVertAdv, momImplVertAdv, |
| 290 |
& multiDimAdvection, useMultiDimAdvec, forcing_In_AB, |
| 291 |
& doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax, |
| 292 |
& periodicExternalForcing, |
| 293 |
& usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr, |
| 294 |
& nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO, |
| 295 |
& allowFreezing, useOldFreezing, groundAtK1, |
| 296 |
& usePickupBeforeC35, usePickupBeforeC54, debugMode, |
| 297 |
& readPickupWithTracer, writePickupWithTracer, |
| 298 |
& pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed, |
| 299 |
& timeave_mdsio, snapshot_mdsio, monitor_stdio, |
| 300 |
& outputTypesInclusive |
| 301 |
|
| 302 |
LOGICAL usingCartesianGrid |
| 303 |
LOGICAL usingSphericalPolarGrid |
| 304 |
LOGICAL usingCylindricalGrid |
| 305 |
LOGICAL usingCurvilinearGrid |
| 306 |
LOGICAL usingSphericalPolarMTerms |
| 307 |
LOGICAL useNHMTerms |
| 308 |
LOGICAL no_slip_sides |
| 309 |
LOGICAL no_slip_bottom |
| 310 |
LOGICAL staggerTimeStep |
| 311 |
LOGICAL momViscosity |
| 312 |
LOGICAL momAdvection |
| 313 |
LOGICAL momForcing |
| 314 |
LOGICAL momPressureForcing |
| 315 |
LOGICAL useCoriolis |
| 316 |
LOGICAL vectorInvariantMomentum |
| 317 |
LOGICAL tempDiffusion |
| 318 |
LOGICAL tempAdvection |
| 319 |
LOGICAL tempForcing |
| 320 |
LOGICAL saltDiffusion |
| 321 |
LOGICAL saltAdvection |
| 322 |
LOGICAL saltForcing |
| 323 |
LOGICAL useRealFreshWaterFlux |
| 324 |
LOGICAL rigidLid |
| 325 |
LOGICAL implicitFreeSurface |
| 326 |
LOGICAL exactConserv |
| 327 |
LOGICAL uniformLin_PhiSurf |
| 328 |
LOGICAL momStepping |
| 329 |
LOGICAL tempStepping |
| 330 |
LOGICAL saltStepping |
| 331 |
LOGICAL metricTerms |
| 332 |
LOGICAL useConstantF |
| 333 |
LOGICAL useBetaPlaneF |
| 334 |
LOGICAL useSphereF |
| 335 |
LOGICAL useCDscheme |
| 336 |
LOGICAL useEnergyConservingCoriolis |
| 337 |
LOGICAL useJamartWetPoints |
| 338 |
LOGICAL useJamartMomAdv |
| 339 |
LOGICAL SadournyCoriolis |
| 340 |
LOGICAL upwindVorticity |
| 341 |
LOGICAL highOrderVorticity |
| 342 |
LOGICAL useAbsVorticity |
| 343 |
LOGICAL implicitDiffusion |
| 344 |
LOGICAL implicitViscosity |
| 345 |
LOGICAL tempImplVertAdv |
| 346 |
LOGICAL saltImplVertAdv |
| 347 |
LOGICAL momImplVertAdv |
| 348 |
LOGICAL multiDimAdvection |
| 349 |
LOGICAL useMultiDimAdvec |
| 350 |
LOGICAL forcing_In_AB |
| 351 |
LOGICAL doThetaClimRelax |
| 352 |
LOGICAL doSaltClimRelax |
| 353 |
LOGICAL doTr1ClimRelax |
| 354 |
LOGICAL periodicExternalForcing |
| 355 |
LOGICAL usingPCoords |
| 356 |
LOGICAL usingZCoords |
| 357 |
LOGICAL useDynP_inEos_Zc |
| 358 |
LOGICAL setCenterDr |
| 359 |
LOGICAL nonHydrostatic |
| 360 |
LOGICAL quasiHydrostatic |
| 361 |
LOGICAL globalFiles |
| 362 |
LOGICAL useSingleCpuIO |
| 363 |
LOGICAL allowFreezing |
| 364 |
LOGICAL useOldFreezing |
| 365 |
LOGICAL groundAtK1 |
| 366 |
LOGICAL usePickupBeforeC35 |
| 367 |
LOGICAL usePickupBeforeC54 |
| 368 |
LOGICAL debugMode |
| 369 |
LOGICAL readPickupWithTracer |
| 370 |
LOGICAL writePickupWithTracer |
| 371 |
LOGICAL pickup_read_mdsio, pickup_write_mdsio |
| 372 |
LOGICAL pickup_write_immed |
| 373 |
LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio |
| 374 |
LOGICAL outputTypesInclusive |
| 375 |
|
| 376 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
| 377 |
C cg2dTargetResidual |
| 378 |
C :: Target residual for cg2d solver; no unit (RHS normalisation) |
| 379 |
C cg2dTargetResWunit |
| 380 |
C :: Target residual for cg2d solver; W unit (No RHS normalisation) |
| 381 |
C cg3dTargetResidual |
| 382 |
C :: Target residual for cg3d solver. |
| 383 |
C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal. |
| 384 |
C Note. 20th May 1998 |
| 385 |
C I made a weird discovery! In the model paper we argue |
| 386 |
C for the form of the preconditioner used here ( see |
| 387 |
C A Finite-volume, Incompressible Navier-Stokes Model |
| 388 |
C ...., Marshall et. al ). The algebra gives a simple |
| 389 |
C 0.5 factor for the averaging of ac and aCw to get a |
| 390 |
C symmettric pre-conditioner. By using a factor of 0.51 |
| 391 |
C i.e. scaling the off-diagonal terms in the |
| 392 |
C preconditioner down slightly I managed to get the |
| 393 |
C number of iterations for convergence in a test case to |
| 394 |
C drop form 192 -> 134! Need to investigate this further! |
| 395 |
C For now I have introduced a parameter cg2dpcOffDFac which |
| 396 |
C defaults to 0.51 but can be set at runtime. |
| 397 |
C delR :: Vertical grid spacing ( units of r ). |
| 398 |
C delRc :: Vertical grid spacing between cell centers (r unit). |
| 399 |
C delX :: Separation between cell faces (m) or (deg), depending |
| 400 |
C delY on input flags. |
| 401 |
C gravity :: Accel. due to gravity ( m/s^2 ) |
| 402 |
C recip_gravity and its inverse |
| 403 |
C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 ) |
| 404 |
C rhoNil :: Reference density for the linear equation of state |
| 405 |
C rhoConst :: Vertically constant reference density |
| 406 |
C rhoConstFresh :: Constant reference density for fresh water (rain) |
| 407 |
C tRef :: reference vertical profile for potential temperature |
| 408 |
C sRef :: reference vertical profile for salinity/specific humidity |
| 409 |
C startTime :: Start time for model ( s ) |
| 410 |
C phiMin :: Latitude of southern most cell face. |
| 411 |
C thetaMin :: Longitude of western most cell face (this |
| 412 |
C is an "inert" parameter but it is included |
| 413 |
C to make geographical references simple.) |
| 414 |
C rSphere :: Radius of sphere for a spherical polar grid ( m ). |
| 415 |
C recip_RSphere :: Reciprocal radius of sphere ( m ). |
| 416 |
C f0 :: Reference coriolis parameter ( 1/s ) |
| 417 |
C ( Southern edge f for beta plane ) |
| 418 |
C beta :: df/dy ( s^-1.m^-1 ) |
| 419 |
C omega :: Angular velocity ( rad/s ) |
| 420 |
C rotationPeriod :: Rotation period (s) (= 2.pi/omega) |
| 421 |
C viscAh :: Eddy viscosity coeff. for mixing of |
| 422 |
C momentum laterally ( m^2/s ) |
| 423 |
C viscAhW :: Eddy viscosity coeff. for mixing of vertical |
| 424 |
C momentum laterally, no effect for hydrostatic |
| 425 |
C model, defaults to viscAh if unset ( m^2/s ) |
| 426 |
C viscAr :: Eddy viscosity coeff. for mixing of |
| 427 |
C momentum vertically ( units of r^2/s ) |
| 428 |
C viscA4 :: Biharmonic viscosity coeff. for mixing of |
| 429 |
C momentum laterally ( m^4/s ) |
| 430 |
C viscC2leith :: Leith non-dimensional viscosity factor |
| 431 |
C viscAhMax :: Maximum eddy viscosity coeff. for mixing of |
| 432 |
C momentum laterally ( m^2/s ) |
| 433 |
C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of |
| 434 |
C momentum laterally ( m^4/s ) |
| 435 |
C viscAhGrid:: non-dimensional grid-size dependent viscosity |
| 436 |
C viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity |
| 437 |
C viscC4leith :: Leith non-dimensional viscosity factor |
| 438 |
C diffKhT :: Laplacian diffusion coeff. for mixing of |
| 439 |
C heat laterally ( m^2/s ) |
| 440 |
C diffKrNrT :: vertical profile of Laplacian diffusion coeff. |
| 441 |
C for mixing of heat vertically ( units of r^2/s ) |
| 442 |
C diffK4T :: Biharmonic diffusion coeff. for mixing of |
| 443 |
C heat laterally ( m^4/s ) |
| 444 |
C diffKhS :: Laplacian diffusion coeff. for mixing of |
| 445 |
C salt laterally ( m^2/s ) |
| 446 |
C diffKrNrS :: vertical profile of Laplacian diffusion coeff. |
| 447 |
C for mixing of salt vertically ( units of r^2/s ), |
| 448 |
C diffK4S :: Biharmonic diffusion coeff. for mixing of |
| 449 |
C salt laterally ( m^4/s ) |
| 450 |
C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979 |
| 451 |
C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979 |
| 452 |
C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979 |
| 453 |
C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979 |
| 454 |
C deltaT :: Default timestep ( s ) |
| 455 |
C deltaTClock :: Timestep used as model "clock". This determines the |
| 456 |
C IO frequencies and is used in tagging output. It can |
| 457 |
C be totally different to the dynamical time. Typically |
| 458 |
C it will be the deep-water timestep for accelerated runs. |
| 459 |
C Frequency of checkpointing and dumping of the model state |
| 460 |
C are referenced to this clock. ( s ) |
| 461 |
C deltaTMom :: Timestep for momemtum equations ( s ) |
| 462 |
C deltaTtracer :: Timestep for tracer equations ( s ) |
| 463 |
C deltaTfreesurf :: Timestep for free-surface equation ( s ) |
| 464 |
C freesurfFac :: Parameter to turn implicit free surface term on or off |
| 465 |
C freesurfac = 1. uses implicit free surface |
| 466 |
C freesurfac = 0. uses rigid lid |
| 467 |
C implicSurfPress :: parameter of the Crank-Nickelson time stepping : |
| 468 |
C Implicit part of Surface Pressure Gradient ( 0-1 ) |
| 469 |
C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping : |
| 470 |
C Implicit part of barotropic flow Divergence ( 0-1 ) |
| 471 |
C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...) |
| 472 |
C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m) |
| 473 |
C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
| 474 |
C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
| 475 |
C hFacInf :: Threshold (inf and sup) for fraction size of surface cell |
| 476 |
C hFacSup that control vanishing and creating levels |
| 477 |
C tauCD :: CD scheme coupling timescale ( 1/s ) |
| 478 |
C rCD :: CD scheme normalised coupling parameter ( 0-1 ) |
| 479 |
C startTime :: Starting time for this integration ( s ). |
| 480 |
C endTime :: Ending time for this integration ( s ). |
| 481 |
C chkPtFreq :: Frequency of rolling check pointing ( s ). |
| 482 |
C pChkPtFreq :: Frequency of permanent check pointing ( s ). |
| 483 |
C dumpFreq :: Frequency with which model state is written to |
| 484 |
C post-processing files ( s ). |
| 485 |
C diagFreq :: Frequency with which model writes diagnostic output |
| 486 |
C of intermediate quantities. |
| 487 |
C afFacMom :: Advection of momentum term tracer parameter |
| 488 |
C vfFacMom :: Momentum viscosity tracer parameter |
| 489 |
C pfFacMom :: Momentum pressure forcing tracer parameter |
| 490 |
C cfFacMom :: Coriolis term tracer parameter |
| 491 |
C foFacMom :: Momentum forcing tracer parameter |
| 492 |
C mtFacMom :: Metric terms tracer parameter |
| 493 |
C cosPower :: Power of cosine of latitude to multiply viscosity |
| 494 |
C cAdjFreq :: Frequency of convective adjustment |
| 495 |
C |
| 496 |
C taveFreq :: Frequency with which time-averaged model state |
| 497 |
C is written to post-processing files ( s ). |
| 498 |
C tave_lastIter :: (for state variable only) fraction of the last time |
| 499 |
C step (of each taveFreq period) put in the time average. |
| 500 |
C (fraction for 1rst iter = 1 - tave_lastIter) |
| 501 |
C tauThetaClimRelax :: Relaxation to climatology time scale ( s ). |
| 502 |
C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ). |
| 503 |
C tauSaltClimRelax :: Relaxation to climatology time scale ( s ). |
| 504 |
C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ). |
| 505 |
C latBandClimRelax :: latitude band where Relaxation to Clim. is applied, |
| 506 |
C i.e. where |yC| <= latBandClimRelax |
| 507 |
C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month) |
| 508 |
C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year) |
| 509 |
C (note: externForcingCycle must be an integer |
| 510 |
C number times externForcingPeriod) |
| 511 |
C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux |
| 512 |
C (use model surface (local) value if set to -1) |
| 513 |
C temp_EvPrRn :: temperature of Rain & Evap. |
| 514 |
C salt_EvPrRn :: salinity of Rain & Evap. |
| 515 |
C trac_EvPrRn :: tracer concentration in Rain & Evap. |
| 516 |
C (notes: a) tracer content of Rain/Evap only used if both |
| 517 |
C NonLin_FrSurf & useRealFreshWater are set. |
| 518 |
C b) use model surface (local) value if set to UNSET_RL) |
| 519 |
C horiVertRatio :: Ratio on units in vertical to units in horizontal. |
| 520 |
C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). |
| 521 |
C ( g*rho if horiz in m and vertical in Pa ). |
| 522 |
C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as |
| 523 |
C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel) |
| 524 |
C bottomDragLinear :: Drag coefficient built in to core dynamics |
| 525 |
C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m ) |
| 526 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit, |
| 527 |
& cg2dpcOffDFac, cg3dTargetResidual, |
| 528 |
& delR, delRc, delX, delY, |
| 529 |
& deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock, |
| 530 |
& abeps, startTime, |
| 531 |
& phiMin, thetaMin, rSphere, recip_RSphere, f0, beta, |
| 532 |
& fCori, fCoriG, fCoriCos, |
| 533 |
& viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith, |
| 534 |
& viscA4, viscA4Max, viscA4Grid, viscC4leith, |
| 535 |
& viscAr, viscAstrain, viscAtension, |
| 536 |
& diffKhT, diffK4T, diffKrNrT, |
| 537 |
& diffKhS, diffK4S, diffKrNrS, |
| 538 |
& diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho, |
| 539 |
& delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow, |
| 540 |
& hFacMin, hFacMinDz, hFacInf, hFacSup, |
| 541 |
& gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, |
| 542 |
& recip_rhoConst, rhoConst, |
| 543 |
& rhoConstFresh, convertEmP2rUnit, tRef, sRef, |
| 544 |
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq, |
| 545 |
& diagFreq, taveFreq, tave_lastIter, monitorFreq, |
| 546 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
| 547 |
& cosPower, cAdjFreq, omega, rotationPeriod, |
| 548 |
& tauThetaClimRelax, lambdaThetaClimRelax, |
| 549 |
& tauSaltClimRelax, lambdaSaltClimRelax, |
| 550 |
& tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax, |
| 551 |
& externForcingCycle, externForcingPeriod, |
| 552 |
& convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn, |
| 553 |
& hFacMinDr, hFacMinDp, |
| 554 |
& horiVertRatio, recip_horiVertRatio, |
| 555 |
& ivdc_kappa, Ro_SeaLevel, |
| 556 |
& bottomDragLinear,bottomDragQuadratic, |
| 557 |
& tCyl |
| 558 |
|
| 559 |
_RL cg2dTargetResidual |
| 560 |
_RL cg2dTargetResWunit |
| 561 |
_RL cg3dTargetResidual |
| 562 |
_RL cg2dpcOffDFac |
| 563 |
_RL delR(Nr) |
| 564 |
_RL delRc(Nr+1) |
| 565 |
_RL delX(Nx) |
| 566 |
_RL delY(Ny) |
| 567 |
_RL deltaT |
| 568 |
_RL deltaTClock |
| 569 |
_RL deltaTmom |
| 570 |
_RL deltaTtracer |
| 571 |
_RL deltaTfreesurf |
| 572 |
_RL abeps |
| 573 |
_RL phiMin |
| 574 |
_RL thetaMin |
| 575 |
_RL rSphere |
| 576 |
_RL recip_RSphere |
| 577 |
_RL f0 |
| 578 |
_RL freeSurfFac |
| 579 |
_RL implicSurfPress |
| 580 |
_RL implicDiv2Dflow |
| 581 |
_RL hFacMin |
| 582 |
_RL hFacMinDz |
| 583 |
_RL hFacMinDp |
| 584 |
_RL hFacMinDr |
| 585 |
_RL hFacInf |
| 586 |
_RL hFacSup |
| 587 |
_RL beta |
| 588 |
_RL viscAh |
| 589 |
_RL viscAhW |
| 590 |
_RL viscAhMax |
| 591 |
_RL viscAhGrid |
| 592 |
_RL viscC2leith |
| 593 |
_RL viscAstrain |
| 594 |
_RL viscAtension |
| 595 |
_RL viscAr |
| 596 |
_RL viscA4 |
| 597 |
_RL viscA4Max |
| 598 |
_RL viscA4Grid |
| 599 |
_RL viscC4leith |
| 600 |
_RL diffKhT |
| 601 |
_RL diffKrNrT(Nr) |
| 602 |
_RL diffK4T |
| 603 |
_RL diffKhS |
| 604 |
_RL diffKrNrS(Nr) |
| 605 |
_RL diffK4S |
| 606 |
_RL diffKrBL79surf |
| 607 |
_RL diffKrBL79deep |
| 608 |
_RL diffKrBL79scl |
| 609 |
_RL diffKrBL79Ho |
| 610 |
_RL delt |
| 611 |
_RL tauCD |
| 612 |
_RL rCD |
| 613 |
_RL gravity |
| 614 |
_RL recip_gravity |
| 615 |
_RL gBaro |
| 616 |
_RL rhonil |
| 617 |
_RL recip_rhonil |
| 618 |
_RL rhoConst |
| 619 |
_RL recip_rhoConst |
| 620 |
_RL rhoConstFresh |
| 621 |
_RL convertEmP2rUnit |
| 622 |
_RL tRef(Nr) |
| 623 |
_RL sRef(Nr) |
| 624 |
_RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 625 |
_RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 626 |
_RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 627 |
_RL startTime |
| 628 |
_RL endTime |
| 629 |
_RL chkPtFreq |
| 630 |
_RL pChkPtFreq |
| 631 |
_RL dumpFreq |
| 632 |
_RL adjDumpFreq |
| 633 |
_RL diagFreq |
| 634 |
_RL taveFreq |
| 635 |
_RL tave_lastIter |
| 636 |
_RL monitorFreq |
| 637 |
_RL afFacMom |
| 638 |
_RL vfFacMom |
| 639 |
_RL pfFacMom |
| 640 |
_RL cfFacMom |
| 641 |
_RL foFacMom |
| 642 |
_RL mTFacMom |
| 643 |
_RL cosPower |
| 644 |
_RL cAdjFreq |
| 645 |
_RL omega |
| 646 |
_RL rotationPeriod |
| 647 |
_RL tauThetaClimRelax |
| 648 |
_RL lambdaThetaClimRelax |
| 649 |
_RL tauSaltClimRelax |
| 650 |
_RL lambdaSaltClimRelax |
| 651 |
_RL tauTr1ClimRelax |
| 652 |
_RL lambdaTr1ClimRelax |
| 653 |
_RL latBandClimRelax |
| 654 |
_RL externForcingCycle |
| 655 |
_RL externForcingPeriod |
| 656 |
_RL convertFW2Salt |
| 657 |
_RL temp_EvPrRn |
| 658 |
_RL salt_EvPrRn |
| 659 |
_RL trac_EvPrRn |
| 660 |
_RL horiVertRatio |
| 661 |
_RL recip_horiVertRatio |
| 662 |
_RL ivdc_kappa |
| 663 |
_RL Ro_SeaLevel |
| 664 |
_RL bottomDragLinear |
| 665 |
_RL bottomDragQuadratic |
| 666 |
_RL tCyl |
| 667 |
|
| 668 |
C-- COMMON /PARM_A/ Thermodynamics constants ? |
| 669 |
COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp |
| 670 |
_RL HeatCapacity_Cp |
| 671 |
_RL recip_Cp |
| 672 |
|
| 673 |
C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...) |
| 674 |
C celsius2K :: convert centigrade (Celsius) degree to Kelvin |
| 675 |
C atm_Po :: standard reference pressure |
| 676 |
C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure |
| 677 |
C atm_Rd :: gas constant for dry air |
| 678 |
C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS) |
| 679 |
C atm_Rq :: water vapour specific volume anomaly relative to dry air |
| 680 |
C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg]) |
| 681 |
C integr_GeoPot :: option to select the way we integrate the geopotential |
| 682 |
C (still a subject of discussions ...) |
| 683 |
C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is |
| 684 |
C derived from the orography. Implemented: 0,1 (see INI_P_GROUND) |
| 685 |
COMMON /PARM_ATM/ |
| 686 |
& celsius2K, |
| 687 |
& atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po, |
| 688 |
& integr_GeoPot, selectFindRoSurf |
| 689 |
_RL celsius2K |
| 690 |
_RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq |
| 691 |
INTEGER integr_GeoPot, selectFindRoSurf |
| 692 |
|
| 693 |
C Logical flags for selecting packages |
| 694 |
LOGICAL useOPPS |
| 695 |
LOGICAL usePP81 |
| 696 |
LOGICAL useMY82 |
| 697 |
LOGICAL useGGL90 |
| 698 |
LOGICAL useKPP |
| 699 |
LOGICAL useGMRedi |
| 700 |
LOGICAL useOBCS |
| 701 |
LOGICAL useAIM |
| 702 |
LOGICAL useLand |
| 703 |
LOGICAL useGrdchk |
| 704 |
LOGICAL useECCO |
| 705 |
LOGICAL useSHAP_FILT |
| 706 |
LOGICAL useZONAL_FILT |
| 707 |
LOGICAL useFLT |
| 708 |
LOGICAL usePTRACERS |
| 709 |
LOGICAL useSBO |
| 710 |
LOGICAL useSEAICE |
| 711 |
LOGICAL useBulkForce |
| 712 |
LOGICAL useThSIce |
| 713 |
LOGICAL usefizhi |
| 714 |
LOGICAL usegridalt |
| 715 |
LOGICAL usediagnostics |
| 716 |
LOGICAL useEBM |
| 717 |
LOGICAL useMNC |
| 718 |
COMMON /PARM_PACKAGES/ |
| 719 |
& useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO, |
| 720 |
& useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT, |
| 721 |
& usePTRACERS, useSBO, useSEAICE, useThSIce, useBulkForce, |
| 722 |
& usefizhi, usegridalt, usediagnostics, useEBM, useMNC, |
| 723 |
& usePP81, useMY82, useOPPS, useGGL90 |
| 724 |
|
| 725 |
CEH3 ;;; Local Variables: *** |
| 726 |
CEH3 ;;; mode:fortran *** |
| 727 |
CEH3 ;;; End: *** |
Parent Directory
| 
Revision Log
| 
Revision Graph