/[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.21 by adcroft, Thu Jul 16 15:23:43 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 180  C     GMlength  - Length to use in Visbe Line 237  C     GMlength  - Length to use in Visbe
237  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     GMalpha   - alpha to use in Visbeck et al. formula for K
238  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
239  C     GMkbackground - background value of GM/Redi coefficient  C     GMkbackground - background value of GM/Redi coefficient
240    C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme
241  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
242  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
243  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
244  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     pChkPtFreq - Frequency of permanent check pointing ( s ).
245  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
246  C                 post-processing files ( s ).  C                 post-processing files ( s ).
247    C     taveFreq  - Frequency with which time-averaged model state is written to
248    C                 post-processing files ( s ).
249  C     afFacMom  - Advection of momentum term scaling parameter  C     afFacMom  - Advection of momentum term scaling parameter
250  C     vfFacMom  - Momentum viscosity scaling parameter  C     vfFacMom  - Momentum viscosity scaling parameter
251  C     pfFacMom  - Momentum pressure forcing parameter  C     pfFacMom  - Momentum pressure forcing parameter
252  C     cfFacMom  - Coriolis term scaling parameter  C     cfFacMom  - Coriolis term scaling parameter
253  C     foFacMom  - Momentum forcing scaling parameter  C     foFacMom  - Momentum forcing scaling parameter
254    C     mtFacMom  - Metric terms scaling parameter
255  C     cAdjFreq  - Frequency of convective adjustment  C     cAdjFreq  - Frequency of convective adjustment
256    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
257    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
258    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
259    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
260    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
261    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
262    C                          (note: externForcingCycle must be an integer
263    C                           number times externForcingPeriod)
264        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
265       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
266       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
267       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
268       & tauCD, rCD, freeSurfFac,       & tauCD, rCD, freeSurfFac,
269       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
270       & gravity, gBaro, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
271       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
272       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
273       & cAdjFreq       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
274         & tauSaltClimRelax, lambdaSaltClimRelax,
275         & externForcingCycle, externForcingPeriod
276        _RL cg2dTargetResidual        _RL cg2dTargetResidual
277        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
278        _RL delZ(Nz)        _RL delZ(Nz)
# Line 215  C     cAdjFreq  - Frequency of convectiv Line 286  C     cAdjFreq  - Frequency of convectiv
286        _RL phiMin        _RL phiMin
287        _RL thetaMin        _RL thetaMin
288        _RL rSphere        _RL rSphere
289          _RL rRSphere
290        _RL f0        _RL f0
291        _RL freeSurfFac        _RL freeSurfFac
292        _RL beta        _RL beta
# Line 235  C     cAdjFreq  - Frequency of convectiv Line 307  C     cAdjFreq  - Frequency of convectiv
307        _RL GMalpha        _RL GMalpha
308        _RL GMdepth        _RL GMdepth
309        _RL GMkbackground        _RL GMkbackground
310          _RL GMmaxval
311        _RL gravity        _RL gravity
312        _RL gBaro        _RL gBaro
313        _RL rhonil        _RL rhonil
314        _RL tRef(Nz)        _RL tRef(Nz)
315        _RL sRef(Nz)        _RL sRef(Nz)
316        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
317        _RL startTime        _RL startTime
318        _RL endTime        _RL endTime
319        _RL chkPtFreq        _RL chkPtFreq
320        _RL pChkPtFreq        _RL pChkPtFreq
321        _RL dumpFreq        _RL dumpFreq
322          _RL taveFreq
323        _RL afFacMom        _RL afFacMom
324        _RL vfFacMom        _RL vfFacMom
325        _RL pfFacMom        _RL pfFacMom
326        _RL cfFacMom        _RL cfFacMom
327        _RL foFacMom        _RL foFacMom
328          _RL mTFacMom
329        _RL cAdjFreq        _RL cAdjFreq
330          _RL omega
331          _RL tauThetaClimRelax
332          _RL lambdaThetaClimRelax
333          _RL tauSaltClimRelax
334          _RL lambdaSaltClimRelax
335          _RL externForcingCycle
336          _RL externForcingPeriod
337    
338        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
339       &                Lamba_theta       &                Lamba_theta
# Line 260  C     cAdjFreq  - Frequency of convectiv Line 342  C     cAdjFreq  - Frequency of convectiv
342    
343  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
344        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
345        _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)
346  C Linear equation of state  C Linear equation of state
347  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
348  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
349        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
350        _RL tAlpha        _RL tAlpha
351        _RL sBeta        _RL sBeta
352          character*(6) eosType
353    
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.21
  ViewVC Help
Powered by ViewVC 1.1.22