/[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.66 by adcroft,
Mon Nov 26 17:11:45 2001 UTC
+revision 1.158 by adcroft,
Tue May 31 18:24:27 2005 UTC
 Line 1
  C $Header$
  C $Name$
  C
  CBOP
- C    !ROUTINE: PARAMS.h
+ C     !ROUTINE: PARAMS.h
- C    !INTERFACE:
+ C     !INTERFACE:
- C    include PARAMS.h
+ C     #include PARAMS.h
- C    !DESCRIPTION: \bv
- C     *==========================================================*
+ C     !DESCRIPTION:
- C     | PARAMS.h
+ C     Header file defining model "parameters".  The values from the
- C     | o Header file defining model "parameters".
+ C     model standard input file are stored into the variables held
- C     *==========================================================*
+ C     here. Notes describing the parameters can also be found here.
- 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
-Line 65 
 C     thetaClimFile   :: File containing
+Line 62 
 C     thetaClimFile   :: File containing
  C                       in relaxation term -lambda(theta-theta*)
  C     saltClimFile    :: File containing salt climataology used
  C                       in relaxation term -lambda(salt-salt*)
- C     surfQfile       :: File containing surface heat flux
+ C     surfQfile       :: File containing surface heat flux, excluding SW
- C     surfQswfile     :: File containing surface shortwave radiation
+ C                        (old version, kept for backward compatibility)
+ C     surfQnetFile    :: File containing surface net heat flux
+ C     surfQswFile     :: File containing surface shortwave radiation
  C     dQdTfile        :: File containing thermal relaxation coefficient
  C     EmPmRfile       :: File containing surface fresh water flux
+ C     saltFluxFile    :: File containing surface salt flux
+ C     pLoadFile       :: File containing pressure loading
+ C     eddyTauxFile    :: File containing zonal Eddy stress data
+ C     eddyTauyFile    :: File containing meridional Eddy stress data
  C     buoyancyRelation :: Flag used to indicate which relation to use to
  C                        get buoyancy.
+ C     eosType         :: choose the equation of state:
+ C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
+ C     the_run_name    :: string identifying the name of the model "run"
        COMMON /PARM_C/ checkPtSuff,
       &                bathyFile, topoFile,
       &                hydrogThetaFile, hydrogSaltFile,
       &                zonalWindFile, meridWindFile, thetaClimFile,
       &                saltClimFile, buoyancyRelation,
-      &                EmPmRfile, surfQfile, surfQswfile,
+      &                EmPmRfile, saltFluxFile,
+      &                surfQfile, surfQnetFile, surfQswFile,
+      &                lambdaThetaFile, lambdaSaltFile,
       &                uVelInitFile, vVelInitFile, pSurfInitFile,
-      &                dQdTfile
+      &                dQdTfile, ploadFile,
+      &                eddyTauxFile, eddyTauyFile,
+      &                eosType, pickupSuff,
+      &                mdsioLocalDir,
+      &                the_run_name
        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
-Line 88 
 C                        get buoyancy.
+Line 100 
 C                        get buoyancy.
        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) saltFluxFile
        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
        CHARACTER*(MAX_LEN_FNAM) dQdTfile
+       CHARACTER*(MAX_LEN_FNAM) ploadFile
+       CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
+       CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
+       CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
+       CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
+       CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
+       CHARACTER*(MAX_LEN_FNAM) the_run_name
+       CHARACTER*(6) eosType
+       CHARACTER*(10) pickupSuff
  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
  C     cg2dMaxIters        :: Maximum number of iterations in the
  C                           two-dimensional con. grad solver.
  C     cg2dChkResFreq      :: Frequency with which to check residual
  C                           in con. grad solver.
+ C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
+ C                            (non-linear free-surf.)
  C     cg3dMaxIters        :: Maximum number of iterations in the
  C                           three-dimensional con. grad solver.
  C     cg3dChkResFreq      :: Frequency with which to check residual
-Line 115 
 C     readBinaryPrec      :: Precision u
