/[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.25 by cnh, Sat Aug 22 17:51:06 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 119  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     delP      - Vertical grid spacing ( Pa ).
186  C                 between "w" surfaces.  C     delZ      - Vertical grid spacing ( m  ).
187    C     delR      - Vertical grid spacing ( units of r ).
188  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
189  C     delY        on input flags.  C     delY        on input flags.
190  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
191    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
192  C     ronil     - Reference density  C     ronil     - Reference density
193    C     rhoConst  - Vertically constant reference density
194  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
195  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
196  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
197  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
198  C                 to make geographical references simple.)  C                 to make geographical references simple.)
199  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
200    C     recip_RSphere  - Reciprocal radius of sphere ( m ).
201  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
202  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
203  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
204    C     omega     - Angular velocity ( rad/s )
205  C     viscAh    - Eddy viscosity coeff. for mixing of  C     viscAh    - Eddy viscosity coeff. for mixing of
206  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
207  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    - Eddy viscosity coeff. for mixing of
208  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
209    C     viscAr    - Eddy viscosity coeff. for mixing of
210    C                 momentum vertically ( units of r^2/s )
211  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    - Biharmonic viscosity coeff. for mixing of
212  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
213  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   - Laplacian diffusion coeff. for mixing of
214  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
215  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   - Laplacian diffusion coeff. for mixing of
216  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
217    C     diffKrT   - Laplacian diffusion coeff. for mixing of
218    C                 heat vertically ( units of r^2/s )
219  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   - Biharmonic diffusion coeff. for mixing of
220  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
221  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  -  Laplacian diffusion coeff. for mixing of
222  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
223  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   - Laplacian diffusion coeff. for mixing of
224  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
225    C     diffKrS   - Laplacian diffusion coeff. for mixing of
226    C                 salt vertically ( units of r^2/s )
227  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
228  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
229  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
# Line 161  C                    Frequency of checkp Line 235  C                    Frequency of checkp
235  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
236  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
237  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
238  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     freesurfFac  - Parameter to turn implicit free surface term on or off
239  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    freesurfac = 1. uses implicit free surface
240  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C                    freesurfac = 0. uses rigid lid
241  C     GMlength  - Length to use in Visbeck et al. formula for K  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
242  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
243  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
244  C     GMbackground - background value of GM/Redi coefficient  C     tauCD        - CD scheme coupling timescale ( 1/s )
245  C     startTime - Starting time for this integration ( s ).  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
246  C     endTime   - Ending time for this integration ( s ).  C     GMmaxslope   - max. slope allowed in GM/Redi tensor
247  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     GMlength     - Length to use in Visbeck et al. formula for K (m)
248  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     GMalpha      - alpha to use in Visbeck et al. formula for K
249  C     dumpFreq  - Frequency with which model state is written to  C     GMdepth      - Depth over which to integrate Richardson # (Visbeck et al.)
250    C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
251    C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
252    C     startTime     - Starting time for this integration ( s ).
253    C     endTime       - Ending time for this integration ( s ).
254    C     chkPtFreq     - Frequency of rolling check pointing ( s ).
255    C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
256    C     dumpFreq      - Frequency with which model state is written to
257    C                     post-processing files ( s ).
258    C     afFacMom      - Advection of momentum term tracer parameter
259    C     vfFacMom      - Momentum viscosity tracer parameter
260    C     pfFacMom      - Momentum pressure forcing tracer parameter
261    C     cfFacMom      - Coriolis term tracer parameter
262    C     foFacMom      - Momentum forcing tracer parameter
263    C     mtFacMom      - Metric terms tracer parameter
264    C     cAdjFreq      - Frequency of convective adjustment
265    C
266    C     taveFreq  - Frequency with which time-averaged model state is written to
267  C                 post-processing files ( s ).  C                 post-processing files ( s ).
268        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
269    C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
270    C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
271    C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
272    C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
273    C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
274    C                          (note: externForcingCycle must be an integer
275    C                           number times externForcingPeriod)
276          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
277         & delP, delZ, delR, delX, delY,
278       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
279       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
280       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,       & viscAh,  viscAz,  viscA4,  viscAr,
281       & tauCD, rCD,       & diffKhT, diffKzT, diffK4T, diffKrT,
282       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & diffKhS, diffKzS, diffK4S, diffKrS,
283       & gravity, rhonil, tRef, sRef,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
284       & endTime, chkPtFreq, pchkPtFreq, dumpFreq       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
285         & gravity, gBaro, rhonil, recip_rhonil, rhoConst, tRef, sRef,
286         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
287         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
288         & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
289         & tauSaltClimRelax, lambdaSaltClimRelax,
290         & externForcingCycle, externForcingPeriod
291        _RL cg2dTargetResidual        _RL cg2dTargetResidual
292        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
293        _RL delZ(Nz)        _RL delZ(Nr)
294          _RL delP(Nr)
295          _RL delR(Nr)
296        _RL delX(Nx)        _RL delX(Nx)
297        _RL delY(Ny)        _RL delY(Ny)
298        _RL deltaT        _RL deltaT
# Line 195  C                 post-processing files Line 303  C                 post-processing files
303        _RL phiMin        _RL phiMin
304        _RL thetaMin        _RL thetaMin
305        _RL rSphere        _RL rSphere
306          _RL recip_RSphere
307        _RL f0        _RL f0
308          _RL freeSurfFac
309          _RL hFacMin
310          _RL hFacMinDz
311        _RL beta        _RL beta
312        _RL viscAh        _RL viscAh
313        _RL viscAz        _RL viscAz
314          _RL viscAr
315        _RL viscA4        _RL viscA4
316        _RL diffKhT        _RL diffKhT
317          _RL diffKrT
318        _RL diffKzT        _RL diffKzT
319        _RL diffK4T        _RL diffK4T
320        _RL diffKhS        _RL diffKhS
321          _RL diffKrS
322        _RL diffKzS        _RL diffKzS
323        _RL diffK4S        _RL diffK4S
324        _RL delt        _RL delt
# Line 214  C                 post-processing files Line 329  C                 post-processing files
329        _RL GMalpha        _RL GMalpha
330        _RL GMdepth        _RL GMdepth
331        _RL GMkbackground        _RL GMkbackground
332          _RL GMmaxval
333        _RL gravity        _RL gravity
334          _RL gBaro
335        _RL rhonil        _RL rhonil
336        _RL tRef(Nz)        _RL recip_rhonil
337        _RL sRef(Nz)        _RL rhoConst
338        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL tRef(Nr)
339          _RL sRef(Nr)
340          _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
341        _RL startTime        _RL startTime
342        _RL endTime        _RL endTime
343        _RL chkPtFreq        _RL chkPtFreq
344        _RL pChkPtFreq        _RL pChkPtFreq
345        _RL dumpFreq        _RL dumpFreq
346          _RL taveFreq
347          _RL afFacMom
348          _RL vfFacMom
349          _RL pfFacMom
350          _RL cfFacMom
351          _RL foFacMom
352          _RL mTFacMom
353          _RL cAdjFreq
354          _RL omega
355          _RL tauThetaClimRelax
356          _RL lambdaThetaClimRelax
357          _RL tauSaltClimRelax
358          _RL lambdaSaltClimRelax
359          _RL externForcingCycle
360          _RL externForcingPeriod
361    
362        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
363       &                Lamba_theta       &                Lamba_theta
# Line 232  C                 post-processing files Line 366  C                 post-processing files
366    
367  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
368        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
369        _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
370  C Linear equation of state  C Linear equation of state
371  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
372  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
373        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
374        _RL tAlpha        _RL tAlpha
375        _RL sBeta        _RL sBeta
376          character*(6) eosType
377    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.25
  ViewVC Help
Powered by ViewVC 1.1.22