/[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.33 by cnh, Wed Oct 28 03:11:36 1998 UTC revision 1.38 by adcroft, Wed May 5 18:32:34 1999 UTC
# 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 55  C     thetaClimFile   - File containing Line 55  C     thetaClimFile   - File containing
55  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
56  C     saltClimFile    - File containing salt climataology used  C     saltClimFile    - File containing salt climataology used
57  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
58    C     surfQfile       - File containing surface heat flux
59    C     EmPmRfile       - File containing surface fresh water flux
60  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation - Flag used to indicate which relation to use to
61  C                        get buoyancy.  C                        get buoyancy.
62        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
63       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
64       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
65       &                saltClimFile, buoyancyRelation       &                saltClimFile, buoyancyRelation,
66         &                EmPmRfile,surfQfile
67        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
68        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
69        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 69  C                        get buoyancy. Line 72  C                        get buoyancy.
72        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
73        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
74        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
75          CHARACTER*(MAX_LEN_FNAM) surfQfile
76          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
77        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
78    
79  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
# Line 88  C     writeStatePrec      - Precision us Line 93  C     writeStatePrec      - Precision us
93  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
94  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
95  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
96    C     nShap               - "Order" of shapiro filter to apply to
97    C                           model prognositic fields.
98    C                           nShap == 1 => del2
99    C                           nShap == 2 => del4
100    C                           nShap == 3 => del6
101    C                           etc...
102    
103        COMMON /PARM_I/        COMMON /PARM_I/
104       &        cg2dMaxIters,       &        cg2dMaxIters,
105       &        cg2dChkResFreq,       &        cg2dChkResFreq,
# Line 96  C     nCheckLev           - Holds curren Line 108  C     nCheckLev           - Holds curren
108       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps,
109       &        numStepsPerPickup,       &        numStepsPerPickup,
110       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
111       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
112         &        nShap
113        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
114        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
115        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 108  C     nCheckLev           - Holds curren Line 121  C     nCheckLev           - Holds curren
121        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
122        INTEGER readBinaryPrec        INTEGER readBinaryPrec
123        INTEGER nCheckLev        INTEGER nCheckLev
124          INTEGER nShap
125    
126  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
127  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
128  C                          coordinate frame.  C                          coordinate frame.
129  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
130  C                               spherical polar frame.  C                               spherical polar frame.
131    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
132    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
133  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
134  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
135  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
# Line 153  C     usingPCoords     - Set to indicate Line 169  C     usingPCoords     - Set to indicate
169  C                        coords.  C                        coords.
170  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
171  C                        coords.  C                        coords.
172    C     openBoundaries - Using open-boundaries
173    C     nonHydrostatic - Using non-hydrostatic terms
174    C     globalFiles    - Selects between "global" and "tiled" files
175    C     allowFreezing  - Allows water to freeze and form ice
176        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
177         & no_slip_sides,no_slip_bottom,
178       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
179       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
180       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
# Line 162  C                        coords. Line 183  C                        coords.
183       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
184       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
185       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
186       & periodicExternalForcing, usingPCoords, usingZCoords       & periodicExternalForcing, usingPCoords, usingZCoords,
187         & openBoundaries, nonHydrostatic, globalFiles,
188         & allowFreezing
189        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
190        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
191        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
192          LOGICAL no_slip_sides
193          LOGICAL no_slip_bottom
194        LOGICAL momViscosity        LOGICAL momViscosity
195        LOGICAL momAdvection        LOGICAL momAdvection
196        LOGICAL momForcing        LOGICAL momForcing
# Line 192  C                        coords. Line 217  C                        coords.
217        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
218        LOGICAL usingPCoords        LOGICAL usingPCoords
219        LOGICAL usingZCoords        LOGICAL usingZCoords
220          LOGICAL openBoundaries
221          LOGICAL nonHydrostatic
222          LOGICAL globalFiles
223          LOGICAL allowFreezing
224    
225  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
226  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 314  C                           number times Line 343  C                           number times
343  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
344  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
345  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
346    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
347    C                          circles ( see filter*.F )
348        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
349       & cg3dTargetResidual,       & cg3dTargetResidual,
350       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 332  C                          ( g*rho if ho Line 363  C                          ( g*rho if ho
363       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
364       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
365       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
366       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
367         & latFFTFiltLo
368    
369        _RL cg2dTargetResidual        _RL cg2dTargetResidual
370        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 416  C                          ( g*rho if ho Line 448  C                          ( g*rho if ho
448        _RL externForcingPeriod        _RL externForcingPeriod
449        _RL horiVertRatio        _RL horiVertRatio
450        _RL recip_horiVertRatio        _RL recip_horiVertRatio
451          _RL latFFTFiltLo
452    
453        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
454       &                Lamba_theta       &                Lamba_theta
455        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
456        _RL Lamba_theta        _RL Lamba_theta
457          _RL recip_Cp
458    
459  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
460        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
# Line 433  C     sBeta     - Linear EOS haline cont Line 467  C     sBeta     - Linear EOS haline cont
467        _RL sBeta        _RL sBeta
468        character*(6) eosType        character*(6) eosType
469    
470    C These are input arrays (of integers) that contain the *absolute*
471    C computational index of an open-boundary (OB) point.
472    C A zero (0) element means there is no corresponding OB in that column/row.
473    C The computational coordinate refers to "tracer" cells.
474    C For a northern/southern OB, the OB V point is to the south/north.
475    C For an eastern/western OB, the OB U point is to the west/east.
476    C eg.
477    C     OB_Jnorth(3)=34  means that:
478    C          T( 3 ,34) is a an OB point
479    C          U(3:4,34) is a an OB point
480    C          V( 4 ,34) is a an OB point
481    C while
482    C     OB_Jsouth(3)=1  means that:
483    C          T( 3 ,1) is a an OB point
484    C          U(3:4,1) is a an OB point
485    C          V( 4 ,2) is a an OB point
486    C
487    C For convenience, negative values for Jnorth/Ieast refer to
488    C points relative to the Northern/Eastern edges of the model
489    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
490    C
491          COMMON /PARM_OB/
492         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
493          INTEGER OB_Jnorth(Nx)
494          INTEGER OB_Jsouth(Nx)
495          INTEGER OB_Ieast(Ny)
496          INTEGER OB_Iwest(Ny)
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.38
  ViewVC Help
Powered by ViewVC 1.1.22