/[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.5 by adcroft,
Thu Apr 30 13:25:01 1998 UTC
+revision 1.150 by jmc,
Wed Apr  6 18:23:21 2005 UTC
 Line 1
  C $Header$
+ C $Name$
  C
- C     /==========================================================\
- C     | PARAMS.h                                                 |
+ CBOP
- C     | o Header file defining model "parameters".               |
+ C     !ROUTINE: PARAMS.h
- C     |==========================================================|
+ C     !INTERFACE:
- C     | The values from the model's standard input file are      |
+ C     #include PARAMS.h
- C     | stored into the variables held here. Notes describing    |
- C     | the parameters can also be found here.                   |
+ C     !DESCRIPTION:
- C     \==========================================================/
+ C     Header file defining model "parameters".  The values from the
+ C     model standard input file are stored into the variables held
+ C     here. Notes describing the parameters can also be found here.
+ CEOP
+ C     Macros for special grid options
+ #include "PARAMS_MACROS.h"
  C--   Contants
- C     nOBands - No. of offline data time bands
-       INTEGER nOBands
-       PARAMETER ( nOBands = 12 )
  C     Useful physical values
        Real*8 PI
        PARAMETER ( PI    = 3.14159265358979323844D0   )
        Real*8 deg2rad
        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
+ C     Symbolic values
+ C     precXXXX :: Used to indicate what precision to use for
+ C                dumping model state.
+       INTEGER precFloat32
+       PARAMETER ( precFloat32 = 32 )
+       INTEGER precFloat64
+       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 )
+       Real*4 UNSET_FLOAT4
+       PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
+       _RL    UNSET_RL
+       PARAMETER ( UNSET_RL     = 1.234567D5 )
+       _RS    UNSET_RS
+       PARAMETER ( UNSET_RS     = 1.234567E5 )
+       INTEGER UNSET_I
+       PARAMETER ( UNSET_I      = 123456789  )
+ C     Checkpoint data
+       INTEGER maxNoChkptLev
+       PARAMETER ( maxNoChkptLev = 2 )
  C--   COMMON /PARM_C/ Character valued parameters used by the model.
- C     oBandId  - Offline dataset identifiers for different periods.
+ C     checkPtSuff :: List of checkpoint file suffices
-       COMMON /PARM_C/ oBandId
+ C     bathyFile   :: File containing bathymetry. If not defined bathymetry
-       CHARACTER*3 oBandId(nOBands)
+ C                   is taken from inline function.
+ C     topoFile    :: File containing the topography of the surface (unit=m)
+ C                   (mainly used for the atmosphere = ground height).
+ C     hydrogThetaFile :: File containing initial hydrographic data for potential
+ C                       temperature.
+ C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
+ C     zonalWindFile   :: File containing zonal wind data
+ C     meridWindFile   :: File containing meridional wind data
+ C     thetaClimFile   :: File containing theta climataology used
+ 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, excluding SW
+ C                        (old version, kept for backward compatibility)
+ C     surfQnetFile    :: File containing surface net heat flux
+ C     surfQswFile     :: File containing surface shortwave radiation
+ C     dQdTfile        :: File containing thermal relaxation coefficient
+ C     EmPmRfile       :: File containing surface fresh water flux
+ C     saltFluxFile    :: File containing surface salt flux
+ C     pLoadFile       :: File containing pressure loading
+ C     eddyTauxFile    :: File containing zonal Eddy stress data
+ C     eddyTauyFile    :: File containing meridional Eddy stress data
+ C     buoyancyRelation :: Flag used to indicate which relation to use to
+ C                        get buoyancy.
+ C     eosType         :: choose the equation of state:
+ C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
+ C     the_run_name    :: string identifying the name of the model "run"
+       COMMON /PARM_C/ checkPtSuff,
+      &                bathyFile, topoFile,
+      &                hydrogThetaFile, hydrogSaltFile,
+      &                zonalWindFile, meridWindFile, thetaClimFile,
+      &                saltClimFile, buoyancyRelation,
+      &                EmPmRfile, saltFluxFile,
+      &                surfQfile, surfQnetFile, surfQswFile,
+      &                uVelInitFile, vVelInitFile, pSurfInitFile,
+      &                dQdTfile, ploadFile,
+      &                eddyTauxFile, eddyTauyFile,
+      &                eosType, pickupSuff,
+      &                mdsioLocalDir,
+      &                the_run_name
+       CHARACTER*(5) checkPtSuff(maxNoChkptLev)
+       CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
+       CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
+       CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
+       CHARACTER*(MAX_LEN_FNAM) zonalWindFile
+       CHARACTER*(MAX_LEN_FNAM) meridWindFile
+       CHARACTER*(MAX_LEN_FNAM) thetaClimFile
+       CHARACTER*(MAX_LEN_FNAM) saltClimFile
+       CHARACTER*(MAX_LEN_FNAM) surfQfile
+       CHARACTER*(MAX_LEN_FNAM) surfQnetFile
+       CHARACTER*(MAX_LEN_FNAM) surfQswFile
+       CHARACTER*(MAX_LEN_FNAM) EmPmRfile
+       CHARACTER*(MAX_LEN_FNAM) saltFluxFile
+       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
+       CHARACTER*(MAX_LEN_FNAM) uVelInitFile
+       CHARACTER*(MAX_LEN_FNAM) vVelInitFile
+       CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
+       CHARACTER*(MAX_LEN_FNAM) dQdTfile
+       CHARACTER*(MAX_LEN_FNAM) ploadFile
+       CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
+       CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
+       CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
+       CHARACTER*(MAX_LEN_FNAM) the_run_name
+       CHARACTER*(6) eosType
+       CHARACTER*(10) pickupSuff
  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
