/[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.3 by cnh, Sun Apr 26 23:41:54 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
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
16  C     Useful physical values  C     Useful physical values
17        Real*8 PI        Real*8 PI
18        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
19        Real*8 deg2rad        Real*8 deg2rad
20        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
21    
22    C     Symbolic values
23    C     precXXXX - Used to indicate what precision to use for
24    C                dumping model state.
25          INTEGER precFloat32
26          PARAMETER ( precFloat32 = 0 )
27          INTEGER precFloat64
28          PARAMETER ( precFloat64 = 1 )
29    
30    C     Checkpoint data
31          INTEGER maxNoChkptLev
32          PARAMETER ( maxNoChkptLev = 2 )
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     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff - List of checkpoint file suffices
36        COMMON /PARM_C/ oBandId  C     bathyFile   - File containing bathymetry. If not defined bathymetry
37        CHARACTER*3 oBandId(nOBands)  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)
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
55  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
# Line 32  C     nIter0              - Start time-s Line 59  C     nIter0              - Start time-s
59  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
60  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
61  C                           of flow fields.  C                           of flow fields.
62    C     writeStatePrec      - Precision used for writing model state.
63    C     writeBinaryPrec     - Precision used for writing binary files
64    C     readBinaryPrec      - Precision used for reading binary files
65    C     nCheckLev           - Holds current checkpoint level
66        COMMON /PARM_I/        COMMON /PARM_I/
67       &        cg2dMaxIters,       &        cg2dMaxIters,
68       &        cg2dChkResFreq,       &        cg2dChkResFreq,
69       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
70       &        numStepsPerPickup       &        numStepsPerPickup,
71         &        writeStatePrec, nCheckLev,
72         &        writeBinaryPrec, readBinaryPrec
73        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
74        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
75        INTEGER nIter0        INTEGER nIter0
76        INTEGER nTimeSteps        INTEGER nTimeSteps
77        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
78          INTEGER writeStatePrec
79          INTEGER writeBinaryPrec
80          INTEGER readBinaryPrec
81          INTEGER nCheckLev
82    
83  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
84  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 52  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 65  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 81  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
154  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
155    C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
156    C     Note. 20th May 1998
157    C           I made a weird discovery! In the model paper we argue
158    C           for the form of the preconditioner used here ( see
159    C           A Finite-volume, Incompressible Navier-Stokes Model
160    C           ...., Marshall et. al ). The algebra gives a simple
161    C           0.5 factor for the averaging of ac and aCw to get a
162    C           symmettric pre-conditioner. By using a factor of 0.51
163    C           i.e. scaling the off-diagonal terms in the
164    C           preconditioner down slightly I managed to get the
165    C           number of iterations for convergence in a test case to
166    C           drop form 192 -> 134! Need to investigate this further!
167    C           For now I have introduced a parameter cg2dpcOffDFac which
168    C           defaults to 0.51 but can be set at runtime.
169  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance
170  C                 between "w" surfaces.  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 97  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 119  C                 salt vertically ( m^2/ Line 203  C                 salt vertically ( m^2/
203  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
204  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
205  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
206    C     deltaTClock  - Timestep used as model "clock". This determines the
207    C                    IO frequencies and is used in tagging output. It can
208    C                    be totally different to the dynamical time. Typically
209    C                    it will be the deep-water timestep for accelerated runs.
210    C                    Frequency of checkpointing and dumping of the model state
211    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
220    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
222    C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
223    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 check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
227    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        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     afFacMom  - Advection of momentum term scaling parameter
231       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     vfFacMom  - Momentum viscosity scaling parameter
232       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     pfFacMom  - Momentum pressure forcing parameter
233       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     cfFacMom  - Coriolis term scaling parameter
234       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,  C     foFacMom  - Momentum forcing scaling parameter
235       & endTime, chkPtFreq, dumpFreq  C     mtFacMom  - Metric terms scaling parameter
236        REAL cg2dTargetResidual  C     cAdjFreq  - Frequency of convective adjustment
237        REAL delZ(Nz)        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
238        REAL delX(Nx)       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
239        REAL delY(Ny)       & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
240        REAL deltaT       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
241        REAL deltaTmom       & tauCD, rCD, freeSurfFac,
242        REAL deltaTtracer       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
243        REAL abeps       & gravity, gBaro, rhonil, tRef, sRef,
244        REAL phiMin       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
245        REAL thetaMin       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
246        REAL rSphere       & cAdjFreq, omega
247        REAL f0        _RL cg2dTargetResidual
248        _RL  beta        _RL cg2dpcOffDFac
249        REAL viscAh        _RL delZ(Nz)
250        REAL viscAz        _RL delX(Nx)
251        REAL viscA4        _RL delY(Ny)
252        REAL diffKhT        _RL deltaT
253        REAL diffKzT        _RL deltaTClock
254        REAL diffK4T        _RL deltaTmom
255        REAL diffKhS        _RL deltaTtracer
256        REAL diffKzS        _RL abeps
257        REAL diffK4S        _RL phiMin
258        REAL delt        _RL thetaMin
259        REAL tauCD        _RL rSphere
260        REAL rCD        _RL rRSphere
261        REAL tAlpha        _RL f0
262        REAL sBeta        _RL freeSurfFac
263        REAL gravity        _RL beta
264        REAL rhonil        _RL viscAh
265        REAL tRef(Nz)        _RL viscAz
266        REAL sRef(Nz)        _RL viscA4
267        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL diffKhT
268        REAL startTime        _RL diffKzT
269        REAL endTime        _RL diffK4T
270        REAL chkPtFreq        _RL diffKhS
271        REAL dumpFreq        _RL diffKzS
272          _RL diffK4S
273          _RL delt
274          _RL tauCD
275          _RL rCD
276          _RL GMmaxslope
277          _RL GMlength
278          _RL GMalpha
279          _RL GMdepth
280          _RL GMkbackground
281          _RL gravity
282          _RL gBaro
283          _RL rhonil
284          _RL tRef(Nz)
285          _RL sRef(Nz)
286          _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
287          _RL startTime
288          _RL endTime
289          _RL chkPtFreq
290          _RL pChkPtFreq
291          _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
303        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
304        REAL Lamba_theta        _RL Lamba_theta
305    
306    C Equation of State (polynomial coeffients)
307          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
308          _RL eosC(9,Nz+1),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)
309    C Linear equation of state
310    C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
311    C     sBeta     - Linear EOS haline contraction coefficient.
312          COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
313          _RL tAlpha
314          _RL sBeta
315          character*(6) eosType
316    
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.17
  ViewVC Help
Powered by ViewVC 1.1.22