/[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.45 by heimbach, Mon Sep 11 23:12:20 2000 UTC revision 1.51 by heimbach, Tue Apr 10 22:35:25 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 57  C     saltClimFile    - File containing Line 58  C     saltClimFile    - File containing
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  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 65  C                        get buoyancy. Line 67  C                        get buoyancy.
67       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
68       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
69       &                EmPmRfile, surfQfile, surfQswfile,       &                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 81  C                        get buoyancy. Line 84  C                        get buoyancy.
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 115  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 129  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 137  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 177  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 193  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         & usePickupBeforeC35
207        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
208        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
209        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
210        LOGICAL no_slip_sides        LOGICAL no_slip_sides
211        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
212          LOGICAL staggerTimeStep
213        LOGICAL momViscosity        LOGICAL momViscosity
214        LOGICAL momAdvection        LOGICAL momAdvection
215        LOGICAL momForcing        LOGICAL momForcing
# Line 227  C     allowFreezing  - Allows water to f Line 237  C     allowFreezing  - Allows water to f
237        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
238        LOGICAL usingPCoords        LOGICAL usingPCoords
239        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
240        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
241        LOGICAL globalFiles        LOGICAL globalFiles
242        LOGICAL allowFreezing        LOGICAL allowFreezing
243          LOGICAL groundAtK1
244          LOGICAL usePickupBeforeC35
245    
246  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
247  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 314  C     deltaTtracer - Timestep for tracer Line 325  C     deltaTtracer - Timestep for tracer
325  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
326  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
327  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
328    C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
329    C                     Implicit part of Surface Pressure Gradient ( 0-1 )
330    C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
331    C                     Implicit part of barotropic flow Divergence ( 0-1 )
332  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
333  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
334  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 350  C     recip_horiVertRatio  ( 1 if horiz Line 365  C     recip_horiVertRatio  ( 1 if horiz
365  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
366  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
367  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
368    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
369    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
370    C     bottomDragLinear   - Drag coefficient built in to core dynamics
371    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
372        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
373       & cg3dTargetResidual,       & cg3dTargetResidual,
374       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 358  C                          circles ( see Line 377  C                          circles ( see
377       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
378       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
379       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
380       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
381         & hFacMin, hFacMinDz,
382       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
383       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
384       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
# Line 369  C                          circles ( see Line 389  C                          circles ( see
389       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
390       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
391       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
392       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
393         & bottomDragLinear,bottomDragQuadratic
394    
395        _RL cg2dTargetResidual        _RL cg2dTargetResidual
396        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 390  C                          circles ( see Line 411  C                          circles ( see
411        _RL recip_RSphere        _RL recip_RSphere
412        _RL f0        _RL f0
413        _RL freeSurfFac        _RL freeSurfFac
414          _RL implicSurfPress
415          _RL implicDiv2Dflow
416        _RL hFacMin        _RL hFacMin
417        _RL hFacMinDz        _RL hFacMinDz
418        _RL hFacMinDp        _RL hFacMinDp
# Line 450  C                          circles ( see Line 473  C                          circles ( see
473        _RL recip_horiVertRatio        _RL recip_horiVertRatio
474        _RL latFFTFiltLo        _RL latFFTFiltLo
475        _RL ivdc_kappa        _RL ivdc_kappa
476          _RL Ro_SeaLevel
477          _RL zonal_filt_lat
478          _RL bottomDragLinear
479          _RL bottomDragQuadratic
480    
481        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
482       &                Lamba_theta       &                Lamba_theta
# Line 468  C     sBeta     - Linear EOS haline cont Line 495  C     sBeta     - Linear EOS haline cont
495        _RL sBeta        _RL sBeta
496        character*(6) eosType        character*(6) eosType
497    
 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)  
   
498  C Logical flags for selecting packages  C Logical flags for selecting packages
499        LOGICAL useKPP        LOGICAL useKPP
500        LOGICAL useGMRedi        LOGICAL useGMRedi
501          LOGICAL useOBCS
502          LOGICAL useAIM
503        LOGICAL useECCO        LOGICAL useECCO
504        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
505       &        useKPP, useGMRedi, useECCO       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO
506    
Legend:
Removed from v.1.45  
changed lines
  Added in v.1.51
  ViewVC Help
Powered by ViewVC 1.1.22