/[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.49.2.2 by adcroft,
Tue Apr  3 02:39:18 2001 UTC
+revision 1.219 by jmc,
Tue Aug  5 21:55:29 2008 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 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"
-Line 20 
 C     Useful physical values
+Line 24 
 C     Useful physical values
        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     checkPtSuff - List of checkpoint file suffices
+ C     buoyancyRelation :: Flag used to indicate which relation to use to
- C     bathyFile   - File containing bathymetry. If not defined bathymetry
+ C                         get buoyancy.
- C                   is taken from inline function.
+ C     eosType         :: choose the equation of state:
- C     hydrogThetaFile - File containing initial hydrographic data for potential
+ C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
- C                       temperature.
+ C     pickupSuff      :: force to start from pickup files (even if nIter0=0)
- C     hydrogSaltFile  - File containing initial hydrographic data for salinity.
+ C                        and read pickup files with this suffix (max 10 Char.)
- C     zonalWindFile   - File containing zonal wind data
+ C     mdsioLocalDir   :: read-write tiled file from/to this directory name
- C     meridWindFile   - File containing meridional wind data
+ C                        (+ 4 digits Processor-Rank) instead of current dir.
- C     thetaClimFile   - File containing theta climataology used
+ C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
+ C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
+ C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
+ C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
+ C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
+ C     delXFile      :: File containing X-spacing grid definition (1.D array)
+ C     delYFile      :: File containing Y-spacing grid definition (1.D array)
+ C     horizGridFile :: File containing horizontal-grid definition
+ C                        (only when using curvilinear_grid)
+ C     bathyFile       :: File containing bathymetry. If not defined bathymetry
+ 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     shelfIceFile    :: File containing the topography of the shelfice draught
+ C                        (unit=m)
+ C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
+ C                        for potential temperature.
+ C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
+ C                        for salinity.
+ C     diffKrFile      :: File containing 3D specification of vertical diffusivity
+ C     zonalWindFile   :: File containing zonal wind data
+ C     meridWindFile   :: File containing meridional wind data
+ C     thetaClimFile   :: File containing surface theta climataology used
  C                       in relaxation term -lambda(theta-theta*)
- C     saltClimFile    - File containing salt climataology used
+ C     saltClimFile    :: File containing surface salt climataology used
  C                       in relaxation term -lambda(salt-salt*)
- C     surfQfile       - File containing surface heat flux
+ C     surfQfile       :: File containing surface heat flux, excluding SW
- C     surfQswfile     - File containing surface shortwave radiation
+ C                        (old version, kept for backward compatibility)
- C     EmPmRfile       - File containing surface fresh water flux
+ C     surfQnetFile    :: File containing surface net heat flux
- C     buoyancyRelation - Flag used to indicate which relation to use to
+ C     surfQswFile     :: File containing surface shortwave radiation
- C                        get buoyancy.
+ C     dQdTfile        :: File containing thermal relaxation coefficient
-       COMMON /PARM_C/ checkPtSuff,
+ C     EmPmRfile       :: File containing surface fresh water flux
-      &                bathyFile, hydrogThetaFile, hydrogSaltFile,
+ C           NOTE: for backward compatibility EmPmRfile is specified in
+ C                 m/s when using external_fields_load.F.  It is converted
+ C                 to kg/m2/s by multiplying by rhoConstFresh.
+ C     saltFluxFile    :: File containing surface salt flux
+ C     pLoadFile       :: File containing pressure loading
+ C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
+ C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
+ C     the_run_name    :: string identifying the name of the model "run"
+       COMMON /PARM_C/
+      &                buoyancyRelation, eosType,
+      &                pickupSuff, mdsioLocalDir,
+      &                tRefFile, sRefFile, rhoRefFile,
+      &                delRFile, delRcFile,
+      &                delXFile, delYFile, horizGridFile,
+      &                bathyFile, topoFile, shelfIceFile,
+      &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
       &                zonalWindFile, meridWindFile, thetaClimFile,
-      &                saltClimFile, buoyancyRelation,
+      &                saltClimFile,
-      &                EmPmRfile, surfQfile, surfQswfile,
+      &                EmPmRfile, saltFluxFile,
-      &                uVelInitFile, vVelInitFile, pSurfInitFile
+      &                surfQfile, surfQnetFile, surfQswFile,
-       CHARACTER*(5) checkPtSuff(maxNoChkptLev)
+      &                lambdaThetaFile, lambdaSaltFile,
-       CHARACTER*(MAX_LEN_FNAM) bathyFile
+      &                uVelInitFile, vVelInitFile, pSurfInitFile,
-       CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
+      &                dQdTfile, ploadFile,
-       CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
+      &                eddyPsiXFile, eddyPsiYFile,
+      &                the_run_name
+       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
+       CHARACTER*(6)  eosType
+       CHARACTER*(10) pickupSuff
+       CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
+       CHARACTER*(MAX_LEN_FNAM) tRefFile
+       CHARACTER*(MAX_LEN_FNAM) sRefFile
+       CHARACTER*(MAX_LEN_FNAM) rhoRefFile
+       CHARACTER*(MAX_LEN_FNAM) delRFile
+       CHARACTER*(MAX_LEN_FNAM) delRcFile
+       CHARACTER*(MAX_LEN_FNAM) delXFile
+       CHARACTER*(MAX_LEN_FNAM) delYFile
+       CHARACTER*(MAX_LEN_FNAM) horizGridFile
+       CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
+       CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
+       CHARACTER*(MAX_LEN_FNAM) diffKrFile
        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) surfQnetFile