- C     cg2dMaxIters        - Maximum number of iterations in the
+ C     cg2dMaxIters        :: Maximum number of iterations in the
  C                           two-dimensional con. grad solver.
- C     cg2dChkResFreq      - Frequency with which to check residual
+ C     cg2dChkResFreq      :: Frequency with which to check residual
+ C                           in con. grad solver.
+ C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
+ C                            (non-linear free-surf.)
+ 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     nIter0              :: Start time-step number of for this run
- C     nTimeSteps          - Number of timesteps to execute
+ C     nTimeSteps          :: Number of timesteps to execute
- C     numStepsPerPickup   - For offline setup. Frequency of pickup
+ C     numStepsPerPickup   :: For offline setup. Frequency of pickup
  C                           of flow fields.
+ C     writeStatePrec      :: Precision used for writing model state.
+ C     writeBinaryPrec     :: Precision used for writing binary files
+ C     readBinaryPrec      :: Precision used for reading binary files
+ C     nCheckLev           :: Holds current checkpoint level
+ C     nonlinFreeSurf      :: option related to non-linear free surface
+ C                           =0 Linear free surface ; >0 Non-linear
+ C     select_rStar        :: option related to r* vertical coordinate
+ C                           =0 (default) use r coord. ; > 0 use r*
+ C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
+ C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
+ C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
+ C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
+ C     debugLevel          :: debug level selector: higher -> more writing
        COMMON /PARM_I/
       &        cg2dMaxIters,
-      &        cg2dChkResFreq,
+      &        cg2dChkResFreq, cg2dPreCondFreq,
-      &        nIter0, nTimeSteps,
+      &        cg3dMaxIters,
-      &        numStepsPerPickup
+      &        cg3dChkResFreq,
+      &        nIter0, nTimeSteps, nEndIter,
+      &        numStepsPerPickup,
+      &        writeStatePrec, nCheckLev,
+      &        writeBinaryPrec, readBinaryPrec,
+      &        nonlinFreeSurf, select_rStar,
+      &        tempAdvScheme, tempVertAdvScheme,
+      &        saltAdvScheme, saltVertAdvScheme,
+      &        debugLevel
        INTEGER cg2dMaxIters
        INTEGER cg2dChkResFreq
+       INTEGER cg2dPreCondFreq
+       INTEGER cg3dMaxIters
+       INTEGER cg3dChkResFreq
        INTEGER nIter0
        INTEGER nTimeSteps
+       INTEGER nEndIter
        INTEGER numStepsPerPickup
+       INTEGER writeStatePrec
+       INTEGER writeBinaryPrec
+       INTEGER readBinaryPrec
+       INTEGER nCheckLev
+       INTEGER nonlinFreeSurf
+       INTEGER select_rStar
+       INTEGER tempAdvScheme, tempVertAdvScheme
+       INTEGER saltAdvScheme, saltVertAdvScheme
+       INTEGER debugLevel
+ C
+       INTEGER debLevZero
+       PARAMETER(debLevZero=0)
+       INTEGER debLevA
+       PARAMETER(debLevA=1)
+       INTEGER debLevB
+       PARAMETER(debLevB=2)
  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
- C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
+ 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     usingSphericalPolarGrid :: If TRUE grid generation will be in a
  C                               spherical polar frame.
