/[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.40 by adcroft, Wed Jul 28 16:32:03 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 144  C     useConstantF  - Coriolis parameter Line 160  C     useConstantF  - Coriolis parameter
160  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
161  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
162  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
163    C     implicitViscosity - Turns implicit vertical viscosity on
164  C     doThetaClimRelax - Set true if relaxation to temperature  C     doThetaClimRelax - Set true if relaxation to temperature
165  C                        climatology is required.  C                        climatology is required.
166  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
# Line 153  C     usingPCoords     - Set to indicate Line 170  C     usingPCoords     - Set to indicate
170  C                        coords.  C                        coords.
171  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
172  C                        coords.  C                        coords.
173    C     openBoundaries - Using open-boundaries
174    C     nonHydrostatic - Using non-hydrostatic terms
175    C     globalFiles    - Selects between "global" and "tiled" files
176    C     allowFreezing  - Allows water to freeze and form ice
177        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
178         & no_slip_sides,no_slip_bottom,
179       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
180       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
181       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
# Line 161  C                        coords. Line 183  C                        coords.
183       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
184       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
185       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
186       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, implicitViscosity,
187       & periodicExternalForcing, usingPCoords, usingZCoords       & doThetaClimRelax, doSaltClimRelax,
188         & periodicExternalForcing, usingPCoords, usingZCoords,
189         & openBoundaries, nonHydrostatic, globalFiles,
190         & allowFreezing
191        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
192        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
193        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
194          LOGICAL no_slip_sides
195          LOGICAL no_slip_bottom
196        LOGICAL momViscosity        LOGICAL momViscosity
197        LOGICAL momAdvection        LOGICAL momAdvection
198        LOGICAL momForcing        LOGICAL momForcing
# Line 187  C                        coords. Line 214  C                        coords.
214        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
215        LOGICAL useSphereF        LOGICAL useSphereF
216        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
217          LOGICAL implicitViscosity
218        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
219        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
220        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
221        LOGICAL usingPCoords        LOGICAL usingPCoords
222        LOGICAL usingZCoords        LOGICAL usingZCoords
223          LOGICAL openBoundaries
224          LOGICAL nonHydrostatic
225          LOGICAL globalFiles
226          LOGICAL allowFreezing
227    
228  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
229  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 299  C     pfFacMom      - Momentum pressure Line 331  C     pfFacMom      - Momentum pressure
331  C     cfFacMom      - Coriolis term tracer parameter  C     cfFacMom      - Coriolis term tracer parameter
332  C     foFacMom      - Momentum forcing tracer parameter  C     foFacMom      - Momentum forcing tracer parameter
333  C     mtFacMom      - Metric terms tracer parameter  C     mtFacMom      - Metric terms tracer parameter
334    C     cosPower      - Power of cosine of latitude to multiply viscosity
335  C     cAdjFreq      - Frequency of convective adjustment  C     cAdjFreq      - Frequency of convective adjustment
336  C  C
337  C     taveFreq      - Frequency with which time-averaged model state is written to  C     taveFreq      - Frequency with which time-averaged model state is written to
# Line 314  C                           number times Line 347  C                           number times
347  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
348  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
349  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
350    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
351    C                          circles ( see filter*.F )
352        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
353       & cg3dTargetResidual,       & cg3dTargetResidual,
354       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 328  C                          ( g*rho if ho Line 363  C                          ( g*rho if ho
363       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
364       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
365       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
366         & cosPower,
367       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
368       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
369       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
370       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
371       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
372         & latFFTFiltLo
373    
374        _RL cg2dTargetResidual        _RL cg2dTargetResidual
375        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 406  C                          ( g*rho if ho Line 443  C                          ( g*rho if ho
443        _RL cfFacMom        _RL cfFacMom
444        _RL foFacMom        _RL foFacMom
445        _RL mTFacMom        _RL mTFacMom
446          _RL cosPower
447        _RL cAdjFreq        _RL cAdjFreq
448        _RL omega        _RL omega
449        _RL tauThetaClimRelax        _RL tauThetaClimRelax
# Line 416  C                          ( g*rho if ho Line 454  C                          ( g*rho if ho
454        _RL externForcingPeriod        _RL externForcingPeriod
455        _RL horiVertRatio        _RL horiVertRatio
456        _RL recip_horiVertRatio        _RL recip_horiVertRatio
457          _RL latFFTFiltLo
458    
459        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
460       &                Lamba_theta       &                Lamba_theta
461        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
462        _RL Lamba_theta        _RL Lamba_theta
463          _RL recip_Cp
464    
465  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
466        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 473  C     sBeta     - Linear EOS haline cont
473        _RL sBeta        _RL sBeta
474        character*(6) eosType        character*(6) eosType
475    
476    C These are input arrays (of integers) that contain the *absolute*
477    C computational index of an open-boundary (OB) point.
478    C A zero (0) element means there is no corresponding OB in that column/row.
479    C The computational coordinate refers to "tracer" cells.
480    C For a northern/southern OB, the OB V point is to the south/north.
481    C For an eastern/western OB, the OB U point is to the west/east.
482    C eg.
483    C     OB_Jnorth(3)=34  means that:
484    C          T( 3 ,34) is a an OB point
485    C          U(3:4,34) is a an OB point
486    C          V( 4 ,34) is a an OB point
487    C while
488    C     OB_Jsouth(3)=1  means that:
489    C          T( 3 ,1) is a an OB point
490    C          U(3:4,1) is a an OB point
491    C          V( 4 ,2) is a an OB point
492    C
493    C For convenience, negative values for Jnorth/Ieast refer to
494    C points relative to the Northern/Eastern edges of the model
495    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
496    C
497          COMMON /PARM_OB/
498         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
499          INTEGER OB_Jnorth(Nx)
500          INTEGER OB_Jsouth(Nx)
501          INTEGER OB_Ieast(Ny)
502          INTEGER OB_Iwest(Ny)
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.40
  ViewVC Help
Powered by ViewVC 1.1.22