/[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.27 by cnh,
Mon Aug 24 02:25:01 1998 UTC
+revision 1.72 by adcroft,
Fri Jun 21 18:36:04 2002 UTC
 Line 1
  C $Header$
+ C $Name$
  C
- C     /==========================================================\
+ CBOP
- C     | PARAMS.h                                                 |
+ C    !ROUTINE: PARAMS.h
- C     | o Header file defining model "parameters".               |
+ C    !INTERFACE:
- C     |==========================================================|
+ C    include PARAMS.h
- C     | The values from the model's standard input file are      |
+ C    !DESCRIPTION: \bv
- C     | stored into the variables held here. Notes describing    |
+ C     *==========================================================*
- C     | the parameters can also be found here.                   |
+ C     | PARAMS.h
- C     \==========================================================/
+ C     | o Header file defining model "parameters".
+ C     *==========================================================*
+ 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     *==========================================================*
+ C     \ev
+ CEOP
  C     Macros for special grid options
  #include "PARAMS_MACROS.h"
-Line 20 
 C     Useful physical values
+Line 28 
 C     Useful physical values
        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
  C     Symbolic values
- C     precXXXX - Used to indicate what precision to use for
+ 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 )
+       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     checkPtSuff - List of checkpoint file suffices
+ C     checkPtSuff :: List of checkpoint file suffices
- C     bathyFile   - File containing bathymetry. If not defined bathymetry
+ C     bathyFile   :: File containing bathymetry. If not defined bathymetry
  C                   is taken from inline function.
- C     hydrogThetaFile - File containing initial hydrographic data for potential
+ 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     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
- C     zonalWindFile   - File containing zonal wind data
+ C     zonalWindFile   :: File containing zonal wind data
- C     meridWindFile   - File containing meridional wind data
+ C     meridWindFile   :: File containing meridional wind data
- C     thetaClimFile   - File containing theta climataology used
+ C     thetaClimFile   :: File containing theta climataology used
  C                       in relaxation term -lambda(theta-theta*)
- C     saltClimFile    - File containing salt climataology used
+ C     saltClimFile    :: File containing salt climataology used
  C                       in relaxation term -lambda(salt-salt*)
- C     buoyancyRelation - Flag used to indicate which relation to use to
+ C     surfQfile       :: File containing surface 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     buoyancyRelation :: Flag used to indicate which relation to use to
  C                        get buoyancy.
        COMMON /PARM_C/ checkPtSuff,
-      &                bathyFile, hydrogThetaFile, hydrogSaltFile,
+      &                bathyFile, topoFile,
+      &                hydrogThetaFile, hydrogSaltFile,
       &                zonalWindFile, meridWindFile, thetaClimFile,
-      &                saltClimFile, buoyancyRelation
+      &                saltClimFile, buoyancyRelation,
+      &                EmPmRfile, surfQfile, surfQswfile,
+      &                uVelInitFile, vVelInitFile, pSurfInitFile,
+      &                dQdTfile
        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
-       CHARACTER*(MAX_LEN_FNAM) bathyFile
+       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) 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
+       CHARACTER*(MAX_LEN_FNAM) dQdTfile
  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     nIter0              - Start time-step number of for this run
+ C     cg3dMaxIters        :: Maximum number of iterations in the
- C     nTimeSteps          - Number of timesteps to execute
+ C                           three-dimensional con. grad solver.
- C     numStepsPerPickup   - For offline setup. Frequency of pickup
+ 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
  C                           of flow fields.
- C     writeStatePrec      - Precision used for writing model state.
+ C     writeStatePrec      :: Precision used for writing model state.
- C     writeBinaryPrec     - Precision used for writing binary files
+ C     writeBinaryPrec     :: Precision used for writing binary files
- C     readBinaryPrec      - Precision used for reading binary files
+ C     readBinaryPrec      :: Precision used for reading binary files
- C     nCheckLev           - Holds current checkpoint level
+ C     nCheckLev           :: Holds current checkpoint level
+ C     nonlinFreeSurf      :: option related to non-linear free surface
+ C                           =0 Linear free surface ; >0 Non-linear
        COMMON /PARM_I/
       &        cg2dMaxIters,
       &        cg2dChkResFreq,
