/[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.13 by cnh, Sat May 30 02:10:16 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        COMMON /PARM_C/ checkPtSuff
37        CHARACTER*3 oBandId(nOBands)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
38    
39  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
40  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
41  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
# Line 32  C     nIter0              - Start time-s Line 45  C     nIter0              - Start time-s
45  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
46  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
47  C                           of flow fields.  C                           of flow fields.
48    C     writeStatePrec      - Precision used for writing model state.
49    C     writeBinaryPrec     - Precision used for writing binary files
50    C     readBinaryPrec      - Precision used for reading binary files
51    C     nCheckLev           - Holds current checkpoint level
52        COMMON /PARM_I/        COMMON /PARM_I/
53       &        cg2dMaxIters,       &        cg2dMaxIters,
54       &        cg2dChkResFreq,       &        cg2dChkResFreq,
55       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
56       &        numStepsPerPickup       &        numStepsPerPickup,
57         &        writeStatePrec, nCheckLev,
58         &        writeBinaryPrec, readBinaryPrec
59        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
60        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
61        INTEGER nIter0        INTEGER nIter0
62        INTEGER nTimeSteps        INTEGER nTimeSteps
63        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
64          INTEGER writeStatePrec
65          INTEGER writeBinaryPrec
66          INTEGER readBinaryPrec
67          INTEGER nCheckLev
68    
69  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
70  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 75  C     momViscosity  - Flag which turns m
75  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
76  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
77  C                     and off.  C                     and off.
78    C     momPressureForcing - Flag which turns pressure term in momentum equation
79    C                          on and off.
80  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useCoriolis   - Flag which turns the coriolis terms on and off.
81  C     tempDiffusion - Flag which turns diffusion of temperature on  C     tempDiffusion - Flag which turns diffusion of temperature on
82  C                     and off.  C                     and off.
# Line 65  C     saltAdvection - Flag which turns a Line 90  C     saltAdvection - Flag which turns a
90  C                     and off.  C                     and off.
91  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
92  C                     and off.  C                     and off.
93    C     implicitFreeSurface - Set to true to use implcit free surface
94    C     rigidLid            - Set to true to use rigid lid
95    C     momStepping   - Turns momentum equation time-stepping off
96    C     momStepping   - Turns temperature equation time-stepping off
97        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
98       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
99       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
100       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
101         & implicitFreeSurface, rigidLid, momStepping, tempStepping
102        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
103        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
104        LOGICAL momViscosity        LOGICAL momViscosity
105        LOGICAL momAdvection        LOGICAL momAdvection
106        LOGICAL momForcing        LOGICAL momForcing
107          LOGICAL momPressureForcing
108        LOGICAL useCoriolis        LOGICAL useCoriolis
109        LOGICAL tempDiffusion        LOGICAL tempDiffusion
110        LOGICAL tempAdvection        LOGICAL tempAdvection
# Line 81  C                     and off. Line 112  C                     and off.
112        LOGICAL saltDiffusion        LOGICAL saltDiffusion
113        LOGICAL saltAdvection        LOGICAL saltAdvection
114        LOGICAL saltForcing        LOGICAL saltForcing
115          LOGICAL implicitFreeSurface
116          LOGICAL rigidLid
117          LOGICAL momStepping
118          LOGICAL tempStepping
119    
120  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
121  C     cg2dTargetResidual  C     cg2dTargetResidual
122  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
123    C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
124    C     Note. 20th May 1998
125    C           I made a weird discovery! In the model paper we argue
126    C           for the form of the preconditioner used here ( see
127    C           A Finite-volume, Incompressible Navier-Stokes Model
128    C           ...., Marshall et. al ). The algebra gives a simple
129    C           0.5 factor for the averaging of ac and aCw to get a
130    C           symmettric pre-conditioner. By using a factor of 0.51
131    C           i.e. scaling the off-diagonal terms in the
132    C           preconditioner down slightly I managed to get the
133    C           number of iterations for convergence in a test case to
134    C           drop form 192 -> 134! Need to investigate this further!
135    C           For now I have introduced a parameter cg2dpcOffDFac which
136    C           defaults to 0.51 but can be set at runtime.
137  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance
138  C                 between "w" surfaces.  C                 between "w" surfaces.
139  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
140  C     delY        on input flags.  C     delY        on input flags.
141  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
142    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
143  C     ronil     - Reference density  C     ronil     - Reference density
144  C     startTime - Start time for model ( s )  C     startTime - Start time for model ( s )
145  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
# Line 119  C                 salt vertically ( m^2/ Line 169  C                 salt vertically ( m^2/
169  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
170  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
171  C     deltaT    - Default timestep ( s )  C     deltaT    - Default timestep ( s )
172    C     deltaTClock  - Timestep used as model "clock". This determines the
173    C                    IO frequencies and is used in tagging output. It can
174    C                    be totally different to the dynamical time. Typically
175    C                    it will be the deep-water timestep for accelerated runs.
176    C                    Frequency of checkpointing and dumping of the model state
177    C                    are referenced to this clock. ( s )
178  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    - Timestep for momemtum equations ( s )
179  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer - Timestep for tracer equations ( s )
180    C     freesurfFac  - Parameter to turn implicit free surface term on or off
181    C                    freesurfac = 1. uses implicit free surface
182    C                    freesurfac = 0. uses rigid lid
183  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
184  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
185  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     GMmaxslope  - max. slope allowed in GM/Redi tensor
186  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)
187  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     GMalpha   - alpha to use in Visbeck et al. formula for K
188  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
189  C     GMbackground - background value of GM/Redi coefficient  C     GMkbackground - background value of GM/Redi coefficient
190  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
191  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
192  C     chkPtFreq - Frequency of check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
193    C     pChkPtFreq - Frequency of permanent check pointing ( s ).
194  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
195  C                 post-processing files ( s ).  C                 post-processing files ( s ).
196        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     afFacMom  - Advection of momentum term scaling parameter
197       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C     vfFacMom  - Momentum viscosity scaling parameter
198       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     pfFacMom  - Momentum pressure forcing parameter
199       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     cfFacMom  - Coriolis term scaling parameter
200    C     foFacMom  - Momentum forcing scaling parameter
201    C     cAdjFreq  - Frequency of convective adjustment
202          COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
203         & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
204         & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
205         & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
206         & tauCD, rCD, freeSurfFac,
207       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
208       & gravity, rhonil, tRef, sRef,       & gravity, gBaro, rhonil, tRef, sRef,
209       & endTime, chkPtFreq, dumpFreq       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
210         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom,
211         & cAdjFreq
212        _RL cg2dTargetResidual        _RL cg2dTargetResidual
213          _RL cg2dpcOffDFac
214        _RL delZ(Nz)        _RL delZ(Nz)
215        _RL delX(Nx)        _RL delX(Nx)
216        _RL delY(Ny)        _RL delY(Ny)
217        _RL deltaT        _RL deltaT
218          _RL deltaTClock
219        _RL deltaTmom        _RL deltaTmom
220        _RL deltaTtracer        _RL deltaTtracer
221        _RL abeps        _RL abeps
# Line 152  C                 post-processing files Line 223  C                 post-processing files
223        _RL thetaMin        _RL thetaMin
224        _RL rSphere        _RL rSphere
225        _RL f0        _RL f0
226          _RL freeSurfFac
227        _RL beta        _RL beta
228        _RL viscAh        _RL viscAh
229        _RL viscAz        _RL viscAz
# Line 171  C                 post-processing files Line 243  C                 post-processing files
243        _RL GMdepth        _RL GMdepth
244        _RL GMkbackground        _RL GMkbackground
245        _RL gravity        _RL gravity
246          _RL gBaro
247        _RL rhonil        _RL rhonil
248        _RL tRef(Nz)        _RL tRef(Nz)
249        _RL sRef(Nz)        _RL sRef(Nz)
250        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
251        _RL startTime        _RL startTime
252        _RL endTime        _RL endTime
253        _RL chkPtFreq        _RL chkPtFreq
254          _RL pChkPtFreq
255        _RL dumpFreq        _RL dumpFreq
256          _RL afFacMom
257          _RL vfFacMom
258          _RL pfFacMom
259          _RL cfFacMom
260          _RL foFacMom
261          _RL cAdjFreq
262    
263        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
264       &                Lamba_theta       &                Lamba_theta
# Line 187  C                 post-processing files Line 267  C                 post-processing files
267    
268  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
269        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
270        _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)
271  C Linear equation of state  C Linear equation of state
272  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
273  C     sBeta     - Linear EOS haline contraction coefficient.  C     sBeta     - Linear EOS haline contraction coefficient.
274        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
275        _RL tAlpha        _RL tAlpha
276        _RL sBeta        _RL sBeta
277          character*(6) eosType
278    
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.13
  ViewVC Help
Powered by ViewVC 1.1.22