+Line 140 
 C     readBinaryPrec      :: Precision u
  C     nCheckLev           :: Holds current checkpoint level
  C     nonlinFreeSurf      :: option related to non-linear free surface
  C                           =0 Linear free surface ; >0 Non-linear
+ C     select_rStar        :: option related to r* vertical coordinate
+ C                           =0 (default) use r coord. ; > 0 use r*
+ C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
+ C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
+ C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
+ C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
+ C     debugLevel          :: debug level selector: higher -> more writing
        COMMON /PARM_I/
       &        cg2dMaxIters,
-      &        cg2dChkResFreq,
+      &        cg2dChkResFreq, cg2dPreCondFreq,
       &        cg3dMaxIters,
       &        cg3dChkResFreq,
       &        nIter0, nTimeSteps, nEndIter,
       &        numStepsPerPickup,
       &        writeStatePrec, nCheckLev,
       &        writeBinaryPrec, readBinaryPrec,
-      &        nonlinFreeSurf,
+      &        nonlinFreeSurf, select_rStar,
-      &        zonal_filt_sinpow, zonal_filt_cospow,
+      &        tempAdvScheme, tempVertAdvScheme,
-      &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
+      &        saltAdvScheme, saltVertAdvScheme,
+      &        debugLevel
        INTEGER cg2dMaxIters
        INTEGER cg2dChkResFreq
+       INTEGER cg2dPreCondFreq
        INTEGER cg3dMaxIters
        INTEGER cg3dChkResFreq
        INTEGER nIter0
-Line 141 
 C                           =0 Linear fr
+Line 175 
 C                           =0 Linear fr
        INTEGER readBinaryPrec
        INTEGER nCheckLev
        INTEGER nonlinFreeSurf
-       INTEGER zonal_filt_sinpow
+       INTEGER select_rStar
-       INTEGER zonal_filt_cospow
+       INTEGER tempAdvScheme, tempVertAdvScheme
-       INTEGER tempAdvScheme
+       INTEGER saltAdvScheme, saltVertAdvScheme
-       INTEGER saltAdvScheme
+       INTEGER debugLevel
-       INTEGER tracerAdvScheme
+ C
+       INTEGER debLevZero
+       PARAMETER(debLevZero=0)
+       INTEGER debLevA
+       PARAMETER(debLevA=1)
+       INTEGER debLevB
+       PARAMETER(debLevB=2)
  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
  C                          coordinate frame.
  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
  C                               spherical polar frame.
+ C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
-Line 163 
 C     momPressureForcing :: Flag which t
+Line 205 
 C     momPressureForcing :: Flag which t
  C                          on and off.
  C     metricTerms   :: Flag which turns metric terms on or off.
  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
+ C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
- C     tempDiffusion :: Flag which turns diffusion of temperature on
- C                     and off.
  C     tempAdvection :: Flag which turns advection of temperature on
  C                     and off.
  C     tempForcing   :: Flag which turns external forcing of temperature on
  C                     and off.
- C     saltDiffusion :: Flag which turns diffusion of salinit on
+ C     saltAdvection :: Flag which turns advection of salinity on
  C                     and off.
- C     saltAdvection :: Flag which turns advection of salinit on
+ C     saltForcing   :: Flag which turns external forcing of salinity on
- C                     and off.
- C     saltForcing   :: Flag which turns external forcing of salinit on
  C                     and off.
+ C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
+ C                         as a real Fresh Water (=> changes the Sea Level)
+ C                         if F, converts P+R-E to salt flux (no SL effect)
+ C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable
+ C                       on irregular grids)
+ C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest
+ C              anisotropic length scale.  It is used only for maximum viscosity
+ C              calculations.  Alistair recommends a value of viscA*GridMax=.25
  C     rigidLid            :: Set to true to use rigid lid
  C     implicitFreeSurface :: Set to true to use implcit free surface
  C     exactConserv        :: Set to true to conserve exactly the total Volume
-Line 184 
 C                           linear relat