-      &        nIter0, nTimeSteps,
+      &        cg3dMaxIters,
+      &        cg3dChkResFreq,
+      &        nIter0, nTimeSteps, nEndIter,
       &        numStepsPerPickup,
       &        writeStatePrec, nCheckLev,
-      &        writeBinaryPrec, readBinaryPrec
+      &        writeBinaryPrec, readBinaryPrec,
+      &        nonlinFreeSurf,
+      &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
        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 nonlinFreeSurf
+       INTEGER tempAdvScheme
+       INTEGER saltAdvScheme
+       INTEGER tracerAdvScheme
  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     no_slip_sides :: Impose "no-slip" at lateral boundaries.
- C     momAdvection  - Flag which turns advection of momentum on and off.
+ C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
- C     momForcing    - Flag which turns external forcing of momentum on
+ 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     momPressureForcing - Flag which turns pressure term in momentum equation
+ C     momPressureForcing :: Flag which turns pressure term in momentum equation
  C                          on and off.
- C     metricTerms   - Flag which turns metric terms on or off.
+ C     metricTerms   :: Flag which turns metric terms on or off.
- C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
+ C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
- C     useCoriolis   - Flag which turns the coriolis terms on and off.
+ C     useCoriolis   :: Flag which turns the coriolis terms on and off.
- C     tempDiffusion - Flag which turns diffusion of temperature on
+ C     tempDiffusion :: Flag which turns diffusion of temperature on
  C                     and off.
- C     tempAdvection - Flag which turns advection of temperature on
+ C     tempAdvection :: Flag which turns advection of temperature on
  C                     and off.
- C     tempForcing   - Flag which turns external forcing of temperature on
+ C     tempForcing   :: Flag which turns external forcing of temperature on
  C                     and off.
- C     saltDiffusion - Flag which turns diffusion of salinit on
+ C     saltDiffusion :: Flag which turns diffusion of salinity on
  C                     and off.
- C     saltAdvection - Flag which turns advection of salinit on
+ C     saltAdvection :: Flag which turns advection of salinity on
  C                     and off.
- C     saltForcing   - Flag which turns external forcing of salinit on
+ C     saltForcing   :: Flag which turns external forcing of salinity on
  C                     and off.
- C     implicitFreeSurface - Set to true to use implcit free surface
+ C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
- C     rigidLid            - Set to true to use rigid lid
+ C                         as a real Fresh Water (=> changes the Sea Level)
- C     momStepping   - Turns momentum equation time-stepping off
+ C                         if F, converts P+R-E to salt flux (no SL effect)
- C     tempStepping  - Turns temperature equation time-stepping off
+ C     rigidLid            :: Set to true to use rigid lid
- C     saltStepping  - Turns salinity equation time-stepping off
+ C     implicitFreeSurface :: Set to true to use implcit free surface
- C     useConstantF  - Coriolis parameter set to f0
+ C     exactConserv        :: Set to true to conserve exactly the total Volume
- C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
+ C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
- C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
+ C                           linear relation Phi_surf = Bo_surf*eta
- C     implicitDiffusion - Turns implicit vertical diffusion on
+ C     momStepping   :: Turns momentum equation time-stepping off
- C     doThetaClimRelax - Set true if relaxation to temperature
+ C     tempStepping  :: Turns temperature equation time-stepping off
+ C     saltStepping  :: Turns salinity equation time-stepping off
+ C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/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     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
+ C     implicitDiffusion :: Turns implicit vertical diffusion on
+ C     implicitViscosity :: Turns implicit vertical viscosity on
+ C     multiDimAdvection :: Flag that enable multi-dimension advection
+ 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     doSaltClimRelax  :: Set true if relaxation to salinity
  C                        climatology is required.