+       CHARACTER*(MAX_LEN_FNAM) surfQswFile
        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
-       CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
+       CHARACTER*(MAX_LEN_FNAM) saltFluxFile
        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) eddyPsiXFile
+       CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
+       CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
+       CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
+       CHARACTER*(MAX_LEN_PREC/2) the_run_name
  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     cg3dMaxIters        - Maximum number of iterations in the
+ 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     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     writeStatePrec      :: Precision used for writing model state.
- C                           of flow fields.
+ C     writeBinaryPrec     :: Precision used for writing binary files
- C     writeStatePrec      - Precision used for writing model state.
+ C     readBinaryPrec      :: Precision used for reading binary files
- C     writeBinaryPrec     - Precision used for writing binary files
+ C     nonlinFreeSurf      :: option related to non-linear free surface
- C     readBinaryPrec      - Precision used for reading binary files
+ C                           =0 Linear free surface ; >0 Non-linear
- C     nCheckLev           - Holds current checkpoint level
+ C     select_rStar        :: option related to r* vertical coordinate
- C     nShap               - "Order" of shapiro filter to apply to
+ C                           =0 (default) use r coord. ; > 0 use r*
- C                           model prognositic fields.
+ C     momForcingOutAB     :: =1: take momentum forcing contribution
- C                           nShap == 1 => del2
+ C                           out of (=0: in) Adams-Bashforth time stepping.
- C                           nShap == 2 => del4
+ C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
- C                           nShap == 3 => del6
+ C                           out of (=0: in) Adams-Bashforth time stepping.
- C                           etc...
+ 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     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
+ C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
+ C     monitorSelect       :: select group of variables to monitor
+ C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
+ C     debugLevel          :: debug level selector: higher -> more writing
        COMMON /PARM_I/
       &        cg2dMaxIters,
-      &        cg2dChkResFreq,
+      &        cg2dChkResFreq, cg2dPreCondFreq,
       &        cg3dMaxIters,
       &        cg3dChkResFreq,
       &        nIter0, nTimeSteps, nEndIter,
-      &        numStepsPerPickup,
+      &        writeStatePrec,
-      &        writeStatePrec, nCheckLev,
       &        writeBinaryPrec, readBinaryPrec,
-      &        nShap, zonal_filt_sinpow, zonal_filt_cospow
+      &        nonlinFreeSurf, select_rStar,
+      &        momForcingOutAB, tracForcingOutAB,
+      &        tempAdvScheme, tempVertAdvScheme,
+      &        saltAdvScheme, saltVertAdvScheme,
+      &        selectKEscheme, selectVortScheme,
+      &        monitorSelect, 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 nShap
+       INTEGER select_rStar
-       INTEGER zonal_filt_sinpow
+       INTEGER momForcingOutAB, tracForcingOutAB
-       INTEGER zonal_filt_cospow
+       INTEGER tempAdvScheme, tempVertAdvScheme
+       INTEGER saltAdvScheme, saltVertAdvScheme
+       INTEGER selectKEscheme
+       INTEGER selectVortScheme
+       INTEGER monitorSelect
+       INTEGER debugLevel
  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
