/[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.44 by adcroft, Wed Jun 21 19:21:44 2000 UTC revision 1.50 by heimbach, Sun Mar 25 22:33:52 2001 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  C     /==========================================================\
5  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
# Line 56  C                       in relaxation te Line 57  C                       in relaxation te
57  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    - File containing salt climataology used
58  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
59  C     surfQfile       - File containing surface heat flux  C     surfQfile       - File containing surface heat flux
60    C     surfQswfile     - File containing surface shortwave radiation
61    C     dQdTfile        - File containing thermal relaxation coefficient
62  C     EmPmRfile       - File containing surface fresh water flux  C     EmPmRfile       - File containing surface fresh water flux
63  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation - Flag used to indicate which relation to use to
64  C                        get buoyancy.  C                        get buoyancy.
# Line 63  C                        get buoyancy. Line 66  C                        get buoyancy.
66       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
67       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
68       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
69       &                EmPmRfile, surfQfile,       &                EmPmRfile, surfQfile, surfQswfile,
70       &                uVelInitFile, vVelInitFile, pSurfInitFile       &                uVelInitFile, vVelInitFile, pSurfInitFile,
71         &                dQdTfile
72        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
73        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
74        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 74  C                        get buoyancy. Line 78  C                        get buoyancy.
78        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
79        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
80        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
81          CHARACTER*(MAX_LEN_FNAM) surfQswfile
82        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
83        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
84        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
85        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
86        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
87          CHARACTER*(MAX_LEN_FNAM) dQdTfile
88    
89  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
90  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 113  C                           etc... Line 119  C                           etc...
119       &        numStepsPerPickup,       &        numStepsPerPickup,
120       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
121       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
122       &        nShap       &        nShap, zonal_filt_sinpow, zonal_filt_cospow
123        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
124        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
125        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 127  C                           etc... Line 133  C                           etc...
133        INTEGER readBinaryPrec        INTEGER readBinaryPrec
134        INTEGER nCheckLev        INTEGER nCheckLev
135        INTEGER nShap        INTEGER nShap
136          INTEGER zonal_filt_sinpow
137          INTEGER zonal_filt_cospow
138    
139  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
140  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 135  C     usingSphericalPolarGrid - If TRUE Line 143  C     usingSphericalPolarGrid - If TRUE
143  C                               spherical polar frame.  C                               spherical polar frame.
144  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides - Impose "no-slip" at lateral boundaries.
145  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom- Impose "no-slip" at bottom boundary.
146    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
147  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
148  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
149  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
# Line 175  C     usingPCoords     - Set to indicate Line 184  C     usingPCoords     - Set to indicate
184  C                        coords.  C                        coords.
185  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
186  C                        coords.  C                        coords.
 C     openBoundaries - Using open-boundaries  
187  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic - Using non-hydrostatic terms
188  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    - Selects between "global" and "tiled" files
189  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  - Allows water to freeze and form ice
190    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
191        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
192       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
193         & staggerTimeStep,
194       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
195       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
196       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
# Line 191  C     allowFreezing  - Allows water to f Line 201  C     allowFreezing  - Allows water to f
201       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
202       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
203       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
204       & openBoundaries, nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
205       & allowFreezing       & allowFreezing, groundAtK1
206        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
207        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
208        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
209        LOGICAL no_slip_sides        LOGICAL no_slip_sides
210        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
211          LOGICAL staggerTimeStep
212        LOGICAL momViscosity        LOGICAL momViscosity
213        LOGICAL momAdvection        LOGICAL momAdvection
214        LOGICAL momForcing        LOGICAL momForcing
# Line 225  C     allowFreezing  - Allows water to f Line 236  C     allowFreezing  - Allows water to f
236        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
237        LOGICAL usingPCoords        LOGICAL usingPCoords
238        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
239        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
240        LOGICAL globalFiles        LOGICAL globalFiles
241        LOGICAL allowFreezing        LOGICAL allowFreezing
242          LOGICAL groundAtK1
243    
244  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
245  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 312  C     deltaTtracer - Timestep for tracer Line 323  C     deltaTtracer - Timestep for tracer
323  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
324  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
325  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
326    C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
327    C                     Implicit part of Surface Pressure Gradient ( 0-1 )
328    C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
329    C                     Implicit part of barotropic flow Divergence ( 0-1 )
330  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
331  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
332  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
# Line 348  C     recip_horiVertRatio  ( 1 if horiz Line 363  C     recip_horiVertRatio  ( 1 if horiz
363  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
364  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
365  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
366    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
367    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
368    C     bottomDragLinear   - Drag coefficient built in to core dynamics
369    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
370        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
371       & cg3dTargetResidual,       & cg3dTargetResidual,
372       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 356  C                          circles ( see Line 375  C                          circles ( see
375       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
376       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
377       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
378       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
379         & hFacMin, hFacMinDz,
380       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
381       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
382       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
# Line 367  C                          circles ( see Line 387  C                          circles ( see
387       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
388       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
389       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
390       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
391         & bottomDragLinear,bottomDragQuadratic
392    
393        _RL cg2dTargetResidual        _RL cg2dTargetResidual
394        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 388  C                          circles ( see Line 409  C                          circles ( see
409        _RL recip_RSphere        _RL recip_RSphere
410        _RL f0        _RL f0
411        _RL freeSurfFac        _RL freeSurfFac
412          _RL implicSurfPress
413          _RL implicDiv2Dflow
414        _RL hFacMin        _RL hFacMin
415        _RL hFacMinDz        _RL hFacMinDz
416        _RL hFacMinDp        _RL hFacMinDp
# Line 448  C                          circles ( see Line 471  C                          circles ( see
471        _RL recip_horiVertRatio        _RL recip_horiVertRatio
472        _RL latFFTFiltLo        _RL latFFTFiltLo
473        _RL ivdc_kappa        _RL ivdc_kappa
474          _RL Ro_SeaLevel
475          _RL zonal_filt_lat
476          _RL bottomDragLinear
477          _RL bottomDragQuadratic
478    
479        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
480       &                Lamba_theta       &                Lamba_theta
# Line 466  C     sBeta     - Linear EOS haline cont Line 493  C     sBeta     - Linear EOS haline cont
493        _RL sBeta        _RL sBeta
494        character*(6) eosType        character*(6) eosType
495    
 C These are input arrays (of integers) that contain the *absolute*  
 C computational index of an open-boundary (OB) point.  
 C A zero (0) element means there is no corresponding OB in that column/row.  
 C The computational coordinate refers to "tracer" cells.  
 C For a northern/southern OB, the OB V point is to the south/north.  
 C For an eastern/western OB, the OB U point is to the west/east.  
 C eg.  
 C     OB_Jnorth(3)=34  means that:  
 C          T( 3 ,34) is a an OB point  
 C          U(3:4,34) is a an OB point  
 C          V( 4 ,34) is a an OB point  
 C while  
 C     OB_Jsouth(3)=1  means that:  
 C          T( 3 ,1) is a an OB point  
 C          U(3:4,1) is a an OB point  
 C          V( 4 ,2) is a an OB point  
 C  
 C For convenience, negative values for Jnorth/Ieast refer to  
 C points relative to the Northern/Eastern edges of the model  
 C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.  
 C  
       COMMON /PARM_OB/  
      & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest  
       INTEGER OB_Jnorth(Nx)  
       INTEGER OB_Jsouth(Nx)  
       INTEGER OB_Ieast(Ny)  
       INTEGER OB_Iwest(Ny)  
   
496  C Logical flags for selecting packages  C Logical flags for selecting packages
497        LOGICAL use_KPPmixing        LOGICAL useKPP
498        LOGICAL use_GMRedi        LOGICAL useGMRedi
499          LOGICAL useOBCS
500          LOGICAL useAIM
501          LOGICAL useECCO
502        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
503       &        use_KPPmixing,use_GMRedi       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO
504    
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.50
  ViewVC Help
Powered by ViewVC 1.1.22