/[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.240 by mlosch,
Sat Sep 25 23:09:54 2010 UTC
+revision 1.250 by dimitri,
Wed Apr 20 13:45:13 2011 UTC
 Line 33 
 C     pickupSuff      :: force to start
  C                        and read pickup files with this suffix (max 10 Char.)
  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
  C                        (+ 4 digits Processor-Rank) instead of current dir.
+ C     adTapeDir       :: read-write checkpointing tape files from/to this
+ C                        directory name instead of current dir. Conflicts
+ C                        mdsioLocalDir, so only one of the two can be set.
+ C                        In contrast to mdsioLocalDir, if specified adTapeDir
+ C                        must exist before the model starts.
  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)
-Line 78 
 C     eddyPsiYFile    :: File containing
+Line 83 
 C     eddyPsiYFile    :: File containing
  C     the_run_name    :: string identifying the name of the model "run"
        COMMON /PARM_C/
       &                buoyancyRelation, eosType,
-      &                pickupSuff, mdsioLocalDir,
+      &                pickupSuff, mdsioLocalDir, adTapeDir,
       &                tRefFile, sRefFile, rhoRefFile,
       &                delRFile, delRcFile, hybSigmFile,
       &                delXFile, delYFile, horizGridFile,
-Line 99 
 C     the_run_name    :: string identify
+Line 104 
 C     the_run_name    :: string identify
        CHARACTER*(6)  eosType
        CHARACTER*(10) pickupSuff
        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
+       CHARACTER*(MAX_LEN_FNAM) adTapeDir
        CHARACTER*(MAX_LEN_FNAM) tRefFile
        CHARACTER*(MAX_LEN_FNAM) sRefFile
        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
-Line 151 
 C     nTimeSteps          :: Number of t
+Line 157 
 C     nTimeSteps          :: Number of t
  C     writeStatePrec      :: Precision used for writing model state.
  C     writeBinaryPrec     :: Precision used for writing binary files
  C     readBinaryPrec      :: Precision used for reading binary files
+ C     selectCoriMap       :: select setting of Coriolis parameter map:
+ C                           =0 f-Plane (Constant Coriolis, = f0)
+ C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
+ C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
+ C                           =3 Read Coriolis 2-d fields from files.
+ C     selectSigmaCoord    :: option related to sigma vertical coordinate
  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     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
  C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
- C     selectSigmaCoord    :: option related to sigma vertical coordinate
  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
  C                            (3-D generalisation of oceanic real-fresh water flux)
  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
-Line 173 
 C     selectKEscheme      :: Kinetic Ene
+Line 184 
 C     selectKEscheme      :: Kinetic Ene
  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
+ C-    debugLevel          :: controls printing of algorithm intermediate results
+ C                            and statistics ; higher -> more writing
        COMMON /PARM_I/
       &        cg2dMaxIters,
-Line 183 
 C     debugLevel          :: debug level
+Line 195 
 C     debugLevel          :: debug level
       &        nIter0, nTimeSteps, nEndIter,
       &        writeStatePrec,
       &        writeBinaryPrec, readBinaryPrec,
+      &        selectCoriMap,
+      &        selectSigmaCoord,
       &        nonlinFreeSurf, select_rStar,
       &        selectNHfreeSurf,
-      &        selectSigmaCoord,
       &        selectAddFluid,
       &        momForcingOutAB, tracForcingOutAB,
       &        tempAdvScheme, tempVertAdvScheme,
-Line 203 
 C     debugLevel          :: debug level
+Line 216 
 C     debugLevel          :: debug level
        INTEGER writeStatePrec
        INTEGER writeBinaryPrec
        INTEGER readBinaryPrec
+       INTEGER selectCoriMap
+       INTEGER selectSigmaCoord
        INTEGER nonlinFreeSurf
        INTEGER select_rStar
        INTEGER selectNHfreeSurf
-       INTEGER selectSigmaCoord
        INTEGER selectAddFluid
        INTEGER momForcingOutAB, tracForcingOutAB
        INTEGER tempAdvScheme, tempVertAdvScheme
-Line 257 
 C     metricTerms   :: Flag which turns
+Line 271 
 C     metricTerms   :: Flag which turns
  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) 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     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
  C                                (default = F = use mom_fluxform package)
-Line 325 
 C                        climatology is
+Line 336 
 C                        climatology is
  C     doSaltClimRelax  :: Set true if relaxation to salinity
  C                        climatology is required.
  C     allowFreezing  :: Allows surface water to freeze and form ice
+ C     allowInteriorFreezing :: Allow water at depth to freeze and rise to the surface
  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
  C     periodicExternalForcing :: Set true if forcing is time-dependant
  C- I/O parameters -
-Line 345 
 C     snapshot_mdsio     :: use mdsio fo
+Line 357 
 C     snapshot_mdsio     :: use mdsio fo
  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.