- C     usingCartesianGrid - If TRUE grid generation will be in a cartesian
+ C- Coordinate + Grid params:
+ 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     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     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
+ C                         this requires specific code for restart & exchange
+ 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     no_slip_sides - Impose "no-slip" at lateral boundaries.
+ C     rotateGrid      :: rotate grid coordinates to geographical coordinates
- C     no_slip_bottom- Impose "no-slip" at bottom boundary.
+ C                        according to Euler angles phiEuler, thetaEuler, psiEuler
- C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V
+ C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
- 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     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
- C     momForcing    - Flag which turns external forcing of momentum on
+ C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
- C                     and off.
+ C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
- C     momPressureForcing - Flag which turns pressure term in momentum equation
+ C- Momentum params:
+ C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
+ C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
+ C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
+ C                       on irregular grids)
+ C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
+ C     useAreaViscLength :: Set to true to use old scaling for viscous lengths,
+ C                          e.g., L2=Raz.  May be preferable for cube sphere.
+ 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                          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     useNHMTerms   :: If TRUE use non-hydrostatic 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     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
- C                     and off.
+ C     useConstantF  :: Coriolis parameter set to f0
- C     tempAdvection - Flag which turns advection of temperature on
+ C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
- C                     and off.
+ C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
- C     tempForcing   - Flag which turns external forcing of temperature on
+ C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
- C                     and off.
+ C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
- C     saltDiffusion - Flag which turns diffusion of salinit on
+ C                                (default = F = use mom_fluxform package)
- C                     and off.
+ C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
- C     saltAdvection - Flag which turns advection of salinit on
+ C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
- C                     and off.
+ C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
- C     saltForcing   - Flag which turns external forcing of salinit on
+ C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
- C                     and off.
+ C     useAbsVorticity :: work with f+zeta in Coriolis terms
- C     implicitFreeSurface - Set to true to use implcit free surface
+ C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
- C     rigidLid            - Set to true to use rigid lid
+ C     momStepping    :: Turns momentum equation time-stepping off
- C     momStepping   - Turns momentum equation time-stepping off
+ C- Temp. & Salt params:
- C     tempStepping  - Turns temperature equation time-stepping off
+ C     tempStepping   :: Turns temperature equation time-stepping off
- C     saltStepping  - Turns salinity equation time-stepping off
+ C     saltStepping   :: Turns salinity equation time-stepping off
- C     useConstantF  - Coriolis parameter set to f0
+ C     tempAdvection  :: Flag which turns advection of temperature on and off.
- C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y
+ C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
- C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)
+ C     tempForcing    :: Flag which turns external forcing of temperature on
- C     implicitDiffusion - Turns implicit vertical diffusion on
+ C                       and off.
- C     implicitViscosity - Turns implicit vertical viscosity on
+ C     saltAdvection  :: Flag which turns advection of salinity on and off.
- C     doThetaClimRelax - Set true if relaxation to temperature
+ C     saltIsActiveTr :: Salinity  is a dynamically active tracer
+ C     saltForcing    :: Flag which turns external forcing of salinity 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- Time-stepping params:
+ C     rigidLid            :: Set to true to use rigid lid
+ C     implicitFreeSurface :: Set to true to use implicit free surface
+ C     exactConserv        :: Set to true to conserve exactly the total Volume
+ C     linFSConserveTr     :: Set to true to correct source/sink of tracer
+ C                            at the surface due to Linear Free Surface
+ C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
+ C                            linear relation Phi_surf = Bo_surf*eta
+ C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
+ C     nonHydrostatic   :: Using non-hydrostatic algorithm
+ C     use3Dsolver      :: set to true to use 3-D pressure solver
+ C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
+ C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
+ 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     momDissip_In_AB   :: if False, put Dissipation tendency contribution
+ C                          out off Adams-Bashforth time stepping.
+ C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
+ C                          apply AB on tracer tendencies (rather than on Tracer)
+ C- Other forcing params -
+ C     balanceEmPmR    :: substract global mean of EmPmR at every time step
+ C     balanceQnet     :: substract global mean of Qnet at every time step
+ C     balancePrintMean:: print substracted global means to STDOUT
+ 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     allowFreezing  :: Allows surface water to freeze and form ice
- C     usingPCoords     - Set to indicate that we are working in pressure
+ C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
- C                        coords.
+ C     periodicExternalForcing :: Set true if forcing is time-dependant
- C     usingZCoords     - Set to indicate that we are working in height
+ C- I/O parameters -
- C                        coords.
+ C     globalFiles    :: Selects between "global" and "tiled" files
- C     nonHydrostatic - Using non-hydrostatic terms
+ C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
- C     globalFiles    - Selects between "global" and "tiled" files
+ C                       slow (f77) or does not work (f90).  When
- C     allowFreezing  - Allows water to freeze and form ice
+ C                       useSingleCpuIO is set, mdsio_writefield.F
- C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)
+ C                       outputs from master mpi process only.
-       COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
+ C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
-      & usingCurvilinearGrid,
+ C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
-      & no_slip_sides,no_slip_bottom,
+ C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
-      & staggerTimeStep,
+ C                           before checkpoint-54a, Jul 06, 2004.
-      & momViscosity, momAdvection, momForcing, useCoriolis,
+ C     pickup_write_mdsio :: use mdsio to write pickups
-      & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
+ C     pickup_read_mdsio  :: use mdsio to read  pickups
-      & saltDiffusion, saltAdvection, saltForcing,
+ C     pickup_write_immed :: echo the pickup immediately (for conversion)
-      & implicitFreeSurface, rigidLid,
+ C     writePickupAtEnd   :: write pickup at the last timestep
-      & momStepping, tempStepping, saltStepping,
+ C     timeave_mdsio      :: use mdsio for timeave output
-      & metricTerms, usingSphericalPolarMTerms,
+ C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
+ C     monitor_stdio      :: use stdio for monitor output
+ C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
+ C                        & Last iteration, in addition multiple of dumpFreq iter.
+       COMMON /PARM_L/
+      & fluidIsAir, fluidIsWater,
+      & usingPCoords, usingZCoords, useDynP_inEos_Zc,
+      & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
+      & usingCurvilinearGrid, usingCylindricalGrid,
+      & deepAtmosphere, setInterFDr, setCenterDr,
+      & no_slip_sides, no_slip_bottom,
+      & useFullLeith, useStrainTensionVisc, useAreaViscLength,
+      & momViscosity, momAdvection, momForcing,
+      & momPressureForcing, metricTerms, useNHMTerms,
+      & useCoriolis, use3dCoriolis,
       & useConstantF, useBetaPlaneF, useSphereF,
