--- MITgcm/model/inc/PARAMS.h 2001/09/27 18:04:52 1.64 +++ MITgcm/model/inc/PARAMS.h 2003/10/29 00:17:44 1.96 @@ -1,4 +1,4 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.64 2001/09/27 18:04:52 adcroft Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.96 2003/10/29 00:17:44 jmc Exp $ C $Name: $ C CBOP @@ -69,8 +69,11 @@ C surfQswfile :: File containing surface shortwave radiation C dQdTfile :: File containing thermal relaxation coefficient C EmPmRfile :: File containing surface fresh water flux +C pLoadFile :: File containing pressure loading C buoyancyRelation :: Flag used to indicate which relation to use to C get buoyancy. +C eosType :: choose the equation of state: +C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS COMMON /PARM_C/ checkPtSuff, & bathyFile, topoFile, & hydrogThetaFile, hydrogSaltFile, @@ -78,7 +81,9 @@ & saltClimFile, buoyancyRelation, & EmPmRfile, surfQfile, surfQswfile, & uVelInitFile, vVelInitFile, pSurfInitFile, - & dQdTfile + & dQdTfile, ploadFile, + & eosType, pickupSuff, + & mdsioLocalDir CHARACTER*(5) checkPtSuff(maxNoChkptLev) CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile @@ -95,6 +100,10 @@ CHARACTER*(MAX_LEN_FNAM) vVelInitFile CHARACTER*(MAX_LEN_FNAM) pSurfInitFile CHARACTER*(MAX_LEN_FNAM) dQdTfile + CHARACTER*(MAX_LEN_FNAM) ploadFile + CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir + CHARACTER*(6) eosType + CHARACTER*(10) pickupSuff C-- COMMON /PARM_I/ Integer valued parameters used by the model. C cg2dMaxIters :: Maximum number of iterations in the @@ -115,6 +124,8 @@ C nCheckLev :: Holds current checkpoint level C nonlinFreeSurf :: option related to non-linear free surface C =0 Linear free surface ; >0 Non-linear +C select_rStar :: option related to r* vertical coordinate +C =0 (default) use r coord. ; > 0 use r* COMMON /PARM_I/ & cg2dMaxIters, @@ -125,9 +136,9 @@ & numStepsPerPickup, & writeStatePrec, nCheckLev, & writeBinaryPrec, readBinaryPrec, - & nonlinFreeSurf, - & zonal_filt_sinpow, zonal_filt_cospow, - & tempAdvScheme, saltAdvScheme, tracerAdvScheme + & nonlinFreeSurf, select_rStar, + & tempAdvScheme, saltAdvScheme, tracerAdvScheme, + & debugLevel INTEGER cg2dMaxIters INTEGER cg2dChkResFreq INTEGER cg3dMaxIters @@ -141,11 +152,19 @@ INTEGER readBinaryPrec INTEGER nCheckLev INTEGER nonlinFreeSurf - INTEGER zonal_filt_sinpow - INTEGER zonal_filt_cospow + INTEGER select_rStar INTEGER tempAdvScheme INTEGER saltAdvScheme INTEGER tracerAdvScheme + INTEGER debugLevel + +C + INTEGER debLevZero + PARAMETER(debLevZero=0) + INTEGER debLevA + PARAMETER(debLevA=1) + INTEGER debLevB + PARAMETER(debLevB=2) C-- COMMON /PARM_L/ Logical valued parameters used by the model. C usingCartesianGrid :: If TRUE grid generation will be in a cartesian @@ -163,6 +182,7 @@ C on and off. C metricTerms :: Flag which turns metric terms on or off. C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms. +C useNHMTerms :: If TRUE use non-hydrostatic metric terms. C useCoriolis :: Flag which turns the coriolis terms on and off. C tempDiffusion :: Flag which turns diffusion of temperature on C and off. @@ -170,12 +190,15 @@ C and off. C tempForcing :: Flag which turns external forcing of temperature on C and off. -C saltDiffusion :: Flag which turns diffusion of salinit on +C saltDiffusion :: Flag which turns diffusion of salinity on C and off. -C saltAdvection :: Flag which turns advection of salinit on +C saltAdvection :: Flag which turns advection of salinity on C and off. -C saltForcing :: Flag which turns external forcing of salinit on +C saltForcing :: Flag which turns external forcing of salinity on C and off. +C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux +C as a real Fresh Water (=> changes the Sea Level) +C if F, converts P+R-E to salt flux (no SL effect) C rigidLid :: Set to true to use rigid lid C implicitFreeSurface :: Set to true to use implcit free surface C exactConserv :: Set to true to conserve exactly the total Volume @@ -188,19 +211,32 @@ C useConstantF :: Coriolis parameter set to f0 C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y C useSphereF :: Coriolis parameter set to 2.omega.sin(phi) +C useCDscheme :: use CD-scheme to calculate Coriolis terms. +C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986) C implicitDiffusion :: Turns implicit vertical diffusion on C implicitViscosity :: Turns implicit vertical viscosity on +C multiDimAdvection :: Flag that enable multi-dimension advection +C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution +C out off Adams-Bashforth time stepping. C doThetaClimRelax :: Set true if relaxation to temperature C climatology is required. C doSaltClimRelax :: Set true if relaxation to salinity C climatology is required. C periodicExternalForcing :: Set true if forcing is time-dependant C usingPCoords :: Set to indicate that we are working in pressure -C coords. +C coords. (jmc: is it still used ?) C usingZCoords :: Set to indicate that we are working in height -C coords. +C coords. (jmc: is it still used ?) +C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.) +C this requires specific code for restart & exchange +C setCenterDr :: set cell Center depth and put Interface at the middle C nonHydrostatic :: Using non-hydrostatic terms +C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm C globalFiles :: Selects between "global" and "tiled" files +C useSingleCpuIO :: On SGI platforms, option globalFiles is either +C slow (f77) or does not work (f90). When +C useSingleCpuIO is set, mdsio_writefield.F +C outputs from master mpi process only. C allowFreezing :: Allows water to freeze and form ice C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground) COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, @@ -211,22 +247,27 @@ & momPressureForcing, vectorInvariantMomentum, & tempDiffusion, tempAdvection, tempForcing, & saltDiffusion, saltAdvection, saltForcing, + & useRealFreshWaterFlux, & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf, & momStepping, tempStepping, saltStepping, tr1Stepping, - & metricTerms, usingSphericalPolarMTerms, + & metricTerms, usingSphericalPolarMTerms, useNHMTerms, & useConstantF, useBetaPlaneF, useSphereF, + & useCDscheme, + & useEnergyConservingCoriolis, useJamartWetPoints, & implicitDiffusion, implicitViscosity, + & multiDimAdvection, forcing_In_AB, & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax, - & periodicExternalForcing, usingPCoords, usingZCoords, - & nonHydrostatic, globalFiles, + & periodicExternalForcing, + & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr, + & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO, & allowFreezing, groundAtK1, & usePickupBeforeC35, debugMode, - & readPickupWithTracer, writePickupWithTracer, - & multiDimAdvection + & readPickupWithTracer, writePickupWithTracer LOGICAL usingCartesianGrid LOGICAL usingSphericalPolarGrid LOGICAL usingCurvilinearGrid LOGICAL usingSphericalPolarMTerms + LOGICAL useNHMTerms LOGICAL no_slip_sides LOGICAL no_slip_bottom LOGICAL staggerTimeStep @@ -242,6 +283,7 @@ LOGICAL saltDiffusion LOGICAL saltAdvection LOGICAL saltForcing + LOGICAL useRealFreshWaterFlux LOGICAL rigidLid LOGICAL implicitFreeSurface LOGICAL exactConserv @@ -254,23 +296,31 @@ LOGICAL useConstantF LOGICAL useBetaPlaneF LOGICAL useSphereF + LOGICAL useCDscheme + LOGICAL useEnergyConservingCoriolis + LOGICAL useJamartWetPoints LOGICAL implicitDiffusion LOGICAL implicitViscosity + LOGICAL multiDimAdvection + LOGICAL forcing_In_AB LOGICAL doThetaClimRelax LOGICAL doSaltClimRelax LOGICAL doTr1ClimRelax LOGICAL periodicExternalForcing LOGICAL usingPCoords LOGICAL usingZCoords + LOGICAL useDynP_inEos_Zc + LOGICAL setCenterDr LOGICAL nonHydrostatic + LOGICAL quasiHydrostatic LOGICAL globalFiles + LOGICAL useSingleCpuIO LOGICAL allowFreezing LOGICAL groundAtK1 LOGICAL usePickupBeforeC35 LOGICAL debugMode LOGICAL readPickupWithTracer LOGICAL writePickupWithTracer - LOGICAL multiDimAdvection C-- COMMON /PARM_R/ "Real" valued parameters used by the model. C gg2dTargetResidual @@ -293,16 +343,16 @@ C drop form 192 -> 134! Need to investigate this further! C For now I have introduced a parameter cg2dpcOffDFac which C defaults to 0.51 but can be set at runtime. -C delP :: Vertical grid spacing ( Pa ). -C delZ :: Vertical grid spacing ( m ). C delR :: Vertical grid spacing ( units of r ). +C delRc :: Vertical grid spacing between cell centers (r unit). C delX :: Separation between cell faces (m) or (deg), depending C delY on input flags. C gravity :: Accel. due to gravity ( m/s^2 ) C recip_gravity and its inverse C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 ) -C ronil :: Reference density +C rhoNil :: Reference density for the linear equation of state C rhoConst :: Vertically constant reference density +C rhoConstFresh :: Constant reference density for fresh water (rain) C startTime :: Start time for model ( s ) C phiMin :: Latitude of southern most cell face. C thetaMin :: Longitude of western most cell face (this @@ -314,32 +364,21 @@ C ( Southern edge f for beta plane ) C beta :: df/dy ( s^-1.m^-1 ) C omega :: Angular velocity ( rad/s ) +C rotationPeriod :: Rotation period (s) (= 2.pi/omega) C viscAh :: Eddy viscosity coeff. for mixing of C momentum laterally ( m^2/s ) -C viscAz :: Eddy viscosity coeff. for mixing of -C momentum vertically ( m^2/s ) -C viscAp :: Eddy viscosity coeff. for mixing of -C momentum vertically ( Pa^2/s ) C viscAr :: Eddy viscosity coeff. for mixing of C momentum vertically ( units of r^2/s ) C viscA4 :: Biharmonic viscosity coeff. for mixing of C momentum laterally ( m^4/s ) C diffKhT :: Laplacian diffusion coeff. for mixing of C heat laterally ( m^2/s ) -C diffKzT :: Laplacian diffusion coeff. for mixing of -C heat vertically ( m^2/s ) -C diffKpT :: Laplacian diffusion coeff. for mixing of -C heat vertically ( Pa^2/s ) C diffKrT :: Laplacian diffusion coeff. for mixing of C heat vertically ( units of r^2/s ) C diffK4T :: Biharmonic diffusion coeff. for mixing of C heat laterally ( m^4/s ) C diffKhS :: Laplacian diffusion coeff. for mixing of C salt laterally ( m^2/s ) -C diffKzS :: Laplacian diffusion coeff. for mixing of -C salt vertically ( m^2/s ) -C diffKpS :: Laplacian diffusion coeff. for mixing of -C salt vertically ( Pa^2/s ) C diffKrS :: Laplacian diffusion coeff. for mixing of C salt vertically ( units of r^2/s ) C diffK4S :: Biharmonic diffusion coeff. for mixing of @@ -353,6 +392,7 @@ C are referenced to this clock. ( s ) C deltaTMom :: Timestep for momemtum equations ( s ) C deltaTtracer :: Timestep for tracer equations ( s ) +C deltaTfreesurf :: Timestep for free-surface equation ( s ) C freesurfFac :: Parameter to turn implicit free surface term on or off C freesurfac = 1. uses implicit free surface C freesurfac = 0. uses rigid lid @@ -385,64 +425,78 @@ C cosPower :: Power of cosine of latitude to multiply viscosity C cAdjFreq :: Frequency of convective adjustment C -C taveFreq :: Frequency with which time-averaged model state is written to -C post-processing files ( s ). +C taveFreq :: Frequency with which time-averaged model state +C is written to post-processing files ( s ). +C tave_lastIter :: (for state variable only) fraction of the last time +C step (of each taveFreq period) put in the time average. +C (fraction for 1rst iter = 1 - tave_lastIter) C tauThetaClimRelax :: Relaxation to climatology time scale ( s ). C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ). C tauSaltClimRelax :: Relaxation to climatology time scale ( s ). C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ). +C latBandClimRelax :: latitude band where Relaxation to Clim. is applied, +C i.e. where |yC| <= latBandClimRelax C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month) C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year) C (note: externForcingCycle must be an integer C number times externForcingPeriod) +C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux +C (use model surface (local) value if set to -1) +C temp_EvPrRn :: temperature of Rain & Evap. +C salt_EvPrRn :: salinity of Rain & Evap. +C trac_EvPrRn :: tracer concentration in Rain & Evap. +C (notes: a) tracer content of Rain/Evap only used if both +C NonLin_FrSurf & useRealFreshWater are set. +C b) use model surface (local) value if set to UNSET_RL) C horiVertRatio :: Ratio on units in vertical to units in horizontal. C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). C ( g*rho if horiz in m and vertical in Pa ). -C latFFTFiltLo :: Low latitude for FFT filtering of latitude -C circles ( see filter*.F ) C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel) C bottomDragLinear :: Drag coefficient built in to core dynamics C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m ) COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit, & cg2dpcOffDFac, cg3dTargetResidual, - & delP, delZ, delR, delX, delY, - & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, + & delR, delRc, delX, delY, + & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock, + & abeps, startTime, & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta, - & fCori, fCoriG, - & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension, - & diffKhT, diffKzT, diffK4T, diffKrT, - & diffKhS, diffKzS, diffK4S, diffKrS, + & fCori, fCoriG, fCoriCos, + & viscAh, viscA4, viscAr, viscAstrain, viscAtension, + & diffKhT, diffK4T, diffKrT, + & diffKhS, diffK4S, diffKrS, & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow, & hFacMin, hFacMinDz, hFacInf, hFacSup, & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, - & recip_rhoConst, rhoConst, tRef, sRef, + & recip_rhoConst, rhoConst, + & rhoConstFresh, convertEmP2rUnit, tRef, sRef, & endTime, chkPtFreq, pchkPtFreq, dumpFreq, - & diagFreq, taveFreq, monitorFreq, + & diagFreq, taveFreq, tave_lastIter, monitorFreq, & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, - & cosPower, cAdjFreq, omega, + & cosPower, cAdjFreq, omega, rotationPeriod, & tauThetaClimRelax, lambdaThetaClimRelax, & tauSaltClimRelax, lambdaSaltClimRelax, - & tauTr1ClimRelax, lambdaTr1ClimRelax, + & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax, & externForcingCycle, externForcingPeriod, - & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, - & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio, - & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat, + & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn, + & hFacMinDr, hFacMinDp, + & horiVertRatio, recip_horiVertRatio, + & ivdc_kappa, Ro_SeaLevel, & bottomDragLinear,bottomDragQuadratic _RL cg2dTargetResidual _RL cg2dTargetResWunit _RL cg3dTargetResidual _RL cg2dpcOffDFac - _RL delZ(Nr) - _RL delP(Nr) _RL delR(Nr) + _RL delRc(Nr+1) _RL delX(Nx) _RL delY(Ny) _RL deltaT _RL deltaTClock _RL deltaTmom _RL deltaTtracer + _RL deltaTfreesurf _RL abeps _RL phiMin _RL thetaMin @@ -462,19 +516,13 @@ _RL viscAh _RL viscAstrain _RL viscAtension - _RL viscAz - _RL viscAp _RL viscAr _RL viscA4 _RL diffKhT _RL diffKrT - _RL diffKzT - _RL diffKpT _RL diffK4T _RL diffKhS _RL diffKrS - _RL diffKzS - _RL diffKpS _RL diffK4S _RL delt _RL tauCD @@ -486,12 +534,13 @@ _RL recip_rhonil _RL rhoConst _RL recip_rhoConst - _RL specVol_S(Nr) + _RL rhoConstFresh + _RL convertEmP2rUnit _RL tRef(Nr) - _RL theta_S(Nr) _RL sRef(Nr) _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) + _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) _RL startTime _RL endTime _RL chkPtFreq @@ -499,6 +548,7 @@ _RL dumpFreq _RL diagFreq _RL taveFreq + _RL tave_lastIter _RL monitorFreq _RL afFacMom _RL vfFacMom @@ -509,61 +559,70 @@ _RL cosPower _RL cAdjFreq _RL omega + _RL rotationPeriod _RL tauThetaClimRelax _RL lambdaThetaClimRelax _RL tauSaltClimRelax _RL lambdaSaltClimRelax _RL tauTr1ClimRelax _RL lambdaTr1ClimRelax + _RL latBandClimRelax _RL externForcingCycle _RL externForcingPeriod + _RL convertFW2Salt + _RL temp_EvPrRn + _RL salt_EvPrRn + _RL trac_EvPrRn _RL horiVertRatio _RL recip_horiVertRatio - _RL latFFTFiltLo _RL ivdc_kappa _RL Ro_SeaLevel - _RL zonal_filt_lat _RL bottomDragLinear _RL bottomDragQuadratic - COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp, - & Lamba_theta +C-- COMMON /PARM_A/ Thermodynamics constants ? + COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp _RL HeatCapacity_Cp - _RL Lamba_theta _RL recip_Cp -C Equation of State (polynomial coeffients) - COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS - _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1) -C Linear equation of state -C tAlpha :: Linear EOS thermal expansion coefficient ( 1/degree ). -C sBeta :: Linear EOS haline contraction coefficient. - COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType - _RL tAlpha - _RL sBeta - character*(6) eosType - -C Atmospheric physical parameters (Ideal Gas EOS, ...) -C atm_po :: standard reference pressure -C atm_cp :: specific heat (Cp) of the (dry) air at constant pressure +C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...) +C celsius2K :: convert centigrade (Celsius) degree to Kelvin +C atm_Po :: standard reference pressure +C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure +C atm_Rd :: gas constant for dry air C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS) -C Integr_GeoPot :: option to select the way we integrate the geopotential +C atm_Rq :: water vapour specific volume anomaly relative to dry air +C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg]) +C integr_GeoPot :: option to select the way we integrate the geopotential C (still a subject of discussions ...) - COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po, - & Integr_GeoPot - _RL atm_cp, atm_kappa, atm_po - INTEGER Integr_GeoPot +C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is +C derived from the orography. Implemented: 0,1 (see INI_P_GROUND) + COMMON /PARM_ATM/ + & celsius2K, + & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po, + & integr_GeoPot, selectFindRoSurf + _RL celsius2K + _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq + INTEGER integr_GeoPot, selectFindRoSurf C Logical flags for selecting packages LOGICAL useKPP LOGICAL useGMRedi LOGICAL useOBCS LOGICAL useAIM + LOGICAL useLand LOGICAL useGrdchk LOGICAL useECCO LOGICAL useSHAP_FILT + LOGICAL useZONAL_FILT LOGICAL useFLT + LOGICAL usePTRACERS + LOGICAL useSBO + LOGICAL useSEAICE + LOGICAL useBulkforce + LOGICAL useThermSEAICE COMMON /PARM_PACKAGES/ - & useKPP, useGMRedi, useOBCS, useAIM, useECCO, - & useSHAP_FILT, useGrdchk, useFLT - + & useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO, + & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT, + & usePTRACERS, useSBO, useSEAICE, + & useThermSEAICE, useBulkforce