/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.73 by mlosch, Wed Jul 31 16:38:30 2002 UTC revision 1.88 by jmc, Mon Mar 17 16:59:38 2003 UTC
# Line 72  C     EmPmRfile       :: File containing Line 72  C     EmPmRfile       :: File containing
72  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
73  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
74  C                        get buoyancy.  C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
78       &                bathyFile, topoFile,       &                bathyFile, topoFile,
79       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
# Line 79  C                        get buoyancy. Line 81  C                        get buoyancy.
81       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
82       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
83       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
84       &                dQdTfile, ploadFile       &                dQdTfile, ploadFile,
85         &                eosType
86        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 97  C                        get buoyancy. Line 100  C                        get buoyancy.
100        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
102        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
103          CHARACTER*(6) eosType
104    
105  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
106  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 117  C     readBinaryPrec      :: Precision u Line 121  C     readBinaryPrec      :: Precision u
121  C     nCheckLev           :: Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
122  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
123  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
124    C     select_rStar        :: option related to r* vertical coordinate
125    C                           =0 (default) use r coord. ; > 0 use r*
126    
127        COMMON /PARM_I/        COMMON /PARM_I/
128       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 127  C                           =0 Linear fr Line 133  C                           =0 Linear fr
133       &        numStepsPerPickup,       &        numStepsPerPickup,
134       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
135       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
136       &        nonlinFreeSurf,       &        nonlinFreeSurf, select_rStar,
137       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
138        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
139        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 142  C                           =0 Linear fr Line 148  C                           =0 Linear fr
148        INTEGER readBinaryPrec        INTEGER readBinaryPrec
149        INTEGER nCheckLev        INTEGER nCheckLev
150        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
151          INTEGER select_rStar
152        INTEGER tempAdvScheme        INTEGER tempAdvScheme
153        INTEGER saltAdvScheme        INTEGER saltAdvScheme
154        INTEGER tracerAdvScheme        INTEGER tracerAdvScheme
# Line 162  C     momPressureForcing :: Flag which t Line 169  C     momPressureForcing :: Flag which t
169  C                          on and off.  C                          on and off.
170  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
171  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
172    C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
173  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
174  C     tempDiffusion :: Flag which turns diffusion of temperature on  C     tempDiffusion :: Flag which turns diffusion of temperature on
175  C                     and off.  C                     and off.
# Line 202  C     doSaltClimRelax  :: Set true if re Line 210  C     doSaltClimRelax  :: Set true if re
210  C                        climatology is required.  C                        climatology is required.
211  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
212  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in pressure
213  C                        coords.  C                        coords. (jmc: is it still used ?)
214  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
215  C                        coords.  C                        coords. (jmc: is it still used ?)
216    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
217    C                         this requires specific code for restart & exchange
218  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
219  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
220    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
221  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
222    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
223    C                       slow (f77) or does not work (f90).  When
224    C                       useSingleCpuIO is set, mdsio_writefield.F
225    C                       outputs from master mpi process only.
226  C     allowFreezing  :: Allows water to freeze and form ice  C     allowFreezing  :: Allows water to freeze and form ice
227  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
228        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
# Line 221  C     groundAtK1  :: put the surface(k=1 Line 236  C     groundAtK1  :: put the surface(k=1
236       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
237       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
238       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
239       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
240       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
241       & useEnergyConservingCoriolis, useJamartWetPoints,       & useEnergyConservingCoriolis, useJamartWetPoints,
242       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
243       & multiDimAdvection, forcing_In_AB,       & multiDimAdvection, forcing_In_AB,
244       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
245       & periodicExternalForcing,       & periodicExternalForcing,
246       & usingPCoords, usingZCoords, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
247       & nonHydrostatic, globalFiles,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
248       & allowFreezing, groundAtK1,       & allowFreezing, groundAtK1,
249       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, debugMode,
250       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer
# Line 237  C     groundAtK1  :: put the surface(k=1 Line 252  C     groundAtK1  :: put the surface(k=1
252        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
253        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
254        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
255          LOGICAL useNHMTerms
256        LOGICAL no_slip_sides        LOGICAL no_slip_sides
257        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
258        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
# Line 277  C     groundAtK1  :: put the surface(k=1 Line 293  C     groundAtK1  :: put the surface(k=1
293        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
294        LOGICAL usingPCoords        LOGICAL usingPCoords
295        LOGICAL usingZCoords        LOGICAL usingZCoords
296          LOGICAL useDynP_inEos_Zc
297        LOGICAL setCenterDr        LOGICAL setCenterDr
298        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
299          LOGICAL quasiHydrostatic
300        LOGICAL globalFiles        LOGICAL globalFiles
301          LOGICAL useSingleCpuIO
302        LOGICAL allowFreezing        LOGICAL allowFreezing
303        LOGICAL groundAtK1        LOGICAL groundAtK1
304        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
# Line 317  C     delY        on input flags. Line 336  C     delY        on input flags.
336  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
337  C     recip_gravity and its inverse  C     recip_gravity and its inverse
338  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
339  C     ronil     :: Reference density  C     rhoNil    :: Reference density for the linear equation of state
340  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
341    C     rhoConstFresh :: Constant reference density for fresh water (rain)
342  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
343  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
344  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 330  C     f0        :: Reference coriolis pa Line 350  C     f0        :: Reference coriolis pa
350  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
351  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
352  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
353    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
354  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
355  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
356  C     viscAz    :: Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
# Line 402  C     mtFacMom      :: Metric terms trac Line 423  C     mtFacMom      :: Metric terms trac
423  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
424  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
425  C  C
426  C     taveFreq      :: Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state
427  C                     post-processing files ( s ).  C                      is written to post-processing files ( s ).
428    C     tave_lastIter :: (for state variable only) fraction of the last time
429    C                      step (of each taveFreq period) put in the time average.
430    C                      (fraction for 1rst iter = 1 - tave_lastIter)
431  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
432  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
433  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 433  C      --"-"--  Quadratic  ( linear: 1/s Line 457  C      --"-"--  Quadratic  ( linear: 1/s
457       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
458       & abeps, startTime,       & abeps, startTime,
459       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
460       & fCori, fCoriG,       & fCori, fCoriG, fCoriCos,
461       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
462       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
463       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
464       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
465       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
466       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
467       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst,
468         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
469       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
470       & diagFreq, taveFreq, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
471       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
472       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
473       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
474       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
475       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax,
# Line 513  C      --"-"--  Quadratic  ( linear: 1/s Line 538  C      --"-"--  Quadratic  ( linear: 1/s
538        _RL recip_rhonil        _RL recip_rhonil
539        _RL rhoConst        _RL rhoConst
540        _RL recip_rhoConst        _RL recip_rhoConst
541          _RL rhoConstFresh
542          _RL convertEmP2rUnit
543        _RL tRef(Nr)        _RL tRef(Nr)
544        _RL sRef(Nr)        _RL sRef(Nr)
545        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
546        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
547          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
548        _RL startTime        _RL startTime
549        _RL endTime        _RL endTime
550        _RL chkPtFreq        _RL chkPtFreq
# Line 524  C      --"-"--  Quadratic  ( linear: 1/s Line 552  C      --"-"--  Quadratic  ( linear: 1/s
552        _RL dumpFreq        _RL dumpFreq
553        _RL diagFreq        _RL diagFreq
554        _RL taveFreq        _RL taveFreq
555          _RL tave_lastIter
556        _RL monitorFreq        _RL monitorFreq
557        _RL afFacMom        _RL afFacMom
558        _RL vfFacMom        _RL vfFacMom
# Line 534  C      --"-"--  Quadratic  ( linear: 1/s Line 563  C      --"-"--  Quadratic  ( linear: 1/s
563        _RL cosPower        _RL cosPower
564        _RL cAdjFreq        _RL cAdjFreq
565        _RL omega        _RL omega
566          _RL rotationPeriod
567        _RL tauThetaClimRelax        _RL tauThetaClimRelax
568        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
569        _RL tauSaltClimRelax        _RL tauSaltClimRelax
# Line 559  C      --"-"--  Quadratic  ( linear: 1/s Line 589  C      --"-"--  Quadratic  ( linear: 1/s
589        _RL Lamba_theta        _RL Lamba_theta
590        _RL recip_Cp        _RL recip_Cp
591    
 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  
   
592  C Atmospheric physical parameters (Ideal Gas EOS, ...)  C Atmospheric physical parameters (Ideal Gas EOS, ...)
593  C     atm_po    :: standard reference pressure  C     atm_Po    :: standard reference pressure
594  C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
595    C     atm_Rd    :: gas constant for dry air
596  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
597  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
598  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
599        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
600       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
601        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,
602        INTEGER Integr_GeoPot       &                  integr_GeoPot, selectFindRoSurf
603          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
604          INTEGER integr_GeoPot, selectFindRoSurf
605    
606  C Logical flags for selecting packages  C Logical flags for selecting packages
607        LOGICAL useKPP        LOGICAL useKPP
# Line 592  C Logical flags for selecting packages Line 614  C Logical flags for selecting packages
614        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
615        LOGICAL useFLT        LOGICAL useFLT
616        LOGICAL usePTRACERS        LOGICAL usePTRACERS
617          LOGICAL useSBO
618          LOGICAL useSEAICE
619    cswdblk -- add ---
620          LOGICAL useBulkforce
621          LOGICAL useThermSEAICE
622    cswdblk --- end add ---
623        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
624       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
625       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
626       &        usePTRACERS       &        usePTRACERS,  useSBO, useSEAICE,
627    cswdblk -- add ---
628         &        useThermSEAICE, useBulkforce
629    cswdblk --- end add ---
Legend:
Removed from v.1.73  
changed lines
  Added in v.1.88
  ViewVC Help
Powered by ViewVC 1.1.22