- C     periodicExternalForcing - Set true if forcing is time-dependant
+ C     periodicExternalForcing :: Set true if forcing is time-dependant
+ C     usingPCoords     :: Set to indicate that we are working in pressure
+ C                        coords.
+ C     usingZCoords     :: Set to indicate that we are working in height
+ C                        coords.
+ C     setCenterDr    :: set cell Center depth and put Interface at the middle
+ C     nonHydrostatic :: Using non-hydrostatic terms
+ C     globalFiles    :: Selects between "global" and "tiled" files
+ C     allowFreezing  :: Allows water to freeze and form ice
+ C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
-      & momViscosity, momAdvection, momForcing, useCoriolis, momPressureForcing,
+      & usingCurvilinearGrid,
+      & no_slip_sides,no_slip_bottom,
+      & staggerTimeStep,
+      & momViscosity, momAdvection, momForcing, useCoriolis,
+      & momPressureForcing, vectorInvariantMomentum,
       & tempDiffusion, tempAdvection, tempForcing,
       & saltDiffusion, saltAdvection, saltForcing,
-      & implicitFreeSurface, rigidLid,
+      & useRealFreshWaterFlux,
-      & momStepping, tempStepping, saltStepping,
+      & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
+      & momStepping, tempStepping, saltStepping, tr1Stepping,
       & metricTerms, usingSphericalPolarMTerms,
       & useConstantF, useBetaPlaneF, useSphereF,
-      & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
+      & useEnergyConservingCoriolis, useJamartWetPoints,
-      & periodicExternalForcing
+      & implicitDiffusion, implicitViscosity,
+      & multiDimAdvection, forcing_In_AB,
+      & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
+      & periodicExternalForcing,
+      & usingPCoords, usingZCoords, setCenterDr,
+      & nonHydrostatic, globalFiles,
+      & allowFreezing, groundAtK1,
+      & usePickupBeforeC35, debugMode,
+      & readPickupWithTracer, writePickupWithTracer
        LOGICAL usingCartesianGrid
        LOGICAL usingSphericalPolarGrid
+       LOGICAL usingCurvilinearGrid
        LOGICAL usingSphericalPolarMTerms
+       LOGICAL no_slip_sides
+       LOGICAL no_slip_bottom
+       LOGICAL staggerTimeStep
        LOGICAL momViscosity
        LOGICAL momAdvection
        LOGICAL momForcing
        LOGICAL momPressureForcing
        LOGICAL useCoriolis
+       LOGICAL vectorInvariantMomentum
        LOGICAL tempDiffusion
        LOGICAL tempAdvection
        LOGICAL tempForcing
        LOGICAL saltDiffusion
        LOGICAL saltAdvection
        LOGICAL saltForcing
-       LOGICAL implicitFreeSurface
+       LOGICAL useRealFreshWaterFlux
        LOGICAL rigidLid
+       LOGICAL implicitFreeSurface
+       LOGICAL exactConserv
+       LOGICAL uniformLin_PhiSurf
        LOGICAL momStepping
        LOGICAL tempStepping
        LOGICAL saltStepping
+       LOGICAL tr1Stepping
        LOGICAL metricTerms
        LOGICAL useConstantF
        LOGICAL useBetaPlaneF
        LOGICAL useSphereF
+       LOGICAL useEnergyConservingCoriolis
+       LOGICAL useJamartWetPoints
        LOGICAL implicitDiffusion
+       LOGICAL implicitViscosity
+       LOGICAL multiDimAdvection
+       LOGICAL forcing_In_AB
        LOGICAL doThetaClimRelax
        LOGICAL doSaltClimRelax
+       LOGICAL doTr1ClimRelax
        LOGICAL periodicExternalForcing
+       LOGICAL usingPCoords
+       LOGICAL usingZCoords
+       LOGICAL setCenterDr
+       LOGICAL nonHydrostatic
+       LOGICAL globalFiles
+       LOGICAL allowFreezing
+       LOGICAL groundAtK1
+       LOGICAL usePickupBeforeC35
+       LOGICAL debugMode
+       LOGICAL readPickupWithTracer
+       LOGICAL writePickupWithTracer
  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
- C     cg2dTargetResidual
+ C     gg2dTargetResidual
- C               - Target residual for cg2d solver.
+ C          :: Target residual for cg2d solver; no unit (RHS normalisation)
- C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
+ C     cg2dTargetResWunit
+ C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
+ 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
-Line 185 
 C           number of iterations for con
