/[MITgcm]/MITgcm/model/inc/PARAMS.h

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.31 by cnh,
Wed Sep  9 15:04:43 1998 UTC
+revision 1.45 by heimbach,
Mon Sep 11 23:12:20 2000 UTC
 Line 4 
 C     /=================================
  C     | PARAMS.h                                                 |
  C     | o Header file defining model "parameters".               |
  C     |==========================================================|
- C     | The values from the model's standard input file are      |
+ C     | The values from the model standard input file are        |
  C     | stored into the variables held here. Notes describing    |
  C     | the parameters can also be found here.                   |
  C     \==========================================================/
 Line 23 
 C     Symbolic values
  C     precXXXX - Used to indicate what precision to use for
  C                dumping model state.
        INTEGER precFloat32
-       PARAMETER ( precFloat32 = 0 )
+       PARAMETER ( precFloat32 = 32 )
        INTEGER precFloat64
-       PARAMETER ( precFloat64 = 1 )
+       PARAMETER ( precFloat64 = 64 )
  C     UNSET_xxx - Used to indicate variables that have not been given a value
        Real*8 UNSET_FLOAT8
        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
 Line 55 
 C     thetaClimFile   - File containing
  C                       in relaxation term -lambda(theta-theta*)
  C     saltClimFile    - File containing salt climataology used
  C                       in relaxation term -lambda(salt-salt*)
+ C     surfQfile       - File containing surface heat flux
+ C     surfQswfile     - File containing surface shortwave radiation
+ C     EmPmRfile       - File containing surface fresh water flux
  C     buoyancyRelation - Flag used to indicate which relation to use to
  C                        get buoyancy.
        COMMON /PARM_C/ checkPtSuff,
       &                bathyFile, hydrogThetaFile, hydrogSaltFile,
       &                zonalWindFile, meridWindFile, thetaClimFile,
-      &                saltClimFile, buoyancyRelation
+      &                saltClimFile, buoyancyRelation,
+      &                EmPmRfile, surfQfile, surfQswfile,
+      &                uVelInitFile, vVelInitFile, pSurfInitFile
        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
        CHARACTER*(MAX_LEN_FNAM) bathyFile
        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
-Line 69 
 C                        get buoyancy.
+Line 74 
 C                        get buoyancy.
        CHARACTER*(MAX_LEN_FNAM) meridWindFile
        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
        CHARACTER*(MAX_LEN_FNAM) saltClimFile
+       CHARACTER*(MAX_LEN_FNAM) surfQfile
+       CHARACTER*(MAX_LEN_FNAM) surfQswfile
+       CHARACTER*(MAX_LEN_FNAM) EmPmRfile
        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
+       CHARACTER*(MAX_LEN_FNAM) uVelInitFile
+       CHARACTER*(MAX_LEN_FNAM) vVelInitFile
+       CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
  C     cg2dMaxIters        - Maximum number of iterations in the
  C                           two-dimensional con. grad solver.
  C     cg2dChkResFreq      - Frequency with which to check residual
  C                           in con. grad solver.
+ C     cg3dMaxIters        - Maximum number of iterations in the
+ C                           three-dimensional con. grad solver.
+ C     cg3dChkResFreq      - Frequency with which to check residual
+ C                           in con. grad solver.
  C     nIter0              - Start time-step number of for this run
  C     nTimeSteps          - Number of timesteps to execute
  C     numStepsPerPickup   - For offline setup. Frequency of pickup
-Line 84 
 C     writeStatePrec      - Precision us
+Line 99 
 C     writeStatePrec      - Precision us
  C     writeBinaryPrec     - Precision used for writing binary files
  C     readBinaryPrec      - Precision used for reading binary files
  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...
        COMMON /PARM_I/
       &        cg2dMaxIters,
       &        cg2dChkResFreq,
-      &        nIter0, nTimeSteps,
+      &        cg3dMaxIters,
+      &        cg3dChkResFreq,
+      &        nIter0, nTimeSteps, nEndIter,
       &        numStepsPerPickup,
       &        writeStatePrec, nCheckLev,
-      &        writeBinaryPrec, readBinaryPrec
+      &        writeBinaryPrec, readBinaryPrec,
+      &        nShap
        INTEGER cg2dMaxIters
        INTEGER cg2dChkResFreq