+      & useCDscheme, vectorInvariantMomentum,
+      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
+      & upwindVorticity, highOrderVorticity,
+      & useAbsVorticity, upwindShear,
+      & momStepping, tempStepping, saltStepping,
+      & tempAdvection, tempIsActiveTr, tempForcing,
+      & saltAdvection, saltIsActiveTr, saltForcing,
+      & useRealFreshWaterFlux,
+      & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
+      & uniformLin_PhiSurf,
+      & quasiHydrostatic, nonHydrostatic,
+      & use3Dsolver, implicitIntGravWave, staggerTimeStep,
       & implicitDiffusion, implicitViscosity,
+      & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
+      & multiDimAdvection, useMultiDimAdvec,
+      & momDissip_In_AB, doAB_onGtGs,
+      & balanceEmPmR, balanceQnet, balancePrintMean,
       & doThetaClimRelax, doSaltClimRelax,
-      & periodicExternalForcing, usingPCoords, usingZCoords,
+      & allowFreezing, useOldFreezing,
-      & nonHydrostatic, globalFiles,
+      & periodicExternalForcing,
-      & allowFreezing, groundAtK1
+      & globalFiles, useSingleCpuIO,
+      & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
+      & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
+      & writePickupAtEnd,
+      & timeave_mdsio, snapshot_mdsio, monitor_stdio,
+      & outputTypesInclusive, dumpInitAndLast, debugMode,
+      & inAdMode, inAdTrue, inAdFalse, inAdExact
+       LOGICAL fluidIsAir
+       LOGICAL fluidIsWater
+       LOGICAL usingPCoords
+       LOGICAL usingZCoords
+       LOGICAL useDynP_inEos_Zc
        LOGICAL usingCartesianGrid
-       LOGICAL usingSphericalPolarGrid
+       LOGICAL usingSphericalPolarGrid, rotateGrid
+       LOGICAL usingCylindricalGrid
        LOGICAL usingCurvilinearGrid
-       LOGICAL usingSphericalPolarMTerms
+       LOGICAL deepAtmosphere
+       LOGICAL setInterFDr
+       LOGICAL setCenterDr
+       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 tempIsActiveTr
        LOGICAL tempForcing
-       LOGICAL saltDiffusion
        LOGICAL saltAdvection
+       LOGICAL saltIsActiveTr
        LOGICAL saltForcing
-       LOGICAL implicitFreeSurface
+       LOGICAL useRealFreshWaterFlux
+       LOGICAL useFullLeith
+       LOGICAL useStrainTensionVisc
+       LOGICAL useAreaViscLength
        LOGICAL rigidLid
+       LOGICAL implicitFreeSurface
+       LOGICAL exactConserv
+       LOGICAL linFSConserveTr
+       LOGICAL uniformLin_PhiSurf
+       LOGICAL quasiHydrostatic
+       LOGICAL nonHydrostatic
+       LOGICAL use3Dsolver
+       LOGICAL implicitIntGravWave
+       LOGICAL staggerTimeStep
        LOGICAL momStepping
        LOGICAL tempStepping
        LOGICAL saltStepping
-Line 228 
 C     groundAtK1  - put the surface(k=1)
+Line 405 
 C     groundAtK1  - put the surface(k=1)
        LOGICAL useConstantF
        LOGICAL useBetaPlaneF
        LOGICAL useSphereF