- C     momViscosity  - Flag which turns momentum friction terms on and off.
+ C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
- C     momAdvection  - Flag which turns advection of momentum on and off.
+ C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
- C     momForcing    - Flag which turns external forcing of momentum on
+ C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
+ C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
+ 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
  C                     and off.
- C     useCoriolis   - Flag which turns the coriolis terms on and off.
+ C     momPressureForcing :: Flag which turns pressure term in momentum equation
- C     tempDiffusion - Flag which turns diffusion of temperature on
+ C                          on and off.
+ C     metricTerms   :: Flag which turns metric terms on or off.
+ C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
+ C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
+ C     useCoriolis   :: Flag which turns the coriolis terms on and off.
+ C     tempAdvection :: Flag which turns advection of temperature on
  C                     and off.
- C     tempAdvection - Flag which turns advection of temperature on
+ C     tempForcing   :: Flag which turns external forcing of temperature on
  C                     and off.
- C     tempForcing   - Flag which turns external forcing of temperature on
+ C     saltAdvection :: Flag which turns advection of salinity on
  C                     and off.
- C     saltDiffusion - Flag which turns diffusion of salinit on
+ C     saltForcing   :: Flag which turns external forcing of salinity on
- C                     and off.
- C     saltAdvection - Flag which turns advection of salinit on
- C                     and off.
- C     saltForcing   - Flag which turns external forcing of salinit on
  C                     and off.
+ C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
+ C                         as a real Fresh Water (=> changes the Sea Level)
+ C                         if F, converts P+R-E to salt flux (no SL effect)
+ C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable
+ C                       on irregular grids)
+ C     rigidLid            :: Set to true to use rigid lid
+ C     implicitFreeSurface :: Set to true to use implcit free surface
+ C     exactConserv        :: Set to true to conserve exactly the total Volume
+ C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
+ C                           linear relation Phi_surf = Bo_surf*eta
+ C     momStepping   :: Turns momentum equation time-stepping off
+ C     tempStepping  :: Turns temperature equation time-stepping off
+ C     saltStepping  :: Turns salinity equation time-stepping off
+ C     useConstantF  :: Coriolis parameter set to f0
+ C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
+ C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
+ C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
+ C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
+ C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
+ C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
+ C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
+ C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
+ C     useAbsVorticity :: work with f+zeta in Coriolis terms
+ C     implicitDiffusion :: Turns implicit vertical diffusion on
+ C     implicitViscosity :: Turns implicit vertical viscosity on
+ C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
+ C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
+ C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
+ C     multiDimAdvection :: Flag that enable multi-dimension advection
+ C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
+ C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
+ C                      out off Adams-Bashforth time stepping.
+ C     doThetaClimRelax :: Set true if relaxation to temperature
+ C                        climatology is required.
+ C     doSaltClimRelax  :: Set true if relaxation to salinity
+ C                        climatology is required.
+ C     periodicExternalForcing :: Set true if forcing is time-dependant
+ C     usingPCoords     :: Set to indicate that we are working in a pressure
+ C                        type coordinate (p or p*).
+ C     usingZCoords     :: Set to indicate that we are working in a height
+ C                        type coordinate (z or z*)
+ C     fluidIsAir       :: Set to indicate that the fluid major constituent
+ C                        is air
+ C     fluidIsWater     :: Set to indicate that the fluid major constituent
+ C                        is water
+ C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
+ C                         this requires specific code for restart & exchange
+ C     setCenterDr    :: set cell Center depth and put Interface at the middle
+ C     nonHydrostatic :: Using non-hydrostatic terms
+ C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
+ C     globalFiles    :: Selects between "global" and "tiled" files
+ C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
+ C                       slow (f77) or does not work (f90).  When
+ C                       useSingleCpuIO is set, mdsio_writefield.F
+ C                       outputs from master mpi process only.
+ C     allowFreezing  :: Allows surface water to freeze and form ice
+ C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
+ C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
+ C     pickup_write_mdsio :: use mdsio to write pickups
+ C     pickup_read_mdsio  :: use mdsio to read  pickups
+ C     pickup_write_immed :: echo the pickup immediately (for conversion)
+ C     timeave_mdsio      :: use mdsio for timeave output
+ C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
+ C     seaice_mdsio       :: use mdsio for seaice output
+ C     monitor_stdio      :: use stdio for monitor output
+ C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
+ C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
+ C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
+ C                      calendar months and years.  Requires pkg/cal.
        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
