Belos Package Browser (Single Doxygen Collection)
Development
|
Hybrid block GMRES iterative linear solver. More...
#include <BelosGmresPolySolMgr.hpp>
Private Types | |
typedef MultiVecTraits< ScalarType, MV > | MVT |
typedef OperatorTraits< ScalarType, MV, OP > | OPT |
typedef Teuchos::ScalarTraits< ScalarType > | STS |
typedef Teuchos::ScalarTraits< ScalarType >::magnitudeType | MagnitudeType |
typedef Teuchos::ScalarTraits< MagnitudeType > | MT |
Static Private Attributes | |
static constexpr int | maxDegree_default_ = 25 |
static constexpr int | maxRestarts_default_ = 20 |
static constexpr int | maxIters_default_ = 1000 |
static constexpr bool | strictConvTol_default_ = false |
static constexpr bool | showMaxResNormOnly_default_ = false |
static constexpr int | blockSize_default_ = 1 |
static constexpr int | numBlocks_default_ = 300 |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr int | outputStyle_default_ = Belos::General |
static constexpr int | outputFreq_default_ = -1 |
static constexpr const char * | impResScale_default_ = "Norm of RHS" |
static constexpr const char * | expResScale_default_ = "Norm of RHS" |
static constexpr const char * | label_default_ = "Belos" |
static constexpr const char * | orthoType_default_ = "DGKS" |
static constexpr std::ostream * | outputStream_default_ = &std::cout |
GmresPolySolMgr Exceptions | |
bool | checkStatusTest () |
bool | generatePoly () |
Constructors/Destructor | |
GmresPolySolMgr () | |
Empty constructor for GmresPolySolMgr. 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... | |
GmresPolySolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for GmresPolySolMgr. More... | |
virtual | ~GmresPolySolMgr () |
Destructor. More... | |
Teuchos::RCP< SolverManager< ScalarType, MV, OP > > | clone () const override |
clone for Inverted Injection (DII) More... | |
Accessor methods | |
const LinearProblem< ScalarType, MV, OP > & | getProblem () const override |
Get current linear problem being solved for in this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const override |
Get a parameter list containing the valid parameters for this object. More... | |
Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const override |
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... | |
int | getNumIters () const override |
Get the iteration count for the most recent call to solve() . More... | |
bool | isLOADetected () const override |
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) override |
Set the linear problem that needs to be solved. More... | |
void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) override |
Set the parameters the solver manager should use to solve the linear problem. More... | |
Reset methods | |
void | reset (const ResetType type) override |
Reset the solver. More... | |
Solver application methods | |
ReturnType | solve () override |
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 | |
std::string | description () const override |
Method to return description of the hybrid block GMRES solver manager. More... | |
Additional Inherited Members | |
![]() | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual Teuchos::ScalarTraits< ScalarType >::magnitudeType | achievedTol () const |
Tolerance achieved by the last solve() invocation. 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) |
virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
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 |
Hybrid block GMRES iterative linear solver.
Definition at line 155 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 157 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 158 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 159 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 160 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 161 of file BelosGmresPolySolMgr.hpp.
Belos::GmresPolySolMgr< ScalarType, MV, OP >::GmresPolySolMgr | ( | ) |
Empty constructor for GmresPolySolMgr. 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 373 of file BelosGmresPolySolMgr.hpp.
Belos::GmresPolySolMgr< ScalarType, MV, OP >::GmresPolySolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for GmresPolySolMgr.
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: 1int
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 Definition at line 404 of file BelosGmresPolySolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 192 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 195 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Get current linear problem being solved for in this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 205 of file BelosGmresPolySolMgr.hpp.
|
overridevirtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 449 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 215 of file BelosGmresPolySolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 222 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 227 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
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 234 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 242 of file BelosGmresPolySolMgr.hpp.
|
overridevirtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 512 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Reset the solver.
type | [in] How to reset the solver. |
If type includes Belos::Problem, then reset the solver's state. This clears out the stored coefficients, so that the next call to solve() actually computes a full block GMRES solve, instead of just reusing the coefficients from the first solve.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 259 of file BelosGmresPolySolMgr.hpp.
|
overridevirtual |
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 1039 of file BelosGmresPolySolMgr.hpp.
|
overridevirtual |
Method to return description of the hybrid block GMRES solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 1393 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 840 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 909 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 308 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 311 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 312 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 315 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 316 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 317 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 318 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 318 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 319 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 322 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 325 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 328 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 329 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 330 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 331 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 332 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 333 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 334 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 335 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 336 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 337 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 338 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 339 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 340 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 341 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 342 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 345 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 345 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 345 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 346 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 346 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 346 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 346 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 348 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 348 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 349 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 350 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 350 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 353 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 354 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 354 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 355 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 356 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 359 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 360 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 360 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 363 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 364 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 364 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 364 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 365 of file BelosGmresPolySolMgr.hpp.
|
mutableprivate |
Cached default (valid) parameters.
Definition at line 368 of file BelosGmresPolySolMgr.hpp.