+       LOGICAL use3dCoriolis
+       LOGICAL useCDscheme
+       LOGICAL useEnergyConservingCoriolis
+       LOGICAL useJamartWetPoints
+       LOGICAL useJamartMomAdv
+       LOGICAL upwindVorticity
+       LOGICAL highOrderVorticity
+       LOGICAL useAbsVorticity
+       LOGICAL upwindShear
        LOGICAL implicitDiffusion
        LOGICAL implicitViscosity
+       LOGICAL tempImplVertAdv
+       LOGICAL saltImplVertAdv
+       LOGICAL momImplVertAdv
+       LOGICAL multiDimAdvection
+       LOGICAL useMultiDimAdvec
+       LOGICAL momDissip_In_AB
+       LOGICAL doAB_onGtGs
+       LOGICAL balanceEmPmR
+       LOGICAL balanceQnet
+       LOGICAL balancePrintMean
        LOGICAL doThetaClimRelax
        LOGICAL doSaltClimRelax
+       LOGICAL allowFreezing
+       LOGICAL useOldFreezing
        LOGICAL periodicExternalForcing
-       LOGICAL usingPCoords
-       LOGICAL usingZCoords
-       LOGICAL nonHydrostatic
        LOGICAL globalFiles
-       LOGICAL allowFreezing
+       LOGICAL useSingleCpuIO
-       LOGICAL groundAtK1
+       LOGICAL pickupStrictlyMatch
+       LOGICAL usePickupBeforeC54
+       LOGICAL startFromPickupAB2
+       LOGICAL pickup_read_mdsio, pickup_write_mdsio
+       LOGICAL pickup_write_immed, writePickupAtEnd
+       LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
+       LOGICAL outputTypesInclusive
+       LOGICAL dumpInitAndLast
+       LOGICAL debugMode
+       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
  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     cg2dTargetResWunit
+ C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
  C     cg3dTargetResidual
- C               - Target residual for cg3d solver.
+ C               :: Target residual for cg3d solver.
- C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
+ 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 259 
 C           number of iterations for con
+Line 465 
 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     delR      :: Vertical grid spacing ( units of r ).
