/[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.259 by dimitri, Fri Mar 2 01:45:22 2012 UTC revision 1.260 by jmc, Wed Apr 11 03:52:43 2012 UTC
# Line 64  C     viscA4Zfile     :: File containing Line 64  C     viscA4Zfile     :: File containing
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing surface salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
# Line 143  C     the_run_name    :: string identify Line 143  C     the_run_name    :: string identify
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
146  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
147  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
148  C                           in con. grad solver.  C                            in con. grad solver.
149  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
151  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
152  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
153  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
154  C                           in con. grad solver.  C                            in con. grad solver.
155  C     printResidualFreq   :: Frequency for printing residual in CG iterations  C     printResidualFreq   :: Frequency for printing residual in CG iterations
156  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
157  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
# Line 174  C     selectAddFluid      :: option to a Line 174  C     selectAddFluid      :: option to a
174  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
175  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
176  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
177  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
178  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
179  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
180  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
181  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
182  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 234  C                            and statist Line 234  C                            and statist
234  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
235  C- Coordinate + Grid params:  C- Coordinate + Grid params:
236  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
237  C                        is air  C                         is air
238  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
239  C                        is water  C                         is water
240  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
241  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
242  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
243  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
244  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc   :: use the dynamical pressure in EOS (with Z-coord.)
245  C                         this requires specific code for restart & exchange  C                           this requires specific code for restart & exchange
246  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
247  C                          coordinate frame.  C                           coordinate frame.
248  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
249  C                               spherical polar frame.  C                                spherical polar frame.
250  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
251  C                        according to Euler angles phiEuler, thetaEuler, psiEuler  C                        according to Euler angles phiEuler, thetaEuler, psiEuler
252  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
# Line 298  C     maskIniTemp    :: apply mask to in Line 298  C     maskIniTemp    :: apply mask to in
298  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
299  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
300  C     checkIniSalt   :: check for points with identically zero initial salinity  C     checkIniSalt   :: check for points with identically zero initial salinity
 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)  
301  C- Pressure solver related parameters (PARM02)  C- Pressure solver related parameters (PARM02)
302  C     useSRCGSolver  :: Set to true to use conjugate gradient  C     useSRCGSolver  :: Set to true to use conjugate gradient
303  C                       solver with single reduction (only one call of  C                       solver with single reduction (only one call of
304  C                       s/r mpi_allreduce), default is false  C                       s/r mpi_allreduce), default is false
305  C- Time-stepping params:  C- Time-stepping & free-surface params:
306  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
307  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
308    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
309    C                            linear relation Phi_surf = Bo_surf*eta
310    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
311  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
312  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
313  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
314  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
315  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
316    C                         if F, converts P+R-E to salt flux (no SL effect)
317  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
318  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
319  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
# Line 380  C     printDomain     :: controls printi Line 381  C     printDomain     :: controls printi
381       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
382       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
383       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
384       & useRealFreshWaterFlux, useSRCGSolver,       & useSRCGSolver,
385       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
386       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
387         & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
388       & quasiHydrostatic, nonHydrostatic, use3Dsolver,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
389       & implicitIntGravWave, staggerTimeStep, doResetHFactors,       & implicitIntGravWave, staggerTimeStep, doResetHFactors,
390       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
# Line 436  C     printDomain     :: controls printi Line 438  C     printDomain     :: controls printi
438        LOGICAL maskIniSalt        LOGICAL maskIniSalt
439        LOGICAL checkIniTemp        LOGICAL checkIniTemp
440        LOGICAL checkIniSalt        LOGICAL checkIniSalt
       LOGICAL useRealFreshWaterFlux  
441        LOGICAL useSRCGSolver        LOGICAL useSRCGSolver
442        LOGICAL rigidLid        LOGICAL rigidLid
443        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
444          LOGICAL uniformLin_PhiSurf
445          LOGICAL uniformFreeSurfLev
446        LOGICAL exactConserv        LOGICAL exactConserv
447        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
448        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
449        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
450        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
451        LOGICAL use3Dsolver        LOGICAL use3Dsolver
# Line 635  C                    are referenced to t Line 638  C                    are referenced to t
638  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
639  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
640  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
641  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
642  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
643  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
644  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
645  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
646  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 662  C     endTime       :: Ending time for t Line 665  C     endTime       :: Ending time for t
665  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
666  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
667  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
668  C                     post-processing files ( s ).  C                      post-processing files ( s ).
669  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
670  C                     of intermediate quantities.  C                      of intermediate quantities.
671  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
672  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
673  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
Legend:
Removed from v.1.259  
changed lines
  Added in v.1.260
  ViewVC Help
Powered by ViewVC 1.1.22