+       INTEGER cg3dMaxIters
+       INTEGER cg3dChkResFreq
        INTEGER nIter0
        INTEGER nTimeSteps
+       INTEGER nEndIter
        INTEGER numStepsPerPickup
        INTEGER writeStatePrec
        INTEGER writeBinaryPrec
        INTEGER readBinaryPrec
        INTEGER nCheckLev
+       INTEGER nShap
  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
  C                          coordinate frame.
  C     usingSphericalPolarGrid - If TRUE grid generation will be in a
  C                               spherical polar frame.
+ C     no_slip_sides - Impose "no-slip" at lateral boundaries.
+ C     no_slip_bottom- Impose "no-slip" at bottom boundary.
  C     momViscosity  - Flag which turns momentum friction terms on and off.
  C     momAdvection  - Flag which turns advection of momentum on and off.
  C     momForcing    - Flag which turns external forcing of momentum on
-Line 136 
 C     useConstantF  - Coriolis parameter
+Line 167 
 C     useConstantF  - Coriolis parameter
  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
  C     implicitDiffusion - Turns implicit vertical diffusion on
+ C     implicitViscosity - Turns implicit vertical viscosity on
  C     doThetaClimRelax - Set true if relaxation to temperature
  C                        climatology is required.
  C     doSaltClimRelax  - Set true if relaxation to salinity
-Line 145 
 C     usingPCoords     - Set to indicate
+Line 177 
 C     usingPCoords     - Set to indicate
  C                        coords.
  C     usingZCoords     - Set to indicate that we are working in height
  C                        coords.
+ C     openBoundaries - Using open-boundaries
+ C     nonHydrostatic - Using non-hydrostatic terms
+ C     globalFiles    - Selects between "global" and "tiled" files
+ C     allowFreezing  - Allows water to freeze and form ice
        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
-      & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
+      & no_slip_sides,no_slip_bottom,
-      & tempDiffusion, tempAdvection, tempForcing,
+      & momViscosity, momAdvection, momForcing, useCoriolis,
+      & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
       & saltDiffusion, saltAdvection, saltForcing,
       & implicitFreeSurface, rigidLid,
       & momStepping, tempStepping, saltStepping,
       & metricTerms, usingSphericalPolarMTerms,
       & useConstantF, useBetaPlaneF, useSphereF,
-      & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
+      & implicitDiffusion, implicitViscosity,
-      & periodicExternalForcing, usingPCoords, usingZCoords
+      & doThetaClimRelax, doSaltClimRelax,
+      & periodicExternalForcing, usingPCoords, usingZCoords,
+      & openBoundaries, nonHydrostatic, globalFiles,
+      & allowFreezing
        LOGICAL usingCartesianGrid
        LOGICAL usingSphericalPolarGrid
        LOGICAL usingSphericalPolarMTerms
+       LOGICAL no_slip_sides
+       LOGICAL no_slip_bottom
        LOGICAL momViscosity
        LOGICAL momAdvection
        LOGICAL momForcing
-Line 179 
 C                        coords.
+Line 221 
 C                        coords.
        LOGICAL useBetaPlaneF
        LOGICAL useSphereF
        LOGICAL implicitDiffusion
+       LOGICAL implicitViscosity
        LOGICAL doThetaClimRelax
        LOGICAL doSaltClimRelax
        LOGICAL periodicExternalForcing
        LOGICAL usingPCoords
        LOGICAL usingZCoords
+       LOGICAL openBoundaries
+       LOGICAL nonHydrostatic
+       LOGICAL globalFiles
+       LOGICAL allowFreezing
  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
  C     cg2dTargetResidual
  C               - Target residual for cg2d solver.
+ C     cg3dTargetResidual
+ C               - Target residual for cg3d solver.
  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
  C     Note. 20th May 1998
  C           I made a weird discovery! In the model paper we argue
-Line 208 
 C     delR      - Vertical grid spacing
+Line 257 
 C     delR      - Vertical grid spacing
  C     delX      - Separation between cell faces (m) or (deg), depending
  C     delY        on input flags.
  C     gravity   - Accel. due to gravity ( m/s^2 )
