/[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.123 by edhill, Tue Sep 7 21:32:09 2004 UTC revision 1.133 by edhill, Mon Oct 18 16:04:20 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3  C  C
4    
5  CBOP  CBOP
6  C    !ROUTINE: PARAMS.h  C     !ROUTINE: PARAMS.h
7  C    !INTERFACE:  C     !INTERFACE:
8  C    include PARAMS.h  C     #include PARAMS.h
9  C    !DESCRIPTION: \bv  
10  C     *==========================================================*  C     !DESCRIPTION:
11  C     | PARAMS.h                                                    C     Header file defining model "parameters".  The values from the
12  C     | o Header file defining model "parameters".                  C     model standard input file are stored into the variables held
13  C     *==========================================================*  C     here. Notes describing the parameters can also be found here.
14  C     | The values from the model standard input file are          
 C     | stored into the variables held here. Notes describing      
 C     | the parameters can also be found here.                      
 C     *==========================================================*  
 C     \ev  
15  CEOP  CEOP
16    
17  C     Macros for special grid options  C     Macros for special grid options
# Line 76  C     buoyancyRelation :: Flag used to i Line 73  C     buoyancyRelation :: Flag used to i
73  C                        get buoyancy.  C                        get buoyancy.
74  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
75  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
76    C     the_run_name    :: string identifying the name of the model "run"
77        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
78       &                bathyFile, topoFile,       &                bathyFile, topoFile,
79       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
# Line 85  C                        LINEAR, POLY3, Line 83  C                        LINEAR, POLY3,
83       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
84       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
85       &                eosType, pickupSuff,       &                eosType, pickupSuff,
86       &                mdsioLocalDir       &                mdsioLocalDir,
87         &                the_run_name
88        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
89        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
90        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 105  C                        LINEAR, POLY3, Line 104  C                        LINEAR, POLY3,
104        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
105        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) the_run_name
108        CHARACTER*(6) eosType        CHARACTER*(6) eosType
109        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
110    
# Line 136  C     tempVertAdvScheme   :: Temp. Vert. Line 136  C     tempVertAdvScheme   :: Temp. Vert.
136  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
137  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
138  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
 C     mon_iotype          :: flag for monitor output (MNC vs. STDOUT)  
139    
140        COMMON /PARM_I/        COMMON /PARM_I/
141       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 151  C     mon_iotype          :: flag for mo Line 150  C     mon_iotype          :: flag for mo
150       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
151       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
152       &        tracerAdvScheme,       &        tracerAdvScheme,
153       &        debugLevel,       &        debugLevel
      &        mon_iotype  
154        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
155        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
156        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
# Line 172  C     mon_iotype          :: flag for mo Line 170  C     mon_iotype          :: flag for mo
170        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
171        INTEGER tracerAdvScheme        INTEGER tracerAdvScheme
172        INTEGER debugLevel        INTEGER debugLevel
       INTEGER mon_iotype  
173    
174  C  C
175        INTEGER debLevZero        INTEGER debLevZero
# Line 224  C                           linear relat Line 221  C                           linear relat
221  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
222  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
223  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
 C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off  