-      & momViscosity, momAdvection, momForcing, useCoriolis,
+      & usingCurvilinearGrid, usingCylindricalGrid,
-      & tempDiffusion, tempAdvection, tempForcing,
+      & no_slip_sides,no_slip_bottom,
-      & saltDiffusion, saltAdvection, saltForcing
+      & staggerTimeStep,
+      & momViscosity, momAdvection, momForcing, useCoriolis,
+      & momPressureForcing, vectorInvariantMomentum,
+      & tempAdvection, tempForcing,
+      & saltAdvection, saltForcing,
+      & useRealFreshWaterFlux,
+      & useFullLeith,
+      & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
+      & momStepping, tempStepping, saltStepping,
+      & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
+      & useConstantF, useBetaPlaneF, useSphereF,
+      & useCDscheme,
+      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
+      & SadournyCoriolis, upwindVorticity, highOrderVorticity,
+      & useAbsVorticity,
+      & implicitDiffusion, implicitViscosity,
+      & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
+      & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
+      & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
+      & periodicExternalForcing,
+      & fluidIsAir, fluidIsWater,
+      & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
+      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
+      & allowFreezing, useOldFreezing, groundAtK1,
+      & usePickupBeforeC35, usePickupBeforeC54, debugMode,
+      & readPickupWithTracer, writePickupWithTracer,
+      & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
+      & timeave_mdsio, snapshot_mdsio, monitor_stdio, seaice_mdsio,
+      & outputTypesInclusive,
+      & inAdMode, inAdTrue, inAdFalse, inAdExact,
+      & calendarDumps
        LOGICAL usingCartesianGrid
        LOGICAL usingSphericalPolarGrid
+       LOGICAL usingCylindricalGrid
+       LOGICAL usingCurvilinearGrid
+       LOGICAL usingSphericalPolarMTerms
+       LOGICAL useNHMTerms
+       LOGICAL no_slip_sides
+       LOGICAL no_slip_bottom
+       LOGICAL staggerTimeStep
        LOGICAL momViscosity
        LOGICAL momAdvection
        LOGICAL momForcing
+       LOGICAL momPressureForcing
        LOGICAL useCoriolis
-       LOGICAL tempDiffusion
+       LOGICAL vectorInvariantMomentum
        LOGICAL tempAdvection
        LOGICAL tempForcing
-       LOGICAL saltDiffusion
        LOGICAL saltAdvection
        LOGICAL saltForcing
+       LOGICAL useRealFreshWaterFlux
+       LOGICAL useFullLeith
+       LOGICAL rigidLid
+       LOGICAL implicitFreeSurface
+       LOGICAL exactConserv
+       LOGICAL uniformLin_PhiSurf
+       LOGICAL momStepping
+       LOGICAL tempStepping
+       LOGICAL saltStepping
+       LOGICAL metricTerms
+       LOGICAL useConstantF
+       LOGICAL useBetaPlaneF
+       LOGICAL useSphereF
+       LOGICAL useCDscheme
+       LOGICAL useEnergyConservingCoriolis
+       LOGICAL useJamartWetPoints
+       LOGICAL useJamartMomAdv
+       LOGICAL SadournyCoriolis
+       LOGICAL upwindVorticity
+       LOGICAL highOrderVorticity
+       LOGICAL useAbsVorticity
+       LOGICAL implicitDiffusion
+       LOGICAL implicitViscosity
+       LOGICAL tempImplVertAdv
+       LOGICAL saltImplVertAdv
+       LOGICAL momImplVertAdv
+       LOGICAL multiDimAdvection
+       LOGICAL useMultiDimAdvec
+       LOGICAL forcing_In_AB
+       LOGICAL doThetaClimRelax
+       LOGICAL doSaltClimRelax
+       LOGICAL doTr1ClimRelax
+       LOGICAL periodicExternalForcing
+       LOGICAL fluidIsAir
+       LOGICAL fluidIsWater
+       LOGICAL usingPCoords
+       LOGICAL usingZCoords
+       LOGICAL useDynP_inEos_Zc
+       LOGICAL setCenterDr
+       LOGICAL nonHydrostatic
+       LOGICAL quasiHydrostatic
+       LOGICAL globalFiles
+       LOGICAL useSingleCpuIO
+       LOGICAL allowFreezing
+       LOGICAL useOldFreezing
+       LOGICAL groundAtK1
+       LOGICAL usePickupBeforeC35
+       LOGICAL usePickupBeforeC54
+       LOGICAL debugMode
+       LOGICAL readPickupWithTracer
+       LOGICAL writePickupWithTracer
+       LOGICAL pickup_read_mdsio, pickup_write_mdsio
+       LOGICAL pickup_write_immed
+       LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
+       LOGICAL seaice_mdsio
+       LOGICAL outputTypesInclusive
+       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
+       LOGICAL calendarDumps
  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
  C     cg2dTargetResidual
