/[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.6 by adcroft, Wed May 20 21:29:31 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
 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    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)
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
62  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
# Line 32  C     nIter0              - Start time-s Line 66  C     nIter0              - Start time-s
66  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
67  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
68  C                           of flow fields.  C                           of flow fields.
69    C     writeStatePrec      - Precision used for writing model state.
70    C     writeBinaryPrec     - Precision used for writing binary files
71    C     readBinaryPrec      - Precision used for reading binary files
72    C     nCheckLev           - Holds current checkpoint level
73        COMMON /PARM_I/        COMMON /PARM_I/
74       &        cg2dMaxIters,       &        cg2dMaxIters,
75       &        cg2dChkResFreq,       &        cg2dChkResFreq,
76       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
77       &        numStepsPerPickup       &        numStepsPerPickup,
78         &        writeStatePrec, nCheckLev,
79         &        writeBinaryPrec, readBinaryPrec
80        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
81        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
82        INTEGER nIter0        INTEGER nIter0
83        INTEGER nTimeSteps        INTEGER nTimeSteps
84        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
85          INTEGER writeStatePrec
86          INTEGER writeBinaryPrec
87          INTEGER readBinaryPrec
88          INTEGER nCheckLev
89    
90  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
91  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 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 65  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 81  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
170  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
171  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
172  C                 between "w" surfaces.  C     Note. 20th May 1998
173    C           I made a weird discovery! In the model paper we argue
174    C           for the form of the preconditioner used here ( see
175    C           A Finite-volume, Incompressible Navier-Stokes Model
176    C           ...., Marshall et. al ). The algebra gives a simple
177    C           0.5 factor for the averaging of ac and aCw to get a
178    C           symmettric pre-conditioner. By using a factor of 0.51
179    C           i.e. scaling the off-diagonal terms in the
180    C           preconditioner down slightly I managed to get the
181    C           number of iterations for convergence in a test case to
182    C           drop form 192 -> 134! Need to investigate this further!
183    C           For now I have introduced a parameter cg2dpcOffDFac which
184    C           defaults to 0.51 but can be set at runtime.
185    C     delR      - Vertical grid spacing ( units of r ).
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 )
189    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
190  C     ronil     - Reference density  C     ronil     - Reference density
191  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
192  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 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 119  C                 salt vertically ( m^2/ Line 218  C                 salt vertically ( m^2/
218  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
219  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
220  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
221    C     deltaTClock  - Timestep used as model "clock". This determines the
222    C                    IO frequencies and is used in tagging output. It can
223    C                    be totally different to the dynamical time. Typically
224    C                    it will be the deep-water timestep for accelerated runs.
225    C                    Frequency of checkpointing and dumping of the model state
226    C                    are referenced to this clock. ( s )
227  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
228  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
229    C     freesurfFac  - Parameter to turn implicit free surface term on or off
230    C                    freesurfac = 1. uses implicit free surface
231    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
237  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)
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     GMbackground - 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 check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
245    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        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     taveFreq  - Frequency with which time-averaged model state is written to
249       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C                 post-processing files ( s ).
250       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     afFacMom  - Advection of momentum term scaling parameter
251       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     vfFacMom  - Momentum viscosity scaling parameter
252       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     pfFacMom  - Momentum pressure forcing parameter
253       & gravity, rhonil, tRef, sRef,  C     cfFacMom  - Coriolis term scaling parameter
254       & endTime, chkPtFreq, dumpFreq  C     foFacMom  - Momentum forcing scaling parameter
255    C     mtFacMom  - Metric terms scaling parameter
256    C     cAdjFreq  - Frequency of convective adjustment
257    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,
267         & thetaMin, rSphere, rRSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
268         & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
269         & tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
270         & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
271         & gravity, gBaro, rhonil, tRef, sRef,
272         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
273         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
274         & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
275         & tauSaltClimRelax, lambdaSaltClimRelax,
276         & externForcingCycle, externForcingPeriod
277        _RL cg2dTargetResidual        _RL cg2dTargetResidual
278        _RL delZ(Nz)        _RL cg2dpcOffDFac
279          _RL delR(Nz)
280        _RL delX(Nx)        _RL delX(Nx)
281        _RL delY(Ny)        _RL delY(Ny)
282        _RL deltaT        _RL deltaT
283          _RL deltaTClock
284        _RL deltaTmom        _RL deltaTmom
285        _RL deltaTtracer        _RL deltaTtracer
286        _RL abeps        _RL abeps
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
293          _RL hFacMin
294          _RL hFacMinDz
295        _RL beta        _RL beta
296        _RL viscAh        _RL viscAh
297        _RL viscAz        _RL viscAz
# Line 170  C                 post-processing files Line 310  C                 post-processing files
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
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
324        _RL dumpFreq        _RL dumpFreq
325          _RL taveFreq
326          _RL afFacMom
327          _RL vfFacMom
328          _RL pfFacMom
329          _RL cfFacMom
330          _RL foFacMom
331          _RL mTFacMom
332          _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 187  C                 post-processing files Line 345  C                 post-processing files
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.6  
changed lines
  Added in v.1.23
  ViewVC Help
Powered by ViewVC 1.1.22