/[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.23 by cnh, Sat Aug 15 16:55:48 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 127  C           number of iterations for con Line 182  C           number of iterations for con
182  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
183  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
184  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
185  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delR      - Vertical grid spacing ( units of r ).
 C                 between "w" surfaces.  
186  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
187  C     delY        on input flags.  C     delY        on input flags.
188  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
# Line 140  C     thetaMin  - Longitude of western m Line 194  C     thetaMin  - Longitude of western m
194  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
195  C                 to make geographical references simple.)  C                 to make geographical references simple.)
196  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
197    C     rRSphere  - Reciprocal radius of sphere for a spherical polar grid ( m ).
198  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
199  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
200  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
201    C     omega     - Angular velocity ( rad/s )
202  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
203  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
204  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
# Line 173  C     deltaTtracer - Timestep for tracer Line 229  C     deltaTtracer - Timestep for tracer
229  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
230  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
231  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
232    C     hFacMin   - Minimum fraction size of a cell (affects hFacC etc...)
233    C     hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc...)
234  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
235  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
236  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     GMmaxslope  - max. slope allowed in GM/Redi tensor
# Line 180  C     GMlength  - Length to use in Visbe Line 238  C     GMlength  - Length to use in Visbe
238  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     GMalpha   - alpha to use in Visbeck et al. formula for K
239  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
240  C     GMkbackground - background value of GM/Redi coefficient  C     GMkbackground - background value of GM/Redi coefficient
241    C     GMmaxval  - max. value of KapGM allowed in GM/Redi scheme
242  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
243  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
244  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
245  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     pChkPtFreq - Frequency of permanent check pointing ( s ).
246  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
247  C                 post-processing files ( s ).  C                 post-processing files ( s ).
248    C     taveFreq  - Frequency with which time-averaged model state is written to
249    C                 post-processing files ( s ).
250  C     afFacMom  - Advection of momentum term scaling parameter  C     afFacMom  - Advection of momentum term scaling parameter
251  C     vfFacMom  - Momentum viscosity scaling parameter  C     vfFacMom  - Momentum viscosity scaling parameter
252  C     pfFacMom  - Momentum pressure forcing parameter  C     pfFacMom  - Momentum pressure forcing parameter
253  C     cfFacMom  - Coriolis term scaling parameter  C     cfFacMom  - Coriolis term scaling parameter
254  C     foFacMom  - Momentum forcing scaling parameter  C     foFacMom  - Momentum forcing scaling parameter
255    C     mtFacMom  - Metric terms scaling parameter
256  C     cAdjFreq  - Frequency of convective adjustment  C     cAdjFreq  - Frequency of convective adjustment
257        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
258    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
259    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
260    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
261    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
262    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
263    C                          (note: externForcingCycle must be an integer
264    C                           number times externForcingPeriod)
265          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delR, delX, delY,
266       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
267       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
268       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
269       & tauCD, rCD, freeSurfFac,       & tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
270       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
271       & gravity, gBaro, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
272       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
273       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
274       & cAdjFreq       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
275         & tauSaltClimRelax, lambdaSaltClimRelax,
276         & externForcingCycle, externForcingPeriod
277        _RL cg2dTargetResidual        _RL cg2dTargetResidual
278        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
279        _RL delZ(Nz)        _RL delR(Nz)
280        _RL delX(Nx)        _RL delX(Nx)
281        _RL delY(Ny)        _RL delY(Ny)
282        _RL deltaT        _RL deltaT
# Line 215  C     cAdjFreq  - Frequency of convectiv Line 287  C     cAdjFreq  - Frequency of convectiv
287        _RL phiMin        _RL phiMin
288        _RL thetaMin        _RL thetaMin
289        _RL rSphere        _RL rSphere
290          _RL rRSphere
291        _RL f0        _RL f0
292        _RL freeSurfFac        _RL freeSurfFac
293          _RL hFacMin
294          _RL hFacMinDz
295        _RL beta        _RL beta
296        _RL viscAh        _RL viscAh
297        _RL viscAz        _RL viscAz
# Line 235  C     cAdjFreq  - Frequency of convectiv Line 310  C     cAdjFreq  - Frequency of convectiv
310        _RL GMalpha        _RL GMalpha
311        _RL GMdepth        _RL GMdepth
312        _RL GMkbackground        _RL GMkbackground
313          _RL GMmaxval
314        _RL gravity        _RL gravity
315        _RL gBaro        _RL gBaro
316        _RL rhonil        _RL rhonil
317        _RL tRef(Nz)        _RL tRef(Nz)
318        _RL sRef(Nz)        _RL sRef(Nz)
319        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
320        _RL startTime        _RL startTime
321        _RL endTime        _RL endTime
322        _RL chkPtFreq        _RL chkPtFreq
323        _RL pChkPtFreq        _RL pChkPtFreq
324        _RL dumpFreq        _RL dumpFreq
325          _RL taveFreq
326        _RL afFacMom        _RL afFacMom
327        _RL vfFacMom        _RL vfFacMom
328        _RL pfFacMom        _RL pfFacMom
329        _RL cfFacMom        _RL cfFacMom
330        _RL foFacMom        _RL foFacMom
331          _RL mTFacMom
332        _RL cAdjFreq        _RL cAdjFreq
333          _RL omega
334          _RL tauThetaClimRelax
335          _RL lambdaThetaClimRelax
336          _RL tauSaltClimRelax
337          _RL lambdaSaltClimRelax
338          _RL externForcingCycle
339          _RL externForcingPeriod
340    
341        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
342       &                Lamba_theta       &                Lamba_theta
# Line 260  C     cAdjFreq  - Frequency of convectiv Line 345  C     cAdjFreq  - Frequency of convectiv
345    
346  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
347        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
348        _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)
349  C Linear equation of state  C Linear equation of state
350  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
351  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
352        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
353        _RL tAlpha        _RL tAlpha
354        _RL sBeta        _RL sBeta
355          character*(6) eosType
356    
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.23
  ViewVC Help
Powered by ViewVC 1.1.22