+ C     debugMode       :: controls printing of debug msg (sequence of S/R calls).
+ C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
        COMMON /PARM_L/
       & fluidIsAir, fluidIsWater,
-Line 357 
 C                        & Last iteratio
+Line 371 
 C                        & Last iteratio
       & momViscosity, momAdvection, momForcing,
       & momPressureForcing, metricTerms, useNHMTerms,
       & useCoriolis, use3dCoriolis,
-      & useConstantF, useBetaPlaneF, useSphereF,
       & useCDscheme, vectorInvariantMomentum,
       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
       & upwindVorticity, highOrderVorticity,
-Line 366 
 C                        & Last iteratio
+Line 379 
 C                        & Last iteratio
       & tempAdvection, tempIsActiveTr, tempForcing,
       & saltAdvection, saltIsActiveTr, saltForcing,
       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
-      & useRealFreshWaterFlux,
+      & useRealFreshWaterFlux, useSRCGSolver,
       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
       & uniformLin_PhiSurf,
       & quasiHydrostatic, nonHydrostatic,
-Line 377 
 C                        & Last iteratio
+Line 390 
 C                        & Last iteratio
       & momDissip_In_AB, doAB_onGtGs,
       & balanceEmPmR, balanceQnet, balancePrintMean,
       & doThetaClimRelax, doSaltClimRelax,
-      & allowFreezing, useOldFreezing,
+      & allowFreezing, allowInteriorFreezing, useOldFreezing,
       & periodicExternalForcing,
       & globalFiles,
       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
       & writePickupAtEnd,
       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
-      & outputTypesInclusive, dumpInitAndLast, debugMode,
+      & outputTypesInclusive, dumpInitAndLast,
-      & inAdMode, inAdTrue, inAdFalse, inAdExact,
+      & debugMode, printDomain,
-      & useSRCGSolver
+      & inAdMode, inAdTrue, inAdFalse, inAdExact
        LOGICAL fluidIsAir
        LOGICAL fluidIsWater
-Line 403 
 C                        & Last iteratio
+Line 416 
 C                        & Last iteratio
        LOGICAL useNHMTerms
        LOGICAL no_slip_sides
        LOGICAL no_slip_bottom
+       LOGICAL useFullLeith
+       LOGICAL useStrainTensionVisc
+       LOGICAL useAreaViscLength
        LOGICAL momViscosity
        LOGICAL momAdvection
        LOGICAL momForcing
-Line 420 
 C                        & Last iteratio
+Line 436 
 C                        & Last iteratio
        LOGICAL checkIniTemp
        LOGICAL checkIniSalt
        LOGICAL useRealFreshWaterFlux
-       LOGICAL useFullLeith
+       LOGICAL useSRCGSolver
-       LOGICAL useStrainTensionVisc
-       LOGICAL useAreaViscLength
        LOGICAL rigidLid
        LOGICAL implicitFreeSurface
        LOGICAL exactConserv
-Line 437 
 C                        & Last iteratio
+Line 451 
 C                        & Last iteratio
        LOGICAL tempStepping
        LOGICAL saltStepping
        LOGICAL metricTerms
-       LOGICAL useConstantF
-       LOGICAL useBetaPlaneF
-       LOGICAL useSphereF
        LOGICAL use3dCoriolis
        LOGICAL useCDscheme
        LOGICAL useEnergyConservingCoriolis
-Line 464 
 C                        & Last iteratio
+Line 475 
 C                        & Last iteratio
        LOGICAL doThetaClimRelax
        LOGICAL doSaltClimRelax
        LOGICAL allowFreezing
+       LOGICAL allowInteriorFreezing
        LOGICAL useOldFreezing
        LOGICAL periodicExternalForcing
        LOGICAL globalFiles
-Line 475 
 C                        & Last iteratio
+Line 487 
 C                        & Last iteratio
        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
        LOGICAL outputTypesInclusive
        LOGICAL dumpInitAndLast
-       LOGICAL debugMode
+       LOGICAL debugMode, printDomain
        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
-       LOGICAL useSRCGSolver
  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
  C     cg2dTargetResidual
-Line 504 
 C     delR      :: Vertical grid spacing
+Line 515 
 C     delR      :: Vertical grid spacing
  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     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
+ C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
+ C                :: parameter but it makes geographical references simple.)
+ C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
+ C                :: most face (Lat-Lon grid).
  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 )
-Line 516 
 C     rho1Ref   :: reference vertical pr
+Line 532 
 C     rho1Ref   :: reference vertical pr
  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     dBdrRef   :: vertical gradient of reference buoyancy  [(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),
-Line 533 
 C     rUnit2mass :: units conversion fac
+Line 549 
 C     rUnit2mass :: units conversion fac
  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     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
- C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
- C                :: parameter but it makes geographical references simple.)
- C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
- C                :: most face (Lat-Lon grid).
  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
