/[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.41 by adcroft, Thu Aug 26 17:47:37 1999 UTC revision 1.45.2.6 by adcroft, Tue Jan 30 21:02:58 2001 UTC
# Line 56  C                       in relaxation te Line 56  C                       in relaxation te
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  C     surfQfile       - File containing surface heat flux
59    C     surfQswfile     - File containing surface shortwave radiation
60  C     EmPmRfile       - File containing surface fresh water flux  C     EmPmRfile       - File containing surface fresh water flux
61  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation - Flag used to indicate which relation to use to
62  C                        get buoyancy.  C                        get buoyancy.
# Line 63  C                        get buoyancy. Line 64  C                        get buoyancy.
64       &                bathyFile, hydrogThetaFile, hydrogSaltFile,       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
65       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
66       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
67       &                EmPmRfile,surfQfile       &                EmPmRfile, surfQfile, surfQswfile,
68         &                uVelInitFile, vVelInitFile, pSurfInitFile
69        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
70        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
71        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 73  C                        get buoyancy. Line 75  C                        get buoyancy.
75        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
76        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
77        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
78          CHARACTER*(MAX_LEN_FNAM) surfQswfile
79        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
80        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
81          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
82          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
83          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
84    
85  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
86  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 109  C                           etc... Line 115  C                           etc...
115       &        numStepsPerPickup,       &        numStepsPerPickup,
116       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
117       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
118       &        nShap       &        nShap, zonal_filt_sinpow, zonal_filt_cospow
119        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
120        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
121        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 123  C                           etc... Line 129  C                           etc...
129        INTEGER readBinaryPrec        INTEGER readBinaryPrec
130        INTEGER nCheckLev        INTEGER nCheckLev
131        INTEGER nShap        INTEGER nShap
132          INTEGER zonal_filt_sinpow
133          INTEGER zonal_filt_cospow
134    
135  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
136  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 131  C     usingSphericalPolarGrid - If TRUE Line 139  C     usingSphericalPolarGrid - If TRUE
139  C                               spherical polar frame.  C                               spherical polar frame.
140  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides - Impose "no-slip" at lateral boundaries.
141  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom- Impose "no-slip" at bottom boundary.
142    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
143  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
144  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
145  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
# Line 171  C     usingPCoords     - Set to indicate Line 180  C     usingPCoords     - Set to indicate
180  C                        coords.  C                        coords.
181  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
182  C                        coords.  C                        coords.
 C     openBoundaries - Using open-boundaries  
183  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic - Using non-hydrostatic terms
184  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    - Selects between "global" and "tiled" files
185  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  - Allows water to freeze and form ice
186    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
187        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
188       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
189         & staggerTimeStep,
190       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
191       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
192       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
# Line 187  C     allowFreezing  - Allows water to f Line 197  C     allowFreezing  - Allows water to f
197       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
198       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
199       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
200       & openBoundaries, nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
201       & allowFreezing       & allowFreezing, groundAtK1
202        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
203        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
204        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
205        LOGICAL no_slip_sides        LOGICAL no_slip_sides
206        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
207          LOGICAL staggerTimeStep
208        LOGICAL momViscosity        LOGICAL momViscosity
209        LOGICAL momAdvection        LOGICAL momAdvection
210        LOGICAL momForcing        LOGICAL momForcing
# Line 221  C     allowFreezing  - Allows water to f Line 232  C     allowFreezing  - Allows water to f
232        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
233        LOGICAL usingPCoords        LOGICAL usingPCoords
234        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
235        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
236        LOGICAL globalFiles        LOGICAL globalFiles
237        LOGICAL allowFreezing        LOGICAL allowFreezing
238          LOGICAL groundAtK1
239    
240  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
241  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 314  C     hFacMinDp    - Minimum dimesional Line 325  C     hFacMinDp    - Minimum dimesional
325  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)
326  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
327  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 )  
328  C     startTime     - Starting time for this integration ( s ).  C     startTime     - Starting time for this integration ( s ).
329  C     endTime       - Ending time for this integration ( s ).  C     endTime       - Ending time for this integration ( s ).
330  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
# Line 350  C     recip_horiVertRatio  ( 1 if horiz Line 355  C     recip_horiVertRatio  ( 1 if horiz
355  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
356  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
357  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
358    C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
359    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
360    C     bottomDragLinear   - Drag coefficient built in to core dynamics
361    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
362        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
363       & cg3dTargetResidual,       & cg3dTargetResidual,
364       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
# Line 359  C                          circles ( see Line 368  C                          circles ( see
368       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
369       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
370       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
      & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,  
371       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
372       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
373       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
# Line 370  C                          circles ( see Line 378  C                          circles ( see
378       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
379       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
380       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
381       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
382         & bottomDragLinear,bottomDragQuadratic
383    
384        _RL cg2dTargetResidual        _RL cg2dTargetResidual
385        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 414  C                          circles ( see Line 423  C                          circles ( see
423        _RL delt        _RL delt
424        _RL tauCD        _RL tauCD
425        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
       _RL GMmaxval  
426        _RL gravity        _RL gravity
427        _RL recip_gravity        _RL recip_gravity
428        _RL gBaro        _RL gBaro
# Line 457  C                          circles ( see Line 460  C                          circles ( see
460        _RL recip_horiVertRatio        _RL recip_horiVertRatio
461        _RL latFFTFiltLo        _RL latFFTFiltLo
462        _RL ivdc_kappa        _RL ivdc_kappa
463          _RL Ro_SeaLevel
464          _RL zonal_filt_lat
465          _RL bottomDragLinear
466          _RL bottomDragQuadratic
467    
468        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
469       &                Lamba_theta       &                Lamba_theta
# Line 475  C     sBeta     - Linear EOS haline cont Line 482  C     sBeta     - Linear EOS haline cont
482        _RL sBeta        _RL sBeta
483        character*(6) eosType        character*(6) eosType
484    
485  C These are input arrays (of integers) that contain the *absolute*  C Logical flags for selecting packages
486  C computational index of an open-boundary (OB) point.        LOGICAL useKPP
487  C A zero (0) element means there is no corresponding OB in that column/row.        LOGICAL useGMRedi
488  C The computational coordinate refers to "tracer" cells.        LOGICAL useOBCS
489  C For a northern/southern OB, the OB V point is to the south/north.        LOGICAL useECCO
490  C For an eastern/western OB, the OB U point is to the west/east.        COMMON /PARM_PACKAGES/
491  C eg.       &        useKPP, useGMRedi, useOBCS, useECCO
 C     OB_Jnorth(3)=34  means that:  
 C          T( 3 ,34) is a an OB point  
 C          U(3:4,34) is a an OB point  
 C          V( 4 ,34) is a an OB point  
 C while  
 C     OB_Jsouth(3)=1  means that:  
 C          T( 3 ,1) is a an OB point  
 C          U(3:4,1) is a an OB point  
 C          V( 4 ,2) is a an OB point  
 C  
 C For convenience, negative values for Jnorth/Ieast refer to  
 C points relative to the Northern/Eastern edges of the model  
 C eg. OB_Jnorth(3)=-1  means that the point (3,Ny-1) is a northern O-B.  
 C  
       COMMON /PARM_OB/  
      & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest  
       INTEGER OB_Jnorth(Nx)  
       INTEGER OB_Jsouth(Nx)  
       INTEGER OB_Ieast(Ny)  
       INTEGER OB_Iwest(Ny)  

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.45.2.6

  ViewVC Help
Powered by ViewVC 1.1.22