+Line 231 
 C                           linear relat
  C     momStepping   :: Turns momentum equation time-stepping off
  C     tempStepping  :: Turns temperature equation time-stepping off
  C     saltStepping  :: Turns salinity equation time-stepping off
- C     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     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
+ C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
+ C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
+ C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
+ C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
+ C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
+ C     useAbsVorticity :: work with f+zeta in Coriolis terms
  C     implicitDiffusion :: Turns implicit vertical diffusion on
  C     implicitViscosity :: Turns implicit vertical viscosity on
+ C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
+ C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
+ C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
+ C     multiDimAdvection :: Flag that enable multi-dimension advection
+ C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
+ C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
+ C                      out off Adams-Bashforth time stepping.
+ C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
  C     doThetaClimRelax :: Set true if relaxation to temperature
  C                        climatology is required.
  C     doSaltClimRelax  :: Set true if relaxation to salinity
  C                        climatology is required.
  C     periodicExternalForcing :: Set true if forcing is time-dependant
- C     usingPCoords     :: Set to indicate that we are working in pressure
+ C     usingPCoords     :: Set to indicate that we are working in a pressure
- C                        coords.
+ C                        type coordinate (p or p*).
- C     usingZCoords     :: Set to indicate that we are working in height
+ C     usingZCoords     :: Set to indicate that we are working in a height
- C                        coords.
+ C                        type coordinate (z or z*)
+ C     fluidIsAir       :: Set to indicate that the fluid major constituent
+ C                        is air
+ C     fluidIsWater     :: Set to indicate that the fluid major constituent
+ C                        is water
+ C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
+ C                         this requires specific code for restart & exchange
+ C     setCenterDr    :: set cell Center depth and put Interface at the middle
  C     nonHydrostatic :: Using non-hydrostatic terms
+ C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
  C     globalFiles    :: Selects between "global" and "tiled" files
- C     allowFreezing  :: Allows water to freeze and form ice
+ C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
+ C                       slow (f77) or does not work (f90).  When
+ C                       useSingleCpuIO is set, mdsio_writefield.F
+ C                       outputs from master mpi process only.
+ C     allowFreezing  :: Allows surface water to freeze and form ice
+ C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
- C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
+ C     pickup_write_mdsio :: use mdsio to write pickups
+ C     pickup_read_mdsio  :: use mdsio to read  pickups
+ C     pickup_write_immed :: echo the pickup immediately (for conversion)
+ C     timeave_mdsio      :: use mdsio for timeave output
+ C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
+ C     monitor_stdio      :: use stdio for monitor output
+ C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
+ C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
+ C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
+ C                      calendar months and years.  Requires pkg/cal.
        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
-      & usingCurvilinearGrid,
+      & usingCurvilinearGrid, usingCylindricalGrid,
       & no_slip_sides,no_slip_bottom,
       & staggerTimeStep,
       & momViscosity, momAdvection, momForcing, useCoriolis,
       & momPressureForcing, vectorInvariantMomentum,
-      & tempDiffusion, tempAdvection, tempForcing,
+      & tempAdvection, tempForcing,
-      & saltDiffusion, saltAdvection, saltForcing,
+      & saltAdvection, saltForcing,
+      & useRealFreshWaterFlux,
+      & useFullLeith, useAnisotropicViscAGridMax,
       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
-      & momStepping, tempStepping, saltStepping, tr1Stepping,
+      & momStepping, tempStepping, saltStepping,
-      & metricTerms, usingSphericalPolarMTerms,
+      & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
       & useConstantF, useBetaPlaneF, useSphereF,
+      & useCDscheme,
+      & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
+      & SadournyCoriolis, upwindVorticity, highOrderVorticity,
+      & useAbsVorticity,
       & implicitDiffusion, implicitViscosity,