+ C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
  C     f0         :: Reference coriolis parameter ( 1/s )
  C                   ( Southern edge f for beta plane )
  C     beta       :: df/dy ( s^-1.m^-1 )
+ C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
+ C                   of rotation (reference value = 2.Omega.Cos(Phi))
  C     omega      :: Angular velocity ( rad/s )
  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
-Line 702 
 C     thetaEuler    :: Euler angle, rota
+Line 716 
 C     thetaEuler    :: Euler angle, rota
  C     psiEuler      :: Euler angle, rotation about new z-axis
        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
       & cg2dpcOffDFac, cg3dTargetResidual,
-      & delR, delRc, delX, delY,
+      & delR, delRc, delX, delY, xgOrigin, ygOrigin,
       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
       & abEps, alph_AB, beta_AB,
-      & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
+      & rSphere, recip_rSphere, radius_fromHorizGrid,
-      & viscAh, viscAhW, viscAhMax,
+      & f0, beta, fPrime, omega, rotationPeriod,
+      & viscFacAdj, viscAh, viscAhW, viscAhMax,
       & viscAhGrid, viscAhGridMax, viscAhGridMin,
       & viscC2leith, viscC2leithD,
       & viscC2smag, viscC4smag,
-Line 732 
 C     psiEuler      :: Euler angle, rota
+Line 747 
 C     psiEuler      :: Euler angle, rota
       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
-      & cosPower, cAdjFreq, omega, rotationPeriod,
+      & cosPower, cAdjFreq,
       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
       & externForcingCycle, externForcingPeriod,
       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
-Line 752 
 C     psiEuler      :: Euler angle, rota
+Line 767 
 C     psiEuler      :: Euler angle, rota
        _RL delRc(Nr+1)
        _RL delX(Nx)
        _RL delY(Ny)
+       _RL xgOrigin
+       _RL ygOrigin
        _RL deltaT
        _RL deltaTClock
        _RL deltaTmom
        _RL dTtracerLev(Nr)
        _RL deltaTfreesurf
        _RL abEps, alph_AB, beta_AB
-       _RL xgOrigin
-       _RL ygOrigin
        _RL rSphere
        _RL recip_rSphere
+       _RL radius_fromHorizGrid
        _RL f0
+       _RL beta
+       _RL fPrime
+       _RL omega
+       _RL rotationPeriod
        _RL freeSurfFac
        _RL implicSurfPress
        _RL implicDiv2Dflow
-Line 773 
 C     psiEuler      :: Euler angle, rota
+Line 793 
 C     psiEuler      :: Euler angle, rota
        _RL hFacMinDr
        _RL hFacInf
        _RL hFacSup
-       _RL beta
        _RL viscArNr(Nr)
+       _RL viscFacAdj
        _RL viscAh
        _RL viscAhW
        _RL viscAhD
-Line 846 
 C     psiEuler      :: Euler angle, rota
+Line 866 
 C     psiEuler      :: Euler angle, rota
        _RL mtFacMom
        _RL cosPower
        _RL cAdjFreq
-       _RL omega
-       _RL rotationPeriod
        _RL tauThetaClimRelax
        _RL tauSaltClimRelax
        _RL latBandClimRelax
-Line 941 
 C Logical flags for selecting packages
+Line 959 
 C Logical flags for selecting packages
        LOGICAL useMNC
        LOGICAL useRunClock
        LOGICAL useEMBED_FILES
-       LOGICAL useOASIS
        LOGICAL useMYPACKAGE
        COMMON /PARM_PACKAGES/
       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
-Line 955 
 C Logical flags for selecting packages
+Line 972 
 C Logical flags for selecting packages
       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
       &        useDiagnostics, useREGRID, useLayers, useMNC,
       &        useRunClock, useEMBED_FILES,
-      &        useOASIS,
       &        useMYPACKAGE
+ C     Logical flags for turning off parts of the code in adjoint mode
+       LOGICAL useKPPinAdMode, useKPPinFwdMode
+       LOGICAL useGMrediInAdMode, useGMrediInFwdMode
+       LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
+       COMMON /PARM_PACKAGES_ADJ/
+      &       useKPPinAdMode, useKPPinFwdMode,
+      &       useGMrediInAdMode, useGMrediInFwdMode,
+      &       useSEAICEinAdMode, useSEAICEinFwdMode
  CEH3 ;;; Local Variables: ***
  CEH3 ;;; mode:fortran ***
  CEH3 ;;; End: ***

 Legend:



Removed from v.1.240
 


changed lines


 
Added in v.1.250
 Legend:



Removed from v.1.240
 


changed lines


 
Added in v.1.250
-Removed from v.1.240
+Added in v.1.250

	ViewVC Help
Powered by ViewVC 1.1.22