- C     delZ      - Vertical grid spacing ( m  ).
+ C     delRc     :: Vertical grid spacing between cell centers (r unit).
- C     delR      - Vertical grid spacing ( units of r ).
+ C     delX      :: Separation between cell faces (m) or (deg), depending
- 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     recip_gravity and its inverse
- C     gBaro     - Accel. due to gravity used in barotropic equation ( m/s^2 )
+ C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
- C     ronil     - Reference density
+ C     rhoNil    :: Reference density for the linear equation of state
- C     rhoConst  - Vertically constant reference density
+ C     rhoConst  :: Vertically constant reference density
- C     startTime - Start time for model ( s )
+ C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
- C     phiMin    - Latitude of southern most cell face.
+ C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
- C     thetaMin  - Longitude of western most cell face (this
+ 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     phiRef    :: reference potential (pressure/rho, geopotential) profile
+ C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
+ C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
+ C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
+ C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
+ C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
+ C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
+ C     wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
+ C                :: from vertical velocity [m/s] to r-coordinate vertical velocity.
+ C                :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
+ C     mass2rUnit :: units conversion factor (surface forcing),
+ C                :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
+ C                :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
+ C                :: p-coord: = gravity    ( [kg/m2] *  g = [Pa] ) ;
+ C     rUnit2mass :: units conversion factor (surface forcing),
+ C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
+ C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
+ C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
+ 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     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
- C                 momentum laterally ( m^2/s )
+ C     viscAr    :: 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                 momentum vertically ( Pa^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     viscAh    :: Eddy viscosity coeff. for mixing of
+ C                 momentum laterally ( m^2/s )
+ C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
+ C                 momentum laterally, no effect for hydrostatic
+ C                 model, defaults to viscAh if unset ( m^2/s )
+ C                 Not used if variable horiz. viscosity is used.
+ 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                 Not used if variable horiz. viscosity is used.
+ 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 visc. factor (grad(div))
+ C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
+ C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
+ C     viscC2smag   :: Smagorinsky non-dimensional viscosity factor (harmonic)
+ C     viscC4smag   :: Smagorinsky non-dimensional viscosity factor (biharmonic)
+ C     viscAhMax    :: Maximum eddy viscosity coeff. for mixing of
+ C                    momentum laterally ( m^2/s )
+ C     viscAhReMax  :: Maximum gridscale Reynolds number for eddy viscosity
+ C                     coeff. for mixing of momentum laterally (non-dim)
+ C     viscAhGrid   :: non-dimensional grid-size dependent viscosity
+ C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
+ C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
+ C     viscA4Max    :: Maximum biharmonic viscosity coeff. for mixing of
+ C                     momentum laterally ( m^4/s )
+ C     viscA4ReMax  :: Maximum Gridscale Reynolds number for
+ C                     biharmonic viscosity coeff. momentum laterally (non-dim)
+ 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     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     diffKpT   - Laplacian diffusion coeff. for mixing of
+ C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
- C                 heat vertically ( Pa^2/s )
- 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                 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     diffKpS   - Laplacian diffusion coeff. for mixing of
+ C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
- C                 salt vertically ( Pa^2/s )
- 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                 salt laterally ( m^4/s )
- C     deltaT    - Default timestep ( s )
+ C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
- C     deltaTClock  - Timestep used as model "clock". This determines the
+ C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
+ C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
+ C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
+ C     BL79LatVary    :: polarwise of this latitude diffKrBL79 is applied with
+ C                       gradual transition to diffKrBLEQ towards Equator
+ C     diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
+ C     diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
+ C     diffKrBLEQscl  :: same as diffKrBL79scl but at Equator
+ C     diffKrBLEQHo   :: same as diffKrBL79Ho but at Equator
+ C     deltaT    :: Default timestep ( s )
+ 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     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
- 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     implicSurfPress - parameter of the Crank-Nickelson time stepping :
+ C     abEps        :: Adams-Bashforth-2 stabilizing weight
+ C     alph_AB      :: Adams-Bashforth-3 primary factor
+ C     beta_AB      :: Adams-Bashforth-3 secondary factor
+ C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
- C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :
+ C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
  C                     Implicit part of barotropic flow Divergence ( 0-1 )
- C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)
+ C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
- C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)
+ C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
- C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
+ C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
- C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
+ C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
- C     tauCD        - CD scheme coupling timescale ( 1/s )
+ C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
- C     rCD          - CD scheme normalised coupling parameter ( 0-1 )
+ C     hFacSup        that control vanishing and creating levels
- C     startTime     - Starting time for this integration ( s ).
+ C     tauCD        :: CD scheme coupling timescale ( 1/s )
- C     endTime       - Ending time for this integration ( s ).
+ C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
- C     chkPtFreq     - Frequency of rolling check pointing ( s ).
+ C     baseTime      :: model base time (time origin) = time @ iteration zero
- C     pChkPtFreq    - Frequency of permanent check pointing ( s ).
+ C     startTime     :: Starting time for this integration ( s ).
- C     dumpFreq      - Frequency with which model state is written to
+ C     endTime       :: Ending time for this integration ( s ).
+ C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
+ 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     cosPower      - Power of cosine of latitude to multiply viscosity
+ C     foFacMom      :: Momentum forcing tracer parameter
- C     cAdjFreq      - Frequency of convective adjustment
+ 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
- C                     post-processing files ( s ).
+ C                      is written to post-processing files ( s ).
- C     tauThetaClimRelax - Relaxation to climatology time scale ( s ).
+ C     tave_lastIter :: (for state variable only) fraction of the last time
- C     lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
+ C                      step (of each taveFreq period) put in the time average.
- C     tauSaltClimRelax - Relaxation to climatology time scale ( s ).
+ C                      (fraction for 1rst iter = 1 - tave_lastIter)
- C     lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
+ C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
- C     externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
+ C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
- C     externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
+ C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
+ C                         i.e. where |yC| <= latBandClimRelax
+ 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                          (note: externForcingCycle must be an integer
  C                           number times externForcingPeriod)
