/[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.9 by cnh, Mon May 25 20:05:55 1998 UTC revision 1.19 by adcroft, Wed Jun 17 21:07:01 1998 UTC
# Line 9  C     | stored into the variables held h Line 9  C     | stored into the variables held h
9  C     | the parameters can also be found here.                   |  C     | the parameters can also be found here.                   |
10  C     \==========================================================/  C     \==========================================================/
11    
12    C     Macros for special grid options
13    #include "PARAMS_MACROS.h"
14    
15  C--   Contants  C--   Contants
16  C     Useful physical values  C     Useful physical values
17        Real*8 PI        Real*8 PI
# Line 30  C     Checkpoint data Line 33  C     Checkpoint data
33    
34  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
35  C     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff - List of checkpoint file suffices
36        COMMON /PARM_C/ checkPtSuff  C     bathyFile   - File containing bathymetry. If not defined bathymetry
37    C                   is taken from inline function.
38    C     hydrogThetaFile - File containing initial hydrographic data for potential
39    C                       temperature.
40    C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
41    C     zonalWindFile   - File containing zonal wind data
42    C     meridWindFile   - File containing meridional wind data
43    C     thetaClimFile   - File containing theta climataology used
44    C                       in relaxation term -lambda(theta-theta*)
45    C     saltClimFile    - File containing salt climataology used
46    C                       in relaxation term -lambda(salt-salt*)
47          COMMON /PARM_C/ checkPtSuff,
48         &                bathyFile, hydrogThetaFile, hydrogSaltFile,
49         &                zonalWindFile, meridWindFile, thetaClimFile,
50         &                saltClimFile
51        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
52          CHARACTER*(MAX_LEN_FNAM) bathyFile
53          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
54          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
55          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
56          CHARACTER*(MAX_LEN_FNAM) meridWindFile
57          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
58          CHARACTER*(MAX_LEN_FNAM) saltClimFile
59    
60  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
61  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 74  C     momForcing    - Flag which turns e Line 98  C     momForcing    - Flag which turns e
98  C                     and off.  C                     and off.
99  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing - Flag which turns pressure term in momentum equation
100  C                          on and off.  C                          on and off.
101    C     metricTerms   - Flag which turns metric terms on or off.
102    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
103  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
104  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
105  C                     and off.  C                     and off.
# Line 89  C     saltForcing   - Flag which turns e Line 115  C     saltForcing   - Flag which turns e
115  C                     and off.  C                     and off.
116  C     implicitFreeSurface - Set to true to use implcit free surface  C     implicitFreeSurface - Set to true to use implcit free surface
117  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
118    C     momStepping   - Turns momentum equation time-stepping off
119    C     tempStepping  - Turns temperature equation time-stepping off
120    C     saltStepping  - Turns salinity equation time-stepping off
121    C     useConstantF  - Coriolis parameter set to f0
122    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
123    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
124    C     implicitDiffusion - Turns implicit vertical diffusion on
125    C     doThetaClimRelax - Set true if relaxation to temperature
126    C                        climatology is required.
127    C     doSaltClimRelax  - Set true if relaxation to salinity
128    C                        climatology is required.
129    C     periodicExternalForcing - Set true if forcing is time-dependant
130        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
131       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
132       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
133       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
134       & implicitFreeSurface, rigidLid       & implicitFreeSurface, rigidLid,
135         & momStepping, tempStepping, saltStepping,
136         & metricTerms, usingSphericalPolarMTerms,
137         & useConstantF, useBetaPlaneF, useSphereF,
138         & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
139         & periodicExternalForcing
140        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
141        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
142          LOGICAL usingSphericalPolarMTerms
143        LOGICAL momViscosity        LOGICAL momViscosity
144        LOGICAL momAdvection        LOGICAL momAdvection
145        LOGICAL momForcing        LOGICAL momForcing
# Line 109  C     rigidLid            - Set to true Line 153  C     rigidLid            - Set to true
153        LOGICAL saltForcing        LOGICAL saltForcing
154        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
155        LOGICAL rigidLid        LOGICAL rigidLid
156          LOGICAL momStepping
157          LOGICAL tempStepping
158          LOGICAL saltStepping
159          LOGICAL metricTerms
160          LOGICAL useConstantF
161          LOGICAL useBetaPlaneF
162          LOGICAL useSphereF
163          LOGICAL implicitDiffusion
164          LOGICAL doThetaClimRelax
165          LOGICAL doSaltClimRelax
166          LOGICAL periodicExternalForcing
167    
168  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
169  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 140  C     thetaMin  - Longitude of western m Line 195  C     thetaMin  - Longitude of western m
195  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
196  C                 to make geographical references simple.)  C                 to make geographical references simple.)
197  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
198    C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).
199  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
200  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
201  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
202    C     omega     - Angular velocity ( rad/s )
203  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
204  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
205  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
# Line 191  C     vfFacMom  - Momentum viscosity sca Line 248  C     vfFacMom  - Momentum viscosity sca
248  C     pfFacMom  - Momentum pressure forcing parameter  C     pfFacMom  - Momentum pressure forcing parameter
249  C     cfFacMom  - Coriolis term scaling parameter  C     cfFacMom  - Coriolis term scaling parameter
250  C     foFacMom  - Momentum forcing scaling parameter  C     foFacMom  - Momentum forcing scaling parameter
251    C     mtFacMom  - Metric terms scaling parameter
252  C     cAdjFreq  - Frequency of convective adjustment  C     cAdjFreq  - Frequency of convective adjustment
253    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
254    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
255    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
256    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
257    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
258    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
259    C                          (note: externForcingCycle must be an integer
260    C                           number times externForcingPeriod)
261        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
262       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
263       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
264       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
265       & tauCD, rCD, freeSurfFac,       & tauCD, rCD, freeSurfFac,
266       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
267       & gravity, gBaro, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
268       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
269       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
270       & cAdjFreq       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
271         & tauSaltClimRelax, lambdaSaltClimRelax,
272         & externForcingCycle, externForcingPeriod
273        _RL cg2dTargetResidual        _RL cg2dTargetResidual
274        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
275        _RL delZ(Nz)        _RL delZ(Nz)
# Line 215  C     cAdjFreq  - Frequency of convectiv Line 283  C     cAdjFreq  - Frequency of convectiv
283        _RL phiMin        _RL phiMin
284        _RL thetaMin        _RL thetaMin
285        _RL rSphere        _RL rSphere
286          _RL rRSphere
287        _RL f0        _RL f0
288        _RL freeSurfFac        _RL freeSurfFac
289        _RL beta        _RL beta
# Line 240  C     cAdjFreq  - Frequency of convectiv Line 309  C     cAdjFreq  - Frequency of convectiv
309        _RL rhonil        _RL rhonil
310        _RL tRef(Nz)        _RL tRef(Nz)
311        _RL sRef(Nz)        _RL sRef(Nz)
312        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
313        _RL startTime        _RL startTime
314        _RL endTime        _RL endTime
315        _RL chkPtFreq        _RL chkPtFreq
# Line 251  C     cAdjFreq  - Frequency of convectiv Line 320  C     cAdjFreq  - Frequency of convectiv
320        _RL pfFacMom        _RL pfFacMom
321        _RL cfFacMom        _RL cfFacMom
322        _RL foFacMom        _RL foFacMom
323          _RL mTFacMom
324        _RL cAdjFreq        _RL cAdjFreq
325          _RL omega
326          _RL tauThetaClimRelax
327          _RL lambdaThetaClimRelax
328          _RL tauSaltClimRelax
329          _RL lambdaSaltClimRelax
330          _RL externForcingCycle
331          _RL externForcingPeriod
332    
333        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
334       &                Lamba_theta       &                Lamba_theta
# Line 260  C     cAdjFreq  - Frequency of convectiv Line 337  C     cAdjFreq  - Frequency of convectiv
337    
338  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
339        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
340        _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)
341  C Linear equation of state  C Linear equation of state
342  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
343  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
344        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
345        _RL tAlpha        _RL tAlpha
346        _RL sBeta        _RL sBeta
347          character*(6) eosType
348    
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.19
  ViewVC Help
Powered by ViewVC 1.1.22