/[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.115 by jmc, Sat Jun 26 02:37:17 2004 UTC revision 1.126 by mlosch, Thu Sep 16 09:35:11 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, tCyl       &                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
       _RL tCyl  
110    
111  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
112  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
113  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
114  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
115  C                           in con. grad solver.  C                           in con. grad solver.
116    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
117    C                            (non-linear free-surf.)
118  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
119  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
120  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
# Line 135  C     debugLevel          :: debug level Line 139  C     debugLevel          :: debug level
139    
140        COMMON /PARM_I/        COMMON /PARM_I/
141       &        cg2dMaxIters,       &        cg2dMaxIters,
142       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
143       &        cg3dMaxIters,       &        cg3dMaxIters,
144       &        cg3dChkResFreq,       &        cg3dChkResFreq,
145       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
# Line 149  C     debugLevel          :: debug level Line 153  C     debugLevel          :: debug level
153       &        debugLevel       &        debugLevel
154        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
155        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
156          INTEGER cg2dPreCondFreq
157        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
158        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
159        INTEGER nIter0        INTEGER nIter0
# Line 233  C     tempImplVertAdv :: Turns on implic Line 238  C     tempImplVertAdv :: Turns on implic
238  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
239  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
240  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
241    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
242  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
243  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
244  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 257  C                       outputs from mas Line 263  C                       outputs from mas
263  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
264  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
265  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
266    C     pickup_write_mdsio :: use mdsio to write pickups
267    C     pickup_read_mdsio  :: use mdsio to read  pickups
268    C     pickup_write_immed :: echo the pickup immediately (for conversion)
269    C     timeave_mdsio      :: use mdsio for timeave output
270    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
271    C     monitor_stdio      :: use stdio for monitor output
272        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
273       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
274       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 276  C     groundAtK1  :: put the surface(k=1 Line 288  C     groundAtK1  :: put the surface(k=1
288       & useAbsVorticity,       & useAbsVorticity,
289       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
290       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
291       & multiDimAdvection, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
292       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
293       & periodicExternalForcing,       & periodicExternalForcing,
294       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
295       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
296       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
297       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
298       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
299         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
300         & timeave_mdsio, snapshot_mdsio, monitor_stdio
301        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
302        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
303        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 332  C     groundAtK1  :: put the surface(k=1 Line 346  C     groundAtK1  :: put the surface(k=1
346        LOGICAL saltImplVertAdv        LOGICAL saltImplVertAdv
347        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
348        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
349          LOGICAL useMultiDimAdvec
350        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
351        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
352        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 349  C     groundAtK1  :: put the surface(k=1 Line 364  C     groundAtK1  :: put the surface(k=1
364        LOGICAL useOldFreezing        LOGICAL useOldFreezing
365        LOGICAL groundAtK1        LOGICAL groundAtK1
366        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
367          LOGICAL usePickupBeforeC54
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    
375  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
376  C     gg2dTargetResidual  C     cg2dTargetResidual
377  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
378  C     cg2dTargetResWunit  C     cg2dTargetResWunit
379  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 528  C      --"-"--  Quadratic  ( linear: 1/s Line 547  C      --"-"--  Quadratic  ( linear: 1/s
547       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
548       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
549       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
550       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
551         & tCyl
552    
553        _RL cg2dTargetResidual        _RL cg2dTargetResidual
554        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 636  C      --"-"--  Quadratic  ( linear: 1/s Line 656  C      --"-"--  Quadratic  ( linear: 1/s
656        _RL Ro_SeaLevel        _RL Ro_SeaLevel
657        _RL bottomDragLinear        _RL bottomDragLinear
658        _RL bottomDragQuadratic        _RL bottomDragQuadratic
659          _RL tCyl
660    
661  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
662        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 663  C             derived from the orography Line 684  C             derived from the orography
684        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
685    
686  C Logical flags for selecting packages  C Logical flags for selecting packages
687          LOGICAL useOPPS
688          LOGICAL usePP81
689          LOGICAL useMY82
690          LOGICAL useGGL90
691        LOGICAL useKPP        LOGICAL useKPP
692        LOGICAL useGMRedi        LOGICAL useGMRedi
693        LOGICAL useOBCS        LOGICAL useOBCS
# Line 686  C Logical flags for selecting packages Line 711  C Logical flags for selecting packages
711       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
712       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
713       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
714       &        usefizhi,  usegridalt, usediagnostics, useEBM       &        usefizhi,  usegridalt, usediagnostics, useEBM,
715         &        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  
   
716    
717  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
718  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.115  
changed lines
  Added in v.1.126
  ViewVC Help
Powered by ViewVC 1.1.22