- C     horiVertRatio      - Ratio on units in vertical to units in horizontal.
+ C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
- C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
+ C                       (use model surface (local) value if set to -1)
- C                          ( g*rho if horiz in m and vertical in Pa ).
+ C     temp_EvPrRn :: temperature of Rain & Evap.
- C     latFFTFiltLo       - Low latitude for FFT filtering of latitude
+ C     salt_EvPrRn :: salinity of Rain & Evap.
- C                          circles ( see filter*.F )
+ C        (notes: a) tracer content of Rain/Evap only used if both
- C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as
+ C                     NonLin_FrSurf & useRealFreshWater are set.
- C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
+ C                b) use model surface (local) value if set to UNSET_RL)
- C     bottomDragLinear   - Drag coefficient built in to core dynamics
+ C     hMixCrit    :: criteria for mixed-layer diagnostic
- C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )
+ C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
-       COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
+ C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
-      & cg3dTargetResidual,
+ C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
-      & delP, delZ, delR, delX, delY,
+ C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
-      & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
+ C                           (default=2: full drag ; =1: gives half-slip BC)
+ C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
+ C     bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
+ C               (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
+ C     smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
+ C                           is to be replace by a smoother function
+ C                           (affects myabs, mymin, mymax)
+ C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
+ C                      (i.e. allows convection at different Rayleigh numbers)
+ C     phiEuler      :: Euler angle, rotation about original z-axis
+ C     thetaEuler    :: Euler angle, rotation about new x-axis
+ C     psiEuler      :: Euler angle, rotation about new z-axis
+       COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
+      & cg2dpcOffDFac, cg3dTargetResidual,
+      & delR, delRc, delX, delY,
+      & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
+      & abEps, alph_AB, beta_AB,
       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
-      & fCori, fCoriG,
+      & viscAh, viscAhW, viscAhMax,
-      & viscAh,  viscAz,  viscA4,  viscAr,
+      & viscAhGrid, viscAhGridMax, viscAhGridMin,
-      & diffKhT, diffKzT, diffK4T, diffKrT,
+      & viscC2leith, viscC2leithD,
-      & diffKhS, diffKzS, diffK4S, diffKrS,
+      & viscC2smag, viscC4smag,
+      & viscAhD, viscAhZ, viscA4D, viscA4Z,
+      & viscA4, viscA4W, viscA4Max,
+      & viscA4Grid, viscA4GridMax, viscA4GridMin,
+      & viscAhReMax, viscA4ReMax,
+      & viscC4leith, viscC4leithD, viscAr,
+      & diffKhT, diffK4T, diffKrNrT,
+      & diffKhS, diffK4S, diffKrNrS,
+      & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
+      & BL79LatVary,
+      & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
-      & hFacMin, hFacMinDz,
+      & hFacMin, hFacMinDz, hFacInf, hFacSup,
-      & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
+      & gravity, recip_gravity, gBaro,
-      & recip_rhoConst, rhoConst, tRef, sRef,
+      & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
-      & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
+      & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
+      & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,
+      & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
+      & baseTime, startTime, endTime,
+      & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
+      & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
-      & cosPower,
+      & cosPower, cAdjFreq, omega, rotationPeriod,
-      & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
+      & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
-      & tauSaltClimRelax, lambdaSaltClimRelax,
       & externForcingCycle, externForcingPeriod,
-      & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
+      & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
-      & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
+      & hFacMinDr, hFacMinDp,
-      & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,
+      & ivdc_kappa, hMixCriteria, Ro_SeaLevel,
-      & bottomDragLinear,bottomDragQuadratic
+      & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
+      & smoothAbsFuncRange,
+      & tCylIn, tCylOut,
+      & phiEuler, thetaEuler, psiEuler
        _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 dTtracerLev(Nr)
-       _RL abeps
+       _RL deltaTfreesurf
+       _RL abEps, alph_AB, beta_AB
        _RL phiMin
        _RL thetaMin
        _RL rSphere
-       _RL recip_RSphere
+       _RL recip_rSphere
        _RL f0
        _RL freeSurfFac
        _RL implicSurfPress
-Line 415 
 C         "     Quadratic  ( linear: 1/s
+Line 723 
 C         "     Quadratic  ( linear: 1/s
        _RL hFacMinDz
        _RL hFacMinDp
        _RL hFacMinDr
+       _RL hFacInf
+       _RL hFacSup
        _RL beta
-       _RL viscAh
-       _RL viscAz
-       _RL viscAp
        _RL viscAr
-       _RL viscA4
+       _RL viscAh
-       _RL diffKhT
+       _RL viscAhW
-       _RL diffKrT
+       _RL viscAhD
-       _RL diffKzT
+       _RL viscAhZ
-       _RL diffKpT
+       _RL viscAhMax
-       _RL diffK4T
+       _RL viscAhReMax
-       _RL diffKhS
+       _RL viscAhGrid, viscAhGridMax, viscAhGridMin
-       _RL diffKrS
+       _RL viscC2leith
-       _RL diffKzS
+       _RL viscC2leithD
-       _RL diffKpS
+       _RL viscC2smag
-       _RL diffK4S
+       _RL viscA4
+       _RL viscA4W
+       _RL viscA4D
+       _RL viscA4Z
+       _RL viscA4Max
+       _RL viscA4ReMax
+       _RL viscA4Grid, viscA4GridMax, viscA4GridMin
+       _RL viscC4leith
+       _RL viscC4leithD
+       _RL viscC4smag
+       _RL diffKhT
+       _RL diffKrNrT(Nr)
+       _RL diffK4T
+       _RL diffKhS
+       _RL diffKrNrS(Nr)
+       _RL diffK4S
+       _RL diffKrBL79surf
+       _RL diffKrBL79deep
+       _RL diffKrBL79scl
+       _RL diffKrBL79Ho
+       _RL BL79LatVary
+       _RL diffKrBLEQsurf
+       _RL diffKrBLEQdeep
+       _RL diffKrBLEQscl
+       _RL diffKrBLEQHo
        _RL delt
        _RL tauCD
        _RL rCD
        _RL gravity
        _RL recip_gravity
        _RL gBaro
-       _RL rhonil
+       _RL rhonil,        recip_rhonil
-       _RL recip_rhonil
+       _RL rhoConst,      recip_rhoConst
-       _RL rhoConst
+       _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
-       _RL recip_rhoConst
+       _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
-       _RL specVol_S(Nr)
+       _RL rhoConstFresh
        _RL tRef(Nr)
-       _RL theta_S(Nr)
        _RL sRef(Nr)
-       _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+       _RL phiRef(2*Nr+1)
-       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+       _RL dBdrRef(Nr)
+       _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
+       _RL mass2rUnit, rUnit2mass
+       _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 mtFacMom
        _RL cosPower
        _RL cAdjFreq
        _RL omega
+       _RL rotationPeriod
        _RL tauThetaClimRelax
-       _RL lambdaThetaClimRelax
        _RL tauSaltClimRelax
-       _RL lambdaSaltClimRelax
+       _RL latBandClimRelax
        _RL externForcingCycle
        _RL externForcingPeriod
-       _RL horiVertRatio
+       _RL convertFW2Salt
-       _RL recip_horiVertRatio
+       _RL temp_EvPrRn
-       _RL latFFTFiltLo
+       _RL salt_EvPrRn
        _RL ivdc_kappa
+       _RL hMixCriteria
        _RL Ro_SeaLevel
-       _RL zonal_filt_lat
+       _RL sideDragFactor
        _RL bottomDragLinear
        _RL bottomDragQuadratic
+       _RL smoothAbsFuncRange
+       _RL nh_Am2
+       _RL tCylIn
+       _RL tCylOut
+       _RL phiEuler, thetaEuler, psiEuler
-       COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
+ C--   COMMON /PARM_A/ Thermodynamics constants ?
-      &                Lamba_theta
+       COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
        _RL HeatCapacity_Cp
-       _RL Lamba_theta
        _RL recip_Cp
- C Equation of State (polynomial coeffients)
+ C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
-       COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
+ C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
-       _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
+ C     atm_Po    :: standard reference pressure
- C Linear equation of state
+ C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
- C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).
+ C     atm_Rd    :: gas constant for dry air
- C     sBeta     - Linear EOS haline contraction coefficient.
+ C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
-       COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
+ C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
-       _RL tAlpha
+ C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
-       _RL sBeta
+ C     integr_GeoPot :: option to select the way we integrate the geopotential
-       character*(6) eosType
+ 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 useGAD
        LOGICAL useGMRedi
        LOGICAL useOBCS
        LOGICAL useAIM
