/[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.7 by cnh, Thu May 21 18:28:50 1998 UTC revision 1.17 by adcroft, Wed Jun 10 16:05:39 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          COMMON /PARM_C/ checkPtSuff,
44         &                bathyFile, hydrogThetaFile, hydrogSaltFile,
45         &                zonalWindFile, meridWindFile
46        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
47          CHARACTER*(MAX_LEN_FNAM) bathyFile
48          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
49          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
50          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
51          CHARACTER*(MAX_LEN_FNAM) meridWindFile
52    
53  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
54  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 72  C     momViscosity  - Flag which turns m Line 89  C     momViscosity  - Flag which turns m
89  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
90  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
91  C                     and off.  C                     and off.
92    C     momPressureForcing - Flag which turns pressure term in momentum equation
93    C                          on and off.
94    C     metricTerms   - Flag which turns metric terms on or off.
95    C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
96  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
97  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
98  C                     and off.  C                     and off.
# Line 85  C     saltAdvection - Flag which turns a Line 106  C     saltAdvection - Flag which turns a
106  C                     and off.  C                     and off.
107  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
108  C                     and off.  C                     and off.
109    C     implicitFreeSurface - Set to true to use implcit free surface
110    C     rigidLid            - Set to true to use rigid lid
111    C     momStepping   - Turns momentum equation time-stepping off
112    C     tempStepping  - Turns temperature equation time-stepping off
113    C     saltStepping  - Turns salinity equation time-stepping off
114    C     useConstantF  - Coriolis parameter set to f0
115    C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
116    C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
117    C     implicitDiffusion - Turns implicit vertical diffusion on
118        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
119       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
120       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
121       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
122         & implicitFreeSurface, rigidLid,
123         & momStepping, tempStepping, saltStepping,
124         & metricTerms, usingSphericalPolarMTerms,
125         & useConstantF, useBetaPlaneF, useSphereF,
126         & implicitDiffusion
127        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
128        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
129          LOGICAL usingSphericalPolarMTerms
130        LOGICAL momViscosity        LOGICAL momViscosity
131        LOGICAL momAdvection        LOGICAL momAdvection
132        LOGICAL momForcing        LOGICAL momForcing
133          LOGICAL momPressureForcing
134        LOGICAL useCoriolis        LOGICAL useCoriolis
135        LOGICAL tempDiffusion        LOGICAL tempDiffusion
136        LOGICAL tempAdvection        LOGICAL tempAdvection
# Line 101  C                     and off. Line 138  C                     and off.
138        LOGICAL saltDiffusion        LOGICAL saltDiffusion
139        LOGICAL saltAdvection        LOGICAL saltAdvection
140        LOGICAL saltForcing        LOGICAL saltForcing
141          LOGICAL implicitFreeSurface
142          LOGICAL rigidLid
143          LOGICAL momStepping
144          LOGICAL tempStepping
145          LOGICAL saltStepping
146          LOGICAL metricTerms
147          LOGICAL useConstantF
148          LOGICAL useBetaPlaneF
149          LOGICAL useSphereF
150          LOGICAL implicitDiffusion
151    
152  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
153  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 124  C                 between "w" surfaces. Line 171  C                 between "w" surfaces.
171  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
172  C     delY        on input flags.  C     delY        on input flags.
173  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
174    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
175  C     ronil     - Reference density  C     ronil     - Reference density
176  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
177  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
# Line 131  C     thetaMin  - Longitude of western m Line 179  C     thetaMin  - Longitude of western m
179  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
180  C                 to make geographical references simple.)  C                 to make geographical references simple.)
181  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
182    C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).
183  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
184  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
185  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
186    C     omega     - Angular velocity ( rad/s )
187  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
188  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
189  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
# Line 161  C                    Frequency of checkp Line 211  C                    Frequency of checkp
211  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
212  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
213  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
214    C     freesurfFac  - Parameter to turn implicit free surface term on or off
215    C                    freesurfac = 1. uses implicit free surface
216    C                    freesurfac = 0. uses rigid lid
217  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
218  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
219  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     GMmaxslope  - max. slope allowed in GM/Redi tensor
220  C     GMlength  - Length to use in Visbeck et al. formula for K  C     GMlength  - Length to use in Visbeck et al. formula for K (m)
221  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     GMalpha   - alpha to use in Visbeck et al. formula for K
222  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
223  C     GMbackground - background value of GM/Redi coefficient  C     GMkbackground - background value of GM/Redi coefficient
224  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
225  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
226  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
227  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     pChkPtFreq - Frequency of permanent check pointing ( s ).
228  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
229  C                 post-processing files ( s ).  C                 post-processing files ( s ).
230    C     afFacMom  - Advection of momentum term scaling parameter
231    C     vfFacMom  - Momentum viscosity scaling parameter
232    C     pfFacMom  - Momentum pressure forcing parameter
233    C     cfFacMom  - Coriolis term scaling parameter
234    C     foFacMom  - Momentum forcing scaling parameter
235    C     mtFacMom  - Metric terms scaling parameter
236    C     cAdjFreq  - Frequency of convective adjustment
237        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
238       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
239       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
240       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
241       & tauCD, rCD,       & tauCD, rCD, freeSurfFac,
242       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
243       & gravity, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
244       & endTime, chkPtFreq, pchkPtFreq, dumpFreq       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
245         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
246         & cAdjFreq, omega
247        _RL cg2dTargetResidual        _RL cg2dTargetResidual
248        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
249        _RL delZ(Nz)        _RL delZ(Nz)
# Line 195  C                 post-processing files Line 257  C                 post-processing files
257        _RL phiMin        _RL phiMin
258        _RL thetaMin        _RL thetaMin
259        _RL rSphere        _RL rSphere
260          _RL rRSphere
261        _RL f0        _RL f0
262          _RL freeSurfFac
263        _RL beta        _RL beta
264        _RL viscAh        _RL viscAh
265        _RL viscAz        _RL viscAz
# Line 215  C                 post-processing files Line 279  C                 post-processing files
279        _RL GMdepth        _RL GMdepth
280        _RL GMkbackground        _RL GMkbackground
281        _RL gravity        _RL gravity
282          _RL gBaro
283        _RL rhonil        _RL rhonil
284        _RL tRef(Nz)        _RL tRef(Nz)
285        _RL sRef(Nz)        _RL sRef(Nz)
286        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
287        _RL startTime        _RL startTime
288        _RL endTime        _RL endTime
289        _RL chkPtFreq        _RL chkPtFreq
290        _RL pChkPtFreq        _RL pChkPtFreq
291        _RL dumpFreq        _RL dumpFreq
292          _RL afFacMom
293          _RL vfFacMom
294          _RL pfFacMom
295          _RL cfFacMom
296          _RL foFacMom
297          _RL mTFacMom
298          _RL cAdjFreq
299          _RL omega
300    
301        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
302       &                Lamba_theta       &                Lamba_theta
# Line 232  C                 post-processing files Line 305  C                 post-processing files
305    
306  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
307        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
308        _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)
309  C Linear equation of state  C Linear equation of state
310  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
311  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
312        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
313        _RL tAlpha        _RL tAlpha
314        _RL sBeta        _RL sBeta
315          character*(6) eosType
316    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.17
  ViewVC Help
Powered by ViewVC 1.1.22