/[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.34 by cnh, Fri Nov 6 22:44:43 1998 UTC revision 1.44 by adcroft, Wed Jun 21 19:21:44 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 100  C                           etc... Line 109  C                           etc...
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,
# Line 111  C                           etc... Line 120  C                           etc...
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
# Line 123  C     usingCartesianGrid - If TRUE grid Line 133  C     usingCartesianGrid - If TRUE grid
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 153  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 162  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 170  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 196  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 290  C     hFacMinDp    - Minimum dimesional Line 318  C     hFacMinDp    - Minimum dimesional
318  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)
319  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
320  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
 C     GMmaxslope    - max. slope allowed in GM/Redi tensor  
 C     GMlength      - Length to use in Visbeck et al. formula for K (m)  
 C     GMalpha       - alpha to use in Visbeck et al. formula for K  
 C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)  
 C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )  
 C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )  
321  C     startTime     - Starting time for this integration ( s ).  C     startTime     - Starting time for this integration ( s ).
322  C     endTime       - Ending time for this integration ( s ).  C     endTime       - Ending time for this integration ( s ).
323  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
# Line 308  C     pfFacMom      - Momentum pressure Line 330  C     pfFacMom      - Momentum pressure
330  C     cfFacMom      - Coriolis term tracer parameter  C     cfFacMom      - Coriolis term tracer parameter
331  C     foFacMom      - Momentum forcing tracer parameter  C     foFacMom      - Momentum forcing tracer parameter
332  C     mtFacMom      - Metric terms tracer parameter  C     mtFacMom      - Metric terms tracer parameter
333    C     cosPower      - Power of cosine of latitude to multiply viscosity
334  C     cAdjFreq      - Frequency of convective adjustment  C     cAdjFreq      - Frequency of convective adjustment
335  C  C
336  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 334  C                          circles ( see Line 357  C                          circles ( see
357       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
358       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
359       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
      & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,  
360       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
361       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
362       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
363       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
364         & cosPower,
365       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
366       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
367       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
368       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
369       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
370       & latFFTFiltLo       & latFFTFiltLo, ivdc_kappa
371    
372        _RL cg2dTargetResidual        _RL cg2dTargetResidual
373        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 388  C                          circles ( see Line 411  C                          circles ( see
411        _RL delt        _RL delt
412        _RL tauCD        _RL tauCD
413        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
       _RL GMmaxval  
414        _RL gravity        _RL gravity
415        _RL recip_gravity        _RL recip_gravity
416        _RL gBaro        _RL gBaro
# Line 418  C                          circles ( see Line 435  C                          circles ( see
435        _RL cfFacMom        _RL cfFacMom
436        _RL foFacMom        _RL foFacMom
437        _RL mTFacMom        _RL mTFacMom
438          _RL cosPower
439        _RL cAdjFreq        _RL cAdjFreq
440        _RL omega        _RL omega
441        _RL tauThetaClimRelax        _RL tauThetaClimRelax
# Line 429  C                          circles ( see Line 447  C                          circles ( see
447        _RL horiVertRatio        _RL horiVertRatio
448        _RL recip_horiVertRatio        _RL recip_horiVertRatio
449        _RL latFFTFiltLo        _RL latFFTFiltLo
450          _RL ivdc_kappa
451    
452        COMMON /PARM_A/ HeatCapacity_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
453       &                Lamba_theta       &                Lamba_theta
454        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
455        _RL Lamba_theta        _RL Lamba_theta
456          _RL recip_Cp
457    
458  C Equation of State (polynomial coeffients)  C Equation of State (polynomial coeffients)
459        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
# Line 446  C     sBeta     - Linear EOS haline cont Line 466  C     sBeta     - Linear EOS haline cont
466        _RL sBeta        _RL sBeta
467        character*(6) eosType        character*(6) eosType
468    
469    C These are input arrays (of integers) that contain the *absolute*
470    C computational index of an open-boundary (OB) point.
471    C A zero (0) element means there is no corresponding OB in that column/row.
472    C The computational coordinate refers to "tracer" cells.
473    C For a northern/southern OB, the OB V point is to the south/north.
474    C For an eastern/western OB, the OB U point is to the west/east.
475    C eg.
476    C     OB_Jnorth(3)=34  means that:
477    C          T( 3 ,34) is a an OB point
478    C          U(3:4,34) is a an OB point
479    C          V( 4 ,34) is a an OB point
480    C while
481    C     OB_Jsouth(3)=1  means that:
482    C          T( 3 ,1) is a an OB point
483    C          U(3:4,1) is a an OB point
484    C          V( 4 ,2) is a an OB point
485    C
486    C For convenience, negative values for Jnorth/Ieast refer to
487    C points relative to the Northern/Eastern edges of the model
488    C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.
489    C
490          COMMON /PARM_OB/
491         & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
492          INTEGER OB_Jnorth(Nx)
493          INTEGER OB_Jsouth(Nx)
494          INTEGER OB_Ieast(Ny)
495          INTEGER OB_Iwest(Ny)
496    
497    C Logical flags for selecting packages
498          LOGICAL use_KPPmixing
499          LOGICAL use_GMRedi
500          COMMON /PARM_PACKAGES/
501         &        use_KPPmixing,use_GMRedi
Legend:
Removed from v.1.34  
changed lines
  Added in v.1.44
  ViewVC Help
Powered by ViewVC 1.1.22