/[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.27 by cnh, Mon Aug 24 02:25:01 1998 UTC revision 1.35 by adcroft, Tue Dec 8 19:44:28 1998 UTC
# Line 4  C     /================================= Line 4  C     /=================================
4  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
5  C     | o Header file defining model "parameters".               |  C     | o Header file defining model "parameters".               |
6  C     |==========================================================|  C     |==========================================================|
7  C     | The values from the model's standard input file are      |  C     | The values from the model standard input file are        |
8  C     | stored into the variables held here. Notes describing    |  C     | stored into the variables held here. Notes describing    |
9  C     | the parameters can also be found here.                   |  C     | the parameters can also be found here.                   |
10  C     \==========================================================/  C     \==========================================================/
# Line 26  C                dumping model state. Line 26  C                dumping model state.
26        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 0 )
27        INTEGER precFloat64        INTEGER precFloat64
28        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 1 )
29    C     UNSET_xxx - Used to indicate variables that have not been given a value
30          Real*8 UNSET_FLOAT8
31          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
32          Real*4 UNSET_FLOAT4
33          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
34          _RL    UNSET_RL    
35          PARAMETER ( UNSET_RL     = 1.234567D5 )
36          _RS    UNSET_RS    
37          PARAMETER ( UNSET_RS     = 1.234567E5 )
38          INTEGER UNSET_I
39          PARAMETER ( UNSET_I      = 123456789  )
40    
41  C     Checkpoint data  C     Checkpoint data
42        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
# Line 65  C     cg2dMaxIters        - Maximum numb Line 76  C     cg2dMaxIters        - Maximum numb
76  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
77  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      - Frequency with which to check residual
78  C                           in con. grad solver.  C                           in con. grad solver.
79    C     cg3dMaxIters        - Maximum number of iterations in the
80    C                           three-dimensional con. grad solver.
81    C     cg3dChkResFreq      - Frequency with which to check residual
82    C                           in con. grad solver.
83  C     nIter0              - Start time-step number of for this run  C     nIter0              - Start time-step number of for this run
84  C     nTimeSteps          - Number of timesteps to execute  C     nTimeSteps          - Number of timesteps to execute
85  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     numStepsPerPickup   - For offline setup. Frequency of pickup
# Line 73  C     writeStatePrec      - Precision us Line 88  C     writeStatePrec      - Precision us
88  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
89  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
90  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
91    C     nShap               - "Order" of shapiro filter to apply to
92    C                           model prognositic fields.
93    C                           nShap == 1 => del2
94    C                           nShap == 2 => del4
95    C                           nShap == 3 => del6
96    C                           etc...
97    
98        COMMON /PARM_I/        COMMON /PARM_I/
99       &        cg2dMaxIters,       &        cg2dMaxIters,
100       &        cg2dChkResFreq,       &        cg2dChkResFreq,
101         &        cg3dMaxIters,
102         &        cg3dChkResFreq,
103       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
104       &        numStepsPerPickup,       &        numStepsPerPickup,
105       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
106       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
107         &        nShap
108        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
109        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
110          INTEGER cg3dMaxIters
111          INTEGER cg3dChkResFreq
112        INTEGER nIter0        INTEGER nIter0
113        INTEGER nTimeSteps        INTEGER nTimeSteps
114        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
# Line 89  C     nCheckLev           - Holds curren Line 116  C     nCheckLev           - Holds curren
116        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
117        INTEGER readBinaryPrec        INTEGER readBinaryPrec
118        INTEGER nCheckLev        INTEGER nCheckLev
119          INTEGER nShap
120    
121  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
122  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 130  C                        climatology is Line 158  C                        climatology is
158  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
159  C                        climatology is required.  C                        climatology is required.
160  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing - Set true if forcing is time-dependant
161    C     usingPCoords     - Set to indicate that we are working in pressure
162    C                        coords.
163    C     usingZCoords     - Set to indicate that we are working in height
164    C                        coords.
165    C     openBoundaries - Using open-boundaries
166        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
167       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & momViscosity, momAdvection, momForcing, useCoriolis,
168       & tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
169       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
170       & implicitFreeSurface, rigidLid,       & implicitFreeSurface, rigidLid,
171       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
172       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
173       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
174       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
175       & periodicExternalForcing       & periodicExternalForcing, usingPCoords, usingZCoords,
176         & openBoundaries
177        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
178        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
179        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
# Line 167  C     periodicExternalForcing - Set true Line 201  C     periodicExternalForcing - Set true
201        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
202        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
203        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
204          LOGICAL usingPCoords
205          LOGICAL usingZCoords
206          LOGICAL openBoundaries
207    
208  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
209  C     cg2dTargetResidual  C     cg2dTargetResidual
210  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
211    C     cg3dTargetResidual
212    C               - Target residual for cg3d solver.
213  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
214  C     Note. 20th May 1998  C     Note. 20th May 1998
215  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
# Line 191  C     delR      - Vertical grid spacing Line 230  C     delR      - Vertical grid spacing
230  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
231  C     delY        on input flags.  C     delY        on input flags.
232  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
233    C     recip_gravity and its inverse
234  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
235  C     ronil     - Reference density  C     ronil     - Reference density
236  C     rhoConst  - Vertically constant reference density  C     rhoConst  - Vertically constant reference density
# Line 249  C                    freesurfac = 1. use Line 289  C                    freesurfac = 1. use
289  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
290  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
291  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
292    C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
293  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
294  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
295  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
# Line 282  C     externForcingPeriod - Is the perio Line 323  C     externForcingPeriod - Is the perio
323  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
324  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
325  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
326    C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
327    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
328    C                          ( g*rho if horiz in m and vertical in Pa ).
329    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
330    C                          circles ( see filter*.F )
331        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
332         & cg3dTargetResidual,
333       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
334       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
335       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
336       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
337       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
338       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
339       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
340       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
341       & gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
342       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
343       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
344       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
345       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
346       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
347       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
348       & viscAp, diffKpT, diffKpS, hFacMinDr,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
349       & theta_S, specVol_S       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
350         & latFFTFiltLo
351    
352        _RL cg2dTargetResidual        _RL cg2dTargetResidual
353          _RL cg3dTargetResidual
354        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
355        _RL delZ(Nr)        _RL delZ(Nr)
356        _RL delP(Nr)        _RL delP(Nr)
# Line 321  C                           number times Line 370  C                           number times
370        _RL freeSurfFac        _RL freeSurfFac
371        _RL hFacMin        _RL hFacMin
372        _RL hFacMinDz        _RL hFacMinDz
373          _RL hFacMinDp
374        _RL hFacMinDr        _RL hFacMinDr
375        _RL beta        _RL beta
376        _RL viscAh        _RL viscAh
# Line 348  C                           number times Line 398  C                           number times
398        _RL GMkbackground        _RL GMkbackground
399        _RL GMmaxval        _RL GMmaxval
400        _RL gravity        _RL gravity
401          _RL recip_gravity
402        _RL gBaro        _RL gBaro
403        _RL rhonil        _RL rhonil
404        _RL recip_rhonil        _RL recip_rhonil
# Line 378  C                           number times Line 429  C                           number times
429        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
430        _RL externForcingCycle        _RL externForcingCycle
431        _RL externForcingPeriod        _RL externForcingPeriod
432          _RL horiVertRatio
433          _RL recip_horiVertRatio
434          _RL latFFTFiltLo
435    
436        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,
437       &                Lamba_theta       &                Lamba_theta
# Line 395  C     sBeta     - Linear EOS haline cont Line 449  C     sBeta     - Linear EOS haline cont
449        _RL sBeta        _RL sBeta
450        character*(6) eosType        character*(6) eosType
451    
452    C These are input arrays (of integers) that contain the *absolute*
453    C computational index of an open-boundary (OB) point.
454    C A zero (0) element means there is no corresponding OB in that column/row.
455    C The computational coordinate refers to "tracer" cells.
456    C For a northern/southern OB, the OB V point is to the south/north.
457    C For an eastern/western OB, the OB U point is to the west/east.
458    C eg.
459    C     OB_Jnorth(3)=34  means that:
460    C          T( 3 ,34) is a an OB point
461    C          U(3:4,34) is a an OB point
462    C          V( 4 ,34) is a an OB point
463    C while
464    C     OB_Jsouth(3)=1  means that:
465    C          T( 3 ,1) is a an OB point
466    C          U(3:4,1) is a an OB point
467    C          V( 4 ,2) is a an OB point
468    C
469    C For convenience, negative values for Jnorth/Ieast refer to
470    C points relative to the Northern/Eastern edges of the model
471    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
472    C
473          COMMON /PARM_OB/
474         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
475          INTEGER OB_Jnorth(Nx)
476          INTEGER OB_Jsouth(Nx)
477          INTEGER OB_Ieast(Ny)
478          INTEGER OB_Iwest(Ny)
Legend:
Removed from v.1.27  
changed lines
  Added in v.1.35
  ViewVC Help
Powered by ViewVC 1.1.22