--- MITgcm/model/inc/PARAMS.h 1998/05/30 02:10:16 1.13 +++ MITgcm/model/inc/PARAMS.h 1998/09/06 17:35:19 1.30 @@ -1,4 +1,4 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.13 1998/05/30 02:10:16 cnh Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.30 1998/09/06 17:35:19 cnh Exp $ C C /==========================================================\ C | PARAMS.h | @@ -26,6 +26,17 @@ PARAMETER ( precFloat32 = 0 ) INTEGER precFloat64 PARAMETER ( precFloat64 = 1 ) +C UNSET_xxx - Used to indicate variables that have not been given a value + Real*8 UNSET_FLOAT8 + PARAMETER ( UNSET_FLOAT8 = 1.234567D5 ) + Real*4 UNSET_FLOAT4 + PARAMETER ( UNSET_FLOAT4 = 1.234567E5 ) + _RL UNSET_RL + PARAMETER ( UNSET_RL = 1.234567D5 ) + _RS UNSET_RS + PARAMETER ( UNSET_RS = 1.234567E5 ) + INTEGER UNSET_I + PARAMETER ( UNSET_I = 123456789 ) C Checkpoint data INTEGER maxNoChkptLev @@ -33,8 +44,32 @@ C-- COMMON /PARM_C/ Character valued parameters used by the model. C checkPtSuff - List of checkpoint file suffices - COMMON /PARM_C/ checkPtSuff +C bathyFile - File containing bathymetry. If not defined bathymetry +C is taken from inline function. +C hydrogThetaFile - File containing initial hydrographic data for potential +C temperature. +C hydrogSaltFile - File containing initial hydrographic data for salinity. +C zonalWindFile - File containing zonal wind data +C meridWindFile - File containing meridional wind data +C thetaClimFile - File containing theta climataology used +C in relaxation term -lambda(theta-theta*) +C saltClimFile - File containing salt climataology used +C in relaxation term -lambda(salt-salt*) +C buoyancyRelation - Flag used to indicate which relation to use to +C get buoyancy. + COMMON /PARM_C/ checkPtSuff, + & bathyFile, hydrogThetaFile, hydrogSaltFile, + & zonalWindFile, meridWindFile, thetaClimFile, + & saltClimFile, buoyancyRelation CHARACTER*(5) checkPtSuff(maxNoChkptLev) + CHARACTER*(MAX_LEN_FNAM) bathyFile + CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile + CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile + CHARACTER*(MAX_LEN_FNAM) zonalWindFile + CHARACTER*(MAX_LEN_FNAM) meridWindFile + CHARACTER*(MAX_LEN_FNAM) thetaClimFile + CHARACTER*(MAX_LEN_FNAM) saltClimFile + CHARACTER*(MAX_LEN_FNAM) buoyancyRelation C-- COMMON /PARM_I/ Integer valued parameters used by the model. C cg2dMaxIters - Maximum number of iterations in the @@ -77,6 +112,8 @@ C and off. C momPressureForcing - Flag which turns pressure term in momentum equation C on and off. +C metricTerms - Flag which turns metric terms on or off. +C usingSphericalPolarMTerms - If TRUE use spherical polar 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. @@ -93,14 +130,34 @@ C implicitFreeSurface - Set to true to use implcit free surface C rigidLid - Set to true to use rigid lid C momStepping - Turns momentum equation time-stepping off -C momStepping - Turns temperature equation time-stepping off +C tempStepping - Turns temperature equation time-stepping off +C saltStepping - Turns salinity equation time-stepping off +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 implicitDiffusion - Turns implicit vertical diffusion on +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 usingZCoords - Set to indicate that we are working in height +C coords. COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing, & tempDiffusion, tempAdvection, tempForcing, & saltDiffusion, saltAdvection, saltForcing, - & implicitFreeSurface, rigidLid, momStepping, tempStepping + & implicitFreeSurface, rigidLid, + & momStepping, tempStepping, saltStepping, + & metricTerms, usingSphericalPolarMTerms, + & useConstantF, useBetaPlaneF, useSphereF, + & implicitDiffusion, doThetaClimRelax, doSaltClimRelax, + & periodicExternalForcing, usingPCoords, usingZCoords LOGICAL usingCartesianGrid LOGICAL usingSphericalPolarGrid + LOGICAL usingSphericalPolarMTerms LOGICAL momViscosity LOGICAL momAdvection LOGICAL momForcing @@ -116,6 +173,17 @@ LOGICAL rigidLid LOGICAL momStepping LOGICAL tempStepping + LOGICAL saltStepping + LOGICAL metricTerms + LOGICAL useConstantF + LOGICAL useBetaPlaneF + LOGICAL useSphereF + LOGICAL implicitDiffusion + LOGICAL doThetaClimRelax + LOGICAL doSaltClimRelax + LOGICAL periodicExternalForcing + LOGICAL usingPCoords + LOGICAL usingZCoords C-- COMMON /PARM_R/ "Real" valued parameters used by the model. C cg2dTargetResidual @@ -134,38 +202,54 @@ 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 delZ - Vertical grid spacing ( m ) - delZ is the distance -C between "w" surfaces. +C delP - Vertical grid spacing ( Pa ). +C delZ - Vertical grid spacing ( m ). +C delR - Vertical grid spacing ( units of r ). 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 gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 ) C ronil - Reference density +C rhoConst - Vertically constant reference density C startTime - Start time for model ( s ) C phiMin - Latitude of southern most cell face. C thetaMin - Longitude of western most cell face (this C is an "inert" parameter but it is included C to make geographical references simple.) C rSphere - Radius of sphere for a spherical polar grid ( m ). +C recip_RSphere - Reciprocal radius of sphere ( m ). C f0 - Reference coriolis parameter ( 1/s ) C ( Southern edge f for beta plane ) C beta - df/dy ( s^-1.m^-1 ) +C omega - Angular velocity ( rad/s ) 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 C salt laterally ( m^4/s ) C deltaT - Default timestep ( s ) @@ -180,38 +264,69 @@ 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 -C tauCD - CD scheme coupling timescale ( 1/s ) -C rCD - CD scheme normalised coupling parameter ( 0-1 ) -C GMmaxslope - max. slope allowed in GM/Redi tensor -C GMlength - Length to use in Visbeck et al. formula for K (m) -C GMalpha - alpha to use in Visbeck et al. formula for K -C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) -C GMkbackground - background value of GM/Redi coefficient -C startTime - Starting time for this integration ( s ). -C endTime - Ending time for this integration ( s ). -C chkPtFreq - Frequency of rolling check pointing ( s ). -C pChkPtFreq - Frequency of permanent check pointing ( s ). -C dumpFreq - Frequency with which model state is written to -C post-processing files ( s ). -C afFacMom - Advection of momentum term scaling parameter -C vfFacMom - Momentum viscosity scaling parameter -C pfFacMom - Momentum pressure forcing parameter -C cfFacMom - Coriolis term scaling parameter -C foFacMom - Momentum forcing scaling parameter -C cAdjFreq - Frequency of convective adjustment - COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY, +C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) +C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) +C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa) +C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r) +C tauCD - CD scheme coupling timescale ( 1/s ) +C rCD - CD scheme normalised coupling parameter ( 0-1 ) +C GMmaxslope - max. slope allowed in GM/Redi tensor +C GMlength - Length to use in Visbeck et al. formula for K (m) +C GMalpha - alpha to use in Visbeck et al. formula for K +C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) +C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s ) +C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s ) +C startTime - Starting time for this integration ( s ). +C endTime - Ending time for this integration ( s ). +C chkPtFreq - Frequency of rolling check pointing ( s ). +C pChkPtFreq - Frequency of permanent check pointing ( s ). +C dumpFreq - Frequency with which model state is written to +C post-processing files ( s ). +C afFacMom - Advection of momentum term tracer parameter +C vfFacMom - Momentum viscosity tracer parameter +C pfFacMom - Momentum pressure forcing tracer parameter +C cfFacMom - Coriolis term tracer parameter +C foFacMom - Momentum forcing tracer parameter +C mtFacMom - Metric terms tracer parameter +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 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 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 horiVertRatio - Ratio on units in vertical to units in horizontal. +C ( 1 if horiz in m and vertical in m ). +C ( g*rho if horiz in m and vertical in Pa ). + COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, + & delP, delZ, delR, delX, delY, & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin, - & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, - & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT, - & tauCD, rCD, freeSurfFac, - & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground, - & gravity, gBaro, rhonil, tRef, sRef, - & endTime, chkPtFreq, pchkPtFreq, dumpFreq, - & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, - & cAdjFreq + & thetaMin, rSphere, recip_RSphere, f0, fCori, beta, + & viscAh, viscAz, viscA4, viscAr, + & diffKhT, diffKzT, diffK4T, diffKrT, + & diffKhS, diffKzS, diffK4S, diffKrS, + & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, + & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, + & gravity, gBaro, rhonil, recip_rhonil, + & recip_rhoConst, rhoConst, tRef, sRef, + & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, + & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, + & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, + & tauSaltClimRelax, lambdaSaltClimRelax, + & externForcingCycle, externForcingPeriod, + & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, + & theta_S, specVol_S, horiVertRatio + _RL cg2dTargetResidual _RL cg2dpcOffDFac - _RL delZ(Nz) + _RL delZ(Nr) + _RL delP(Nr) + _RL delR(Nr) _RL delX(Nx) _RL delY(Ny) _RL deltaT @@ -222,17 +337,28 @@ _RL phiMin _RL thetaMin _RL rSphere + _RL recip_RSphere _RL f0 _RL freeSurfFac + _RL hFacMin + _RL hFacMinDz + _RL hFacMinDp + _RL hFacMinDr _RL beta _RL viscAh _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 @@ -242,23 +368,39 @@ _RL GMalpha _RL GMdepth _RL GMkbackground + _RL GMmaxval _RL gravity _RL gBaro _RL rhonil - _RL tRef(Nz) - _RL sRef(Nz) + _RL recip_rhonil + _RL rhoConst + _RL recip_rhoConst + _RL specVol_S(Nr) + _RL tRef(Nr) + _RL theta_S(Nr) + _RL sRef(Nr) _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) _RL startTime _RL endTime _RL chkPtFreq _RL pChkPtFreq _RL dumpFreq + _RL taveFreq _RL afFacMom _RL vfFacMom _RL pfFacMom _RL cfFacMom _RL foFacMom + _RL mTFacMom _RL cAdjFreq + _RL omega + _RL tauThetaClimRelax + _RL lambdaThetaClimRelax + _RL tauSaltClimRelax + _RL lambdaSaltClimRelax + _RL externForcingCycle + _RL externForcingPeriod + _RL horiVertRatio COMMON /PARM_A/ HeatCapacity_Cp, & Lamba_theta @@ -267,7 +409,7 @@ C Equation of State (polynomial coeffients) COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS - _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1) + _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.