/[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.2 by cnh, Fri Apr 24 02:11:37 1998 UTC revision 1.8 by cnh, Mon May 25 16:17:36 1998 UTC
# Line 10  C     | the parameters can also be found Line 10  C     | the parameters can also be found
10  C     \==========================================================/  C     \==========================================================/
11    
12  C--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
13  C     Useful physical values  C     Useful physical values
14        Real*8 PI        Real*8 PI
15        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
16        Real*8 deg2rad        Real*8 deg2rad
17        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
18    
19    C     Symbolic values
20    C     precXXXX - Used to indicate what precision to use for
21    C                dumping model state.
22          INTEGER precFloat32
23          PARAMETER ( precFloat32 = 0 )
24          INTEGER precFloat64
25          PARAMETER ( precFloat64 = 1 )
26    
27    C     Checkpoint data
28          INTEGER maxNoChkptLev
29          PARAMETER ( maxNoChkptLev = 2 )
30    
31  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
32  C     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff - List of checkpoint file suffices
33        COMMON /PARM_C/ oBandId        COMMON /PARM_C/ checkPtSuff
34        CHARACTER*3 oBandId(nOBands)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
35    
36  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
37  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
38  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
# Line 32  C     nIter0              - Start time-s Line 42  C     nIter0              - Start time-s
42  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
43  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
44  C                           of flow fields.  C                           of flow fields.
45    C     writeStatePrec      - Precision used for writing model state.
46    C     writeBinaryPrec     - Precision used for writing binary files
47    C     readBinaryPrec      - Precision used for reading binary files
48    C     nCheckLev           - Holds current checkpoint level
49        COMMON /PARM_I/        COMMON /PARM_I/
50       &        cg2dMaxIters,       &        cg2dMaxIters,
51       &        cg2dChkResFreq,       &        cg2dChkResFreq,
52       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
53       &        numStepsPerPickup       &        numStepsPerPickup,
54         &        writeStatePrec, nCheckLev,
55         &        writeBinaryPrec, readBinaryPrec
56        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
57        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
58        INTEGER nIter0        INTEGER nIter0
59        INTEGER nTimeSteps        INTEGER nTimeSteps
60        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
61          INTEGER writeStatePrec
62          INTEGER writeBinaryPrec
63          INTEGER readBinaryPrec
64          INTEGER nCheckLev
65    
66  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
67  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 65  C     saltAdvection - Flag which turns a Line 85  C     saltAdvection - Flag which turns a
85  C                     and off.  C                     and off.
86  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
87  C                     and off.  C                     and off.
88    C     implicitFreeSurface - Set to true to use implcit free surface
89    C     rigidLid            - Set to true to use rigid lid
90        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
91       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
92       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
93       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
94         & implicitFreeSurface, rigidLid
95        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
96        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
97        LOGICAL momViscosity        LOGICAL momViscosity
# Line 81  C                     and off. Line 104  C                     and off.
104        LOGICAL saltDiffusion        LOGICAL saltDiffusion
105        LOGICAL saltAdvection        LOGICAL saltAdvection
106        LOGICAL saltForcing        LOGICAL saltForcing
107          LOGICAL implicitFreeSurface
108          LOGICAL rigidLid
109    
110  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
111  C     cg2dTargetResidual  C     cg2dTargetResidual
112  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
113  C     delZ      - Vertical grid spacing (Pa) - delZ is the distance  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
114    C     Note. 20th May 1998
115    C           I made a weird discovery! In the model paper we argue
116    C           for the form of the preconditioner used here ( see
117    C           A Finite-volume, Incompressible Navier-Stokes Model
118    C           ...., Marshall et. al ). The algebra gives a simple
119    C           0.5 factor for the averaging of ac and aCw to get a
120    C           symmettric pre-conditioner. By using a factor of 0.51
121    C           i.e. scaling the off-diagonal terms in the
122    C           preconditioner down slightly I managed to get the
123    C           number of iterations for convergence in a test case to
124    C           drop form 192 -> 134! Need to investigate this further!
125    C           For now I have introduced a parameter cg2dpcOffDFac which
126    C           defaults to 0.51 but can be set at runtime.
127    C     delZ      - Vertical grid spacing ( m ) - delZ is the distance
128  C                 between "w" surfaces.  C                 between "w" surfaces.
129  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
130  C     delY        on input flags.  C     delY        on input flags.
131  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
132    C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
133  C     ronil     - Reference density  C     ronil     - Reference density
134  C     startTime - Start time for model  C     startTime - Start time for model ( s )
 C     oBandBeg  - Offline bands start and end times.  
 C     oBandEnd  
 C     oPeriodLength - Lenght of offline period.  
135  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
136  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
137  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
138  C                 to make geographical references simple.)  C                 to make geographical references simple.)
139  C     rSphere   - Radius of sphere for a spherical polar grid.  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
140  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
141  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
142  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 121  C     diffKzS   - Laplacian diffusion co Line 158  C     diffKzS   - Laplacian diffusion co
158  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
159  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
160  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
161  C     delt      - Timestep ( s )  C     deltaT    - Default timestep ( s )
162    C     deltaTClock  - Timestep used as model "clock". This determines the
163    C                    IO frequencies and is used in tagging output. It can
164    C                    be totally different to the dynamical time. Typically
165    C                    it will be the deep-water timestep for accelerated runs.
166    C                    Frequency of checkpointing and dumping of the model state
167    C                    are referenced to this clock. ( s )
168    C     deltaTMom    - Timestep for momemtum equations ( s )
169    C     deltaTtracer - Timestep for tracer equations ( s )
170    C     freesurfFac  - Parameter to turn implicit free surface term on or off
171    C                    freesurfac = 1. uses implicit free surface
172    C                    freesurfac = 0. uses rigid lid
173  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
174  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
175    C     GMmaxslope  - max. slope allowed in GM/Redi tensor
176    C     GMlength  - Length to use in Visbeck et al. formula for K (m)
177    C     GMalpha   - alpha to use in Visbeck et al. formula for K
178    C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
179    C     GMkbackground - background value of GM/Redi coefficient
180  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
181  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
182  C     chkPtFreq - Frequency of check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
183    C     pChkPtFreq - Frequency of permanent check pointing ( s ).
184  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
185  C                 post-processing files ( s ).  C                 post-processing files ( s ).
186        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
187       & deltaTmom, deltaTtracer, abeps, startTime, oBandBeg, oBandEnd,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
188       & oPeriodLength, phiMin, thetaMin, rSphere, f0, fCori, beta,       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
189       & viscAh, viscAz, viscA4, diffKhT, diffKzT, diffK4T,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
190       & diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,       & tauCD, rCD, freeSurfFac,
191       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
192       & endTime, chkPtFreq, dumpFreq       & gravity, gBaro, rhonil, tRef, sRef,
193        REAL cg2dTargetResidual       & endTime, chkPtFreq, pchkPtFreq, dumpFreq
194        REAL delZ(Nz)        _RL cg2dTargetResidual
195        REAL delX(Nx)        _RL cg2dpcOffDFac
196        REAL delY(Ny)        _RL delZ(Nz)
197        REAL deltaTmom        _RL delX(Nx)
198        REAL deltaTtracer        _RL delY(Ny)
199        REAL abeps        _RL deltaT
200        REAL oBandBeg(nOBands),oBandEnd(nOBands)        _RL deltaTClock
201        REAL oPeriodLength        _RL deltaTmom
202        REAL phiMin        _RL deltaTtracer
203        REAL thetaMin        _RL abeps
204        REAL rSphere        _RL phiMin
205        REAL f0        _RL thetaMin
206        _RL  beta        _RL rSphere
207        REAL viscAh        _RL f0
208        REAL viscAz        _RL freeSurfFac
209        REAL viscA4        _RL beta
210        REAL diffKhT        _RL viscAh
211        REAL diffKzT        _RL viscAz
212        REAL diffK4T        _RL viscA4
213        REAL diffKhS        _RL diffKhT
214        REAL diffKzS        _RL diffKzT
215        REAL diffK4S        _RL diffK4T
216        REAL delt        _RL diffKhS
217        REAL tauCD        _RL diffKzS
218        REAL rCD        _RL diffK4S
219        REAL tAlpha        _RL delt
220        REAL sBeta        _RL tauCD
221        REAL gravity        _RL rCD
222        REAL rhonil        _RL GMmaxslope
223        REAL tRef(Nz)        _RL GMlength
224        REAL sRef(Nz)        _RL GMalpha
225        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL GMdepth
226        REAL startTime        _RL GMkbackground
227        REAL endTime        _RL gravity
228        REAL chkPtFreq        _RL gBaro
229        REAL dumpFreq        _RL rhonil
230          _RL tRef(Nz)
231          _RL sRef(Nz)
232          _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
233          _RL startTime
234          _RL endTime
235          _RL chkPtFreq
236          _RL pChkPtFreq
237          _RL dumpFreq
238    
239        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
240       &                Lamba_theta       &                Lamba_theta
241        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
242        REAL Lamba_theta        _RL Lamba_theta
243    
244    C Equation of State (polynomial coeffients)
245          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
246          _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)
247    C Linear equation of state
248    C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
249    C     sBeta     - Linear EOS haline contraction coefficient.
250          COMMON /PARM_EOS_LIN/ tAlpha,sBeta
251          _RL tAlpha
252          _RL sBeta
253    
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.8
  ViewVC Help
Powered by ViewVC 1.1.22