/[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.68 by jmc, Sat Feb 9 23:38:55 2002 UTC revision 1.76 by jmc, Mon Oct 7 16:18:07 2002 UTC
# Line 69  C     surfQfile       :: File containing Line 69  C     surfQfile       :: File containing
69  C     surfQswfile     :: File containing surface shortwave radiation  C     surfQswfile     :: File containing surface shortwave radiation
70  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
71  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
72    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
77        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
78       &                bathyFile, topoFile,       &                bathyFile, topoFile,
79       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
# Line 78  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       &                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 95  C                        get buoyancy. Line 99  C                        get buoyancy.
99        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
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
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 167  C     tempAdvection :: Flag which turns Line 173  C     tempAdvection :: Flag which turns
173  C                     and off.  C                     and off.
174  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
175  C                     and off.  C                     and off.
176  C     saltDiffusion :: Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
177  C                     and off.  C                     and off.
178  C     saltAdvection :: Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
179  C                     and off.  C                     and off.
180  C     saltForcing   :: Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
181  C                     and off.  C                     and off.
182  C     useRealFreshWaterFlux :: if true (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
183  C                         as a real Fresh Water (=> changes the seal level)  C                         as a real Fresh Water (=> changes the Sea Level)
184  C                              if false, converts P+R-E to virtual salt flux  C                         if F, converts P+R-E to salt flux (no SL effect)
185  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
186  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
187  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 188  C     tr1Stepping   :: Turns passive tra Line 194  C     tr1Stepping   :: Turns passive tra
194  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
195  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
196  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
197    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
198  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
199  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
200    C     multiDimAdvection :: Flag that enable multi-dimension advection
201    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
202    C                      out off Adams-Bashforth time stepping.
203  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
204  C                        climatology is required.  C                        climatology is required.
205  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 199  C     usingPCoords     :: Set to indicat Line 209  C     usingPCoords     :: Set to indicat
209  C                        coords.  C                        coords.
210  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
211  C                        coords.  C                        coords.
212    C     setCenterDr    :: set cell Center depth and put Interface at the middle
213  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
214  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
215  C     allowFreezing  :: Allows water to freeze and form ice  C     allowFreezing  :: Allows water to freeze and form ice
216  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
 C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  
217        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
218       & usingCurvilinearGrid,       & usingCurvilinearGrid,
219       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 217  C     useJamartWetPoints :: Use wet-poin Line 227  C     useJamartWetPoints :: Use wet-poin
227       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
228       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
229       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
230         & useEnergyConservingCoriolis, useJamartWetPoints,
231       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
232         & multiDimAdvection, forcing_In_AB,
233       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
234       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing,
235         & usingPCoords, usingZCoords, setCenterDr,
236       & nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
237       & allowFreezing, groundAtK1,       & allowFreezing, groundAtK1,
238       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, debugMode,
239       & readPickupWithTracer, writePickupWithTracer,       & readPickupWithTracer, writePickupWithTracer
      & multiDimAdvection, useEnergyConservingCoriolis,  
      & useJamartWetPoints  
240        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
241        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
242        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
# Line 258  C     useJamartWetPoints :: Use wet-poin Line 269  C     useJamartWetPoints :: Use wet-poin
269        LOGICAL useConstantF        LOGICAL useConstantF
270        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
271        LOGICAL useSphereF        LOGICAL useSphereF
272          LOGICAL useEnergyConservingCoriolis
273          LOGICAL useJamartWetPoints
274        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
275        LOGICAL implicitViscosity        LOGICAL implicitViscosity
276          LOGICAL multiDimAdvection
277          LOGICAL forcing_In_AB
278        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
279        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
280        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
281        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
282        LOGICAL usingPCoords        LOGICAL usingPCoords
283        LOGICAL usingZCoords        LOGICAL usingZCoords
284          LOGICAL setCenterDr
285        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
286        LOGICAL globalFiles        LOGICAL globalFiles
287        LOGICAL allowFreezing        LOGICAL allowFreezing
# Line 274  C     useJamartWetPoints :: Use wet-poin Line 290  C     useJamartWetPoints :: Use wet-poin
290        LOGICAL debugMode        LOGICAL debugMode
291        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
292        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
       LOGICAL multiDimAdvection  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
293    
294  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
295  C     gg2dTargetResidual  C     gg2dTargetResidual
# Line 302  C           defaults to 0.51 but can be Line 315  C           defaults to 0.51 but can be
315  C     delP      :: Vertical grid spacing ( Pa ).  C     delP      :: Vertical grid spacing ( Pa ).
316  C     delZ      :: Vertical grid spacing ( m  ).  C     delZ      :: Vertical grid spacing ( m  ).
317  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
318    C     delRc     :: Vertical grid spacing between cell centers (r unit).
319  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
320  C     delY        on input flags.  C     delY        on input flags.
321  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
322  C     recip_gravity and its inverse  C     recip_gravity and its inverse
323  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 )
324  C     ronil     :: Reference density  C     rhoNil    :: Reference density for the linear equation of state
325  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
326    C     rhoConstFresh :: Constant reference density for fresh water (rain)
327  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
328  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
329  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 359  C                    Frequency of checkp Line 374  C                    Frequency of checkp
374  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
375  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
376  C     deltaTtracer :: Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
377    C     deltaTfreesurf :: Timestep for free-surface equation ( s )
378  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
379  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
380  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
# Line 391  C     mtFacMom      :: Metric terms trac Line 407  C     mtFacMom      :: Metric terms trac
407  C     cosPower      :: Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
408  C     cAdjFreq      :: Frequency of convective adjustment  C     cAdjFreq      :: Frequency of convective adjustment
409  C  C
410  C     taveFreq      :: Frequency with which time-averaged model state is written to  C     taveFreq      :: Frequency with which time-averaged model state
411  C                     post-processing files ( s ).  C                      is written to post-processing files ( s ).
412    C     tave_lastIter :: (for state variable only) fraction of the last time
413    C                      step (of each taveFreq period) put in the time average.
414    C                      (fraction for 1rst iter = 1 - tave_lastIter)
415  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
416  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
417  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
# Line 418  C     bottomDragLinear   :: Drag coeffic Line 437  C     bottomDragLinear   :: Drag coeffic
437  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
438        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
439       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
440       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delRc, delX, delY,
441       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
442         & abeps, startTime,
443       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
444       & fCori, fCoriG,       & fCori, fCoriG,
445       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
# Line 428  C      --"-"--  Quadratic  ( linear: 1/s Line 448  C      --"-"--  Quadratic  ( linear: 1/s
448       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
449       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
450       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
451       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst,
452         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
453       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
454       & diagFreq, taveFreq, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
455       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
456       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega,
457       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
# Line 450  C      --"-"--  Quadratic  ( linear: 1/s Line 471  C      --"-"--  Quadratic  ( linear: 1/s
471        _RL delZ(Nr)        _RL delZ(Nr)
472        _RL delP(Nr)        _RL delP(Nr)
473        _RL delR(Nr)        _RL delR(Nr)
474          _RL delRc(Nr+1)
475        _RL delX(Nx)        _RL delX(Nx)
476        _RL delY(Ny)        _RL delY(Ny)
477        _RL deltaT        _RL deltaT
478        _RL deltaTClock        _RL deltaTClock
479        _RL deltaTmom        _RL deltaTmom
480        _RL deltaTtracer        _RL deltaTtracer
481          _RL deltaTfreesurf
482        _RL abeps        _RL abeps
483        _RL phiMin        _RL phiMin
484        _RL thetaMin        _RL thetaMin
# Line 499  C      --"-"--  Quadratic  ( linear: 1/s Line 522  C      --"-"--  Quadratic  ( linear: 1/s
522        _RL recip_rhonil        _RL recip_rhonil
523        _RL rhoConst        _RL rhoConst
524        _RL recip_rhoConst        _RL recip_rhoConst
525          _RL rhoConstFresh
526          _RL convertEmP2rUnit
527        _RL tRef(Nr)        _RL tRef(Nr)
528        _RL sRef(Nr)        _RL sRef(Nr)
529        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
# Line 510  C      --"-"--  Quadratic  ( linear: 1/s Line 535  C      --"-"--  Quadratic  ( linear: 1/s
535        _RL dumpFreq        _RL dumpFreq
536        _RL diagFreq        _RL diagFreq
537        _RL taveFreq        _RL taveFreq
538          _RL tave_lastIter
539        _RL monitorFreq        _RL monitorFreq
540        _RL afFacMom        _RL afFacMom
541        _RL vfFacMom        _RL vfFacMom
# Line 545  C      --"-"--  Quadratic  ( linear: 1/s Line 571  C      --"-"--  Quadratic  ( linear: 1/s
571        _RL Lamba_theta        _RL Lamba_theta
572        _RL recip_Cp        _RL recip_Cp
573    
574  C Equation of State (polynomial coeffients)  CmlC Equation of State (polynomial coeffients)
575        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
576        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
577  C Linear equation of state  CmlC Linear equation of state
578  C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).  CmlC     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
579  C     sBeta     :: Linear EOS haline contraction coefficient.  CmlC     sBeta     :: Linear EOS haline contraction coefficient.
580        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  Cml      COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
581        _RL tAlpha  Cml      _RL tAlpha
582        _RL sBeta  Cml      _RL sBeta
       character*(6) eosType  
583    
584  C Atmospheric physical parameters (Ideal Gas EOS, ...)  C Atmospheric physical parameters (Ideal Gas EOS, ...)
585  C     atm_po    :: standard reference pressure  C     atm_po    :: standard reference pressure
# Line 577  C Logical flags for selecting packages Line 602  C Logical flags for selecting packages
602        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
603        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
604        LOGICAL useFLT        LOGICAL useFLT
605          LOGICAL usePTRACERS
606        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
607       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
608       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
609         &        usePTRACERS
610    
Legend:
Removed from v.1.68  
changed lines
  Added in v.1.76
  ViewVC Help
Powered by ViewVC 1.1.22