+       LOGICAL useLand
+       LOGICAL useCAL
+       LOGICAL useEXF
+       LOGICAL useEBM
+       LOGICAL useGrdchk
        LOGICAL useECCO
+       LOGICAL useSHAP_FILT
+       LOGICAL useZONAL_FILT
+       LOGICAL useFLT
+       LOGICAL usePTRACERS
+       LOGICAL useGCHEM
+       LOGICAL useRBCS
+       LOGICAL useOffLine
+       LOGICAL useMATRIX
+       LOGICAL useSBO
+       LOGICAL useSEAICE
+       LOGICAL useShelfIce
+       LOGICAL useThSIce
+       LOGICAL useATM2d
+       LOGICAL useBulkForce
+       LOGICAL usefizhi
+       LOGICAL usegridalt
+       LOGICAL useDiagnostics
+       LOGICAL useMNC
+       LOGICAL useREGRID
+       LOGICAL useRunClock
+       LOGICAL useEMBED_FILES
+       LOGICAL useMYPACKAGE
+       LOGICAL useSALT_PLUME
+       LOGICAL useCheapAML
        COMMON /PARM_PACKAGES/
-      &        useKPP, useGMRedi, useOBCS, useAIM, useECCO
+      &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
+      &        useGAD, useGMRedi, useOBCS, useAIM, useLand,
+      &        useCAL, useEXF, useEBM, useGrdchk, useECCO,
+      &        useSHAP_FILT, useZONAL_FILT, useFLT,
+      &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
+      &        useSBO, useSEAICE, useShelfIce,
+      &        useThSIce, useATM2D, useBulkForce,
+      &        usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
+      &        useRunClock, useEMBED_FILES, useSALT_PLUME, useCheapAML,
+      &        useMYPACKAGE
+ CEH3 ;;; Local Variables: ***
+ CEH3 ;;; mode:fortran ***
+ CEH3 ;;; End: ***

 Legend:



Removed from v.1.49.2.2
 


changed lines


 
Added in v.1.219
 Legend:



Removed from v.1.49.2.2
 


changed lines


 
Added in v.1.219
-Removed from v.1.49.2.2
+Added in v.1.219

	ViewVC Help
Powered by ViewVC 1.1.22