- C               - Target residual for cg2d solver.
+ C          :: Target residual for cg2d solver; no unit (RHS normalisation)
- C     delZ      - Vertical grid spacing ( m ) - delZ is the distance
+ C     cg2dTargetResWunit
- C                 between "w" surfaces.
+ C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
- C     delX      - Separation between cell faces (m) or (deg), depending
+ 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
+ C           for the form of the preconditioner used here ( see
+ C           A Finite-volume, Incompressible Navier-Stokes Model
+ C           ...., Marshall et. al ). The algebra gives a simple
+ C           0.5 factor for the averaging of ac and aCw to get a
+ C           symmettric pre-conditioner. By using a factor of 0.51
+ C           i.e. scaling the off-diagonal terms in the
+ C           preconditioner down slightly I managed to get the
+ C           number of iterations for convergence in a test case to
+ C           drop form 192 -> 134! Need to investigate this further!
+ C           For now I have introduced a parameter cg2dpcOffDFac which
+ C           defaults to 0.51 but can be set at runtime.
+ C     delR      :: Vertical grid spacing ( units of r ).
+ C     delRc     :: Vertical grid spacing between cell centers (r unit).
+ 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     gravity   :: Accel. due to gravity ( m/s^2 )
- C     ronil     - Reference density
+ C     recip_gravity and its inverse
- C     startTime - Start time for model ( s )
+ C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
- C     phiMin    - Latitude of southern most cell face.
+ C     rhoNil    :: Reference density for the linear equation of state
- C     thetaMin  - Longitude of western most cell face (this
+ C     rhoConst  :: Vertically constant reference density
+ C     rhoConstFresh :: Constant reference density for fresh water (rain)
+ C     tRef      :: reference vertical profile for potential temperature
+ C     sRef      :: reference vertical profile for salinity/specific humidity
+ C     phiMin    :: Latitude of southern most cell face.
+ C     thetaMin  :: Longitude of western most cell face (this
  C                 is an "inert" parameter but it is included
  C                 to make geographical references simple.)
- C     rSphere   - Radius of sphere for a spherical polar grid ( m ).
+ C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
- C     f0        - Reference coriolis parameter ( 1/s )
+ C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
+ C     f0        :: Reference coriolis parameter ( 1/s )
  C                 ( Southern edge f for beta plane )
- C     beta      - df/dy ( s^-1.m^-1 )
+ C     beta      :: df/dy ( s^-1.m^-1 )
- C     viscAh    - Eddy viscosity coeff. for mixing of
+ C     omega     :: Angular velocity ( rad/s )
+ C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
+ C     viscAh    :: Eddy viscosity coeff. for mixing of
  C                 momentum laterally ( m^2/s )
- C     viscAz    - Eddy viscosity coeff. for mixing of
+ C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
- C                 momentum vertically ( m^2/s )
+ C                 momentum laterally, no effect for hydrostatic
- C     viscA4    - Biharmonic viscosity coeff. for mixing of
+ C                 model, defaults to viscAh if unset ( m^2/s )
+ C     viscAr    :: Eddy viscosity coeff. for mixing of
+ C                 momentum vertically ( units of r^2/s )
+ C     viscA4    :: Biharmonic viscosity coeff. for mixing of
  C                 momentum laterally ( m^4/s )
- C     diffKhT   - Laplacian diffusion coeff. for mixing of
+ C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
+ C                 momentum laterally, no effect for hydrostatic
+ C                 model, defaults to viscA4 if unset ( m^2/s )
+ C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
+ C                  (act on Divergence part) ( m^2/s )
+ C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
+ C                  (act on Vorticity  part) ( m^2/s )
+ C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
+ C                  (act on Divergence part) ( m^4/s )
+ C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
+ C                  (act on Vorticity  part) ( m^4/s )
+ C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
+ C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
+ C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor
+ C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
+ C                 momentum laterally ( m^2/s )
+ C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
+ C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity
+ C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
+ C                 momentum laterally ( m^4/s )
+ C     viscAhGrid:: non-dimensional grid-size dependent viscosity
+ C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
+ C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
+ C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
+ C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
+ C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
+ C     diffKhT   :: Laplacian diffusion coeff. for mixing of
  C                 heat laterally ( m^2/s )
- C     diffKzT   - Laplacian diffusion coeff. for mixing of
+ C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
- C                 heat vertically ( m^2/s )
+ C                 for mixing of heat vertically ( units of r^2/s )
- C     diffK4T   - Biharmonic diffusion coeff. for mixing of
+ C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
  C                 heat laterally ( m^4/s )
- C     diffKhS  -  Laplacian diffusion coeff. for mixing of
+ C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
  C                 salt laterally ( m^2/s )
- C     diffKzS   - Laplacian diffusion coeff. for mixing of
+ C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
- C                 salt vertically ( m^2/s )
+ C                 for mixing of salt vertically ( units of r^2/s ),
- C     diffK4S   - Biharmonic diffusion coeff. for mixing of
+ C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
  C                 salt laterally ( m^4/s )
- C     deltaT    - Default timestep ( s )
+ C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
- C     deltaTMom    - Timestep for momemtum equations ( s )
+ C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
- C     deltaTtracer - Timestep for tracer equations ( s )
+ C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
- C     tauCD     - CD scheme coupling timescale ( 1/s )
+ C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
- C     rCD       - CD scheme normalised coupling parameter ( 0-1 )
+ C     deltaT    :: Default timestep ( s )
- C     startTime - Starting time for this integration ( s ).
+ C     deltaTClock  :: Timestep used as model "clock". This determines the
- C     endTime   - Ending time for this integration ( s ).
+ C                    IO frequencies and is used in tagging output. It can
- C     chkPtFreq - Frequency of check pointing ( s ).
+ C                    be totally different to the dynamical time. Typically
- C     dumpFreq  - Frequency with which model state is written to
+ C                    it will be the deep-water timestep for accelerated runs.
- C                 post-processing files ( s ).
+ C                    Frequency of checkpointing and dumping of the model state
-       COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,
+ C                    are referenced to this clock. ( s )
-      & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,
+ C     deltaTMom    :: Timestep for momemtum equations ( s )
-      & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,
+ C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
-      & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,
+ C     deltaTfreesurf :: Timestep for free-surface equation ( s )
-      & gravity, rhonil, tRef, sRef,
+ C     freesurfFac  :: Parameter to turn implicit free surface term on or off
-      & endTime, chkPtFreq, dumpFreq
+ C                    freesurfac = 1. uses implicit free surface
-       REAL cg2dTargetResidual
+ C                    freesurfac = 0. uses rigid lid
-       REAL delZ(Nz)
+ C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
-       REAL delX(Nx)
+ C                     Implicit part of Surface Pressure Gradient ( 0-1 )
-       REAL delY(Ny)
+ C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
-       REAL deltaT
+ C                     Implicit part of barotropic flow Divergence ( 0-1 )
-       REAL deltaTmom
+ C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
-       REAL deltaTtracer
+ C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
-       REAL abeps
+ C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
-       REAL phiMin
+ C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
-       REAL thetaMin
+ C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
-       REAL rSphere
+ C     hFacSup        that control vanishing and creating levels
-       REAL f0
+ C     tauCD        :: CD scheme coupling timescale ( 1/s )
-       _RL  beta
+ C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
-       REAL viscAh
+ C     baseTime      :: model base time (time origin) = time @ iteration zero
-       REAL viscAz
+ C     startTime     :: Starting time for this integration ( s ).
-       REAL viscA4
+ C     endTime       :: Ending time for this integration ( s ).
-       REAL diffKhT
+ C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
-       REAL diffKzT
+ C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
-       REAL diffK4T
+ C     dumpFreq      :: Frequency with which model state is written to
-       REAL diffKhS
+ C                     post-processing files ( s ).
-       REAL diffKzS
+ C     diagFreq      :: Frequency with which model writes diagnostic output
-       REAL diffK4S
+ C                     of intermediate quantities.
-       REAL delt
+ C     afFacMom      :: Advection of momentum term tracer parameter
-       REAL tauCD
+ C     vfFacMom      :: Momentum viscosity tracer parameter
-       REAL rCD
+ C     pfFacMom      :: Momentum pressure forcing tracer parameter
-       REAL gravity
+ C     cfFacMom      :: Coriolis term tracer parameter
-       REAL rhonil
+ C     foFacMom      :: Momentum forcing tracer parameter
-       REAL tRef(Nz)
+ C     mtFacMom      :: Metric terms tracer parameter
-       REAL sRef(Nz)
+ C     cosPower      :: Power of cosine of latitude to multiply viscosity
-       real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+ C     cAdjFreq      :: Frequency of convective adjustment
-       REAL startTime
+ C
-       REAL endTime
+ C     taveFreq      :: Frequency with which time-averaged model state
-       REAL chkPtFreq
+ C                      is written to post-processing files ( s ).
-       REAL dumpFreq
+ C     tave_lastIter :: (for state variable only) fraction of the last time
-       COMMON /PARM_A/ HeatCapacity_Cp,
+ C                      step (of each taveFreq period) put in the time average.
-      &                Lamba_theta
+ C                      (fraction for 1rst iter = 1 - tave_lastIter)
-       REAL HeatCapacity_Cp
+ C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
-       REAL Lamba_theta
+ C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
+ C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
- C Equation of State (polynomial coeffients)
+ C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
-       COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
+ C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
-       REAL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)
+ C                         i.e. where |yC| <= latBandClimRelax
- C Linear equation of state
+ C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
- C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
+ C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
- C     sBeta     - Linear EOS haline contraction coefficient.
+ C                          (note: externForcingCycle must be an integer
-       COMMON /PARM_EOS_LIN/ tAlpha,sBeta
+ C                           number times externForcingPeriod)
-       REAL tAlpha
+ C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
-       REAL sBeta
+ C                       (use model surface (local) value if set to -1)
+ C     temp_EvPrRn :: temperature of Rain & Evap.
+ C     salt_EvPrRn :: salinity of Rain & Evap.
+ C        (notes: a) tracer content of Rain/Evap only used if both
+ C                     NonLin_FrSurf & useRealFreshWater are set.
+ C                b) use model surface (local) value if set to UNSET_RL)
+ 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     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
+ C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
+ C     bottomDragLinear   :: Drag coefficient built in to core dynamics
+ C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
+       COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
+      & cg2dpcOffDFac, cg3dTargetResidual,
+      & delR, delRc, delX, delY,
+      & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
+      & abeps,
+      & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
+      & viscAh, viscAhW, viscAhMax,
+      & viscAhGrid, viscAhGridMax, viscAhGridMin,
+      & viscC2leith, viscC2leithD,
+      & viscC2smag,
+      & viscAhD, viscAhZ, viscA4D, viscA4Z,
+      & viscA4, viscA4W,
+      & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
+      & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
+      & diffKhT, diffK4T, diffKrNrT,
+      & diffKhS, diffK4S, diffKrNrS,
+      & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
+      & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
+      & hFacMin, hFacMinDz, hFacInf, hFacSup,
+      & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
+      & recip_rhoConst, rhoConst,
+      & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
+      & baseTime, startTime, endTime,
+      & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
+      & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
+      & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
+      & cosPower, cAdjFreq, omega, rotationPeriod,
+      & tauThetaClimRelax, lambdaThetaClimRelax,
+      & tauSaltClimRelax, lambdaSaltClimRelax,
+      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
+      & externForcingCycle, externForcingPeriod,
+      & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
+      & hFacMinDr, hFacMinDp,
+      & horiVertRatio, recip_horiVertRatio,
+      & ivdc_kappa, Ro_SeaLevel,
+      & bottomDragLinear,bottomDragQuadratic,
+      & tCylIn, tCylOut
+       _RL cg2dTargetResidual
+       _RL cg2dTargetResWunit
+       _RL cg3dTargetResidual
+       _RL cg2dpcOffDFac
+       _RL delR(Nr)
+       _RL delRc(Nr+1)
+       _RL delX(Nx)
+       _RL delY(Ny)
+       _RL deltaT
+       _RL deltaTClock
+       _RL deltaTmom
+       _RL dTtracerLev(Nr)
+       _RL deltaTfreesurf
+       _RL abeps
+       _RL phiMin
+       _RL thetaMin
+       _RL rSphere
+       _RL recip_RSphere
+       _RL f0
+       _RL freeSurfFac
+       _RL implicSurfPress
+       _RL implicDiv2Dflow
+       _RL hFacMin
+       _RL hFacMinDz
+       _RL hFacMinDp
+       _RL hFacMinDr
+       _RL hFacInf
+       _RL hFacSup
+       _RL beta
+       _RL viscAh
+       _RL viscAhW
+       _RL viscAhD
+       _RL viscAhZ
+       _RL viscAhMax
+       _RL viscAhGrid
+       _RL viscAhGridMax
+       _RL viscAhGridMin
+       _RL viscC2leith
+       _RL viscC2leithD
+       _RL viscC2smag
+       _RL viscAstrain
+       _RL viscAtension
+       _RL viscAr
+       _RL viscA4
+       _RL viscA4W
+       _RL viscA4D
+       _RL viscA4Z
+       _RL viscA4Max
+       _RL viscA4Grid, viscA4GridMax, viscA4GridMin
+       _RL viscC4leith
+       _RL viscC4leithD
+       _RL diffKhT
+       _RL diffKrNrT(Nr)
+       _RL diffK4T
+       _RL diffKhS
+       _RL diffKrNrS(Nr)
+       _RL diffK4S
+       _RL diffKrBL79surf
+       _RL diffKrBL79deep
+       _RL diffKrBL79scl
+       _RL diffKrBL79Ho
+       _RL delt
+       _RL tauCD
+       _RL rCD
+       _RL gravity
+       _RL recip_gravity
+       _RL gBaro
+       _RL rhonil
+       _RL recip_rhonil
+       _RL rhoConst
+       _RL recip_rhoConst
+       _RL rhoConstFresh
+       _RL convertEmP2rUnit
+       _RL tRef(Nr)
+       _RL sRef(Nr)
+       _RL baseTime
+       _RL startTime
+       _RL endTime
+       _RL chkPtFreq
+       _RL pChkPtFreq
+       _RL dumpFreq
+       _RL adjDumpFreq
+       _RL diagFreq
+       _RL taveFreq
+       _RL tave_lastIter
+       _RL monitorFreq
+       _RL adjMonitorFreq
+       _RL afFacMom
+       _RL vfFacMom
+       _RL pfFacMom
+       _RL cfFacMom
+       _RL foFacMom
+       _RL mTFacMom
+       _RL cosPower
+       _RL cAdjFreq
+       _RL omega
+       _RL rotationPeriod
+       _RL tauThetaClimRelax
+       _RL lambdaThetaClimRelax
+       _RL tauSaltClimRelax
+       _RL lambdaSaltClimRelax
+       _RL tauTr1ClimRelax
+       _RL lambdaTr1ClimRelax
+       _RL latBandClimRelax
+       _RL externForcingCycle
+       _RL externForcingPeriod
+       _RL convertFW2Salt
+       _RL temp_EvPrRn
+       _RL salt_EvPrRn
+       _RL horiVertRatio
+       _RL recip_horiVertRatio
+       _RL ivdc_kappa
+       _RL Ro_SeaLevel
+       _RL bottomDragLinear
+       _RL bottomDragQuadratic
+       _RL tCylIn
+       _RL tCylOut
+ C--   COMMON /PARM_A/ Thermodynamics constants ?
+       COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
+       _RL HeatCapacity_Cp
+       _RL recip_Cp
+ C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
+ C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
+ C     atm_Po    :: standard reference pressure
+ C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
+ C     atm_Rd    :: gas constant for dry air
+ C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
+ C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
+ C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
+ C     integr_GeoPot :: option to select the way we integrate the geopotential
+ C                     (still a subject of discussions ...)
+ C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
+ C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
+       COMMON /PARM_ATM/
+      &            celsius2K,
+      &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
+      &            integr_GeoPot, selectFindRoSurf
+       _RL celsius2K
+       _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
+       INTEGER integr_GeoPot, selectFindRoSurf
+ C Logical flags for selecting packages
+       LOGICAL useOPPS
+       LOGICAL usePP81
+       LOGICAL useMY82
+       LOGICAL useGGL90
+       LOGICAL useKPP
+       LOGICAL useGMRedi
+       LOGICAL useOBCS
+       LOGICAL useAIM
+       LOGICAL useLand
+       LOGICAL useGrdchk
+       LOGICAL useECCO
+       LOGICAL useSHAP_FILT
+       LOGICAL useZONAL_FILT
+       LOGICAL useFLT
+       LOGICAL usePTRACERS
+       LOGICAL useGCHEM
+       LOGICAL useSBO
+       LOGICAL useSEAICE
+       LOGICAL useBulkForce
+       LOGICAL useThSIce
+       LOGICAL usefizhi
+       LOGICAL usegridalt
+       LOGICAL usediagnostics
+       LOGICAL useEBM
+       LOGICAL useMNC
+       COMMON /PARM_PACKAGES/
+      &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
+      &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
+      &        usePTRACERS, useGCHEM,
+      &        useSBO, useSEAICE, useThSIce, useBulkForce,
+      &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
+      &        usePP81, useMY82, useOPPS, useGGL90
+ CEH3 ;;; Local Variables: ***
+ CEH3 ;;; mode:fortran ***
+ CEH3 ;;; End: ***

 Legend:



Removed from v.1.5
 


changed lines


 
Added in v.1.150
 Legend:



Removed from v.1.5
 


changed lines


 
Added in v.1.150
-Removed from v.1.5
+Added in v.1.150

	ViewVC Help
Powered by ViewVC 1.1.22