+      & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
+      & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
-      & periodicExternalForcing, usingPCoords, usingZCoords,
+      & periodicExternalForcing,
-      & nonHydrostatic, globalFiles,
+      & fluidIsAir, fluidIsWater,
-      & allowFreezing, groundAtK1,
+      & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
-      & usePickupBeforeC35, debugMode,
+      & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
-      & readPickupWithTracer, writePickupWithTracer,
+      & allowFreezing, useOldFreezing, groundAtK1,
-      & multiDimAdvection, useEnergyConservingCoriolis,
+      & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
-      & useJamartWetPoints
+      & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
+      & timeave_mdsio, snapshot_mdsio, monitor_stdio,
+      & outputTypesInclusive, debugMode,
+      & inAdMode, inAdTrue, inAdFalse, inAdExact,
+      & calendarDumps
        LOGICAL usingCartesianGrid
        LOGICAL usingSphericalPolarGrid
+       LOGICAL usingCylindricalGrid
        LOGICAL usingCurvilinearGrid
        LOGICAL usingSphericalPolarMTerms
+       LOGICAL useNHMTerms
        LOGICAL no_slip_sides
        LOGICAL no_slip_bottom
        LOGICAL staggerTimeStep
-Line 238 
 C     useJamartWetPoints :: Use wet-poin
+Line 336 
 C     useJamartWetPoints :: Use wet-poin
        LOGICAL momPressureForcing
        LOGICAL useCoriolis
        LOGICAL vectorInvariantMomentum
-       LOGICAL tempDiffusion
        LOGICAL tempAdvection
        LOGICAL tempForcing
-       LOGICAL saltDiffusion
        LOGICAL saltAdvection
        LOGICAL saltForcing
+       LOGICAL useRealFreshWaterFlux
+       LOGICAL useFullLeith, useAnisotropicViscAGridMax
        LOGICAL rigidLid
        LOGICAL implicitFreeSurface
        LOGICAL exactConserv
-Line 251 
 C     useJamartWetPoints :: Use wet-poin
+Line 349 
 C     useJamartWetPoints :: Use wet-poin
        LOGICAL momStepping
        LOGICAL tempStepping
        LOGICAL saltStepping
-       LOGICAL tr1Stepping
        LOGICAL metricTerms
        LOGICAL useConstantF
        LOGICAL useBetaPlaneF
        LOGICAL useSphereF
+       LOGICAL useCDscheme
+       LOGICAL useEnergyConservingCoriolis
+       LOGICAL useJamartWetPoints
+       LOGICAL useJamartMomAdv
+       LOGICAL SadournyCoriolis
+       LOGICAL upwindVorticity
+       LOGICAL highOrderVorticity
+       LOGICAL useAbsVorticity
        LOGICAL implicitDiffusion
        LOGICAL implicitViscosity
+       LOGICAL tempImplVertAdv
+       LOGICAL saltImplVertAdv
+       LOGICAL momImplVertAdv
+       LOGICAL multiDimAdvection
+       LOGICAL useMultiDimAdvec
+       LOGICAL forcing_In_AB
        LOGICAL doThetaClimRelax
        LOGICAL doSaltClimRelax
        LOGICAL doTr1ClimRelax
        LOGICAL periodicExternalForcing
+       LOGICAL fluidIsAir
+       LOGICAL fluidIsWater
        LOGICAL usingPCoords
        LOGICAL usingZCoords
+       LOGICAL useDynP_inEos_Zc
+       LOGICAL setCenterDr
        LOGICAL nonHydrostatic
+       LOGICAL quasiHydrostatic
        LOGICAL globalFiles
+       LOGICAL useSingleCpuIO
        LOGICAL allowFreezing
+       LOGICAL useOldFreezing
        LOGICAL groundAtK1
        LOGICAL usePickupBeforeC35
+       LOGICAL usePickupBeforeC54
+       LOGICAL startFromPickupAB2
        LOGICAL debugMode
-       LOGICAL readPickupWithTracer
+       LOGICAL pickup_read_mdsio, pickup_write_mdsio
-       LOGICAL writePickupWithTracer
+       LOGICAL pickup_write_immed
-       LOGICAL multiDimAdvection
+       LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
-       LOGICAL useEnergyConservingCoriolis
+       LOGICAL outputTypesInclusive
-       LOGICAL useJamartWetPoints
+       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
+       LOGICAL calendarDumps
  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
