| 1 |
C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.284 2016/11/28 22:47:42 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-- Contants |
| 18 |
C Useful physical values |
| 19 |
Real*8 PI |
| 20 |
PARAMETER ( PI = 3.14159265358979323844D0 ) |
| 21 |
Real*8 deg2rad |
| 22 |
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
| 23 |
|
| 24 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
| 25 |
C buoyancyRelation :: Flag used to indicate which relation to use to |
| 26 |
C get buoyancy. |
| 27 |
C eosType :: choose the equation of state: |
| 28 |
C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS |
| 29 |
C pickupSuff :: force to start from pickup files (even if nIter0=0) |
| 30 |
C and read pickup files with this suffix (max 10 Char.) |
| 31 |
C mdsioLocalDir :: read-write tiled file from/to this directory name |
| 32 |
C (+ 4 digits Processor-Rank) instead of current dir. |
| 33 |
C adTapeDir :: read-write checkpointing tape files from/to this |
| 34 |
C directory name instead of current dir. Conflicts |
| 35 |
C mdsioLocalDir, so only one of the two can be set. |
| 36 |
C In contrast to mdsioLocalDir, if specified adTapeDir |
| 37 |
C must exist before the model starts. |
| 38 |
C tRefFile :: File containing reference Potential Temperat. tRef (1.D) |
| 39 |
C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D) |
| 40 |
C rhoRefFile :: File containing reference density profile rhoRef (1.D) |
| 41 |
C gravityFile :: File containing gravity vertical profile (1.D) |
| 42 |
C delRFile :: File containing vertical grid spacing delR (1.D array) |
| 43 |
C delRcFile :: File containing vertical grid spacing delRc (1.D array) |
| 44 |
C hybSigmFile :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D) |
| 45 |
C delXFile :: File containing X-spacing grid definition (1.D array) |
| 46 |
C delYFile :: File containing Y-spacing grid definition (1.D array) |
| 47 |
C horizGridFile :: File containing horizontal-grid definition |
| 48 |
C (only when using curvilinear_grid) |
| 49 |
C bathyFile :: File containing bathymetry. If not defined bathymetry |
| 50 |
C is taken from inline function. |
| 51 |
C topoFile :: File containing the topography of the surface (unit=m) |
| 52 |
C (mainly used for the atmosphere = ground height). |
| 53 |
C addWwallFile :: File containing 2-D additional Western cell-edge wall |
| 54 |
C addSwallFile :: File containing 2-D additional Southern cell-edge wall |
| 55 |
C (e.g., to add "thin-wall" where it is =1) |
| 56 |
C hydrogThetaFile :: File containing initial hydrographic data (3-D) |
| 57 |
C for potential temperature. |
| 58 |
C hydrogSaltFile :: File containing initial hydrographic data (3-D) |
| 59 |
C for salinity. |
| 60 |
C diffKrFile :: File containing 3D specification of vertical diffusivity |
| 61 |
C viscAhDfile :: File containing 3D specification of horizontal viscosity |
| 62 |
C viscAhZfile :: File containing 3D specification of horizontal viscosity |
| 63 |
C viscA4Dfile :: File containing 3D specification of horizontal viscosity |
| 64 |
C viscA4Zfile :: File containing 3D specification of horizontal viscosity |
| 65 |
C zonalWindFile :: File containing zonal wind data |
| 66 |
C meridWindFile :: File containing meridional wind data |
| 67 |
C thetaClimFile :: File containing surface theta climataology used |
| 68 |
C in relaxation term -lambda(theta-theta*) |
| 69 |
C saltClimFile :: File containing surface salt climataology used |
| 70 |
C in relaxation term -lambda(salt-salt*) |
| 71 |
C surfQfile :: File containing surface heat flux, excluding SW |
| 72 |
C (old version, kept for backward compatibility) |
| 73 |
C surfQnetFile :: File containing surface net heat flux |
| 74 |
C surfQswFile :: File containing surface shortwave radiation |
| 75 |
C EmPmRfile :: File containing surface fresh water flux |
| 76 |
C NOTE: for backward compatibility EmPmRfile is specified in |
| 77 |
C m/s when using external_fields_load.F. It is converted |
| 78 |
C to kg/m2/s by multiplying by rhoConstFresh. |
| 79 |
C saltFluxFile :: File containing surface salt flux |
| 80 |
C pLoadFile :: File containing pressure loading |
| 81 |
C addMassFile :: File containing source/sink of fluid in the interior |
| 82 |
C eddyPsiXFile :: File containing zonal Eddy streamfunction data |
| 83 |
C eddyPsiYFile :: File containing meridional Eddy streamfunction data |
| 84 |
C the_run_name :: string identifying the name of the model "run" |
| 85 |
COMMON /PARM_C/ |
| 86 |
& buoyancyRelation, eosType, |
| 87 |
& pickupSuff, mdsioLocalDir, adTapeDir, |
| 88 |
& tRefFile, sRefFile, rhoRefFile, gravityFile, |
| 89 |
& delRFile, delRcFile, hybSigmFile, |
| 90 |
& delXFile, delYFile, horizGridFile, |
| 91 |
& bathyFile, topoFile, addWwallFile, addSwallFile, |
| 92 |
& viscAhDfile, viscAhZfile, |
| 93 |
& viscA4Dfile, viscA4Zfile, |
| 94 |
& hydrogThetaFile, hydrogSaltFile, diffKrFile, |
| 95 |
& zonalWindFile, meridWindFile, thetaClimFile, |
| 96 |
& saltClimFile, |
| 97 |
& EmPmRfile, saltFluxFile, |
| 98 |
& surfQfile, surfQnetFile, surfQswFile, |
| 99 |
& lambdaThetaFile, lambdaSaltFile, |
| 100 |
& uVelInitFile, vVelInitFile, pSurfInitFile, |
| 101 |
& pLoadFile, addMassFile, |
| 102 |
& eddyPsiXFile, eddyPsiYFile, geothermalFile, |
| 103 |
& the_run_name |
| 104 |
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation |
| 105 |
CHARACTER*(6) eosType |
| 106 |
CHARACTER*(10) pickupSuff |
| 107 |
CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir |
| 108 |
CHARACTER*(MAX_LEN_FNAM) adTapeDir |
| 109 |
CHARACTER*(MAX_LEN_FNAM) tRefFile |
| 110 |
CHARACTER*(MAX_LEN_FNAM) sRefFile |
| 111 |
CHARACTER*(MAX_LEN_FNAM) rhoRefFile |
| 112 |
CHARACTER*(MAX_LEN_FNAM) gravityFile |
| 113 |
CHARACTER*(MAX_LEN_FNAM) delRFile |
| 114 |
CHARACTER*(MAX_LEN_FNAM) delRcFile |
| 115 |
CHARACTER*(MAX_LEN_FNAM) hybSigmFile |
| 116 |
CHARACTER*(MAX_LEN_FNAM) delXFile |
| 117 |
CHARACTER*(MAX_LEN_FNAM) delYFile |
| 118 |
CHARACTER*(MAX_LEN_FNAM) horizGridFile |
| 119 |
CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile |
| 120 |
CHARACTER*(MAX_LEN_FNAM) addWwallFile, addSwallFile |
| 121 |
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile |
| 122 |
CHARACTER*(MAX_LEN_FNAM) diffKrFile |
| 123 |
CHARACTER*(MAX_LEN_FNAM) viscAhDfile |
| 124 |
CHARACTER*(MAX_LEN_FNAM) viscAhZfile |
| 125 |
CHARACTER*(MAX_LEN_FNAM) viscA4Dfile |
| 126 |
CHARACTER*(MAX_LEN_FNAM) viscA4Zfile |
| 127 |
CHARACTER*(MAX_LEN_FNAM) zonalWindFile |
| 128 |
CHARACTER*(MAX_LEN_FNAM) meridWindFile |
| 129 |
CHARACTER*(MAX_LEN_FNAM) thetaClimFile |
| 130 |
CHARACTER*(MAX_LEN_FNAM) saltClimFile |
| 131 |
CHARACTER*(MAX_LEN_FNAM) surfQfile |
| 132 |
CHARACTER*(MAX_LEN_FNAM) surfQnetFile |
| 133 |
CHARACTER*(MAX_LEN_FNAM) surfQswFile |
| 134 |
CHARACTER*(MAX_LEN_FNAM) EmPmRfile |
| 135 |
CHARACTER*(MAX_LEN_FNAM) saltFluxFile |
| 136 |
CHARACTER*(MAX_LEN_FNAM) uVelInitFile |
| 137 |
CHARACTER*(MAX_LEN_FNAM) vVelInitFile |
| 138 |
CHARACTER*(MAX_LEN_FNAM) pSurfInitFile |
| 139 |
CHARACTER*(MAX_LEN_FNAM) pLoadFile |
| 140 |
CHARACTER*(MAX_LEN_FNAM) addMassFile |
| 141 |
CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile |
| 142 |
CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile |
| 143 |
CHARACTER*(MAX_LEN_FNAM) geothermalFile |
| 144 |
CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile |
| 145 |
CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile |
| 146 |
CHARACTER*(MAX_LEN_PREC/2) the_run_name |
| 147 |
|
| 148 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
| 149 |
C cg2dMaxIters :: Maximum number of iterations in the |
| 150 |
C two-dimensional con. grad solver. |
| 151 |
C cg2dChkResFreq :: Frequency with which to check residual |
| 152 |
C in con. grad solver. |
| 153 |
C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner |
| 154 |
C (non-linear free-surf.) |
| 155 |
C cg2dUseMinResSol :: =0 : use last-iteration/converged solution |
| 156 |
C =1 : use solver minimum-residual solution |
| 157 |
C cg3dMaxIters :: Maximum number of iterations in the |
| 158 |
C three-dimensional con. grad solver. |
| 159 |
C cg3dChkResFreq :: Frequency with which to check residual |
| 160 |
C in con. grad solver. |
| 161 |
C printResidualFreq :: Frequency for printing residual in CG iterations |
| 162 |
C nIter0 :: Start time-step number of for this run |
| 163 |
C nTimeSteps :: Number of timesteps to execute |
| 164 |
C nTimeSteps_l2 :: Number of inner timesteps to execute per timestep |
| 165 |
C writeStatePrec :: Precision used for writing model state. |
| 166 |
C writeBinaryPrec :: Precision used for writing binary files |
| 167 |
C readBinaryPrec :: Precision used for reading binary files |
| 168 |
C selectCoriMap :: select setting of Coriolis parameter map: |
| 169 |
C =0 f-Plane (Constant Coriolis, = f0) |
| 170 |
C =1 Beta-Plane Coriolis (= f0 + beta.y) |
| 171 |
C =2 Spherical Coriolis (= 2.omega.sin(phi)) |
| 172 |
C =3 Read Coriolis 2-d fields from files. |
| 173 |
C selectSigmaCoord :: option related to sigma vertical coordinate |
| 174 |
C nonlinFreeSurf :: option related to non-linear free surface |
| 175 |
C =0 Linear free surface ; >0 Non-linear |
| 176 |
C select_rStar :: option related to r* vertical coordinate |
| 177 |
C =0 (default) use r coord. ; > 0 use r* |
| 178 |
C selectNHfreeSurf :: option for Non-Hydrostatic (free-)Surface formulation: |
| 179 |
C =0 (default) hydrostatic surf. ; > 0 add NH effects. |
| 180 |
C selectP_inEOS_Zc :: select which pressure to use in EOS (for z-coords) |
| 181 |
C =0: simply: -g*rhoConst*z |
| 182 |
C =1: use pRef = integral{-g*rho(Tref,Sref,pRef)*dz} |
| 183 |
C =2: use hydrostatic dynamical pressure |
| 184 |
C =3: use full (Hyd+NH) dynamical pressure |
| 185 |
C selectAddFluid :: option to add mass source/sink of fluid in the interior |
| 186 |
C (3-D generalisation of oceanic real-fresh water flux) |
| 187 |
C =0 off ; =1 add fluid ; =-1 virtual flux (no mass added) |
| 188 |
C selectImplicitDrag :: select Implicit treatment of bottom/top drag |
| 189 |
C = 0: fully explicit |
| 190 |
C = 1: implicit on provisional velocity |
| 191 |
C (i.e., before grad.Eta increment) |
| 192 |
C = 2: fully implicit (combined with Impl Surf.Press) |
| 193 |
C momForcingOutAB :: =1: take momentum forcing contribution |
| 194 |
C out of (=0: in) Adams-Bashforth time stepping. |
| 195 |
C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution |
| 196 |
C out of (=0: in) Adams-Bashforth time stepping. |
| 197 |
C tempAdvScheme :: Temp. Horiz.Advection scheme selector |
| 198 |
C tempVertAdvScheme :: Temp. Vert. Advection scheme selector |
| 199 |
C saltAdvScheme :: Salt. Horiz.advection scheme selector |
| 200 |
C saltVertAdvScheme :: Salt. Vert. Advection scheme selector |
| 201 |
C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.) |
| 202 |
C selectVortScheme :: Scheme selector for Vorticity term (Vector Inv.) |
| 203 |
C selectBotDragQuadr :: quadratic bottom drag discretisation option: |
| 204 |
C =0: average KE from grid center to U & V location |
| 205 |
C =1: use local velocity norm @ U & V location |
| 206 |
C =2: same with wet-point averaging of other component |
| 207 |
C monitorSelect :: select group of variables to monitor |
| 208 |
C =1 : dynvars ; =2 : + vort ; =3 : + surface |
| 209 |
C- debugLevel :: controls printing of algorithm intermediate results |
| 210 |
C and statistics ; higher -> more writing |
| 211 |
|
| 212 |
COMMON /PARM_I/ |
| 213 |
& cg2dMaxIters, cg2dChkResFreq, |
| 214 |
& cg2dPreCondFreq, cg2dUseMinResSol, |
| 215 |
& cg3dMaxIters, cg3dChkResFreq, |
| 216 |
& printResidualFreq, |
| 217 |
& nIter0, nTimeSteps, nTimeSteps_l2, nEndIter, |
| 218 |
& writeStatePrec, |
| 219 |
& writeBinaryPrec, readBinaryPrec, |
| 220 |
& selectCoriMap, |
| 221 |
& selectSigmaCoord, |
| 222 |
& nonlinFreeSurf, select_rStar, |
| 223 |
& selectNHfreeSurf, selectP_inEOS_Zc, |
| 224 |
& selectAddFluid, selectImplicitDrag, |
| 225 |
& momForcingOutAB, tracForcingOutAB, |
| 226 |
& tempAdvScheme, tempVertAdvScheme, |
| 227 |
& saltAdvScheme, saltVertAdvScheme, |
| 228 |
& selectKEscheme, selectVortScheme, |
| 229 |
& selectBotDragQuadr, |
| 230 |
& monitorSelect, debugLevel |
| 231 |
INTEGER cg2dMaxIters |
| 232 |
INTEGER cg2dChkResFreq |
| 233 |
INTEGER cg2dPreCondFreq |
| 234 |
INTEGER cg2dUseMinResSol |
| 235 |
INTEGER cg3dMaxIters |
| 236 |
INTEGER cg3dChkResFreq |
| 237 |
INTEGER printResidualFreq |
| 238 |
INTEGER nIter0 |
| 239 |
INTEGER nTimeSteps |
| 240 |
INTEGER nTimeSteps_l2 |
| 241 |
INTEGER nEndIter |
| 242 |
INTEGER writeStatePrec |
| 243 |
INTEGER writeBinaryPrec |
| 244 |
INTEGER readBinaryPrec |
| 245 |
INTEGER selectCoriMap |
| 246 |
INTEGER selectSigmaCoord |
| 247 |
INTEGER nonlinFreeSurf |
| 248 |
INTEGER select_rStar |
| 249 |
INTEGER selectNHfreeSurf |
| 250 |
INTEGER selectP_inEOS_Zc |
| 251 |
INTEGER selectAddFluid |
| 252 |
INTEGER selectImplicitDrag |
| 253 |
INTEGER momForcingOutAB, tracForcingOutAB |
| 254 |
INTEGER tempAdvScheme, tempVertAdvScheme |
| 255 |
INTEGER saltAdvScheme, saltVertAdvScheme |
| 256 |
INTEGER selectKEscheme |
| 257 |
INTEGER selectVortScheme |
| 258 |
INTEGER selectBotDragQuadr |
| 259 |
INTEGER monitorSelect |
| 260 |
INTEGER debugLevel |
| 261 |
|
| 262 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
| 263 |
C- Coordinate + Grid params: |
| 264 |
C fluidIsAir :: Set to indicate that the fluid major constituent |
| 265 |
C is air |
| 266 |
C fluidIsWater :: Set to indicate that the fluid major constituent |
| 267 |
C is water |
| 268 |
C usingPCoords :: Set to indicate that we are working in a pressure |
| 269 |
C type coordinate (p or p*). |
| 270 |
C usingZCoords :: Set to indicate that we are working in a height |
| 271 |
C type coordinate (z or z*) |
| 272 |
C usingCartesianGrid :: If TRUE grid generation will be in a cartesian |
| 273 |
C coordinate frame. |
| 274 |
C usingSphericalPolarGrid :: If TRUE grid generation will be in a |
| 275 |
C spherical polar frame. |
| 276 |
C rotateGrid :: rotate grid coordinates to geographical coordinates |
| 277 |
C according to Euler angles phiEuler, thetaEuler, psiEuler |
| 278 |
C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical |
| 279 |
C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided) |
| 280 |
C hasWetCSCorners :: domain contains CS-type corners where dynamics is solved |
| 281 |
C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation) |
| 282 |
C setInterFDr :: set Interface depth (put cell-Center at the middle) |
| 283 |
C setCenterDr :: set cell-Center depth (put Interface at the middle) |
| 284 |
C- Momentum params: |
| 285 |
C no_slip_sides :: Impose "no-slip" at lateral boundaries. |
| 286 |
C no_slip_bottom :: Impose "no-slip" at bottom boundary. |
| 287 |
C bottomVisc_pCell :: account for partial-cell in bottom visc. (no-slip BC) |
| 288 |
C useSmag3D :: Use isotropic 3-D Smagorinsky |
| 289 |
C useFullLeith :: Set to true to use full Leith viscosity(may be unstable |
| 290 |
C on irregular grids) |
| 291 |
C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms |
| 292 |
C useAreaViscLength :: Set to true to use old scaling for viscous lengths, |
| 293 |
C e.g., L2=Raz. May be preferable for cube sphere. |
| 294 |
C momViscosity :: Flag which turns momentum friction terms on and off. |
| 295 |
C momAdvection :: Flag which turns advection of momentum on and off. |
| 296 |
C momForcing :: Flag which turns external forcing of momentum on |
| 297 |
C and off. |
| 298 |
C momPressureForcing :: Flag which turns pressure term in momentum equation |
| 299 |
C on and off. |
| 300 |
C metricTerms :: Flag which turns metric terms on or off. |
| 301 |
C useNHMTerms :: If TRUE use non-hydrostatic metric terms. |
| 302 |
C useCoriolis :: Flag which turns the coriolis terms on and off. |
| 303 |
C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off |
| 304 |
C useCDscheme :: use CD-scheme to calculate Coriolis terms. |
| 305 |
C vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package) |
| 306 |
C (default = F = use mom_fluxform package) |
| 307 |
C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986) |
| 308 |
C useJamartMomAdv :: Use wet-point method for V.I. non-linear term |
| 309 |
C upwindVorticity :: bias interpolation of vorticity in the Coriolis term |
| 310 |
C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection) |
| 311 |
C useAbsVorticity :: work with f+zeta in Coriolis terms |
| 312 |
C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection) |
| 313 |
C momStepping :: Turns momentum equation time-stepping off |
| 314 |
C calc_wVelocity :: Turns vertical velocity calculation off |
| 315 |
C- Temp. & Salt params: |
| 316 |
C tempStepping :: Turns temperature equation time-stepping on/off |
| 317 |
C saltStepping :: Turns salinity equation time-stepping on/off |
| 318 |
C addFrictionHeating :: account for frictional heating |
| 319 |
C tempAdvection :: Flag which turns advection of temperature on and off. |
| 320 |
C tempVertDiff4 :: use vertical bi-harmonic diffusion for temperature |
| 321 |
C tempIsActiveTr :: Pot.Temp. is a dynamically active tracer |
| 322 |
C tempForcing :: Flag which turns external forcing of temperature on/off |
| 323 |
C saltAdvection :: Flag which turns advection of salinity on and off. |
| 324 |
C saltVertDiff4 :: use vertical bi-harmonic diffusion for salinity |
| 325 |
C saltIsActiveTr :: Salinity is a dynamically active tracer |
| 326 |
C saltForcing :: Flag which turns external forcing of salinity on/off |
| 327 |
C maskIniTemp :: apply mask to initial Pot.Temp. |
| 328 |
C maskIniSalt :: apply mask to initial salinity |
| 329 |
C checkIniTemp :: check for points with identically zero initial Pot.Temp. |
| 330 |
C checkIniSalt :: check for points with identically zero initial salinity |
| 331 |
C- Pressure solver related parameters (PARM02) |
| 332 |
C useSRCGSolver :: Set to true to use conjugate gradient |
| 333 |
C solver with single reduction (only one call of |
| 334 |
C s/r mpi_allreduce), default is false |
| 335 |
C- Time-stepping & free-surface params: |
| 336 |
C rigidLid :: Set to true to use rigid lid |
| 337 |
C implicitFreeSurface :: Set to true to use implicit free surface |
| 338 |
C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the |
| 339 |
C linear relation Phi_surf = Bo_surf*eta |
| 340 |
C uniformFreeSurfLev :: TRUE if free-surface level-index is uniform (=1) |
| 341 |
C exactConserv :: Set to true to conserve exactly the total Volume |
| 342 |
C linFSConserveTr :: Set to true to correct source/sink of tracer |
| 343 |
C at the surface due to Linear Free Surface |
| 344 |
C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux |
| 345 |
C as a real Fresh Water (=> changes the Sea Level) |
| 346 |
C if F, converts P+R-E to salt flux (no SL effect) |
| 347 |
C storePhiHyd4Phys :: store hydrostatic potential for use in Physics/EOS |
| 348 |
C this requires specific code for restart & exchange |
| 349 |
C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm |
| 350 |
C nonHydrostatic :: Using non-hydrostatic algorithm |
| 351 |
C use3Dsolver :: set to true to use 3-D pressure solver |
| 352 |
C implicitIntGravWave :: treat Internal Gravity Wave implicitly |
| 353 |
C staggerTimeStep :: enable a Stagger time stepping U,V (& W) then T,S |
| 354 |
C applyExchUV_early :: Apply EXCH to U,V earlier, just before integr_continuity |
| 355 |
C doResetHFactors :: Do reset thickness factors @ beginning of each time-step |
| 356 |
C implicitDiffusion :: Turns implicit vertical diffusion on |
| 357 |
C implicitViscosity :: Turns implicit vertical viscosity on |
| 358 |
C tempImplVertAdv :: Turns on implicit vertical advection for Temperature |
| 359 |
C saltImplVertAdv :: Turns on implicit vertical advection for Salinity |
| 360 |
C momImplVertAdv :: Turns on implicit vertical advection for Momentum |
| 361 |
C multiDimAdvection :: Flag that enable multi-dimension advection |
| 362 |
C useMultiDimAdvec :: True if multi-dim advection is used at least once |
| 363 |
C momDissip_In_AB :: if False, put Dissipation tendency contribution |
| 364 |
C out off Adams-Bashforth time stepping. |
| 365 |
C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always |
| 366 |
C apply AB on tracer tendencies (rather than on Tracer) |
| 367 |
C- Other forcing params - |
| 368 |
C balanceEmPmR :: substract global mean of EmPmR at every time step |
| 369 |
C balanceQnet :: substract global mean of Qnet at every time step |
| 370 |
C balancePrintMean:: print substracted global means to STDOUT |
| 371 |
C doThetaClimRelax :: Set true if relaxation to temperature |
| 372 |
C climatology is required. |
| 373 |
C doSaltClimRelax :: Set true if relaxation to salinity |
| 374 |
C climatology is required. |
| 375 |
C balanceThetaClimRelax :: substract global mean effect at every time step |
| 376 |
C balanceSaltClimRelax :: substract global mean effect at every time step |
| 377 |
C allowFreezing :: Allows surface water to freeze and form ice |
| 378 |
C periodicExternalForcing :: Set true if forcing is time-dependant |
| 379 |
C- I/O parameters - |
| 380 |
C globalFiles :: Selects between "global" and "tiled" files. |
| 381 |
C On some platforms with MPI, option globalFiles is either |
| 382 |
C slow or does not work. Use useSingleCpuIO instead. |
| 383 |
C useSingleCpuIO :: moved to EEPARAMS.h |
| 384 |
C pickupStrictlyMatch :: check and stop if pickup-file do not stricly match |
| 385 |
C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup |
| 386 |
C usePickupBeforeC54 :: start from old-pickup files, generated with code from |
| 387 |
C before checkpoint-54a, Jul 06, 2004. |
| 388 |
C pickup_write_mdsio :: use mdsio to write pickups |
| 389 |
C pickup_read_mdsio :: use mdsio to read pickups |
| 390 |
C pickup_write_immed :: echo the pickup immediately (for conversion) |
| 391 |
C writePickupAtEnd :: write pickup at the last timestep |
| 392 |
C timeave_mdsio :: use mdsio for timeave output |
| 393 |
C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output |
| 394 |
C monitor_stdio :: use stdio for monitor output |
| 395 |
C dumpInitAndLast :: dumps model state to files at Initial (nIter0) |
| 396 |
C & Last iteration, in addition multiple of dumpFreq iter. |
| 397 |
C printDomain :: controls printing of domain fields (bathy, hFac ...). |
| 398 |
|
| 399 |
COMMON /PARM_L/ |
| 400 |
& fluidIsAir, fluidIsWater, |
| 401 |
& usingPCoords, usingZCoords, |
| 402 |
& usingCartesianGrid, usingSphericalPolarGrid, rotateGrid, |
| 403 |
& usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners, |
| 404 |
& deepAtmosphere, setInterFDr, setCenterDr, |
| 405 |
& no_slip_sides, no_slip_bottom, bottomVisc_pCell, useSmag3D, |
| 406 |
& useFullLeith, useStrainTensionVisc, useAreaViscLength, |
| 407 |
& momViscosity, momAdvection, momForcing, |
| 408 |
& momPressureForcing, metricTerms, useNHMTerms, |
| 409 |
& useCoriolis, use3dCoriolis, |
| 410 |
& useCDscheme, vectorInvariantMomentum, |
| 411 |
& useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv, |
| 412 |
& upwindVorticity, highOrderVorticity, |
| 413 |
& useAbsVorticity, upwindShear, |
| 414 |
& momStepping, calc_wVelocity, tempStepping, saltStepping, |
| 415 |
& addFrictionHeating, |
| 416 |
& tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing, |
| 417 |
& saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing, |
| 418 |
& maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt, |
| 419 |
& useSRCGSolver, |
| 420 |
& rigidLid, implicitFreeSurface, |
| 421 |
& uniformLin_PhiSurf, uniformFreeSurfLev, |
| 422 |
& exactConserv, linFSConserveTr, useRealFreshWaterFlux, |
| 423 |
& storePhiHyd4Phys, quasiHydrostatic, nonHydrostatic, |
| 424 |
& use3Dsolver, implicitIntGravWave, staggerTimeStep, |
| 425 |
& applyExchUV_early, doResetHFactors, |
| 426 |
& implicitDiffusion, implicitViscosity, |
| 427 |
& tempImplVertAdv, saltImplVertAdv, momImplVertAdv, |
| 428 |
& multiDimAdvection, useMultiDimAdvec, |
| 429 |
& momDissip_In_AB, doAB_onGtGs, |
| 430 |
& balanceEmPmR, balanceQnet, balancePrintMean, |
| 431 |
& balanceThetaClimRelax, balanceSaltClimRelax, |
| 432 |
& doThetaClimRelax, doSaltClimRelax, |
| 433 |
& allowFreezing, |
| 434 |
& periodicExternalForcing, |
| 435 |
& globalFiles, |
| 436 |
& pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2, |
| 437 |
& pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed, |
| 438 |
& writePickupAtEnd, |
| 439 |
& timeave_mdsio, snapshot_mdsio, monitor_stdio, |
| 440 |
& outputTypesInclusive, dumpInitAndLast, |
| 441 |
& printDomain |
| 442 |
|
| 443 |
LOGICAL fluidIsAir |
| 444 |
LOGICAL fluidIsWater |
| 445 |
LOGICAL usingPCoords |
| 446 |
LOGICAL usingZCoords |
| 447 |
LOGICAL usingCartesianGrid |
| 448 |
LOGICAL usingSphericalPolarGrid, rotateGrid |
| 449 |
LOGICAL usingCylindricalGrid |
| 450 |
LOGICAL usingCurvilinearGrid, hasWetCSCorners |
| 451 |
LOGICAL deepAtmosphere |
| 452 |
LOGICAL setInterFDr |
| 453 |
LOGICAL setCenterDr |
| 454 |
|
| 455 |
LOGICAL no_slip_sides |
| 456 |
LOGICAL no_slip_bottom |
| 457 |
LOGICAL bottomVisc_pCell |
| 458 |
LOGICAL useSmag3D |
| 459 |
LOGICAL useFullLeith |
| 460 |
LOGICAL useStrainTensionVisc |
| 461 |
LOGICAL useAreaViscLength |
| 462 |
LOGICAL momViscosity |
| 463 |
LOGICAL momAdvection |
| 464 |
LOGICAL momForcing |
| 465 |
LOGICAL momPressureForcing |
| 466 |
LOGICAL metricTerms |
| 467 |
LOGICAL useNHMTerms |
| 468 |
|
| 469 |
LOGICAL useCoriolis |
| 470 |
LOGICAL use3dCoriolis |
| 471 |
LOGICAL useCDscheme |
| 472 |
LOGICAL vectorInvariantMomentum |
| 473 |
LOGICAL useEnergyConservingCoriolis |
| 474 |
LOGICAL useJamartWetPoints |
| 475 |
LOGICAL useJamartMomAdv |
| 476 |
LOGICAL upwindVorticity |
| 477 |
LOGICAL highOrderVorticity |
| 478 |
LOGICAL useAbsVorticity |
| 479 |
LOGICAL upwindShear |
| 480 |
LOGICAL momStepping |
| 481 |
LOGICAL calc_wVelocity |
| 482 |
LOGICAL tempStepping |
| 483 |
LOGICAL saltStepping |
| 484 |
LOGICAL addFrictionHeating |
| 485 |
LOGICAL tempAdvection |
| 486 |
LOGICAL tempVertDiff4 |
| 487 |
LOGICAL tempIsActiveTr |
| 488 |
LOGICAL tempForcing |
| 489 |
LOGICAL saltAdvection |
| 490 |
LOGICAL saltVertDiff4 |
| 491 |
LOGICAL saltIsActiveTr |
| 492 |
LOGICAL saltForcing |
| 493 |
LOGICAL maskIniTemp |
| 494 |
LOGICAL maskIniSalt |
| 495 |
LOGICAL checkIniTemp |
| 496 |
LOGICAL checkIniSalt |
| 497 |
LOGICAL useSRCGSolver |
| 498 |
LOGICAL rigidLid |
| 499 |
LOGICAL implicitFreeSurface |
| 500 |
LOGICAL uniformLin_PhiSurf |
| 501 |
LOGICAL uniformFreeSurfLev |
| 502 |
LOGICAL exactConserv |
| 503 |
LOGICAL linFSConserveTr |
| 504 |
LOGICAL useRealFreshWaterFlux |
| 505 |
LOGICAL storePhiHyd4Phys |
| 506 |
LOGICAL quasiHydrostatic |
| 507 |
LOGICAL nonHydrostatic |
| 508 |
LOGICAL use3Dsolver |
| 509 |
LOGICAL implicitIntGravWave |
| 510 |
LOGICAL staggerTimeStep |
| 511 |
LOGICAL applyExchUV_early |
| 512 |
LOGICAL doResetHFactors |
| 513 |
LOGICAL implicitDiffusion |
| 514 |
LOGICAL implicitViscosity |
| 515 |
LOGICAL tempImplVertAdv |
| 516 |
LOGICAL saltImplVertAdv |
| 517 |
LOGICAL momImplVertAdv |
| 518 |
LOGICAL multiDimAdvection |
| 519 |
LOGICAL useMultiDimAdvec |
| 520 |
LOGICAL momDissip_In_AB |
| 521 |
LOGICAL doAB_onGtGs |
| 522 |
LOGICAL balanceEmPmR |
| 523 |
LOGICAL balanceQnet |
| 524 |
LOGICAL balancePrintMean |
| 525 |
LOGICAL doThetaClimRelax |
| 526 |
LOGICAL doSaltClimRelax |
| 527 |
LOGICAL balanceThetaClimRelax |
| 528 |
LOGICAL balanceSaltClimRelax |
| 529 |
LOGICAL allowFreezing |
| 530 |
LOGICAL periodicExternalForcing |
| 531 |
LOGICAL globalFiles |
| 532 |
LOGICAL pickupStrictlyMatch |
| 533 |
LOGICAL usePickupBeforeC54 |
| 534 |
LOGICAL startFromPickupAB2 |
| 535 |
LOGICAL pickup_read_mdsio, pickup_write_mdsio |
| 536 |
LOGICAL pickup_write_immed, writePickupAtEnd |
| 537 |
LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio |
| 538 |
LOGICAL outputTypesInclusive |
| 539 |
LOGICAL dumpInitAndLast |
| 540 |
LOGICAL printDomain |
| 541 |
|
| 542 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
| 543 |
C cg2dTargetResidual |
| 544 |
C :: Target residual for cg2d solver; no unit (RHS normalisation) |
| 545 |
C cg2dTargetResWunit |
| 546 |
C :: Target residual for cg2d solver; W unit (No RHS normalisation) |
| 547 |
C cg3dTargetResidual |
| 548 |
C :: Target residual for cg3d solver. |
| 549 |
C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal. |
| 550 |
C Note. 20th May 1998 |
| 551 |
C I made a weird discovery! In the model paper we argue |
| 552 |
C for the form of the preconditioner used here ( see |
| 553 |
C A Finite-volume, Incompressible Navier-Stokes Model |
| 554 |
C ...., Marshall et. al ). The algebra gives a simple |
| 555 |
C 0.5 factor for the averaging of ac and aCw to get a |
| 556 |
C symmettric pre-conditioner. By using a factor of 0.51 |
| 557 |
C i.e. scaling the off-diagonal terms in the |
| 558 |
C preconditioner down slightly I managed to get the |
| 559 |
C number of iterations for convergence in a test case to |
| 560 |
C drop form 192 -> 134! Need to investigate this further! |
| 561 |
C For now I have introduced a parameter cg2dpcOffDFac which |
| 562 |
C defaults to 0.51 but can be set at runtime. |
| 563 |
C delR :: Vertical grid spacing ( units of r ). |
| 564 |
C delRc :: Vertical grid spacing between cell centers (r unit). |
| 565 |
C delX :: Separation between cell faces (m) or (deg), depending |
| 566 |
C delY on input flags. Note: moved to header file SET_GRID.h |
| 567 |
C xgOrigin :: Origin of the X-axis (Cartesian Grid) / Longitude of Western |
| 568 |
C :: most cell face (Lat-Lon grid) (Note: this is an "inert" |
| 569 |
C :: parameter but it makes geographical references simple.) |
| 570 |
C ygOrigin :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern |
| 571 |
C :: most face (Lat-Lon grid). |
| 572 |
C rSphere :: Radius of sphere for a spherical polar grid ( m ). |
| 573 |
C recip_rSphere :: Reciprocal radius of sphere ( m^-1 ). |
| 574 |
C radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid) |
| 575 |
C seaLev_Z :: the reference height of sea-level (usually zero) |
| 576 |
C top_Pres :: pressure (P-Coords) or reference pressure (Z-Coords) at the top |
| 577 |
C rSigmaBnd :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma) |
| 578 |
C gravity :: Acceleration due to constant gravity ( m/s^2 ) |
| 579 |
C recip_gravity :: Reciprocal gravity acceleration ( s^2/m ) |
| 580 |
C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 ) |
| 581 |
C gravFacC :: gravity factor (vs surf. gravity) vert. profile at cell-Center |
| 582 |
C gravFacF :: gravity factor (vs surf. gravity) vert. profile at cell-interF |
| 583 |
C rhoNil :: Reference density for the linear equation of state |
| 584 |
C rhoConst :: Vertically constant reference density (Boussinesq) |
| 585 |
C rho1Ref :: reference vertical profile for density (anelastic) |
| 586 |
C rhoFacC :: normalized (by rhoConst) reference density at cell-Center |
| 587 |
C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace |
| 588 |
C rhoConstFresh :: Constant reference density for fresh water (rain) |
| 589 |
C thetaConst :: Constant reference for potential temperature |
| 590 |
C tRef :: reference vertical profile for potential temperature |
| 591 |
C sRef :: reference vertical profile for salinity/specific humidity |
| 592 |
C pRef4EOS :: reference pressure used in EOS (case selectP_inEOS_Zc=1) |
| 593 |
C phiRef :: reference potential (press/rho, geopot) profile (m^2/s^2) |
| 594 |
C dBdrRef :: vertical gradient of reference buoyancy [(m/s/r)^2]: |
| 595 |
C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2] |
| 596 |
C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2] |
| 597 |
C rVel2wUnit :: units conversion factor (Non-Hydrostatic code), |
| 598 |
C :: from r-coordinate vertical velocity to vertical velocity [m/s]. |
| 599 |
C :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit |
| 600 |
C wUnit2rVel :: units conversion factor (Non-Hydrostatic code), |
| 601 |
C :: from vertical velocity [m/s] to r-coordinate vertical velocity. |
| 602 |
C :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel |
| 603 |
C mass2rUnit :: units conversion factor (surface forcing), |
| 604 |
C :: from mass per unit area [kg/m2] to vertical r-coordinate unit. |
| 605 |
C :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ; |
| 606 |
C :: p-coord: = gravity ( [kg/m2] * g = [Pa] ) ; |
| 607 |
C rUnit2mass :: units conversion factor (surface forcing), |
| 608 |
C :: from vertical r-coordinate unit to mass per unit area [kg/m2]. |
| 609 |
C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ; |
| 610 |
C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ; |
| 611 |
C f0 :: Reference coriolis parameter ( 1/s ) |
| 612 |
C ( Southern edge f for beta plane ) |
| 613 |
C beta :: df/dy ( s^-1.m^-1 ) |
| 614 |
C fPrime :: Second Coriolis parameter ( 1/s ), related to Y-component |
| 615 |
C of rotation (reference value = 2.Omega.Cos(Phi)) |
| 616 |
C omega :: Angular velocity ( rad/s ) |
| 617 |
C rotationPeriod :: Rotation period (s) (= 2.pi/omega) |
| 618 |
C viscArNr :: vertical profile of Eddy viscosity coeff. |
| 619 |
C for vertical mixing of momentum ( units of r^2/s ) |
| 620 |
C viscAh :: Eddy viscosity coeff. for mixing of |
| 621 |
C momentum laterally ( m^2/s ) |
| 622 |
C viscAhW :: Eddy viscosity coeff. for mixing of vertical |
| 623 |
C momentum laterally, no effect for hydrostatic |
| 624 |
C model, defaults to viscAhD if unset ( m^2/s ) |
| 625 |
C Not used if variable horiz. viscosity is used. |
| 626 |
C viscA4 :: Biharmonic viscosity coeff. for mixing of |
| 627 |
C momentum laterally ( m^4/s ) |
| 628 |
C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical |
| 629 |
C momentum laterally, no effect for hydrostatic |
| 630 |
C model, defaults to viscA4D if unset ( m^2/s ) |
| 631 |
C Not used if variable horiz. viscosity is used. |
| 632 |
C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally |
| 633 |
C (act on Divergence part) ( m^2/s ) |
| 634 |
C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally |
| 635 |
C (act on Vorticity part) ( m^2/s ) |
| 636 |
C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally |
| 637 |
C (act on Divergence part) ( m^4/s ) |
| 638 |
C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally |
| 639 |
C (act on Vorticity part) ( m^4/s ) |
| 640 |
C smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-) |
| 641 |
C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort)) |
| 642 |
C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div)) |
| 643 |
C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort)) |
| 644 |
C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div)) |
| 645 |
C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic) |
| 646 |
C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic) |
| 647 |
C viscAhMax :: Maximum eddy viscosity coeff. for mixing of |
| 648 |
C momentum laterally ( m^2/s ) |
| 649 |
C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity |
| 650 |
C coeff. for mixing of momentum laterally (non-dim) |
| 651 |
C viscAhGrid :: non-dimensional grid-size dependent viscosity |
| 652 |
C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ... |
| 653 |
C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc. |
| 654 |
C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of |
| 655 |
C momentum laterally ( m^4/s ) |
| 656 |
C viscA4ReMax :: Maximum Gridscale Reynolds number for |
| 657 |
C biharmonic viscosity coeff. momentum laterally (non-dim) |
| 658 |
C viscA4Grid :: non-dimensional grid-size dependent bi-harmonic viscosity |
| 659 |
C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ... |
| 660 |
C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity |
| 661 |
C diffKhT :: Laplacian diffusion coeff. for mixing of |
| 662 |
C heat laterally ( m^2/s ) |
| 663 |
C diffK4T :: Biharmonic diffusion coeff. for mixing of |
| 664 |
C heat laterally ( m^4/s ) |
| 665 |
C diffKrNrT :: vertical profile of Laplacian diffusion coeff. |
| 666 |
C for mixing of heat vertically ( units of r^2/s ) |
| 667 |
C diffKr4T :: vertical profile of Biharmonic diffusion coeff. |
| 668 |
C for mixing of heat vertically ( units of r^4/s ) |
| 669 |
C diffKhS :: Laplacian diffusion coeff. for mixing of |
| 670 |
C salt laterally ( m^2/s ) |
| 671 |
C diffK4S :: Biharmonic diffusion coeff. for mixing of |
| 672 |
C salt laterally ( m^4/s ) |
| 673 |
C diffKrNrS :: vertical profile of Laplacian diffusion coeff. |
| 674 |
C for mixing of salt vertically ( units of r^2/s ), |
| 675 |
C diffKr4S :: vertical profile of Biharmonic diffusion coeff. |
| 676 |
C for mixing of salt vertically ( units of r^4/s ) |
| 677 |
C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979 |
| 678 |
C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979 |
| 679 |
C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979 |
| 680 |
C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979 |
| 681 |
C BL79LatVary :: polarwise of this latitude diffKrBL79 is applied with |
| 682 |
C gradual transition to diffKrBLEQ towards Equator |
| 683 |
C diffKrBLEQsurf :: same as diffKrBL79surf but at Equator |
| 684 |
C diffKrBLEQdeep :: same as diffKrBL79deep but at Equator |
| 685 |
C diffKrBLEQscl :: same as diffKrBL79scl but at Equator |
| 686 |
C diffKrBLEQHo :: same as diffKrBL79Ho but at Equator |
| 687 |
C deltaT :: Default timestep ( s ) |
| 688 |
C deltaTClock :: Timestep used as model "clock". This determines the |
| 689 |
C IO frequencies and is used in tagging output. It can |
| 690 |
C be totally different to the dynamical time. Typically |
| 691 |
C it will be the deep-water timestep for accelerated runs. |
| 692 |
C Frequency of checkpointing and dumping of the model state |
| 693 |
C are referenced to this clock. ( s ) |
| 694 |
C deltaTMom :: Timestep for momemtum equations ( s ) |
| 695 |
C dTtracerLev :: Timestep for tracer equations ( s ), function of level k |
| 696 |
C deltaTFreeSurf :: Timestep for free-surface equation ( s ) |
| 697 |
C freeSurfFac :: Parameter to turn implicit free surface term on or off |
| 698 |
C freeSurFac = 1. uses implicit free surface |
| 699 |
C freeSurFac = 0. uses rigid lid |
| 700 |
C abEps :: Adams-Bashforth-2 stabilizing weight |
| 701 |
C alph_AB :: Adams-Bashforth-3 primary factor |
| 702 |
C beta_AB :: Adams-Bashforth-3 secondary factor |
| 703 |
C implicSurfPress :: parameter of the Crank-Nickelson time stepping : |
| 704 |
C Implicit part of Surface Pressure Gradient ( 0-1 ) |
| 705 |
C implicDiv2DFlow :: parameter of the Crank-Nickelson time stepping : |
| 706 |
C Implicit part of barotropic flow Divergence ( 0-1 ) |
| 707 |
C implicitNHPress :: parameter of the Crank-Nickelson time stepping : |
| 708 |
C Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 ) |
| 709 |
C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...) |
| 710 |
C hFacMinDz :: Minimum dimensional size of a cell (affects hFacC etc..., m) |
| 711 |
C hFacMinDp :: Minimum dimensional size of a cell (affects hFacC etc..., Pa) |
| 712 |
C hFacMinDr :: Minimum dimensional size of a cell (-> hFacC etc..., r units) |
| 713 |
C hFacInf :: Threshold (inf and sup) for fraction size of surface cell |
| 714 |
C hFacSup that control vanishing and creating levels |
| 715 |
C tauCD :: CD scheme coupling timescale ( s ) |
| 716 |
C rCD :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD) |
| 717 |
C epsAB_CD :: Adams-Bashforth-2 stabilizing weight used in CD scheme |
| 718 |
C baseTime :: model base time (time origin) = time @ iteration zero |
| 719 |
C startTime :: Starting time for this integration ( s ). |
| 720 |
C endTime :: Ending time for this integration ( s ). |
| 721 |
C chkPtFreq :: Frequency of rolling check pointing ( s ). |
| 722 |
C pChkPtFreq :: Frequency of permanent check pointing ( s ). |
| 723 |
C dumpFreq :: Frequency with which model state is written to |
| 724 |
C post-processing files ( s ). |
| 725 |
C diagFreq :: Frequency with which model writes diagnostic output |
| 726 |
C of intermediate quantities. |
| 727 |
C afFacMom :: Advection of momentum term tracer parameter |
| 728 |
C vfFacMom :: Momentum viscosity tracer parameter |
| 729 |
C pfFacMom :: Momentum pressure forcing tracer parameter |
| 730 |
C cfFacMom :: Coriolis term tracer parameter |
| 731 |
C foFacMom :: Momentum forcing tracer parameter |
| 732 |
C mtFacMom :: Metric terms tracer parameter |
| 733 |
C cosPower :: Power of cosine of latitude to multiply viscosity |
| 734 |
C cAdjFreq :: Frequency of convective adjustment |
| 735 |
C |
| 736 |
C taveFreq :: Frequency with which time-averaged model state |
| 737 |
C is written to post-processing files ( s ). |
| 738 |
C tave_lastIter :: (for state variable only) fraction of the last time |
| 739 |
C step (of each taveFreq period) put in the time average. |
| 740 |
C (fraction for 1rst iter = 1 - tave_lastIter) |
| 741 |
C tauThetaClimRelax :: Relaxation to climatology time scale ( s ). |
| 742 |
C tauSaltClimRelax :: Relaxation to climatology time scale ( s ). |
| 743 |
C latBandClimRelax :: latitude band where Relaxation to Clim. is applied, |
| 744 |
C i.e. where |yC| <= latBandClimRelax |
| 745 |
C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month) |
| 746 |
C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year) |
| 747 |
C (note: externForcingCycle must be an integer |
| 748 |
C number times externForcingPeriod) |
| 749 |
C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux |
| 750 |
C (use model surface (local) value if set to -1) |
| 751 |
C temp_EvPrRn :: temperature of Rain & Evap. |
| 752 |
C salt_EvPrRn :: salinity of Rain & Evap. |
| 753 |
C temp_addMass :: temperature of addMass array |
| 754 |
C salt_addMass :: salinity of addMass array |
| 755 |
C (notes: a) tracer content of Rain/Evap only used if both |
| 756 |
C NonLin_FrSurf & useRealFreshWater are set. |
| 757 |
C b) use model surface (local) value if set to UNSET_RL) |
| 758 |
C hMixCriteria:: criteria for mixed-layer diagnostic |
| 759 |
C dRhoSmall :: parameter for mixed-layer diagnostic |
| 760 |
C hMixSmooth :: Smoothing parameter for mixed-layer diag (default=0=no smoothing) |
| 761 |
C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s] |
| 762 |
C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides) |
| 763 |
C (default=2: full drag ; =1: gives half-slip BC) |
| 764 |
C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s) |
| 765 |
C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m) |
| 766 |
C (if using zcoordinate, units becomes linear: m/s, quadratic: [-]) |
| 767 |
C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS |
| 768 |
C is to be replace by a smoother function |
| 769 |
C (affects myabs, mymin, mymax) |
| 770 |
C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales |
| 771 |
C (i.e. allows convection at different Rayleigh numbers) |
| 772 |
C tCylIn :: Temperature of the cylinder inner boundary |
| 773 |
C tCylOut :: Temperature of the cylinder outer boundary |
| 774 |
C phiEuler :: Euler angle, rotation about original z-axis |
| 775 |
C thetaEuler :: Euler angle, rotation about new x-axis |
| 776 |
C psiEuler :: Euler angle, rotation about new z-axis |
| 777 |
COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit, |
| 778 |
& cg2dpcOffDFac, cg3dTargetResidual, |
| 779 |
& delR, delRc, xgOrigin, ygOrigin, rSphere, recip_rSphere, |
| 780 |
& radius_fromHorizGrid, seaLev_Z, top_Pres, rSigmaBnd, |
| 781 |
& deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock, |
| 782 |
& abEps, alph_AB, beta_AB, |
| 783 |
& f0, beta, fPrime, omega, rotationPeriod, |
| 784 |
& viscFacAdj, viscAh, viscAhW, smag3D_coeff, |
| 785 |
& viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin, |
| 786 |
& viscC2leith, viscC2leithD, |
| 787 |
& viscC2smag, viscC4smag, |
| 788 |
& viscAhD, viscAhZ, viscA4D, viscA4Z, |
| 789 |
& viscA4, viscA4W, viscA4Max, |
| 790 |
& viscA4Grid, viscA4GridMax, viscA4GridMin, |
| 791 |
& viscAhReMax, viscA4ReMax, |
| 792 |
& viscC4leith, viscC4leithD, viscArNr, |
| 793 |
& diffKhT, diffK4T, diffKrNrT, diffKr4T, |
| 794 |
& diffKhS, diffK4S, diffKrNrS, diffKr4S, |
| 795 |
& diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho, |
| 796 |
& BL79LatVary, |
| 797 |
& diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo, |
| 798 |
& tauCD, rCD, epsAB_CD, |
| 799 |
& freeSurfFac, implicSurfPress, implicDiv2DFlow, implicitNHPress, |
| 800 |
& hFacMin, hFacMinDz, hFacInf, hFacSup, |
| 801 |
& gravity, recip_gravity, gBaro, |
| 802 |
& gravFacC, recip_gravFacC, gravFacF, recip_gravFacF, |
| 803 |
& rhoNil, rhoConst, recip_rhoConst, rho1Ref, |
| 804 |
& rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF, rhoConstFresh, |
| 805 |
& thetaConst, tRef, sRef, pRef4EOS, phiRef, dBdrRef, |
| 806 |
& rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass, |
| 807 |
& baseTime, startTime, endTime, |
| 808 |
& chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq, |
| 809 |
& diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq, |
| 810 |
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
| 811 |
& cosPower, cAdjFreq, |
| 812 |
& tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax, |
| 813 |
& externForcingCycle, externForcingPeriod, |
| 814 |
& convertFW2Salt, temp_EvPrRn, salt_EvPrRn, |
| 815 |
& temp_addMass, salt_addMass, hFacMinDr, hFacMinDp, |
| 816 |
& ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, |
| 817 |
& sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2, |
| 818 |
& smoothAbsFuncRange, |
| 819 |
& tCylIn, tCylOut, |
| 820 |
& phiEuler, thetaEuler, psiEuler |
| 821 |
#ifdef ALLOW_PRESSURE_RELEASE_CODE |
| 822 |
& ,cg2dMinColumnEps, pReleaseVisc |
| 823 |
#endif |
| 824 |
|
| 825 |
_RL cg2dTargetResidual |
| 826 |
_RL cg2dTargetResWunit |
| 827 |
_RL cg3dTargetResidual |
| 828 |
_RL cg2dpcOffDFac |
| 829 |
_RL delR(Nr) |
| 830 |
_RL delRc(Nr+1) |
| 831 |
_RL xgOrigin |
| 832 |
_RL ygOrigin |
| 833 |
_RL rSphere |
| 834 |
_RL recip_rSphere |
| 835 |
_RL radius_fromHorizGrid |
| 836 |
_RL seaLev_Z |
| 837 |
_RL top_Pres |
| 838 |
_RL rSigmaBnd |
| 839 |
_RL deltaT |
| 840 |
_RL deltaTClock |
| 841 |
_RL deltaTMom |
| 842 |
_RL dTtracerLev(Nr) |
| 843 |
_RL deltaTFreeSurf |
| 844 |
_RL abEps, alph_AB, beta_AB |
| 845 |
_RL f0 |
| 846 |
_RL beta |
| 847 |
_RL fPrime |
| 848 |
_RL omega |
| 849 |
_RL rotationPeriod |
| 850 |
_RL freeSurfFac |
| 851 |
_RL implicSurfPress |
| 852 |
_RL implicDiv2DFlow |
| 853 |
_RL implicitNHPress |
| 854 |
_RL hFacMin |
| 855 |
_RL hFacMinDz |
| 856 |
_RL hFacMinDp |
| 857 |
_RL hFacMinDr |
| 858 |
_RL hFacInf |
| 859 |
_RL hFacSup |
| 860 |
_RL viscArNr(Nr) |
| 861 |
_RL viscFacAdj |
| 862 |
_RL viscAh |
| 863 |
_RL viscAhW |
| 864 |
_RL viscAhD |
| 865 |
_RL viscAhZ |
| 866 |
_RL smag3D_coeff |
| 867 |
_RL viscAhMax |
| 868 |
_RL viscAhReMax |
| 869 |
_RL viscAhGrid, viscAhGridMax, viscAhGridMin |
| 870 |
_RL viscC2leith |
| 871 |
_RL viscC2leithD |
| 872 |
_RL viscC2smag |
| 873 |
_RL viscA4 |
| 874 |
_RL viscA4W |
| 875 |
_RL viscA4D |
| 876 |
_RL viscA4Z |
| 877 |
_RL viscA4Max |
| 878 |
_RL viscA4ReMax |
| 879 |
_RL viscA4Grid, viscA4GridMax, viscA4GridMin |
| 880 |
_RL viscC4leith |
| 881 |
_RL viscC4leithD |
| 882 |
_RL viscC4smag |
| 883 |
_RL diffKhT |
| 884 |
_RL diffK4T |
| 885 |
_RL diffKrNrT(Nr) |
| 886 |
_RL diffKr4T(Nr) |
| 887 |
_RL diffKhS |
| 888 |
_RL diffK4S |
| 889 |
_RL diffKrNrS(Nr) |
| 890 |
_RL diffKr4S(Nr) |
| 891 |
_RL diffKrBL79surf |
| 892 |
_RL diffKrBL79deep |
| 893 |
_RL diffKrBL79scl |
| 894 |
_RL diffKrBL79Ho |
| 895 |
_RL BL79LatVary |
| 896 |
_RL diffKrBLEQsurf |
| 897 |
_RL diffKrBLEQdeep |
| 898 |
_RL diffKrBLEQscl |
| 899 |
_RL diffKrBLEQHo |
| 900 |
_RL tauCD, rCD, epsAB_CD |
| 901 |
_RL gravity, recip_gravity |
| 902 |
_RL gBaro |
| 903 |
_RL gravFacC(Nr), recip_gravFacC(Nr) |
| 904 |
_RL gravFacF(Nr+1), recip_gravFacF(Nr+1) |
| 905 |
_RL rhoNil |
| 906 |
_RL rhoConst, recip_rhoConst |
| 907 |
_RL rho1Ref(Nr) |
| 908 |
_RL rhoFacC(Nr), recip_rhoFacC(Nr) |
| 909 |
_RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1) |
| 910 |
_RL rhoConstFresh |
| 911 |
_RL thetaConst |
| 912 |
_RL tRef(Nr) |
| 913 |
_RL sRef(Nr) |
| 914 |
_RL pRef4EOS(Nr) |
| 915 |
_RL phiRef(2*Nr+1) |
| 916 |
_RL dBdrRef(Nr) |
| 917 |
_RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1) |
| 918 |
_RL mass2rUnit, rUnit2mass |
| 919 |
_RL baseTime |
| 920 |
_RL startTime |
| 921 |
_RL endTime |
| 922 |
_RL chkPtFreq |
| 923 |
_RL pChkPtFreq |
| 924 |
_RL dumpFreq |
| 925 |
_RL adjDumpFreq |
| 926 |
_RL diagFreq |
| 927 |
_RL taveFreq |
| 928 |
_RL tave_lastIter |
| 929 |
_RL monitorFreq |
| 930 |
_RL adjMonitorFreq |
| 931 |
_RL afFacMom |
| 932 |
_RL vfFacMom |
| 933 |
_RL pfFacMom |
| 934 |
_RL cfFacMom |
| 935 |
_RL foFacMom |
| 936 |
_RL mtFacMom |
| 937 |
_RL cosPower |
| 938 |
_RL cAdjFreq |
| 939 |
_RL tauThetaClimRelax |
| 940 |
_RL tauSaltClimRelax |
| 941 |
_RL latBandClimRelax |
| 942 |
_RL externForcingCycle |
| 943 |
_RL externForcingPeriod |
| 944 |
_RL convertFW2Salt |
| 945 |
_RL temp_EvPrRn |
| 946 |
_RL salt_EvPrRn |
| 947 |
_RL temp_addMass |
| 948 |
_RL salt_addMass |
| 949 |
_RL ivdc_kappa |
| 950 |
_RL hMixCriteria |
| 951 |
_RL dRhoSmall |
| 952 |
_RL hMixSmooth |
| 953 |
_RL sideDragFactor |
| 954 |
_RL bottomDragLinear |
| 955 |
_RL bottomDragQuadratic |
| 956 |
_RL smoothAbsFuncRange |
| 957 |
_RL nh_Am2 |
| 958 |
_RL tCylIn, tCylOut |
| 959 |
_RL phiEuler, thetaEuler, psiEuler |
| 960 |
#ifdef ALLOW_PRESSURE_RELEASE_CODE |
| 961 |
_RL cg2dMinColumnEps, pReleaseVisc |
| 962 |
#endif |
| 963 |
|
| 964 |
C-- COMMON /PARM_A/ Thermodynamics constants ? |
| 965 |
COMMON /PARM_A/ HeatCapacity_Cp |
| 966 |
_RL HeatCapacity_Cp |
| 967 |
|
| 968 |
C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...) |
| 969 |
C celsius2K :: convert centigrade (Celsius) degree to Kelvin |
| 970 |
C atm_Po :: standard reference pressure |
| 971 |
C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure |
| 972 |
C atm_Rd :: gas constant for dry air |
| 973 |
C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS) |
| 974 |
C atm_Rq :: water vapour specific volume anomaly relative to dry air |
| 975 |
C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg]) |
| 976 |
C integr_GeoPot :: option to select the way we integrate the geopotential |
| 977 |
C (still a subject of discussions ...) |
| 978 |
C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is |
| 979 |
C derived from the orography. Implemented: 0,1 (see INI_P_GROUND) |
| 980 |
COMMON /PARM_ATM/ |
| 981 |
& celsius2K, |
| 982 |
& atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po, |
| 983 |
& integr_GeoPot, selectFindRoSurf |
| 984 |
_RL celsius2K |
| 985 |
_RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq |
| 986 |
INTEGER integr_GeoPot, selectFindRoSurf |
| 987 |
|
| 988 |
C Logical flags for selecting packages |
| 989 |
LOGICAL useGAD |
| 990 |
LOGICAL useOBCS |
| 991 |
LOGICAL useSHAP_FILT |
| 992 |
LOGICAL useZONAL_FILT |
| 993 |
LOGICAL useOPPS |
| 994 |
LOGICAL usePP81 |
| 995 |
LOGICAL useKL10 |
| 996 |
LOGICAL useMY82 |
| 997 |
LOGICAL useGGL90 |
| 998 |
LOGICAL useKPP |
| 999 |
LOGICAL useGMRedi |
| 1000 |
LOGICAL useDOWN_SLOPE |
| 1001 |
LOGICAL useBBL |
| 1002 |
LOGICAL useCAL |
| 1003 |
LOGICAL useEXF |
| 1004 |
LOGICAL useBulkForce |
| 1005 |
LOGICAL useEBM |
| 1006 |
LOGICAL useCheapAML |
| 1007 |
LOGICAL useAUTODIFF |
| 1008 |
LOGICAL useGrdchk |
| 1009 |
LOGICAL useSMOOTH |
| 1010 |
LOGICAL usePROFILES |
| 1011 |
LOGICAL useECCO |
| 1012 |
LOGICAL useCTRL |
| 1013 |
LOGICAL useSBO |
| 1014 |
LOGICAL useFLT |
| 1015 |
LOGICAL usePTRACERS |
| 1016 |
LOGICAL useGCHEM |
| 1017 |
LOGICAL useRBCS |
| 1018 |
LOGICAL useOffLine |
| 1019 |
LOGICAL useMATRIX |
| 1020 |
LOGICAL useFRAZIL |
| 1021 |
LOGICAL useSEAICE |
| 1022 |
LOGICAL useSALT_PLUME |
| 1023 |
LOGICAL useShelfIce |
| 1024 |
LOGICAL useStreamIce |
| 1025 |
LOGICAL useICEFRONT |
| 1026 |
LOGICAL useThSIce |
| 1027 |
LOGICAL useLand |
| 1028 |
LOGICAL useATM2d |
| 1029 |
LOGICAL useAIM |
| 1030 |
LOGICAL useAtm_Phys |
| 1031 |
LOGICAL useFizhi |
| 1032 |
LOGICAL useGridAlt |
| 1033 |
LOGICAL useDiagnostics |
| 1034 |
LOGICAL useREGRID |
| 1035 |
LOGICAL useLayers |
| 1036 |
LOGICAL useMNC |
| 1037 |
LOGICAL useRunClock |
| 1038 |
LOGICAL useEMBED_FILES |
| 1039 |
LOGICAL useMYPACKAGE |
| 1040 |
COMMON /PARM_PACKAGES/ |
| 1041 |
& useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT, |
| 1042 |
& useOPPS, usePP81, useKL10, useMY82, useGGL90, useKPP, |
| 1043 |
& useGMRedi, useBBL, useDOWN_SLOPE, |
| 1044 |
& useCAL, useEXF, useBulkForce, useEBM, useCheapAML, |
| 1045 |
& useGrdchk, useSMOOTH, usePROFILES, useECCO, useCTRL, |
| 1046 |
& useSBO, useFLT, useAUTODIFF, |
| 1047 |
& usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX, |
| 1048 |
& useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce, |
| 1049 |
& useStreamIce, useICEFRONT, useThSIce, useLand, |
| 1050 |
& useATM2D, useAIM, useAtm_Phys, useFizhi, useGridAlt, |
| 1051 |
& useDiagnostics, useREGRID, useLayers, useMNC, |
| 1052 |
& useRunClock, useEMBED_FILES, |
| 1053 |
& useMYPACKAGE |
| 1054 |
|
| 1055 |
CEH3 ;;; Local Variables: *** |
| 1056 |
CEH3 ;;; mode:fortran *** |
| 1057 |
CEH3 ;;; End: *** |
Parent Directory
| 
Revision Log
| 
Revision Graph