224  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
225  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
226  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
# Line 266  C                       outputs from mas Line 262  C                       outputs from mas
262  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
263  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
264  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
265    C     pickup_write_mdsio :: use mdsio to write pickups
266    C     pickup_read_mdsio  :: use mdsio to read  pickups
267    C     pickup_write_immed :: echo the pickup immediately (for conversion)
268    C     timeave_mdsio      :: use mdsio for timeave output
269    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
270    C     monitor_stdio      :: use stdio for monitor output
271        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
272       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
273       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 276  C     groundAtK1  :: put the surface(k=1 Line 278  C     groundAtK1  :: put the surface(k=1
278       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
279       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
280       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
281       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
282       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
283       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
284       & useCDscheme,       & useCDscheme,
# Line 292  C     groundAtK1  :: put the surface(k=1 Line 294  C     groundAtK1  :: put the surface(k=1
294       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
295       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
296       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
297       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
298         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
299         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
300         & outputTypesInclusive
301    
302        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
303        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
304        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 322  C     groundAtK1  :: put the surface(k=1 Line 328  C     groundAtK1  :: put the surface(k=1
328        LOGICAL momStepping        LOGICAL momStepping
329        LOGICAL tempStepping        LOGICAL tempStepping
330        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
331        LOGICAL metricTerms        LOGICAL metricTerms
332        LOGICAL useConstantF        LOGICAL useConstantF
333        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 363  C     groundAtK1  :: put the surface(k=1 Line 368  C     groundAtK1  :: put the surface(k=1
368        LOGICAL debugMode        LOGICAL debugMode
369        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
370        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
371          LOGICAL pickup_read_mdsio, pickup_write_mdsio
372          LOGICAL pickup_write_immed
373          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
374          LOGICAL outputTypesInclusive
375    
376  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
377  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 395  C     gBaro     :: Accel. due to gravity Line 404  C     gBaro     :: Accel. due to gravity
404  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
405  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
406  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
407    C     tRef      :: reference vertical profile for potential temperature
408    C     sRef      :: reference vertical profile for salinity/specific humidity
409  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
410  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
411  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 409  C     omega     :: Angular velocity ( ra Line 420  C     omega     :: Angular velocity ( ra
420  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
421  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
422  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
423    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
424    C                 momentum laterally, no effect for hydrostatic
425    C                 model, defaults to viscAh if unset ( m^2/s )
426  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
427  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
428  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
# Line 423  C     viscA4Grid:: non-dimensional grid- Line 437  C     viscA4Grid:: non-dimensional grid-
437  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor
438  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
439  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
440  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
441  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
442  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
443  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
444  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
445  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
446  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
447  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
448  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
449  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
450  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
# Line 516  C      --"-"--  Quadratic  ( linear: 1/s Line 530  C      --"-"--  Quadratic  ( linear: 1/s
530       & abeps, startTime,       & abeps, startTime,
531       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
532       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
533       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
534       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
535       & viscAr, viscAstrain, viscAtension,       & viscAr, viscAstrain, viscAtension,
536       & diffKhT, diffK4T, diffKrT,       & diffKhT, diffK4T, diffKrNrT,
537       & diffKhS, diffK4S, diffKrS,       & diffKhS, diffK4S, diffKrNrS,
538       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
539       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
540       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
# Line 572  C      --"-"--  Quadratic  ( linear: 1/s Line 586  C      --"-"--  Quadratic  ( linear: 1/s
586        _RL hFacSup        _RL hFacSup
587        _RL beta        _RL beta
588        _RL viscAh        _RL viscAh
589          _RL viscAhW
590        _RL viscAhMax        _RL viscAhMax
591        _RL viscAhGrid        _RL viscAhGrid
592        _RL viscC2leith        _RL viscC2leith
# Line 583  C      --"-"--  Quadratic  ( linear: 1/s Line 598  C      --"-"--  Quadratic  ( linear: 1/s
598        _RL viscA4Grid        _RL viscA4Grid
599        _RL viscC4leith        _RL viscC4leith
600        _RL diffKhT        _RL diffKhT
601        _RL diffKrT        _RL diffKrNrT(Nr)
602        _RL diffK4T        _RL diffK4T
603        _RL diffKhS        _RL diffKhS
604        _RL diffKrS        _RL diffKrNrS(Nr)
605        _RL diffK4S        _RL diffK4S
606        _RL diffKrBL79surf        _RL diffKrBL79surf
607        _RL diffKrBL79deep        _RL diffKrBL79deep
# Line 676  C             derived from the orography Line 691  C             derived from the orography
691        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
692    
693  C Logical flags for selecting packages  C Logical flags for selecting packages
694          LOGICAL useOPPS
695        LOGICAL usePP81        LOGICAL usePP81
696        LOGICAL useMY82        LOGICAL useMY82
697          LOGICAL useGGL90
698        LOGICAL useKPP        LOGICAL useKPP
699        LOGICAL useGMRedi        LOGICAL useGMRedi
700        LOGICAL useOBCS        LOGICAL useOBCS
# Line 697  C Logical flags for selecting packages Line 714  C Logical flags for selecting packages
714        LOGICAL usegridalt        LOGICAL usegridalt
715        LOGICAL usediagnostics        LOGICAL usediagnostics
716        LOGICAL useEBM        LOGICAL useEBM
717          LOGICAL useMNC
718        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
719       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
720       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
721       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
722       &        usefizhi,  usegridalt, usediagnostics, useEBM,       &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
723       &        usePP81, useMY82       &        usePP81, useMY82, useOPPS, useGGL90
   
 C     Run-time flags for early-initialization of MNC  
       LOGICAL  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_use_for_mon  
       CHARACTER*(MAX_LEN_FNAM) mnc_outdir_str  
       CHARACTER*(MAX_LEN_FNAM) mnc_indir_str  
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       COMMON /PARM_MNC/  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_use_for_mon,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     the_run_name  
   
724    
725  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
726  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.123  
changed lines
  Added in v.1.133
  ViewVC Help
Powered by ViewVC 1.1.22