/[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.22 by adcroft, Wed Jul 29 18:33:47 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 72  C     momViscosity  - Flag which turns m Line 96  C     momViscosity  - Flag which turns m
96  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
97  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
98  C                     and off.  C                     and off.
99    C     momPressureForcing - Flag which turns pressure term in momentum equation
100    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 85  C     saltAdvection - Flag which turns a Line 113  C     saltAdvection - Flag which turns a
113  C                     and off.  C                     and off.
114  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
115  C                     and off.  C                     and off.
116    C     implicitFreeSurface - Set to true to use implcit free surface
117    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,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
132       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
133       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
134         & 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
146          LOGICAL momPressureForcing
147        LOGICAL useCoriolis        LOGICAL useCoriolis
148        LOGICAL tempDiffusion        LOGICAL tempDiffusion
149        LOGICAL tempAdvection        LOGICAL tempAdvection
# Line 101  C                     and off. Line 151  C                     and off.
151        LOGICAL saltDiffusion        LOGICAL saltDiffusion
152        LOGICAL saltAdvection        LOGICAL saltAdvection
153        LOGICAL saltForcing        LOGICAL saltForcing
154          LOGICAL implicitFreeSurface
155          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 124  C                 between "w" surfaces. Line 187  C                 between "w" surfaces.
187  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
188  C     delY        on input flags.  C     delY        on input flags.
189  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
190    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
191  C     ronil     - Reference density  C     ronil     - Reference density
192  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
193  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 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 161  C                    Frequency of checkp Line 227  C                    Frequency of checkp
227  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
228  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
229  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
230    C     freesurfFac  - Parameter to turn implicit free surface term on or off
231    C                    freesurfac = 1. uses implicit free surface
232    C                    freesurfac = 0. uses rigid lid
233    C     hFacMin   - Minimum fraction size of a cell (affects hFacC etc...)
234    C     hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc...)
235  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
236  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
237  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     GMmaxslope  - max. slope allowed in GM/Redi tensor
238  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)
239  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     GMalpha   - alpha to use in Visbeck et al. formula for K
240  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
241  C     GMbackground - background value of GM/Redi coefficient  C     GMkbackground - background value of GM/Redi coefficient
242    C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme
243  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
244  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
245  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
246  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     pChkPtFreq - Frequency of permanent check pointing ( s ).
247  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
248  C                 post-processing files ( s ).  C                 post-processing files ( s ).
249    C     taveFreq  - Frequency with which time-averaged model state is written to
250    C                 post-processing files ( s ).
251    C     afFacMom  - Advection of momentum term scaling parameter
252    C     vfFacMom  - Momentum viscosity scaling parameter
253    C     pfFacMom  - Momentum pressure forcing parameter
254    C     cfFacMom  - Coriolis term scaling parameter
255    C     foFacMom  - Momentum forcing scaling parameter
256    C     mtFacMom  - Metric terms scaling parameter
257    C     cAdjFreq  - Frequency of convective adjustment
258    C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
259    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
260    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
261    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
262    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
263    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
264    C                          (note: externForcingCycle must be an integer
265    C                           number times externForcingPeriod)
266        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
267       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
268       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
269       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
270       & tauCD, rCD,       & tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
271       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
272       & gravity, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
273       & endTime, chkPtFreq, pchkPtFreq, dumpFreq       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
274         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
275         & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
276         & tauSaltClimRelax, lambdaSaltClimRelax,
277         & externForcingCycle, externForcingPeriod
278        _RL cg2dTargetResidual        _RL cg2dTargetResidual
279        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
280        _RL delZ(Nz)        _RL delZ(Nz)
# Line 195  C                 post-processing files Line 288  C                 post-processing files
288        _RL phiMin        _RL phiMin
289        _RL thetaMin        _RL thetaMin
290        _RL rSphere        _RL rSphere
291          _RL rRSphere
292        _RL f0        _RL f0
293          _RL freeSurfFac
294          _RL hFacMin
295          _RL hFacMinDz
296        _RL beta        _RL beta
297        _RL viscAh        _RL viscAh
298        _RL viscAz        _RL viscAz
# Line 214  C                 post-processing files Line 311  C                 post-processing files
311        _RL GMalpha        _RL GMalpha
312        _RL GMdepth        _RL GMdepth
313        _RL GMkbackground        _RL GMkbackground
314          _RL GMmaxval
315        _RL gravity        _RL gravity
316          _RL gBaro
317        _RL rhonil        _RL rhonil
318        _RL tRef(Nz)        _RL tRef(Nz)
319        _RL sRef(Nz)        _RL sRef(Nz)
320        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
321        _RL startTime        _RL startTime
322        _RL endTime        _RL endTime
323        _RL chkPtFreq        _RL chkPtFreq
324        _RL pChkPtFreq        _RL pChkPtFreq
325        _RL dumpFreq        _RL dumpFreq
326          _RL taveFreq
327          _RL afFacMom
328          _RL vfFacMom
329          _RL pfFacMom
330          _RL cfFacMom
331          _RL foFacMom
332          _RL mTFacMom
333          _RL cAdjFreq
334          _RL omega
335          _RL tauThetaClimRelax
336          _RL lambdaThetaClimRelax
337          _RL tauSaltClimRelax
338          _RL lambdaSaltClimRelax
339          _RL externForcingCycle
340          _RL externForcingPeriod
341    
342        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
343       &                Lamba_theta       &                Lamba_theta
# Line 232  C                 post-processing files Line 346  C                 post-processing files
346    
347  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
348        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
349        _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)
350  C Linear equation of state  C Linear equation of state
351  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
352  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
353        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
354        _RL tAlpha        _RL tAlpha
355        _RL sBeta        _RL sBeta
356          character*(6) eosType
357    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.22
  ViewVC Help
Powered by ViewVC 1.1.22