/[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.7 by cnh, Thu May 21 18:28:50 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 85  C                     and off. Line 105  C                     and off.
105  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
106  C     cg2dTargetResidual  C     cg2dTargetResidual
107  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
108  C     delZ      - Vertical grid spacing (Pa) - delZ is the distance  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
109    C     Note. 20th May 1998
110    C           I made a weird discovery! In the model paper we argue
111    C           for the form of the preconditioner used here ( see
112    C           A Finite-volume, Incompressible Navier-Stokes Model
113    C           ...., Marshall et. al ). The algebra gives a simple
114    C           0.5 factor for the averaging of ac and aCw to get a
115    C           symmettric pre-conditioner. By using a factor of 0.51
116    C           i.e. scaling the off-diagonal terms in the
117    C           preconditioner down slightly I managed to get the
118    C           number of iterations for convergence in a test case to
119    C           drop form 192 -> 134! Need to investigate this further!
120    C           For now I have introduced a parameter cg2dpcOffDFac which
121    C           defaults to 0.51 but can be set at runtime.
122    C     delZ      - Vertical grid spacing ( m ) - delZ is the distance
123  C                 between "w" surfaces.  C                 between "w" surfaces.
124  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
125  C     delY        on input flags.  C     delY        on input flags.
126  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
127  C     ronil     - Reference density  C     ronil     - Reference density
128  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.  
129  C     phiMin    - Latitude of southern most cell face.  C     phiMin    - Latitude of southern most cell face.
130  C     thetaMin  - Longitude of western most cell face (this  C     thetaMin  - Longitude of western most cell face (this
131  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
132  C                 to make geographical references simple.)  C                 to make geographical references simple.)
133  C     rSphere   - Radius of sphere for a spherical polar grid.  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
134  C     f0        - Reference coriolis parameter ( 1/s )  C     f0        - Reference coriolis parameter ( 1/s )
135  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
136  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      - df/dy ( s^-1.m^-1 )
# Line 121  C     diffKzS   - Laplacian diffusion co Line 152  C     diffKzS   - Laplacian diffusion co
152  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
153  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   - Biharmonic diffusion coeff. for mixing of
154  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
155  C     delt      - Timestep ( s )  C     deltaT    - Default timestep ( s )
156    C     deltaTClock  - Timestep used as model "clock". This determines the
157    C                    IO frequencies and is used in tagging output. It can
158    C                    be totally different to the dynamical time. Typically
159    C                    it will be the deep-water timestep for accelerated runs.
160    C                    Frequency of checkpointing and dumping of the model state
161    C                    are referenced to this clock. ( s )
162    C     deltaTMom    - Timestep for momemtum equations ( s )
163    C     deltaTtracer - Timestep for tracer equations ( s )
164  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     tauCD     - CD scheme coupling timescale ( 1/s )
165  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
166    C     GMmaxslope  - max. slope allowed in GM/Redi tensor
167    C     GMlength  - Length to use in Visbeck et al. formula for K
168    C     GMalpha   - alpha to use in Visbeck et al. formula for K
169    C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)
170    C     GMbackground - background value of GM/Redi coefficient
171  C     startTime - Starting time for this integration ( s ).  C     startTime - Starting time for this integration ( s ).
172  C     endTime   - Ending time for this integration ( s ).  C     endTime   - Ending time for this integration ( s ).
173  C     chkPtFreq - Frequency of check pointing ( s ).  C     chkPtFreq  - Frequency of rolling check pointing ( s ).
174    C     pChkPtFreq - Frequency of permanent check pointing ( s ).
175  C     dumpFreq  - Frequency with which model state is written to  C     dumpFreq  - Frequency with which model state is written to
176  C                 post-processing files ( s ).  C                 post-processing files ( s ).
177        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,
178       & deltaTmom, deltaTtracer, abeps, startTime, oBandBeg, oBandEnd,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
179       & oPeriodLength, phiMin, thetaMin, rSphere, f0, fCori, beta,       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,
180       & viscAh, viscAz, viscA4, diffKhT, diffKzT, diffK4T,       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,
181       & diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,       & tauCD, rCD,
182       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,
183       & endTime, chkPtFreq, dumpFreq       & gravity, rhonil, tRef, sRef,
184        REAL cg2dTargetResidual       & endTime, chkPtFreq, pchkPtFreq, dumpFreq
185        REAL delZ(Nz)        _RL cg2dTargetResidual
186        REAL delX(Nx)        _RL cg2dpcOffDFac
187        REAL delY(Ny)        _RL delZ(Nz)
188        REAL deltaTmom        _RL delX(Nx)
189        REAL deltaTtracer        _RL delY(Ny)
190        REAL abeps        _RL deltaT
191        REAL oBandBeg(nOBands),oBandEnd(nOBands)        _RL deltaTClock
192        REAL oPeriodLength        _RL deltaTmom
193        REAL phiMin        _RL deltaTtracer
194        REAL thetaMin        _RL abeps
195        REAL rSphere        _RL phiMin
196        REAL f0        _RL thetaMin
197        _RL  beta        _RL rSphere
198        REAL viscAh        _RL f0
199        REAL viscAz        _RL beta
200        REAL viscA4        _RL viscAh
201        REAL diffKhT        _RL viscAz
202        REAL diffKzT        _RL viscA4
203        REAL diffK4T        _RL diffKhT
204        REAL diffKhS        _RL diffKzT
205        REAL diffKzS        _RL diffK4T
206        REAL diffK4S        _RL diffKhS
207        REAL delt        _RL diffKzS
208        REAL tauCD        _RL diffK4S
209        REAL rCD        _RL delt
210        REAL tAlpha        _RL tauCD
211        REAL sBeta        _RL rCD
212        REAL gravity        _RL GMmaxslope
213        REAL rhonil        _RL GMlength
214        REAL tRef(Nz)        _RL GMalpha
215        REAL sRef(Nz)        _RL GMdepth
216        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL GMkbackground
217        REAL startTime        _RL gravity
218        REAL endTime        _RL rhonil
219        REAL chkPtFreq        _RL tRef(Nz)
220        REAL dumpFreq        _RL sRef(Nz)
221          _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
222          _RL startTime
223          _RL endTime
224          _RL chkPtFreq
225          _RL pChkPtFreq
226          _RL dumpFreq
227    
228        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
229       &                Lamba_theta       &                Lamba_theta
230        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
231        REAL Lamba_theta        _RL Lamba_theta
232    
233    C Equation of State (polynomial coeffients)
234          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
235          _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)
236    C Linear equation of state
237    C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
238    C     sBeta     - Linear EOS haline contraction coefficient.
239          COMMON /PARM_EOS_LIN/ tAlpha,sBeta
240          _RL tAlpha
241          _RL sBeta
242    
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.7
  ViewVC Help
Powered by ViewVC 1.1.22