- C     gg2dTargetResidual
+ C     cg2dTargetResidual
  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
  C     cg2dTargetResWunit
  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
-Line 297 
 C           number of iterations for con
+Line 418 
 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     delZ      :: Vertical grid spacing ( m  ).
  C     delR      :: Vertical grid spacing ( units of r ).
+ C     delRc     :: Vertical grid spacing between cell centers (r unit).
  C     delX      :: Separation between cell faces (m) or (deg), depending
  C     delY        on input flags.
  C     gravity   :: Accel. due to gravity ( m/s^2 )
  C     recip_gravity and its inverse
  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     startTime :: Start time for model ( s )
+ C     rhoConstFresh :: Constant reference density for fresh water (rain)
+ C     tRef      :: reference vertical profile for potential temperature
+ C     sRef      :: reference vertical profile for salinity/specific humidity
  C     phiMin    :: Latitude of southern most cell face.
  C     thetaMin  :: Longitude of western most cell face (this
  C                 is an "inert" parameter but it is included
-Line 318 
 C     f0        :: Reference coriolis pa
+Line 440 
 C     f0        :: Reference coriolis pa
  C                 ( Southern edge f for beta plane )
  C     beta      :: df/dy ( s^-1.m^-1 )
  C     omega     :: Angular velocity ( rad/s )
+ C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
  C     viscAh    :: Eddy viscosity coeff. for mixing of
  C                 momentum laterally ( m^2/s )
- C     viscAz    :: Eddy viscosity coeff. for mixing of
+ C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
- C                 momentum vertically ( m^2/s )
+ C                 momentum laterally, no effect for hydrostatic
- C     viscAp    :: Eddy viscosity coeff. for mixing of
+ C                 model, defaults to viscAh if unset ( m^2/s )
- 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                 momentum laterally ( m^4/s )
+ C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
+ C                 momentum laterally, no effect for hydrostatic
+ C                 model, defaults to viscA4 if unset ( m^2/s )
+ C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
+ C                  (act on Divergence part) ( m^2/s )
+ C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
+ C                  (act on Vorticity  part) ( m^2/s )
+ C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
+ C                  (act on Divergence part) ( m^4/s )
+ C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
+ C                  (act on Vorticity  part) ( m^4/s )
+ C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
+ C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
+ C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor
+ C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
+ C                 momentum laterally ( m^2/s )
+ C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
+ C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity
+ C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
+ C                 momentum laterally ( m^4/s )
+ C     viscAhGrid:: non-dimensional grid-size dependent viscosity
+ C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
+ C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
+ C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
+ C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
+ C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
  C                 heat laterally ( m^2/s )
- C     diffKzT   :: Laplacian diffusion coeff. for mixing of
+ C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
- C                 heat vertically ( m^2/s )
+ C                 for mixing of heat vertically ( units of r^2/s )
- C     diffKpT   :: Laplacian 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                 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                 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     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
+ 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     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
-Line 356 
 C                    it will be the deep
+Line 500 
 C                    it will be the deep
  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     deltaTtracer :: Timestep for tracer equations ( s )
+ C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
+ 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     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 :
-Line 372 
 C     hFacInf      :: Threshold (inf and
+Line 520 
 C     hFacInf      :: Threshold (inf and
  C     hFacSup        that control vanishing and creating levels
  C     tauCD        :: CD scheme coupling timescale ( 1/s )
  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
+ C     baseTime      :: model base time (time origin) = time @ iteration zero
  C     startTime     :: Starting time for this integration ( s ).
  C     endTime       :: Ending time for this integration ( s ).
  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
-Line 389 
 C     mtFacMom      :: Metric terms trac
+Line 538 
 C     mtFacMom      :: Metric terms trac
  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     tave_lastIter :: (for state variable only) fraction of the last time
+ C                      step (of each taveFreq period) put in the time average.
+ C                      (fraction for 1rst iter = 1 - tave_lastIter)
  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
- C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
- C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
+ 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     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
+ C                       (use model surface (local) value if set to -1)
+ C     temp_EvPrRn :: temperature of Rain & Evap.
+ C     salt_EvPrRn :: salinity of Rain & Evap.
+ C        (notes: a) tracer content of Rain/Evap only used if both
+ C                     NonLin_FrSurf & useRealFreshWater are set.
+ C                b) use model surface (local) value if set to UNSET_RL)
  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
  C                          ( g*rho if horiz in m and vertical in Pa ).
- C     latFFTFiltLo       :: Low latitude for FFT filtering of latitude
- C                          circles ( see filter*.F )
  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, delX, delY,
+      & delR, delRc, delX, delY,
-      & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
+      & 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, viscAstrain, viscAtension,
+      & viscAhGrid, viscAhGridMax, viscAhGridMin,
-      & diffKhT, diffKzT, diffK4T, diffKrT,
+      & viscC2leith, viscC2leithD,
-      & diffKhS, diffKzS, diffK4S, diffKrS,
+      & viscC2smag,
+      & viscAhD, viscAhZ, viscA4D, viscA4Z,
+      & viscA4, viscA4W,
+      & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
+      & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
+      & diffKhT, diffK4T, diffKrNrT,
+      & diffKhS, diffK4S, diffKrNrS,
+      & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
       & hFacMin, hFacMinDz, hFacInf, hFacSup,
       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
-      & recip_rhoConst, rhoConst, tRef, sRef,
+      & recip_rhoConst, rhoConst,
-      & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
+      & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
-      & diagFreq, taveFreq, monitorFreq,
+      & baseTime, startTime, endTime,
+      & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
+      & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
-      & cosPower, cAdjFreq, omega,
+      & cosPower, cAdjFreq, omega, rotationPeriod,
-      & tauThetaClimRelax, lambdaThetaClimRelax,
+      & tauThetaClimRelax,
-      & tauSaltClimRelax, lambdaSaltClimRelax,
+      & tauSaltClimRelax,
-      & tauTr1ClimRelax, lambdaTr1ClimRelax,
+      & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
       & 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,
+      & horiVertRatio, recip_horiVertRatio,
-      & bottomDragLinear,bottomDragQuadratic
+      & ivdc_kappa, Ro_SeaLevel,
+      & bottomDragLinear,bottomDragQuadratic,nh_Am2,
+      & tCylIn, tCylOut
+       _RL nh_Am2
        _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
-Line 464 
 C      --"-"--  Quadratic  ( linear: 1/s
+Line 634 
 C      --"-"--  Quadratic  ( linear: 1/s
        _RL hFacSup
        _RL beta
        _RL viscAh
+       _RL viscAhW
+       _RL viscAhD
+       _RL viscAhZ
+       _RL viscAhMax
+       _RL viscAhGrid
+       _RL viscAhGridMax
+       _RL viscAhGridMin
+       _RL viscC2leith
+       _RL viscC2leithD
+       _RL viscC2smag
        _RL viscAstrain
        _RL viscAtension
-       _RL viscAz
-       _RL viscAp
        _RL viscAr
        _RL viscA4
+       _RL viscA4W
+       _RL viscA4D
+       _RL viscA4Z
+       _RL viscA4Max
+       _RL viscA4Grid, viscA4GridMax, viscA4GridMin
+       _RL viscC4leith
+       _RL viscC4leithD
        _RL diffKhT
-       _RL diffKrT
+       _RL diffKrNrT(Nr)
-       _RL diffKzT
-       _RL diffKpT
        _RL diffK4T
        _RL diffKhS
-       _RL diffKrS
+       _RL diffKrNrS(Nr)
-       _RL diffKzS
-       _RL diffKpS
        _RL diffK4S
+       _RL diffKrBL79surf
+       _RL diffKrBL79deep
+       _RL diffKrBL79scl
+       _RL diffKrBL79Ho
        _RL delt
        _RL tauCD
        _RL rCD
-Line 490 
 C      --"-"--  Quadratic  ( linear: 1/s
+Line 675 
 C      --"-"--  Quadratic  ( linear: 1/s
        _RL recip_rhonil
        _RL rhoConst
        _RL recip_rhoConst
-       _RL specVol_S(Nr)
+       _RL rhoConstFresh
+       _RL convertEmP2rUnit
        _RL tRef(Nr)
-       _RL theta_S(Nr)
        _RL sRef(Nr)
-       _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
+       _RL baseTime
-       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
        _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
-Line 513 
 C      --"-"--  Quadratic  ( linear: 1/s
+Line 700 
 C      --"-"--  Quadratic  ( linear: 1/s
        _RL cosPower
        _RL cAdjFreq
        _RL omega
+       _RL rotationPeriod
        _RL tauThetaClimRelax
-       _RL lambdaThetaClimRelax
        _RL tauSaltClimRelax
-       _RL lambdaSaltClimRelax
        _RL tauTr1ClimRelax
        _RL lambdaTr1ClimRelax
+       _RL latBandClimRelax
        _RL externForcingCycle
        _RL externForcingPeriod
+       _RL convertFW2Salt
+       _RL temp_EvPrRn
+       _RL salt_EvPrRn
        _RL horiVertRatio
        _RL recip_horiVertRatio
-       _RL latFFTFiltLo
        _RL ivdc_kappa
        _RL Ro_SeaLevel
-       _RL zonal_filt_lat
        _RL bottomDragLinear
        _RL bottomDragQuadratic
+       _RL tCylIn
+       _RL tCylOut
-       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.
-       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     atm_Rq    :: water vapour specific volume anomaly relative to dry air
+ C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
+ C     integr_GeoPot :: option to select the way we integrate the geopotential
  C                     (still a subject of discussions ...)
-       COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
+ C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
-      &                  Integr_GeoPot
+ C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
-       _RL atm_cp, atm_kappa, atm_po
+       COMMON /PARM_ATM/
-       INTEGER Integr_GeoPot
+      &            celsius2K,
+      &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
+      &            integr_GeoPot, selectFindRoSurf
+       _RL celsius2K
+       _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
+       INTEGER integr_GeoPot, selectFindRoSurf
  C Logical flags for selecting packages
+       LOGICAL useOPPS
+       LOGICAL usePP81
+       LOGICAL useMY82
+       LOGICAL useGGL90
        LOGICAL useKPP
        LOGICAL useGMRedi
        LOGICAL useOBCS
        LOGICAL useAIM
+       LOGICAL useLand
        LOGICAL useGrdchk
        LOGICAL useECCO
        LOGICAL useSHAP_FILT
+       LOGICAL useZONAL_FILT
        LOGICAL useFLT
+       LOGICAL usePTRACERS
+       LOGICAL useGCHEM
+       LOGICAL useSBO
+       LOGICAL useSEAICE
+       LOGICAL useBulkForce
+       LOGICAL useThSIce
+       LOGICAL usefizhi
+       LOGICAL usegridalt
+       LOGICAL usediagnostics
+       LOGICAL useEBM
+       LOGICAL useMNC
+       LOGICAL useMATRIX
+       LOGICAL useRunClock
        COMMON /PARM_PACKAGES/
-      &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
+      &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
-      &        useSHAP_FILT, useGrdchk, useFLT
+      &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
+      &        usePTRACERS, useGCHEM,
+      &        useSBO, useSEAICE, useThSIce, useBulkForce,
+      &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
+      &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
+      &        useRunClock
+ CEH3 ;;; Local Variables: ***
+ CEH3 ;;; mode:fortran ***
+ CEH3 ;;; End: ***

 Legend:



Removed from v.1.66
 


changed lines


 
Added in v.1.158
 Legend:



Removed from v.1.66
 


changed lines


 
Added in v.1.158
-Removed from v.1.66
+Added in v.1.158

	ViewVC Help
Powered by ViewVC 1.1.22