/[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.45 by heimbach, Mon Sep 11 23:12:20 2000 UTC revision 1.49.2.3 by jmc, Fri Apr 6 12:59:45 2001 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  C     /==========================================================\
5  C     | PARAMS.h                                                 |  C     | PARAMS.h                                                 |
# Line 115  C                           etc... Line 116  C                           etc...
116       &        numStepsPerPickup,       &        numStepsPerPickup,
117       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
118       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
119       &        nShap       &        nShap, zonal_filt_sinpow, zonal_filt_cospow
120        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
121        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
122        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 129  C                           etc... Line 130  C                           etc...
130        INTEGER readBinaryPrec        INTEGER readBinaryPrec
131        INTEGER nCheckLev        INTEGER nCheckLev
132        INTEGER nShap        INTEGER nShap
133          INTEGER zonal_filt_sinpow
134          INTEGER zonal_filt_cospow
135    
136  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
137  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
# Line 137  C     usingSphericalPolarGrid - If TRUE Line 140  C     usingSphericalPolarGrid - If TRUE
140  C                               spherical polar frame.  C                               spherical polar frame.
141  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides - Impose "no-slip" at lateral boundaries.
142  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom- Impose "no-slip" at bottom boundary.
143    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
144  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
145  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
146  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    - Flag which turns external forcing of momentum on
# Line 158  C     saltAdvection - Flag which turns a Line 162  C     saltAdvection - Flag which turns a
162  C                     and off.  C                     and off.
163  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
164  C                     and off.  C                     and off.
 C     implicitFreeSurface - Set to true to use implcit free surface  
165  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
166    C     implicitFreeSurface - Set to true to use implcit free surface
167    C     exactConserv   -   Set to true to conserve exactly the total Volume
168    C     nonlinFreeSurf -   Set to true to use non-linear free surface
169  C     momStepping   - Turns momentum equation time-stepping off  C     momStepping   - Turns momentum equation time-stepping off
170  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  - Turns temperature equation time-stepping off
171  C     saltStepping  - Turns salinity equation time-stepping off  C     saltStepping  - Turns salinity equation time-stepping off
# Line 177  C     usingPCoords     - Set to indicate Line 183  C     usingPCoords     - Set to indicate
183  C                        coords.  C                        coords.
184  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
185  C                        coords.  C                        coords.
 C     openBoundaries - Using open-boundaries  
186  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic - Using non-hydrostatic terms
187  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    - Selects between "global" and "tiled" files
188  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  - Allows water to freeze and form ice
189    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
190        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
191         & usingCurvilinearGrid,
192       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
193         & staggerTimeStep,
194       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
195       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,       & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
196       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
197       & implicitFreeSurface, rigidLid,       & rigidLid, implicitFreeSurface, exactConserv, nonlinFreeSurf,
198       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
199       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
200       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
201       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
202       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
203       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing, usingPCoords, usingZCoords,
204       & openBoundaries, nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
205       & allowFreezing       & allowFreezing, groundAtK1
206        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
207        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
208          LOGICAL usingCurvilinearGrid
209        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
210        LOGICAL no_slip_sides        LOGICAL no_slip_sides
211        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
212          LOGICAL staggerTimeStep
213        LOGICAL momViscosity        LOGICAL momViscosity
214        LOGICAL momAdvection        LOGICAL momAdvection
215        LOGICAL momForcing        LOGICAL momForcing
# Line 211  C     allowFreezing  - Allows water to f Line 221  C     allowFreezing  - Allows water to f
221        LOGICAL saltDiffusion        LOGICAL saltDiffusion
222        LOGICAL saltAdvection        LOGICAL saltAdvection
223        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
224        LOGICAL rigidLid        LOGICAL rigidLid
225          LOGICAL implicitFreeSurface
226          LOGICAL exactConserv
227          LOGICAL nonlinFreeSurf
228        LOGICAL momStepping        LOGICAL momStepping
229        LOGICAL tempStepping        LOGICAL tempStepping
230        LOGICAL saltStepping        LOGICAL saltStepping
# Line 227  C     allowFreezing  - Allows water to f Line 239  C     allowFreezing  - Allows water to f
239        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
240        LOGICAL usingPCoords        LOGICAL usingPCoords
241        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
242        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
243        LOGICAL globalFiles        LOGICAL globalFiles
244        LOGICAL allowFreezing        LOGICAL allowFreezing
245          LOGICAL groundAtK1
246    
247  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
248  C     cg2dTargetResidual  C     gg2dTargetResidual
249  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
250    C     cg2dTargetResWunit
251    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
252  C     cg3dTargetResidual  C     cg3dTargetResidual
253  C               - Target residual for cg3d solver.  C               - Target residual for cg3d solver.
254  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
# Line 314  C     deltaTtracer - Timestep for tracer Line 328  C     deltaTtracer - Timestep for tracer
328  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
329  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
330  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
331    C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
332    C                     Implicit part of Surface Pressure Gradient ( 0-1 )
333    C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
334    C                     Implicit part of barotropic flow Divergence ( 0-1 )
335  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
336  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
337  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
338  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)
339    C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
340    C     hFacSup        that control vanishing and creating levels
341  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
342  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
343  C     startTime     - Starting time for this integration ( s ).  C     startTime     - Starting time for this integration ( s ).
# Line 350  C     recip_horiVertRatio  ( 1 if horiz Line 370  C     recip_horiVertRatio  ( 1 if horiz
370  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
371  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
372  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
373        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,  C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
374       & cg3dTargetResidual,  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
375    C     bottomDragLinear   - Drag coefficient built in to core dynamics
376    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
377          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
378         & cg2dpcOffDFac, cg3dTargetResidual,
379       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
380       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
381       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
382         & fCori, fCoriG,
383       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
384       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
385       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
386       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
387         & hFacMin, hFacMinDz, hFacInf, hFacSup,
388       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
389       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
390       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
# Line 369  C                          circles ( see Line 395  C                          circles ( see
395       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
396       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
397       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
398       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
399         & bottomDragLinear,bottomDragQuadratic
400    
401        _RL cg2dTargetResidual        _RL cg2dTargetResidual
402          _RL cg2dTargetResWunit
403        _RL cg3dTargetResidual        _RL cg3dTargetResidual
404        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
405        _RL delZ(Nr)        _RL delZ(Nr)
# Line 390  C                          circles ( see Line 418  C                          circles ( see
418        _RL recip_RSphere        _RL recip_RSphere
419        _RL f0        _RL f0
420        _RL freeSurfFac        _RL freeSurfFac
421          _RL implicSurfPress
422          _RL implicDiv2Dflow
423        _RL hFacMin        _RL hFacMin
424        _RL hFacMinDz        _RL hFacMinDz
425        _RL hFacMinDp        _RL hFacMinDp
426        _RL hFacMinDr        _RL hFacMinDr
427          _RL hFacInf
428          _RL hFacSup
429        _RL beta        _RL beta
430        _RL viscAh        _RL viscAh
431        _RL viscAz        _RL viscAz
# Line 424  C                          circles ( see Line 456  C                          circles ( see
456        _RL tRef(Nr)        _RL tRef(Nr)
457        _RL theta_S(Nr)        _RL theta_S(Nr)
458        _RL sRef(Nr)        _RL sRef(Nr)
459        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
460          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
461        _RL startTime        _RL startTime
462        _RL endTime        _RL endTime
463        _RL chkPtFreq        _RL chkPtFreq
# Line 450  C                          circles ( see Line 483  C                          circles ( see
483        _RL recip_horiVertRatio        _RL recip_horiVertRatio
484        _RL latFFTFiltLo        _RL latFFTFiltLo
485        _RL ivdc_kappa        _RL ivdc_kappa
486          _RL Ro_SeaLevel
487          _RL zonal_filt_lat
488          _RL bottomDragLinear
489          _RL bottomDragQuadratic
490    
491        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
492       &                Lamba_theta       &                Lamba_theta
# Line 468  C     sBeta     - Linear EOS haline cont Line 505  C     sBeta     - Linear EOS haline cont
505        _RL sBeta        _RL sBeta
506        character*(6) eosType        character*(6) eosType
507    
 C These are input arrays (of integers) that contain the *absolute*  
 C computational index of an open-boundary (OB) point.  
 C A zero (0) element means there is no corresponding OB in that column/row.  
 C The computational coordinate refers to "tracer" cells.  
 C For a northern/southern OB, the OB V point is to the south/north.  
 C For an eastern/western OB, the OB U point is to the west/east.  
 C eg.  
 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)  
   
508  C Logical flags for selecting packages  C Logical flags for selecting packages
509        LOGICAL useKPP        LOGICAL useKPP
510        LOGICAL useGMRedi        LOGICAL useGMRedi
511          LOGICAL useOBCS
512          LOGICAL useAIM
513        LOGICAL useECCO        LOGICAL useECCO
514        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
515       &        useKPP, useGMRedi, useECCO       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO
516    
Legend:
Removed from v.1.45  
changed lines
  Added in v.1.49.2.3
  ViewVC Help
Powered by ViewVC 1.1.22