+Line 306 
 C           number of iterations for con
  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     delP      - Vertical grid spacing ( Pa ).
+ C     delP      :: Vertical grid spacing ( Pa ).
- C     delZ      - Vertical grid spacing ( m  ).
+ C     delZ      :: Vertical grid spacing ( m  ).
- C     delR      - Vertical grid spacing ( units of r ).
+ C     delR      :: Vertical grid spacing ( units of r ).
- C     delX      - Separation between cell faces (m) or (deg), depending
+ 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     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
+ C     recip_gravity and its inverse
- C     ronil     - Reference density
+ C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
- C     rhoConst  - Vertically constant reference density
+ C     ronil     :: Reference density
- C     startTime - Start time for model ( s )
+ C     rhoConst  :: Vertically constant reference density
- C     phiMin    - Latitude of southern most cell face.
+ C     startTime :: Start time for model ( s )
- C     thetaMin  - Longitude of western most cell face (this
+ 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     recip_RSphere  - Reciprocal radius of sphere ( m ).
+ C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
- C     f0        - Reference coriolis parameter ( 1/s )
+ 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     omega     - Angular velocity ( rad/s )
+ C     omega     :: Angular velocity ( rad/s )
- C     viscAh    - Eddy viscosity coeff. for mixing of
+ C     viscAh    :: Eddy viscosity coeff. for mixing of
  C                 momentum laterally ( m^2/s )
- C     viscAz    - Eddy viscosity coeff. for mixing of
+ C     viscAz    :: Eddy viscosity coeff. for mixing of
  C                 momentum vertically ( m^2/s )
- C     viscAp    - Eddy viscosity coeff. for mixing of
+ C     viscAp    :: Eddy viscosity coeff. for mixing of
  C                 momentum vertically ( Pa^2/s )
- C     viscAr    - Eddy viscosity coeff. for mixing of
+ 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     viscA4    :: Biharmonic viscosity coeff. for mixing of
  C                 momentum laterally ( m^4/s )
- C     diffKhT   - Laplacian diffusion coeff. for mixing of
+ C     diffKhT   :: Laplacian diffusion coeff. for mixing of
  C                 heat laterally ( m^2/s )
- C     diffKzT   - Laplacian diffusion coeff. for mixing of
+ C     diffKzT   :: Laplacian diffusion coeff. for mixing of
  C                 heat vertically ( m^2/s )
- C     diffKpT   - Laplacian diffusion coeff. for mixing of
+ C     diffKpT   :: Laplacian diffusion coeff. for mixing of
  C                 heat vertically ( Pa^2/s )
- C     diffKrT   - Laplacian diffusion coeff. for mixing of
+ C     diffKrT   :: Laplacian diffusion coeff. for mixing of
  C                 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     diffKzS   :: Laplacian diffusion coeff. for mixing of
  C                 salt vertically ( m^2/s )
- C     diffKpS   - Laplacian diffusion coeff. for mixing of
+ C     diffKpS   :: Laplacian diffusion coeff. for mixing of
  C                 salt vertically ( Pa^2/s )
- C     diffKrS   - Laplacian diffusion coeff. for mixing of
+ C     diffKrS   :: Laplacian diffusion coeff. for mixing of
  C                 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     deltaT    :: Default timestep ( s )
- C     deltaTClock  - Timestep used as model "clock". This determines the
+ C     deltaTClock  :: Timestep used as model "clock". This determines the
  C                    IO frequencies and is used in tagging output. It can
  C                    be totally different to the dynamical time. Typically
  C                    it will be the deep-water timestep for accelerated runs.
  C                    Frequency of checkpointing and dumping of the model state
  C                    are referenced to this clock. ( s )
- C     deltaTMom    - Timestep for momemtum equations ( s )
+ C     deltaTMom    :: Timestep for momemtum equations ( s )
- C     deltaTtracer - Timestep for tracer equations ( s )
+ C     deltaTtracer :: Timestep for tracer equations ( s )
- C     freesurfFac  - Parameter to turn implicit free surface term on or off
+ C     deltaTfreesurf :: Timestep for free-surface equation ( s )
+ C     freesurfFac  :: Parameter to turn implicit free surface term on or off
  C                    freesurfac = 1. uses implicit free surface
  C                    freesurfac = 0. uses rigid lid
- C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
+ C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
- C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
+ C                     Implicit part of Surface Pressure Gradient ( 0-1 )
- C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
+ C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
- C     tauCD        - CD scheme coupling timescale ( 1/s )
+ C                     Implicit part of barotropic flow Divergence ( 0-1 )
- C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
+ C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
- C     GMmaxslope    - max. slope allowed in GM/Redi tensor
+ C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
- C     GMlength      - Length to use in Visbeck et al. formula for K (m)
+ C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
- C     GMalpha       - alpha to use in Visbeck et al. formula for K
+ C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
- C     GMdepth       - Depth over which to integrate Richardson # (Visbeck et al.)
+ C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
- C     GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
+ C     hFacSup        that control vanishing and creating levels
- C     GMmaxval      - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
+ C     tauCD        :: CD scheme coupling timescale ( 1/s )
- C     startTime     - Starting time for this integration ( s ).
+ C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
- C     endTime       - Ending time for this integration ( s ).
+ C     startTime     :: Starting time for this integration ( s ).
- C     chkPtFreq     - Frequency of rolling check pointing ( s ).
+ C     endTime       :: Ending time for this integration ( s ).
- C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
+ C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
- C     dumpFreq      - Frequency with which model state is written to
+ C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
+ C     dumpFreq      :: Frequency with which model state is written to
  C                     post-processing files ( s ).
- C     afFacMom      - Advection of momentum term tracer parameter
+ C     diagFreq      :: Frequency with which model writes diagnostic output
- C     vfFacMom      - Momentum viscosity tracer parameter
+ C                     of intermediate quantities.
- C     pfFacMom      - Momentum pressure forcing tracer parameter
+ C     afFacMom      :: Advection of momentum term tracer parameter
- C     cfFacMom      - Coriolis term tracer parameter
+ C     vfFacMom      :: Momentum viscosity tracer parameter
- C     foFacMom      - Momentum forcing tracer parameter
+ C     pfFacMom      :: Momentum pressure forcing tracer parameter
- C     mtFacMom      - Metric terms tracer parameter
+ C     cfFacMom      :: Coriolis term tracer parameter
- C     cAdjFreq      - Frequency of convective adjustment
+ 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
+ C     taveFreq      :: Frequency with which time-averaged model state is written to
  C                     post-processing files ( s ).
- C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
+ C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
- C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
+ C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
- C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
+ C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
- C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
+ C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
- C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
+ C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
- C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
+ C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
  C                          (note: externForcingCycle must be an integer
  C                           number times externForcingPeriod)
-       COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
+ C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
-      & delP, delZ, delR, delX, delY,
+ C                       (use model surface (local) value if set to -1)
-      & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,
+ C     temp_EvPrRn :: temperature of Rain & Evap.
-      & thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
+ C     salt_EvPrRn :: salinity of Rain & Evap.
-      & viscAh,  viscAz,  viscA4,  viscAr,
+ C     trac_EvPrRn :: tracer concentration in 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,
+      & delP, delZ, delR, delRc, delX, delY,
+      & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
+      & abeps, startTime,
+      & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
+      & fCori, fCoriG,
+      & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
       & diffKhT, diffKzT, diffK4T, diffKrT,
       & diffKhS, diffKzS, diffK4S, diffKrS,
-      & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
+      & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
-      & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
+      & hFacMin, hFacMinDz, hFacInf, hFacSup,
-      & gravity, gBaro, rhonil, recip_rhonil,
+      & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
       & recip_rhoConst, rhoConst, tRef, sRef,
-      & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
+      & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
+      & diagFreq, taveFreq, monitorFreq,
       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
-      & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
+      & cosPower, cAdjFreq, omega,
+      & tauThetaClimRelax, lambdaThetaClimRelax,
       & tauSaltClimRelax, lambdaSaltClimRelax,
+      & tauTr1ClimRelax, lambdaTr1ClimRelax,
       & externForcingCycle, externForcingPeriod,
-      & viscAp, diffKpT, diffKpS, hFacMinDr,
+      & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
-      & theta_S, specVol_S
+      & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
+      & horiVertRatio, recip_horiVertRatio,
+      & ivdc_kappa, Ro_SeaLevel,
+      & bottomDragLinear,bottomDragQuadratic
        _RL cg2dTargetResidual
+       _RL cg2dTargetResWunit
+       _RL cg3dTargetResidual
        _RL cg2dpcOffDFac
        _RL delZ(Nr)
        _RL delP(Nr)
        _RL delR(Nr)
+       _RL delRc(Nr+1)
        _RL delX(Nx)
        _RL delY(Ny)
        _RL deltaT
        _RL deltaTClock
        _RL deltaTmom
        _RL deltaTtracer
+       _RL deltaTfreesurf
        _RL abeps
        _RL phiMin
        _RL thetaMin
-Line 319 
 C                           number times
+Line 475 
 C                           number times
        _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 viscAstrain
+       _RL viscAtension
        _RL viscAz
        _RL viscAp
        _RL viscAr
-Line 341 
 C                           number times
+Line 504 
 C                           number times
        _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
        _RL rhoConst
        _RL recip_rhoConst
-       _RL specVol_S(Nr)
        _RL tRef(Nr)
-       _RL theta_S(Nr)
        _RL sRef(Nr)
-       _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+       _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
        _RL startTime
        _RL endTime
        _RL chkPtFreq
        _RL pChkPtFreq
        _RL dumpFreq
+       _RL diagFreq
        _RL taveFreq
+       _RL monitorFreq
        _RL afFacMom
        _RL vfFacMom
        _RL pfFacMom
        _RL cfFacMom
        _RL foFacMom
        _RL mTFacMom
+       _RL cosPower
        _RL cAdjFreq
        _RL omega
        _RL tauThetaClimRelax
        _RL lambdaThetaClimRelax
        _RL tauSaltClimRelax
        _RL lambdaSaltClimRelax
+       _RL tauTr1ClimRelax
+       _RL lambdaTr1ClimRelax
        _RL externForcingCycle
        _RL externForcingPeriod
+       _RL convertFW2Salt
+       _RL temp_EvPrRn
+       _RL salt_EvPrRn
+       _RL trac_EvPrRn
+       _RL horiVertRatio
+       _RL recip_horiVertRatio
+       _RL ivdc_kappa
+       _RL Ro_SeaLevel
+       _RL bottomDragLinear
+       _RL bottomDragQuadratic
-       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
        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
  C Linear equation of state
- C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
+ C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
- C     sBeta     - Linear EOS haline contraction coefficient.
+ C     sBeta     :: Linear EOS haline contraction coefficient.
        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
        _RL tAlpha
        _RL sBeta
        character*(6) eosType
+ C Atmospheric physical parameters (Ideal Gas EOS, ...)
+ C     atm_po    :: standard reference pressure
+ C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure
+ C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
+ C     Integr_GeoPot :: option to select the way we integrate the geopotential
+ C                     (still a subject of discussions ...)
+       COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
+      &                  Integr_GeoPot
+       _RL atm_cp, atm_kappa, atm_po
+       INTEGER Integr_GeoPot
+ C Logical flags for selecting packages
+       LOGICAL useKPP
+       LOGICAL useGMRedi
+       LOGICAL useOBCS
+       LOGICAL useAIM
+       LOGICAL useGrdchk
+       LOGICAL useECCO
+       LOGICAL useSHAP_FILT
+       LOGICAL useZONAL_FILT
+       LOGICAL useFLT
+       LOGICAL usePTRACERS
+       COMMON /PARM_PACKAGES/
+      &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
+      &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
+      &        usePTRACERS

 Legend:



Removed from v.1.27
 


changed lines


 
Added in v.1.72
 Legend:



Removed from v.1.27
 


changed lines


 
Added in v.1.72
-Removed from v.1.27
+Added in v.1.72

	ViewVC Help
Powered by ViewVC 1.1.22