/[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.119 by jmc, Fri Jul 9 22:31:16 2004 UTC revision 1.132 by jmc, Sun Oct 17 23:03:08 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 65  C     thetaClimFile   :: File containing Line 62  C     thetaClimFile   :: File containing
62  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
63  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing salt climataology used
64  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
65  C     surfQfile       :: File containing surface heat flux  C     surfQfile       :: File containing surface heat flux, excluding SW
66  C     surfQswfile     :: File containing surface shortwave radiation  C                        (old version, kept for backward compatibility)
67    C     surfQnetFile    :: File containing surface net heat flux
68    C     surfQswFile     :: File containing surface shortwave radiation
69  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
70  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
71  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
# Line 74  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,
80       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
81       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
82       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQnetFile, surfQswFile,
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 93  C                        LINEAR, POLY3, Line 94  C                        LINEAR, POLY3,
94        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
95        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
96        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
97        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
98          CHARACTER*(MAX_LEN_FNAM) surfQswFile
99        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
100        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
101        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
# Line 102  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 218  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 260  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 270  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 286  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         & timeave_ioinc, snapshot_ioinc, monitor_ioinc,
301         & pickup_write_ioinc
302    
303        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
304        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
305        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 316  C     groundAtK1  :: put the surface(k=1 Line 329  C     groundAtK1  :: put the surface(k=1
329        LOGICAL momStepping        LOGICAL momStepping
330        LOGICAL tempStepping        LOGICAL tempStepping
331        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
332        LOGICAL metricTerms        LOGICAL metricTerms
333        LOGICAL useConstantF        LOGICAL useConstantF
334        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 357  C     groundAtK1  :: put the surface(k=1 Line 369  C     groundAtK1  :: put the surface(k=1
369        LOGICAL debugMode        LOGICAL debugMode
370        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
371        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
372          LOGICAL pickup_read_mdsio, pickup_write_mdsio
373          LOGICAL pickup_write_immed
374          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
375          LOGICAL timeave_ioinc, snapshot_ioinc, monitor_ioinc
376          LOGICAL pickup_write_ioinc
377    
378  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
379  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 389  C     gBaro     :: Accel. due to gravity Line 406  C     gBaro     :: Accel. due to gravity
406  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
407  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
408  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
409    C     tRef      :: reference vertical profile for potential temperature
410    C     sRef      :: reference vertical profile for salinity/specific humidity
411  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
412  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
413  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 403  C     omega     :: Angular velocity ( ra Line 422  C     omega     :: Angular velocity ( ra
422  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
423  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
424  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
425    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
426    C                 momentum laterally, no effect for hydrostatic
427    C                 model, defaults to viscAh if unset ( m^2/s )
428  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
429  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
430  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
# Line 417  C     viscA4Grid:: non-dimensional grid- Line 439  C     viscA4Grid:: non-dimensional grid-
439  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor
440  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
441  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
442  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
443  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
444  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
445  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
446  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
447  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
448  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
449  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
450  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
451  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
452  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 510  C      --"-"--  Quadratic  ( linear: 1/s Line 532  C      --"-"--  Quadratic  ( linear: 1/s
532       & abeps, startTime,       & abeps, startTime,
533       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
534       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
535       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
536       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
537       & viscAr, viscAstrain, viscAtension,       & viscAr, viscAstrain, viscAtension,
538       & diffKhT, diffK4T, diffKrT,       & diffKhT, diffK4T, diffKrNrT,
539       & diffKhS, diffK4S, diffKrS,       & diffKhS, diffK4S, diffKrNrS,
540       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
541       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
542       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
# Line 566  C      --"-"--  Quadratic  ( linear: 1/s Line 588  C      --"-"--  Quadratic  ( linear: 1/s
588        _RL hFacSup        _RL hFacSup
589        _RL beta        _RL beta
590        _RL viscAh        _RL viscAh
591          _RL viscAhW
592        _RL viscAhMax        _RL viscAhMax
593        _RL viscAhGrid        _RL viscAhGrid
594        _RL viscC2leith        _RL viscC2leith
# Line 577  C      --"-"--  Quadratic  ( linear: 1/s Line 600  C      --"-"--  Quadratic  ( linear: 1/s
600        _RL viscA4Grid        _RL viscA4Grid
601        _RL viscC4leith        _RL viscC4leith
602        _RL diffKhT        _RL diffKhT
603        _RL diffKrT        _RL diffKrNrT(Nr)
604        _RL diffK4T        _RL diffK4T
605        _RL diffKhS        _RL diffKhS
606        _RL diffKrS        _RL diffKrNrS(Nr)
607        _RL diffK4S        _RL diffK4S
608        _RL diffKrBL79surf        _RL diffKrBL79surf
609        _RL diffKrBL79deep        _RL diffKrBL79deep
# Line 670  C             derived from the orography Line 693  C             derived from the orography
693        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
694    
695  C Logical flags for selecting packages  C Logical flags for selecting packages
696          LOGICAL useOPPS
697          LOGICAL usePP81
698          LOGICAL useMY82
699          LOGICAL useGGL90
700        LOGICAL useKPP        LOGICAL useKPP
701        LOGICAL useGMRedi        LOGICAL useGMRedi
702        LOGICAL useOBCS        LOGICAL useOBCS
# Line 689  C Logical flags for selecting packages Line 716  C Logical flags for selecting packages
716        LOGICAL usegridalt        LOGICAL usegridalt
717        LOGICAL usediagnostics        LOGICAL usediagnostics
718        LOGICAL useEBM        LOGICAL useEBM
719          LOGICAL useMNC
720        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
721       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
722       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
723       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
724       &        usefizhi,  usegridalt, usediagnostics, useEBM       &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
725         &        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  
       COMMON /PARM_MNC/  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     mnc_use_for_mon  
   
726    
727  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
728  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.119  
changed lines
  Added in v.1.132
  ViewVC Help
Powered by ViewVC 1.1.22