/[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.53 by adcroft, Wed May 30 19:33:18 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 57  C     saltClimFile    - File containing Line 58  C     saltClimFile    - File containing
58  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
59  C     surfQfile       - File containing surface heat flux  C     surfQfile       - File containing surface heat flux
60  C     surfQswfile     - File containing surface shortwave radiation  C     surfQswfile     - File containing surface shortwave radiation
61    C     dQdTfile        - File containing thermal relaxation coefficient
62  C     EmPmRfile       - File containing surface fresh water flux  C     EmPmRfile       - File containing surface fresh water flux
63  C     buoyancyRelation - Flag used to indicate which relation to use to  C     buoyancyRelation - Flag used to indicate which relation to use to
64  C                        get buoyancy.  C                        get buoyancy.
# Line 65  C                        get buoyancy. Line 67  C                        get buoyancy.
67       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
68       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
69       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
70       &                uVelInitFile, vVelInitFile, pSurfInitFile       &                uVelInitFile, vVelInitFile, pSurfInitFile,
71         &                dQdTfile
72        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
73        CHARACTER*(MAX_LEN_FNAM) bathyFile        CHARACTER*(MAX_LEN_FNAM) bathyFile
74        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 81  C                        get buoyancy. Line 84  C                        get buoyancy.
84        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
85        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
86        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
87          CHARACTER*(MAX_LEN_FNAM) dQdTfile
88    
89  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
90  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        - Maximum number of iterations in the
# Line 99  C     writeStatePrec      - Precision us Line 103  C     writeStatePrec      - Precision us
103  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     - Precision used for writing binary files
104  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      - Precision used for reading binary files
105  C     nCheckLev           - Holds current checkpoint level  C     nCheckLev           - Holds current checkpoint level
 C     nShap               - "Order" of shapiro filter to apply to  
 C                           model prognositic fields.  
 C                           nShap == 1 => del2  
 C                           nShap == 2 => del4  
 C                           nShap == 3 => del6  
 C                           etc...  
106    
107        COMMON /PARM_I/        COMMON /PARM_I/
108       &        cg2dMaxIters,       &        cg2dMaxIters,
# Line 115  C                           etc... Line 113  C                           etc...
113       &        numStepsPerPickup,       &        numStepsPerPickup,
114       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
115       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
116       &        nShap       &        zonal_filt_sinpow, zonal_filt_cospow
117        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
118        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
119        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
# Line 128  C                           etc... Line 126  C                           etc...
126        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
127        INTEGER readBinaryPrec        INTEGER readBinaryPrec
128        INTEGER nCheckLev        INTEGER nCheckLev
129        INTEGER nShap        INTEGER zonal_filt_sinpow
130          INTEGER zonal_filt_cospow
131    
132  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
133  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 136  C     usingSphericalPolarGrid - If TRUE
136  C                               spherical polar frame.  C                               spherical polar frame.
137  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     no_slip_sides - Impose "no-slip" at lateral boundaries.
138  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_bottom- Impose "no-slip" at bottom boundary.
139    C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
140  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  - Flag which turns momentum friction terms on and off.
141  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  - Flag which turns advection of momentum on and off.
142  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 158  C     saltAdvection - Flag which turns a
158  C                     and off.  C                     and off.
159  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   - Flag which turns external forcing of salinit on
160  C                     and off.  C                     and off.
 C     implicitFreeSurface - Set to true to use implcit free surface  
161  C     rigidLid            - Set to true to use rigid lid  C     rigidLid            - Set to true to use rigid lid
162    C     implicitFreeSurface - Set to true to use implcit free surface
163    C     exactConserv   -   Set to true to conserve exactly the total Volume
164    C     nonlinFreeSurf -   Set to true to use non-linear free surface
165  C     momStepping   - Turns momentum equation time-stepping off  C     momStepping   - Turns momentum equation time-stepping off
166  C     tempStepping  - Turns temperature equation time-stepping off  C     tempStepping  - Turns temperature equation time-stepping off
167  C     saltStepping  - Turns salinity equation time-stepping off  C     saltStepping  - Turns salinity equation time-stepping off
# Line 177  C     usingPCoords     - Set to indicate Line 179  C     usingPCoords     - Set to indicate
179  C                        coords.  C                        coords.
180  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     - Set to indicate that we are working in height
181  C                        coords.  C                        coords.
 C     openBoundaries - Using open-boundaries  
182  C     nonHydrostatic - Using non-hydrostatic terms  C     nonHydrostatic - Using non-hydrostatic terms
183  C     globalFiles    - Selects between "global" and "tiled" files  C     globalFiles    - Selects between "global" and "tiled" files
184  C     allowFreezing  - Allows water to freeze and form ice  C     allowFreezing  - Allows water to freeze and form ice
185    C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
186        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
187         & usingCurvilinearGrid,
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,
193       & implicitFreeSurface, rigidLid,       & rigidLid, implicitFreeSurface, exactConserv, nonlinFreeSurf,
194       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
195       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
196       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
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         & usePickupBeforeC35
203        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
204        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
205          LOGICAL usingCurvilinearGrid
206        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
207        LOGICAL no_slip_sides        LOGICAL no_slip_sides
208        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
209          LOGICAL staggerTimeStep
210        LOGICAL momViscosity        LOGICAL momViscosity
211        LOGICAL momAdvection        LOGICAL momAdvection
212        LOGICAL momForcing        LOGICAL momForcing
# Line 211  C     allowFreezing  - Allows water to f Line 218  C     allowFreezing  - Allows water to f
218        LOGICAL saltDiffusion        LOGICAL saltDiffusion
219        LOGICAL saltAdvection        LOGICAL saltAdvection
220        LOGICAL saltForcing        LOGICAL saltForcing
       LOGICAL implicitFreeSurface  
221        LOGICAL rigidLid        LOGICAL rigidLid
222          LOGICAL implicitFreeSurface
223          LOGICAL exactConserv
224          LOGICAL nonlinFreeSurf
225        LOGICAL momStepping        LOGICAL momStepping
226        LOGICAL tempStepping        LOGICAL tempStepping
227        LOGICAL saltStepping        LOGICAL saltStepping
# Line 227  C     allowFreezing  - Allows water to f Line 236  C     allowFreezing  - Allows water to f
236        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
237        LOGICAL usingPCoords        LOGICAL usingPCoords
238        LOGICAL usingZCoords        LOGICAL usingZCoords
       LOGICAL openBoundaries  
239        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
240        LOGICAL globalFiles        LOGICAL globalFiles
241        LOGICAL allowFreezing        LOGICAL allowFreezing
242          LOGICAL groundAtK1
243          LOGICAL usePickupBeforeC35
244    
245  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
246  C     cg2dTargetResidual  C     gg2dTargetResidual
247  C               - Target residual for cg2d solver.  C          - Target residual for cg2d solver; no unit (RHS normalisation)
248    C     cg2dTargetResWunit
249    C          - Target residual for cg2d solver; W unit (No RHS normalisation)
250  C     cg3dTargetResidual  C     cg3dTargetResidual
251  C               - Target residual for cg3d solver.  C               - Target residual for cg3d solver.
252  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
# Line 314  C     deltaTtracer - Timestep for tracer Line 326  C     deltaTtracer - Timestep for tracer
326  C     freesurfFac  - Parameter to turn implicit free surface term on or off  C     freesurfFac  - Parameter to turn implicit free surface term on or off
327  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
328  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
329    C     implicSurfPress - parameter of the Crank-Nickelson time stepping :
330    C                     Implicit part of Surface Pressure Gradient ( 0-1 )
331    C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
332    C                     Implicit part of barotropic flow Divergence ( 0-1 )
333  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
334  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
335  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
336  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)
337    C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell
338    C     hFacSup        that control vanishing and creating levels
339  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        - CD scheme coupling timescale ( 1/s )
340  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
341  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 368  C     recip_horiVertRatio  ( 1 if horiz
368  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
369  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude  C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
370  C                          circles ( see filter*.F )  C                          circles ( see filter*.F )
371        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,  C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
372       & cg3dTargetResidual,  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
373    C     bottomDragLinear   - Drag coefficient built in to core dynamics
374    C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
375          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
376         & cg2dpcOffDFac, cg3dTargetResidual,
377       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delX, delY,
378       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
379       & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
380         & fCori, fCoriG,
381       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAh,  viscAz,  viscA4,  viscAr,
382       & diffKhT, diffKzT, diffK4T, diffKrT,       & diffKhT, diffKzT, diffK4T, diffKrT,
383       & diffKhS, diffKzS, diffK4S, diffKrS,       & diffKhS, diffKzS, diffK4S, diffKrS,
384       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
385         & hFacMin, hFacMinDz, hFacInf, hFacSup,
386       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
387       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst, tRef, sRef,
388       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, monitorFreq,
389       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
390       & cosPower,       & cosPower,
391       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
# Line 369  C                          circles ( see Line 393  C                          circles ( see
393       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
394       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
395       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
396       & latFFTFiltLo, ivdc_kappa       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
397         & bottomDragLinear,bottomDragQuadratic
398    
399        _RL cg2dTargetResidual        _RL cg2dTargetResidual
400          _RL cg2dTargetResWunit
401        _RL cg3dTargetResidual        _RL cg3dTargetResidual
402        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
403        _RL delZ(Nr)        _RL delZ(Nr)
# Line 390  C                          circles ( see Line 416  C                          circles ( see
416        _RL recip_RSphere        _RL recip_RSphere
417        _RL f0        _RL f0
418        _RL freeSurfFac        _RL freeSurfFac
419          _RL implicSurfPress
420          _RL implicDiv2Dflow
421        _RL hFacMin        _RL hFacMin
422        _RL hFacMinDz        _RL hFacMinDz
423        _RL hFacMinDp        _RL hFacMinDp
424        _RL hFacMinDr        _RL hFacMinDr
425          _RL hFacInf
426          _RL hFacSup
427        _RL beta        _RL beta
428        _RL viscAh        _RL viscAh
429        _RL viscAz        _RL viscAz
# Line 424  C                          circles ( see Line 454  C                          circles ( see
454        _RL tRef(Nr)        _RL tRef(Nr)
455        _RL theta_S(Nr)        _RL theta_S(Nr)
456        _RL sRef(Nr)        _RL sRef(Nr)
457        _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
458          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
459        _RL startTime        _RL startTime
460        _RL endTime        _RL endTime
461        _RL chkPtFreq        _RL chkPtFreq
462        _RL pChkPtFreq        _RL pChkPtFreq
463        _RL dumpFreq        _RL dumpFreq
464        _RL taveFreq        _RL taveFreq
465          _RL monitorFreq
466        _RL afFacMom        _RL afFacMom
467        _RL vfFacMom        _RL vfFacMom
468        _RL pfFacMom        _RL pfFacMom
# Line 450  C                          circles ( see Line 482  C                          circles ( see
482        _RL recip_horiVertRatio        _RL recip_horiVertRatio
483        _RL latFFTFiltLo        _RL latFFTFiltLo
484        _RL ivdc_kappa        _RL ivdc_kappa
485          _RL Ro_SeaLevel
486          _RL zonal_filt_lat
487          _RL bottomDragLinear
488          _RL bottomDragQuadratic
489    
490        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
491       &                Lamba_theta       &                Lamba_theta
# Line 468  C     sBeta     - Linear EOS haline cont Line 504  C     sBeta     - Linear EOS haline cont
504        _RL sBeta        _RL sBeta
505        character*(6) eosType        character*(6) eosType
506    
 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)  
   
507  C Logical flags for selecting packages  C Logical flags for selecting packages
508        LOGICAL useKPP        LOGICAL useKPP
509        LOGICAL useGMRedi        LOGICAL useGMRedi
510          LOGICAL useOBCS
511          LOGICAL useAIM
512        LOGICAL useECCO        LOGICAL useECCO
513          LOGICAL useSHAP_FILT
514        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
515       &        useKPP, useGMRedi, useECCO       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO, useSHAP_FILT
516    
Legend:
Removed from v.1.45  
changed lines
  Added in v.1.53
  ViewVC Help
Powered by ViewVC 1.1.22