/[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.122 by edhill, Sat Sep 4 18:19:21 2004 UTC revision 1.136 by dimitri, Tue Nov 2 23:57:29 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 221  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 246  C                        climatology is Line 245  C                        climatology is
245  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
246  C                        climatology is required.  C                        climatology is required.
247  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
248  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
249  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
250  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
251  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
252    C     fluidIsAir       :: Set to indicate that the fluid major constituent
253    C                        is air
254    C     fluidIsWater     :: Set to indicate that the fluid major constituent
255    C                        is water
256  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
257  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
258  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
# Line 263  C                       outputs from mas Line 266  C                       outputs from mas
266  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
267  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
268  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
269    C     pickup_write_mdsio :: use mdsio to write pickups
270    C     pickup_read_mdsio  :: use mdsio to read  pickups
271    C     pickup_write_immed :: echo the pickup immediately (for conversion)
272    C     timeave_mdsio      :: use mdsio for timeave output
273    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
274    C     monitor_stdio      :: use stdio for monitor output
275        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
276       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
277       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 273  C     groundAtK1  :: put the surface(k=1 Line 282  C     groundAtK1  :: put the surface(k=1
282       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
283       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
284       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
285       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
286       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
287       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
288       & useCDscheme,       & useCDscheme,
# Line 285  C     groundAtK1  :: put the surface(k=1 Line 294  C     groundAtK1  :: put the surface(k=1
294       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
295       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
296       & periodicExternalForcing,       & periodicExternalForcing,
297         & fluidIsAir, fluidIsWater,
298       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
299       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
300       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
301       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
302       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
303         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
304         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
305         & outputTypesInclusive
306    
307        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
308        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
309        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 319  C     groundAtK1  :: put the surface(k=1 Line 333  C     groundAtK1  :: put the surface(k=1
333        LOGICAL momStepping        LOGICAL momStepping
334        LOGICAL tempStepping        LOGICAL tempStepping
335        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
336        LOGICAL metricTerms        LOGICAL metricTerms
337        LOGICAL useConstantF        LOGICAL useConstantF
338        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 344  C     groundAtK1  :: put the surface(k=1 Line 357  C     groundAtK1  :: put the surface(k=1
357        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
358        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
359        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
360          LOGICAL fluidIsAir
361          LOGICAL fluidIsWater
362        LOGICAL usingPCoords        LOGICAL usingPCoords
363        LOGICAL usingZCoords        LOGICAL usingZCoords
364        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 360  C     groundAtK1  :: put the surface(k=1 Line 375  C     groundAtK1  :: put the surface(k=1
375        LOGICAL debugMode        LOGICAL debugMode
376        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
377        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
378          LOGICAL pickup_read_mdsio, pickup_write_mdsio
379          LOGICAL pickup_write_immed
380          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
381          LOGICAL outputTypesInclusive
382    
383  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
384  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 392  C     gBaro     :: Accel. due to gravity Line 411  C     gBaro     :: Accel. due to gravity
411  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
412  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
413  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
414    C     tRef      :: reference vertical profile for potential temperature
415    C     sRef      :: reference vertical profile for salinity/specific humidity
416  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
417  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
418  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 406  C     omega     :: Angular velocity ( ra Line 427  C     omega     :: Angular velocity ( ra
427  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
428  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
429  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
430    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
431    C                 momentum laterally, no effect for hydrostatic
432    C                 model, defaults to viscAh if unset ( m^2/s )
433  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
434  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
435  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
436  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
437    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
438    C                  (act on Divergence part) ( m^2/s )
439    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
440    C                  (act on Vorticity  part) ( m^2/s )
441    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
442    C                  (act on Divergence part) ( m^4/s )
443    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
444    C                  (act on Vorticity  part) ( m^4/s )
445  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscC2leith :: Leith non-dimensional viscosity factor
446  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
447  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
# Line 417  C     viscA4Max :: Maximum biharmonic vi Line 449  C     viscA4Max :: Maximum biharmonic vi
449  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
450  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
451  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
452    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
453    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
454  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor
455  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
456  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
457  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
458  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
459  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
460  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
461  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
462  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
463  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
464  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
465  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
466  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
467  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 513  C      --"-"--  Quadratic  ( linear: 1/s Line 547  C      --"-"--  Quadratic  ( linear: 1/s
547       & abeps, startTime,       & abeps, startTime,
548       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
549       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
550       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
551       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
552       & viscAr, viscAstrain, viscAtension,       & viscA4,  viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
553       & diffKhT, diffK4T, diffKrT,       & viscC4leith, viscAr, viscAstrain, viscAtension,
554       & diffKhS, diffK4S, diffKrS,       & diffKhT, diffK4T, diffKrNrT,
555         & diffKhS, diffK4S, diffKrNrS,
556       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
557       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
558       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
# Line 569  C      --"-"--  Quadratic  ( linear: 1/s Line 604  C      --"-"--  Quadratic  ( linear: 1/s
604        _RL hFacSup        _RL hFacSup
605        _RL beta        _RL beta
606        _RL viscAh        _RL viscAh
607          _RL viscAhW
608          _RL viscAhD
609          _RL viscAhZ
610        _RL viscAhMax        _RL viscAhMax
611        _RL viscAhGrid        _RL viscAhGrid
612        _RL viscC2leith        _RL viscC2leith
# Line 576  C      --"-"--  Quadratic  ( linear: 1/s Line 614  C      --"-"--  Quadratic  ( linear: 1/s
614        _RL viscAtension        _RL viscAtension
615        _RL viscAr        _RL viscAr
616        _RL viscA4        _RL viscA4
617          _RL viscA4D
618          _RL viscA4Z
619        _RL viscA4Max        _RL viscA4Max
620        _RL viscA4Grid        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
621        _RL viscC4leith        _RL viscC4leith
622        _RL diffKhT        _RL diffKhT
623        _RL diffKrT        _RL diffKrNrT(Nr)
624        _RL diffK4T        _RL diffK4T
625        _RL diffKhS        _RL diffKhS
626        _RL diffKrS        _RL diffKrNrS(Nr)
627        _RL diffK4S        _RL diffK4S
628        _RL diffKrBL79surf        _RL diffKrBL79surf
629        _RL diffKrBL79deep        _RL diffKrBL79deep
# Line 673  C             derived from the orography Line 713  C             derived from the orography
713        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
714    
715  C Logical flags for selecting packages  C Logical flags for selecting packages
716          LOGICAL useOPPS
717        LOGICAL usePP81        LOGICAL usePP81
718        LOGICAL useMY82        LOGICAL useMY82
719          LOGICAL useGGL90
720        LOGICAL useKPP        LOGICAL useKPP
721        LOGICAL useGMRedi        LOGICAL useGMRedi
722        LOGICAL useOBCS        LOGICAL useOBCS
# Line 694  C Logical flags for selecting packages Line 736  C Logical flags for selecting packages
736        LOGICAL usegridalt        LOGICAL usegridalt
737        LOGICAL usediagnostics        LOGICAL usediagnostics
738        LOGICAL useEBM        LOGICAL useEBM
739          LOGICAL useMNC
740        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
741       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
742       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
743       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
744       &        usefizhi,  usegridalt, usediagnostics, useEBM,       &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
745       &        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  
   
746    
747  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
748  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.122  
changed lines
  Added in v.1.136
  ViewVC Help
Powered by ViewVC 1.1.22