/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.226 by dfer, Fri Nov 14 03:06:11 2008 UTC revision 1.235 by dimitri, Wed Jan 20 23:33:45 2010 UTC
# Line 143  C     nonlinFreeSurf      :: option rela Line 143  C     nonlinFreeSurf      :: option rela
143  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
144  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
145  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
146    C     selectNHfreeSurf    :: option for Non-Hydrostatic (free-)Surface formulation:
147    C                           =0 (default) hydrostatic surf. ; > 0 add NH effects.
148  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior  C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
149  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
150  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
# Line 169  C     debugLevel          :: debug level Line 171  C     debugLevel          :: debug level
171       &        writeStatePrec,       &        writeStatePrec,
172       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
173       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
174         &        selectNHfreeSurf,
175       &        selectAddFluid,       &        selectAddFluid,
176       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
177       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
# Line 188  C     debugLevel          :: debug level Line 191  C     debugLevel          :: debug level
191        INTEGER readBinaryPrec        INTEGER readBinaryPrec
192        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
193        INTEGER select_rStar        INTEGER select_rStar
194          INTEGER selectNHfreeSurf
195        INTEGER selectAddFluid        INTEGER selectAddFluid
196        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
197        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
# Line 262  C     saltAdvection  :: Flag which turns Line 266  C     saltAdvection  :: Flag which turns
266  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
267  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on
268  C                       and off.  C                       and off.
269    C     maskIniTemp    :: apply mask to initial Pot.Temp.
270    C     maskIniSalt    :: apply mask to initial salinity
271    C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
272    C     checkIniSalt   :: check for points with identically zero initial salinity
273  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
274  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
275  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
276    C- Pressure solver related parameters (PARM02)
277    C     useSRCGSolver  :: Set to true to use conjugate gradient
278    C                       solver with single reduction (only one call of
279    C                       s/r mpi_allreduce), default is false
280  C- Time-stepping params:  C- Time-stepping params:
281  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
282  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
# Line 339  C                        & Last iteratio Line 351  C                        & Last iteratio
351       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
352       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
353       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
354         & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
355       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
356       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
357       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
# Line 358  C                        & Last iteratio Line 371  C                        & Last iteratio
371       & writePickupAtEnd,       & writePickupAtEnd,
372       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
373       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
374       & inAdMode, inAdTrue, inAdFalse, inAdExact       & inAdMode, inAdTrue, inAdFalse, inAdExact,
375         & useSRCGSolver
376    
377        LOGICAL fluidIsAir        LOGICAL fluidIsAir
378        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 387  C                        & Last iteratio Line 401  C                        & Last iteratio
401        LOGICAL saltAdvection        LOGICAL saltAdvection
402        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
403        LOGICAL saltForcing        LOGICAL saltForcing
404          LOGICAL maskIniTemp
405          LOGICAL maskIniSalt
406          LOGICAL checkIniTemp
407          LOGICAL checkIniSalt
408        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
409        LOGICAL useFullLeith        LOGICAL useFullLeith
410        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
# Line 446  C                        & Last iteratio Line 464  C                        & Last iteratio
464        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
465        LOGICAL debugMode        LOGICAL debugMode
466        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
467          LOGICAL useSRCGSolver
468    
469  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
470  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 501  C     rUnit2mass :: units conversion fac Line 520  C     rUnit2mass :: units conversion fac
520  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
521  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
522  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
523  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
524  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
525  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
526  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
527  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
528    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
529  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
530  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
531  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
532  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
533  C     omega     :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
534  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
535  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
536  C                 momentum vertically ( units of r^2/s )  C                   for vertical mixing of momentum ( units of r^2/s )
537  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
538  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
539  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
540  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
541  C                 model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAh if unset ( m^2/s )
542  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
543  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
544  C                 momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
545  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
546  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
547  C                 model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4 if unset ( m^2/s )
548  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
549  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
550  C                  (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
551  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
552  C                  (act on Vorticity  part) ( m^2/s )  C                   (act on Vorticity  part) ( m^2/s )
553  C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
554  C                  (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
555  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
556  C                  (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
557  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
558  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
559  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 596  C     implicSurfPress :: parameter of th Line 616  C     implicSurfPress :: parameter of th
616  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
617  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
618  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
619    C     implicitNHPress :: parameter of the Crank-Nickelson time stepping :
620    C                     Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
621  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
622  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimensional size of a cell (affects hFacC etc..., m)
623  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
624  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
625  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
626  C     hFacSup        that control vanishing and creating levels  C     hFacSup          that control vanishing and creating levels
627  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD         :: CD scheme coupling timescale ( s )
628  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD           :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
629    C     epsAB_CD      :: Adams-Bashforth-2 stabilizing weight used in CD scheme
630  C     baseTime      :: model base time (time origin) = time @ iteration zero  C     baseTime      :: model base time (time origin) = time @ iteration zero
631  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
632  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
# Line 666  C     psiEuler      :: Euler angle, rota Line 689  C     psiEuler      :: Euler angle, rota
689       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
690       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
691       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
692       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
693       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
694       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
695       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
# Line 675  C     psiEuler      :: Euler angle, rota Line 698  C     psiEuler      :: Euler angle, rota
698       & viscA4, viscA4W, viscA4Max,       & viscA4, viscA4W, viscA4Max,
699       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
700       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
701       & viscC4leith, viscC4leithD, viscAr,       & viscC4leith, viscC4leithD, viscArNr,
702       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
703       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
704       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
705       & BL79LatVary,       & BL79LatVary,
706       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
707       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & tauCD, rCD, epsAB_CD,
708         & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
709       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
710       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
711       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
# Line 717  C     psiEuler      :: Euler angle, rota Line 741  C     psiEuler      :: Euler angle, rota
741        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
742        _RL deltaTfreesurf        _RL deltaTfreesurf
743        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
744        _RL phiMin        _RL xgOrigin
745        _RL thetaMin        _RL ygOrigin
746        _RL rSphere        _RL rSphere
747        _RL recip_rSphere        _RL recip_rSphere
748        _RL f0        _RL f0
749        _RL freeSurfFac        _RL freeSurfFac
750        _RL implicSurfPress        _RL implicSurfPress
751        _RL implicDiv2Dflow        _RL implicDiv2Dflow
752          _RL implicitNHPress
753        _RL hFacMin        _RL hFacMin
754        _RL hFacMinDz        _RL hFacMinDz
755        _RL hFacMinDp        _RL hFacMinDp
# Line 732  C     psiEuler      :: Euler angle, rota Line 757  C     psiEuler      :: Euler angle, rota
757        _RL hFacInf        _RL hFacInf
758        _RL hFacSup        _RL hFacSup
759        _RL beta        _RL beta
760        _RL viscAr        _RL viscArNr(Nr)
761        _RL viscAh        _RL viscAh
762        _RL viscAhW        _RL viscAhW
763        _RL viscAhD        _RL viscAhD
# Line 768  C     psiEuler      :: Euler angle, rota Line 793  C     psiEuler      :: Euler angle, rota
793        _RL diffKrBLEQdeep        _RL diffKrBLEQdeep
794        _RL diffKrBLEQscl        _RL diffKrBLEQscl
795        _RL diffKrBLEQHo        _RL diffKrBLEQHo
796        _RL delt        _RL tauCD, rCD, epsAB_CD
       _RL tauCD  
       _RL rCD  
797        _RL gravity        _RL gravity
798        _RL recip_gravity        _RL recip_gravity
799        _RL gBaro        _RL gBaro
# Line 873  C Logical flags for selecting packages Line 896  C Logical flags for selecting packages
896        LOGICAL useEBM        LOGICAL useEBM
897        LOGICAL useCheapAML        LOGICAL useCheapAML
898        LOGICAL useGrdchk        LOGICAL useGrdchk
899          LOGICAL useSMOOTH
900        LOGICAL useECCO        LOGICAL useECCO
901        LOGICAL useSBO        LOGICAL useSBO
902        LOGICAL useFLT        LOGICAL useFLT
# Line 884  C Logical flags for selecting packages Line 908  C Logical flags for selecting packages
908        LOGICAL useSEAICE        LOGICAL useSEAICE
909        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
910        LOGICAL useShelfIce        LOGICAL useShelfIce
911          LOGICAL useICEFRONT
912        LOGICAL useThSIce        LOGICAL useThSIce
913        LOGICAL useATM2d        LOGICAL useATM2d
914        LOGICAL useAIM        LOGICAL useAIM
# Line 892  C Logical flags for selecting packages Line 917  C Logical flags for selecting packages
917        LOGICAL useGridAlt        LOGICAL useGridAlt
918        LOGICAL useDiagnostics        LOGICAL useDiagnostics
919        LOGICAL useREGRID        LOGICAL useREGRID
920          LOGICAL useLayers
921        LOGICAL useMNC        LOGICAL useMNC
922        LOGICAL useRunClock        LOGICAL useRunClock
923        LOGICAL useEMBED_FILES        LOGICAL useEMBED_FILES
# Line 901  C Logical flags for selecting packages Line 927  C Logical flags for selecting packages
927       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
928       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useDOWN_SLOPE,
929       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
930       &        useGrdchk, useECCO, useSBO, useFLT,       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
931       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
932       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useSEAICE, useSALT_PLUME, useShelfIce,
933         &        useICEFRONT, useThSIce,
934       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
935       &        useDiagnostics, useREGRID, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
936       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
937       &        useMYPACKAGE       &        useMYPACKAGE
938  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
Legend:
Removed from v.1.226  
changed lines
  Added in v.1.235
  ViewVC Help
Powered by ViewVC 1.1.22