/[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.36 by adcroft, Tue Dec 15 00:20:34 1998 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 55  C     thetaClimFile   - File containing Line 56  C     thetaClimFile   - File containing
56  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
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
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
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.
65        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
66       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
67       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
68       &                saltClimFile, buoyancyRelation       &                saltClimFile, buoyancyRelation,
69         &                EmPmRfile, surfQfile, surfQswfile,
70         &                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 69  C                        get buoyancy. Line 77  C                        get buoyancy.
77        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
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
81          CHARACTER*(MAX_LEN_FNAM) surfQswfile
82          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
83        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
84          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
85          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
86          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 100  C                           etc... Line 115  C                           etc...
115       &        cg2dChkResFreq,       &        cg2dChkResFreq,
116       &        cg3dMaxIters,       &        cg3dMaxIters,
117       &        cg3dChkResFreq,       &        cg3dChkResFreq,
118       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps, nEndIter,
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
126        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
127        INTEGER nIter0        INTEGER nIter0
128        INTEGER nTimeSteps        INTEGER nTimeSteps
129          INTEGER nEndIter
130        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
131        INTEGER writeStatePrec        INTEGER writeStatePrec
132        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
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 125  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 155  C     useConstantF  - Coriolis parameter Line 174  C     useConstantF  - Coriolis parameter
174  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
175  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
176  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
177    C     implicitViscosity - Turns implicit vertical viscosity on
178  C     doThetaClimRelax - Set true if relaxation to temperature  C     doThetaClimRelax - Set true if relaxation to temperature
179  C                        climatology is required.  C                        climatology is required.
180  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
# Line 164  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.
187  C     openBoundaries - Using open-boundaries  C     nonHydrostatic - Using non-hydrostatic terms
188    C     globalFiles    - Selects between "global" and "tiled" files
189    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 174  C     openBoundaries - Using open-bounda Line 198  C     openBoundaries - Using open-bounda
198       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
199       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
200       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
201       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, implicitViscosity,
202         & doThetaClimRelax, doSaltClimRelax,
203       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
204       & openBoundaries       & nonHydrostatic, globalFiles,
205         & 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 203  C     openBoundaries - Using open-bounda Line 231  C     openBoundaries - Using open-bounda
231        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
232        LOGICAL useSphereF        LOGICAL useSphereF
233        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
234          LOGICAL implicitViscosity
235        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
236        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
237        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
238        LOGICAL usingPCoords        LOGICAL usingPCoords
239        LOGICAL usingZCoords        LOGICAL usingZCoords
240        LOGICAL openBoundaries        LOGICAL nonHydrostatic
241          LOGICAL globalFiles
242          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 292  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)
335  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
336  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
337  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
 C     GMmaxslope    - max. slope allowed in GM/Redi tensor  
 C     GMlength      - Length to use in Visbeck et al. formula for K (m)  
 C     GMalpha       - alpha to use in Visbeck et al. formula for K  
 C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)  
 C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )  
 C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )  
338  C     startTime     - Starting time for this integration ( s ).  C     startTime     - Starting time for this integration ( s ).
339  C     endTime       - Ending time for this integration ( s ).  C     endTime       - Ending time for this integration ( s ).
340  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
# Line 316  C     pfFacMom      - Momentum pressure Line 347  C     pfFacMom      - Momentum pressure
347  C     cfFacMom      - Coriolis term tracer parameter  C     cfFacMom      - Coriolis term tracer parameter
348  C     foFacMom      - Momentum forcing tracer parameter  C     foFacMom      - Momentum forcing tracer parameter
349  C     mtFacMom      - Metric terms tracer parameter  C     mtFacMom      - Metric terms tracer parameter
350    C     cosPower      - Power of cosine of latitude to multiply viscosity
351  C     cAdjFreq      - Frequency of convective adjustment  C     cAdjFreq      - Frequency of convective adjustment
352  C  C
353  C     taveFreq      - Frequency with which time-averaged model state is written to  C     taveFreq      - Frequency with which time-averaged model state is written to
# Line 333  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 341  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       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,       & 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,
385       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
386         & cosPower,
387       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
388       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
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       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
393         & bottomDragLinear,bottomDragQuadratic
394    
395        _RL cg2dTargetResidual        _RL cg2dTargetResidual
396        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 373  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 396  C                          circles ( see Line 436  C                          circles ( see
436        _RL delt        _RL delt
437        _RL tauCD        _RL tauCD
438        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
       _RL GMmaxval  
439        _RL gravity        _RL gravity
440        _RL recip_gravity        _RL recip_gravity
441        _RL gBaro        _RL gBaro
# Line 426  C                          circles ( see Line 460  C                          circles ( see
460        _RL cfFacMom        _RL cfFacMom
461        _RL foFacMom        _RL foFacMom
462        _RL mTFacMom        _RL mTFacMom
463          _RL cosPower
464        _RL cAdjFreq        _RL cAdjFreq
465        _RL omega        _RL omega
466        _RL tauThetaClimRelax        _RL tauThetaClimRelax
# Line 437  C                          circles ( see Line 472  C                          circles ( see
472        _RL horiVertRatio        _RL horiVertRatio
473        _RL recip_horiVertRatio        _RL recip_horiVertRatio
474        _RL latFFTFiltLo        _RL latFFTFiltLo
475          _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 455  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    
498  C These are input arrays (of integers) that contain the *absolute*  C Logical flags for selecting packages
499  C computational index of an open-boundary (OB) point.        LOGICAL useKPP
500  C A zero (0) element means there is no corresponding OB in that column/row.        LOGICAL useGMRedi
501  C The computational coordinate refers to "tracer" cells.        LOGICAL useOBCS
502  C For a northern/southern OB, the OB V point is to the south/north.        LOGICAL useAIM
503  C For an eastern/western OB, the OB U point is to the west/east.        LOGICAL useECCO
504  C eg.        COMMON /PARM_PACKAGES/
505  C     OB_Jnorth(3)=34  means that:       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO
506  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)  
Legend:
Removed from v.1.36  
changed lines
  Added in v.1.51
  ViewVC Help
Powered by ViewVC 1.1.22