Belos Package Browser (Single Doxygen Collection)
Development
|
Interface to Block GMRES and Flexible GMRES. More...
#include <BelosBlockGmresSolMgr.hpp>
Private Types | |
typedef MultiVecTraits< ScalarType, MV > | MVT |
typedef OperatorTraits< ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits< ScalarType > | SCT |
typedef Teuchos::ScalarTraits< ScalarType >::magnitudeType | MagnitudeType |
typedef Teuchos::ScalarTraits< MagnitudeType > | MT |
BlockGmresSolMgr Exceptions | |
static const MagnitudeType | convtol_default_ = 1e-8 |
static const MagnitudeType | orthoKappa_default_ = -1.0 |
static const int | maxRestarts_default_ = 20 |
static const int | maxIters_default_ = 1000 |
static const bool | adaptiveBlockSize_default_ = true |
static const bool | showMaxResNormOnly_default_ = false |
static const bool | flexibleGmres_default_ = false |
static const bool | expResTest_default_ = false |
static const int | blockSize_default_ = 1 |
static const int | numBlocks_default_ = 300 |
static const int | verbosity_default_ = Belos::Errors |
static const int | outputStyle_default_ = Belos::General |
static const int | outputFreq_default_ = -1 |
static const std::string | impResScale_default_ = "Norm of Preconditioned Initial Residual" |
static const std::string | expResScale_default_ = "Norm of Initial Residual" |
static const std::string | label_default_ = "Belos" |
static const std::string | orthoType_default_ = "DGKS" |
static const Teuchos::RCP< std::ostream > | outputStream_default_ = Teuchos::rcp(&std::cout,false) |
bool | checkStatusTest () |
Constructors/Destructor | |
BlockGmresSolMgr () | |
Empty constructor for BlockGmresSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters(). More... | |
BlockGmresSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for BlockGmresSolMgr. More... | |
virtual | ~BlockGmresSolMgr () |
Destructor. More... | |
Accessor methods | |
const LinearProblem< ScalarType, MV, OP > & | getProblem () const |
Get current linear problem being solved for in this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Get a parameter list containing the valid parameters for this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const |
Get a parameter list containing the current parameters for this object. More... | |
Teuchos::Array< Teuchos::RCP< Teuchos::Time > > | getTimers () const |
Return the timers for this object. More... | |
MagnitudeType | achievedTol () const |
Tolerance achieved by the last solve() invocation. More... | |
int | getNumIters () const |
Get the iteration count for the most recent call to solve() . More... | |
bool | isLOADetected () const |
Return whether a loss of accuracy was detected by this solver during the most current solve. More... | |
Set methods | |
void | setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) |
Set the linear problem that needs to be solved. More... | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) |
Set the parameters the solver manager should use to solve the linear problem. More... | |
Reset methods | |
void | reset (const ResetType type) |
Performs a reset of the solver manager specified by the ResetType . This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy. More... | |
Solver application methods | |
ReturnType | solve () |
This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit. More... | |
Overridden from Teuchos::Describable | |
void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const |
Print the object with the given verbosity level to a FancyOStream. More... | |
std::string | description () const |
Return a one-line description of this object. More... | |
Additional Inherited Members | |
![]() | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual void | setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &comboType=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
Set user-defined convergence status test. More... | |
virtual void | setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debugStatusTest) |
Set user-defined debug status test. More... | |
![]() | |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
![]() | |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
![]() | |
static const EVerbosityLevel | verbLevel_default |
Interface to Block GMRES and Flexible GMRES.
This class provides an interface to Block GMRES, for solving linear systems with one or more right-hand sides. Our Block GMRES implementation also has an option (the Boolean "Flexible Gmres" parameter) to use the Flexible variant of GMRES. Flexible GMRES allows the preconditioner (which must be a right preconditioner) to change from iteration to iteration.
If you are a new Belos user and just want standard GMRES, use PseudoBlockGmresSolMgr
. If you want Flexible GMRES, use this class with the "Flexible Gmres" parameter set to true.
Definition at line 125 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 128 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 129 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 130 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 131 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 132 of file BelosBlockGmresSolMgr.hpp.
Belos::BlockGmresSolMgr< ScalarType, MV, OP >::BlockGmresSolMgr | ( | ) |
Empty constructor for BlockGmresSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters().
Definition at line 409 of file BelosBlockGmresSolMgr.hpp.
Belos::BlockGmresSolMgr< ScalarType, MV, OP >::BlockGmresSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for BlockGmresSolMgr.
This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:
int
specifying the block size to be used by the underlying block GMRES solver. Default: 1bool
specifying whether the block size can be modified throughout the solve. Default: trueint
specifying the number of blocks allocated for the Krylov basis. Default: 300int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000int
specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 20std::string
specifying the desired orthogonalization: DGKS, ICGS, and IMGS. Default: "DGKS"MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8 pl | [in] ParameterList with construction information
|
Definition at line 439 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 170 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Get current linear problem being solved for in this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 178 of file BelosBlockGmresSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 479 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 188 of file BelosBlockGmresSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 195 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Tolerance achieved by the last solve()
invocation.
This is the maximum over all right-hand sides' achieved convergence tolerances, and is set whether or not the solve actually managed to achieve the desired convergence tolerance.
isLOADetected()
to check for a loss of accuracy during the last solve. Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 209 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 214 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Return whether a loss of accuracy was detected by this solver during the most current solve.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 221 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 229 of file BelosBlockGmresSolMgr.hpp.
|
virtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 542 of file BelosBlockGmresSolMgr.hpp.
|
inlinevirtual |
Performs a reset of the solver manager specified by the ResetType
. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 242 of file BelosBlockGmresSolMgr.hpp.
|
virtual |
This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.
This method calls BlockGmresIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from BlockGmresIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 922 of file BelosBlockGmresSolMgr.hpp.
|
virtual |
Print the object with the given verbosity level to a FancyOStream.
out | [out] Output stream to which to print. |
verbLevel | [in] Verbosity level. The default verbosity (verbLevel=Teuchos::VERB_DEFAULT) is Teuchos::VERB_LOW. |
Reimplemented from Teuchos::Describable.
Definition at line 1338 of file BelosBlockGmresSolMgr.hpp.
|
virtual |
Return a one-line description of this object.
Reimplemented from Teuchos::Describable.
Definition at line 1318 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 840 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 294 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 297 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 298 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 301 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 302 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 303 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 304 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 304 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 305 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 308 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 311 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 314 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 315 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 316 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 317 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 318 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 319 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 320 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 321 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 322 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 323 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 324 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 325 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 326 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 327 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 328 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 329 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 330 of file BelosBlockGmresSolMgr.hpp.
|
staticprivate |
Definition at line 331 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 334 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 334 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 334 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 335 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 335 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 335 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 336 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 336 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 336 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 336 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 336 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 337 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 337 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 337 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 337 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 338 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 339 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 342 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 343 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 346 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 346 of file BelosBlockGmresSolMgr.hpp.
|
private |
Definition at line 347 of file BelosBlockGmresSolMgr.hpp.