/[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.28 by cnh, Sat Sep 5 17:52:13 1998 UTC revision 1.36 by adcroft, Tue Dec 15 00:20:34 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 23  C     Symbolic values Line 23  C     Symbolic values
23  C     precXXXX - Used to indicate what precision to use for  C     precXXXX - Used to indicate what precision to use for
24  C                dumping model state.  C                dumping model state.
25        INTEGER precFloat32        INTEGER precFloat32
26        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
27        INTEGER precFloat64        INTEGER precFloat64
28        PARAMETER ( precFloat64 = 1 )        PARAMETER ( precFloat64 = 64 )
29  C     UNSET_xxx - Used to indicate variables that have not been given a value  C     UNSET_xxx - Used to indicate variables that have not been given a value
30        Real*8 UNSET_FLOAT8        Real*8 UNSET_FLOAT8
31        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
# Line 76  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 84  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 100  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
123  C                          coordinate frame.  C                          coordinate frame.
124  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
125  C                               spherical polar frame.  C                               spherical polar frame.
126    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
127    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
128  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
129  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
130  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
# Line 141  C                        climatology is Line 160  C                        climatology is
160  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
161  C                        climatology is required.  C                        climatology is required.
162  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing - Set true if forcing is time-dependant
163    C     usingPCoords     - Set to indicate that we are working in pressure
164    C                        coords.
165    C     usingZCoords     - Set to indicate that we are working in height
166    C                        coords.
167    C     openBoundaries - Using open-boundaries
168        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
169       & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,       & no_slip_sides,no_slip_bottom,
170       & tempDiffusion, tempAdvection, tempForcing,       & momViscosity, momAdvection, momForcing, useCoriolis,
171         & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
172       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
173       & implicitFreeSurface, rigidLid,       & implicitFreeSurface, rigidLid,
174       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
175       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
176       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
177       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
178       & periodicExternalForcing       & periodicExternalForcing, usingPCoords, usingZCoords,
179         & openBoundaries
180        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
181        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
182        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
183          LOGICAL no_slip_sides
184          LOGICAL no_slip_bottom
185        LOGICAL momViscosity        LOGICAL momViscosity
186        LOGICAL momAdvection        LOGICAL momAdvection
187        LOGICAL momForcing        LOGICAL momForcing
# Line 178  C     periodicExternalForcing - Set true Line 206  C     periodicExternalForcing - Set true
206        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
207        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
208        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
209          LOGICAL usingPCoords
210          LOGICAL usingZCoords
211          LOGICAL openBoundaries
212    
213  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
214  C     cg2dTargetResidual  C     cg2dTargetResidual
215  C               - Target residual for cg2d solver.  C               - Target residual for cg2d solver.
216    C     cg3dTargetResidual
217    C               - Target residual for cg3d solver.
218  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
219  C     Note. 20th May 1998  C     Note. 20th May 1998
220  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 202  C     delR      - Vertical grid spacing Line 235  C     delR      - Vertical grid spacing
235  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      - Separation between cell faces (m) or (deg), depending
236  C     delY        on input flags.  C     delY        on input flags.
237  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   - Accel. due to gravity ( m/s^2 )
238    C     recip_gravity and its inverse
239  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 )
240  C     ronil     - Reference density  C     ronil     - Reference density
241  C     rhoConst  - Vertically constant reference density  C     rhoConst  - Vertically constant reference density
# Line 294  C     externForcingPeriod - Is the perio Line 328  C     externForcingPeriod - Is the perio
328  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
329  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
330  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
331    C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
332    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
333    C                          ( g*rho if horiz in m and vertical in Pa ).
334    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
335    C                          circles ( see filter*.F )
336        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
337         & cg3dTargetResidual,
338       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
339       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
340       & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
341       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
342       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
343       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
344       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
345       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
346       & gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
347       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
348       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
349       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
# Line 311  C                           number times Line 351  C                           number times
351       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
352       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
353       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
354       & theta_S, specVol_S       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
355         & latFFTFiltLo
356    
357        _RL cg2dTargetResidual        _RL cg2dTargetResidual
358          _RL cg3dTargetResidual
359        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
360        _RL delZ(Nr)        _RL delZ(Nr)
361        _RL delP(Nr)        _RL delP(Nr)
# Line 361  C                           number times Line 403  C                           number times
403        _RL GMkbackground        _RL GMkbackground
404        _RL GMmaxval        _RL GMmaxval
405        _RL gravity        _RL gravity
406          _RL recip_gravity
407        _RL gBaro        _RL gBaro
408        _RL rhonil        _RL rhonil
409        _RL recip_rhonil        _RL recip_rhonil
# Line 391  C                           number times Line 434  C                           number times
434        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
435        _RL externForcingCycle        _RL externForcingCycle
436        _RL externForcingPeriod        _RL externForcingPeriod
437          _RL horiVertRatio
438          _RL recip_horiVertRatio
439          _RL latFFTFiltLo
440    
441        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
442       &                Lamba_theta       &                Lamba_theta
443        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
444        _RL Lamba_theta        _RL Lamba_theta
445          _RL recip_Cp
446    
447  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
448        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
# Line 408  C     sBeta     - Linear EOS haline cont Line 455  C     sBeta     - Linear EOS haline cont
455        _RL sBeta        _RL sBeta
456        character*(6) eosType        character*(6) eosType
457    
458    C These are input arrays (of integers) that contain the *absolute*
459    C computational index of an open-boundary (OB) point.
460    C A zero (0) element means there is no corresponding OB in that column/row.
461    C The computational coordinate refers to "tracer" cells.
462    C For a northern/southern OB, the OB V point is to the south/north.
463    C For an eastern/western OB, the OB U point is to the west/east.
464    C eg.
465    C     OB_Jnorth(3)=34  means that:
466    C          T( 3 ,34) is a an OB point
467    C          U(3:4,34) is a an OB point
468    C          V( 4 ,34) is a an OB point
469    C while
470    C     OB_Jsouth(3)=1  means that:
471    C          T( 3 ,1) is a an OB point
472    C          U(3:4,1) is a an OB point
473    C          V( 4 ,2) is a an OB point
474    C
475    C For convenience, negative values for Jnorth/Ieast refer to
476    C points relative to the Northern/Eastern edges of the model
477    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
478    C
479          COMMON /PARM_OB/
480         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
481          INTEGER OB_Jnorth(Nx)
482          INTEGER OB_Jsouth(Nx)
483          INTEGER OB_Ieast(Ny)
484          INTEGER OB_Iwest(Ny)
Legend:
Removed from v.1.28  
changed lines
  Added in v.1.36
  ViewVC Help
Powered by ViewVC 1.1.22