/[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.43 by adcroft, Wed Apr 5 17:52:16 2000 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         &                uVelInitFile, vVelInitFile, pSurfInitFile
68        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
69        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
70        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 69  C                        get buoyancy. Line 73  C                        get buoyancy.
73        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
74        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
75        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
76          CHARACTER*(MAX_LEN_FNAM) surfQfile
77          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
78        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
79          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
80          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
81          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
82    
83  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
84  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 88  C     writeStatePrec      - Precision us Line 97  C     writeStatePrec      - Precision us
97  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
98  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
99  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
100    C     nShap               - "Order" of shapiro filter to apply to
101    C                           model prognositic fields.
102    C                           nShap == 1 => del2
103    C                           nShap == 2 => del4
104    C                           nShap == 3 => del6
105    C                           etc...
106    
107        COMMON /PARM_I/        COMMON /PARM_I/
108       &        cg2dMaxIters,       &        cg2dMaxIters,
109       &        cg2dChkResFreq,       &        cg2dChkResFreq,
110       &        cg3dMaxIters,       &        cg3dMaxIters,
111       &        cg3dChkResFreq,       &        cg3dChkResFreq,
112       &        nIter0, nTimeSteps,       &        nIter0, nTimeSteps, nEndIter,
113       &        numStepsPerPickup,       &        numStepsPerPickup,
114       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
115       &        writeBinaryPrec, readBinaryPrec       &        writeBinaryPrec, readBinaryPrec,
116         &        nShap
117        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
118        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
119        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
120        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
121        INTEGER nIter0        INTEGER nIter0
122        INTEGER nTimeSteps        INTEGER nTimeSteps
123          INTEGER nEndIter
124        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
125        INTEGER writeStatePrec        INTEGER writeStatePrec
126        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
127        INTEGER readBinaryPrec        INTEGER readBinaryPrec
128        INTEGER nCheckLev        INTEGER nCheckLev
129          INTEGER nShap
130    
131  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
132  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
133  C                          coordinate frame.  C                          coordinate frame.
134  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
135  C                               spherical polar frame.  C                               spherical polar frame.
136    C     no_slip_sides - Impose "no-slip" at lateral boundaries.
137    C     no_slip_bottom- Impose "no-slip" at bottom boundary.
138  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
139  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
140  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 165  C     useConstantF  - Coriolis parameter
165  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
166  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
167  C     implicitDiffusion - Turns implicit vertical diffusion on  C     implicitDiffusion - Turns implicit vertical diffusion on
168    C     implicitViscosity - Turns implicit vertical viscosity on
169  C     doThetaClimRelax - Set true if relaxation to temperature  C     doThetaClimRelax - Set true if relaxation to temperature
170  C                        climatology is required.  C                        climatology is required.
171  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  - Set true if relaxation to salinity
# Line 153  C     usingPCoords     - Set to indicate Line 175  C     usingPCoords     - Set to indicate
175  C                        coords.  C                        coords.
176  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
177  C                        coords.  C                        coords.
178    C     openBoundaries - Using open-boundaries
179    C     nonHydrostatic - Using non-hydrostatic terms
180    C     globalFiles    - Selects between "global" and "tiled" files
181    C     allowFreezing  - Allows water to freeze and form ice
182        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
183         & no_slip_sides,no_slip_bottom,
184       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
185       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
186       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
# Line 161  C                        coords. Line 188  C                        coords.
188       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
189       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
190       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
191       & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,       & implicitDiffusion, implicitViscosity,
192       & periodicExternalForcing, usingPCoords, usingZCoords       & doThetaClimRelax, doSaltClimRelax,
193         & periodicExternalForcing, usingPCoords, usingZCoords,
194         & openBoundaries, nonHydrostatic, globalFiles,
195         & allowFreezing
196        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
197        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
198        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
199          LOGICAL no_slip_sides
200          LOGICAL no_slip_bottom
201        LOGICAL momViscosity        LOGICAL momViscosity
202        LOGICAL momAdvection        LOGICAL momAdvection
203        LOGICAL momForcing        LOGICAL momForcing
# Line 187  C                        coords. Line 219  C                        coords.
219        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
220        LOGICAL useSphereF        LOGICAL useSphereF
221        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
222          LOGICAL implicitViscosity
223        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
224        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
225        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
226        LOGICAL usingPCoords        LOGICAL usingPCoords
227        LOGICAL usingZCoords        LOGICAL usingZCoords
228          LOGICAL openBoundaries
229          LOGICAL nonHydrostatic
230          LOGICAL globalFiles
231          LOGICAL allowFreezing
232    
233  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
234  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 299  C     pfFacMom      - Momentum pressure Line 336  C     pfFacMom      - Momentum pressure
336  C     cfFacMom      - Coriolis term tracer parameter  C     cfFacMom      - Coriolis term tracer parameter
337  C     foFacMom      - Momentum forcing tracer parameter  C     foFacMom      - Momentum forcing tracer parameter
338  C     mtFacMom      - Metric terms tracer parameter  C     mtFacMom      - Metric terms tracer parameter
339    C     cosPower      - Power of cosine of latitude to multiply viscosity
340  C     cAdjFreq      - Frequency of convective adjustment  C     cAdjFreq      - Frequency of convective adjustment
341  C  C
342  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 352  C                           number times
352  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
353  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
354  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
355    C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
356    C                          circles ( see filter*.F )
357        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
358       & cg3dTargetResidual,       & cg3dTargetResidual,
359       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 328  C                          ( g*rho if ho Line 368  C                          ( g*rho if ho
368       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
369       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
370       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
371         & cosPower,
372       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
373       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
374       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
375       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
376       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
377         & latFFTFiltLo, ivdc_kappa
378    
379        _RL cg2dTargetResidual        _RL cg2dTargetResidual
380        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 406  C                          ( g*rho if ho Line 448  C                          ( g*rho if ho
448        _RL cfFacMom        _RL cfFacMom
449        _RL foFacMom        _RL foFacMom
450        _RL mTFacMom        _RL mTFacMom
451          _RL cosPower
452        _RL cAdjFreq        _RL cAdjFreq
453        _RL omega        _RL omega
454        _RL tauThetaClimRelax        _RL tauThetaClimRelax
# Line 416  C                          ( g*rho if ho Line 459  C                          ( g*rho if ho
459        _RL externForcingPeriod        _RL externForcingPeriod
460        _RL horiVertRatio        _RL horiVertRatio
461        _RL recip_horiVertRatio        _RL recip_horiVertRatio
462          _RL latFFTFiltLo
463          _RL ivdc_kappa
464    
465        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
466       &                Lamba_theta       &                Lamba_theta
467        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
468        _RL Lamba_theta        _RL Lamba_theta
469          _RL recip_Cp
470    
471  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
472        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 479  C     sBeta     - Linear EOS haline cont
479        _RL sBeta        _RL sBeta
480        character*(6) eosType        character*(6) eosType
481    
482    C These are input arrays (of integers) that contain the *absolute*
483    C computational index of an open-boundary (OB) point.
484    C A zero (0) element means there is no corresponding OB in that column/row.
485    C The computational coordinate refers to "tracer" cells.
486    C For a northern/southern OB, the OB V point is to the south/north.
487    C For an eastern/western OB, the OB U point is to the west/east.
488    C eg.
489    C     OB_Jnorth(3)=34  means that:
490    C          T( 3 ,34) is a an OB point
491    C          U(3:4,34) is a an OB point
492    C          V( 4 ,34) is a an OB point
493    C while
494    C     OB_Jsouth(3)=1  means that:
495    C          T( 3 ,1) is a an OB point
496    C          U(3:4,1) is a an OB point
497    C          V( 4 ,2) is a an OB point
498    C
499    C For convenience, negative values for Jnorth/Ieast refer to
500    C points relative to the Northern/Eastern edges of the model
501    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
502    C
503          COMMON /PARM_OB/
504         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
505          INTEGER OB_Jnorth(Nx)
506          INTEGER OB_Jsouth(Nx)
507          INTEGER OB_Ieast(Ny)
508          INTEGER OB_Iwest(Ny)
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.43
  ViewVC Help
Powered by ViewVC 1.1.22