+ C     recip_gravity and its inverse
  C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
  C     ronil     - Reference density
  C     rhoConst  - Vertically constant reference density
-Line 270 
 C     hFacMinDp    - Minimum dimesional
+Line 320 
 C     hFacMinDp    - Minimum dimesional
  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
  C     tauCD        - CD scheme coupling timescale ( 1/s )
  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 )
  C     startTime     - Starting time for this integration ( s ).
  C     endTime       - Ending time for this integration ( s ).
  C     chkPtFreq     - Frequency of rolling check pointing ( s ).
-Line 288 
 C     pfFacMom      - Momentum pressure
+Line 332 
 C     pfFacMom      - Momentum pressure
  C     cfFacMom      - Coriolis term tracer parameter
  C     foFacMom      - Momentum forcing tracer parameter
  C     mtFacMom      - Metric terms tracer parameter
+ C     cosPower      - Power of cosine of latitude to multiply viscosity
  C     cAdjFreq      - Frequency of convective adjustment
  C
  C     taveFreq      - Frequency with which time-averaged model state is written to
-Line 303 
 C                           number times
+Line 348 
 C                           number times
  C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
  C                          ( g*rho if horiz in m and vertical in Pa ).
+ C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
+ C                          circles ( see filter*.F )
        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
+      & cg3dTargetResidual,
       & delP, delZ, delR, delX, delY,
-      & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
+      & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
-      & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
+      & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
       & viscAh,  viscAz,  viscA4,  viscAr,
       & diffKhT, diffKzT, diffK4T, diffKrT,
       & diffKhS, diffKzS, diffK4S, diffKrS,
       & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
-      & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
+      & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
-      & gravity, gBaro, rhonil, recip_rhonil,
       & recip_rhoConst, rhoConst, tRef, sRef,
       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
+      & cosPower,
       & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
       & tauSaltClimRelax, lambdaSaltClimRelax,
       & externForcingCycle, externForcingPeriod,
       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
-      & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio
+      & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
+      & latFFTFiltLo, ivdc_kappa
        _RL cg2dTargetResidual
+       _RL cg3dTargetResidual
        _RL cg2dpcOffDFac
        _RL delZ(Nr)
        _RL delP(Nr)
-Line 363 
 C                          ( g*rho if ho
+Line 413 
 C                          ( g*rho if ho
        _RL delt
        _RL tauCD
        _RL rCD
-       _RL GMmaxslope
-       _RL GMlength
-       _RL GMalpha
-       _RL GMdepth
-       _RL GMkbackground
-       _RL GMmaxval
        _RL gravity
+       _RL recip_gravity
        _RL gBaro
        _RL rhonil
        _RL recip_rhonil
-Line 392 
 C                          ( g*rho if ho
+Line 437 
 C                          ( g*rho if ho
        _RL cfFacMom
        _RL foFacMom
        _RL mTFacMom
+       _RL cosPower
        _RL cAdjFreq
        _RL omega
        _RL tauThetaClimRelax
-Line 402 
 C                          ( g*rho if ho
+Line 448 
 C                          ( g*rho if ho
        _RL externForcingPeriod
        _RL horiVertRatio
        _RL recip_horiVertRatio
+       _RL latFFTFiltLo
+       _RL ivdc_kappa
-       COMMON /PARM_A/ HeatCapacity_Cp,
+       COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
       &                Lamba_theta
        _RL HeatCapacity_Cp
        _RL Lamba_theta
+       _RL recip_Cp
  C Equation of State (polynomial coeffients)
        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
-Line 419 
 C     sBeta     - Linear EOS haline cont
+Line 468 
 C     sBeta     - Linear EOS haline cont
        _RL sBeta
        character*(6) eosType
+ 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)
+ C Logical flags for selecting packages
+       LOGICAL useKPP
+       LOGICAL useGMRedi
+       LOGICAL useECCO
+       COMMON /PARM_PACKAGES/
+      &        useKPP, useGMRedi, useECCO

 Legend:



Removed from v.1.31
 


changed lines


 
Added in v.1.45
 Legend:



Removed from v.1.31
 


changed lines


 
Added in v.1.45
-Removed from v.1.31
+Added in v.1.45

	ViewVC Help
Powered by ViewVC 1.1.22