Belos Package Browser (Single Doxygen Collection)
Development
|
The GMRES polynomial can be created in conjunction with any standard preconditioner. More...
#include <BelosGmresPolySolMgr.hpp>
Private Types | |
typedef MultiVecTraits < ScalarType, MV > | MVT |
typedef Teuchos::ScalarTraits < ScalarType > | STS |
typedef Teuchos::ScalarTraits < ScalarType >::magnitudeType | MagnitudeType |
typedef Belos::GmresPolyOp < ScalarType, MV, OP > | gmres_poly_t |
typedef Belos::GmresPolyMv < ScalarType, MV > | gmres_poly_mv_t |
Private Attributes | |
Teuchos::RCP< LinearProblem < ScalarType, MV, OP > > | problem_ |
Teuchos::RCP< std::ostream > | outputStream_ |
Teuchos::RCP < Teuchos::ParameterList > | params_ |
Teuchos::RCP < Teuchos::ParameterList > | outerParams_ |
MagnitudeType | polyTol_ |
int | maxDegree_ |
int | numIters_ |
int | verbosity_ |
bool | hasOuterSolver_ |
bool | randomRHS_ |
bool | damp_ |
bool | addRoots_ |
std::string | polyType_ |
std::string | outerSolverType_ |
std::string | orthoType_ |
int | poly_dim_ |
Teuchos::RCP< gmres_poly_t > | poly_Op_ |
std::string | label_ |
Teuchos::RCP< Teuchos::Time > | timerPoly_ |
bool | isSet_ |
bool | loaDetected_ |
Teuchos::RCP< const Teuchos::ParameterList > | validPL_ |
Cached default (valid) parameters. More... | |
Static Private Attributes | |
static constexpr int | maxDegree_default_ = 25 |
static constexpr int | verbosity_default_ = Belos::Errors |
static constexpr const char * | label_default_ = "Belos" |
static constexpr const char * | outerSolverType_default_ = "" |
static constexpr const char * | polyType_default_ = "Arnoldi" |
static constexpr const char * | orthoType_default_ = "ICGS" |
static constexpr bool | addRoots_default_ = true |
static constexpr bool | dampPoly_default_ = false |
static constexpr bool | randomRHS_default_ = true |
static constexpr std::ostream * | outputStream_default_ = &std::cout |
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 | |
Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP > | |
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 > > &, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
Set user-defined convergence status test. More... | |
virtual void | setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &) |
Set user-defined debug status test. More... | |
Public Member Functions inherited from Teuchos::Describable | |
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 Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
The GMRES polynomial can be created in conjunction with any standard preconditioner.
Hybrid block GMRES iterative linear solver.
Simply pass the preconditioner to the LinearProblem before calling the GmresPolySolMgr and your preconditioner will be combined with the polynomial automatically.
Here is a list of all the parameters that this solver accepts:
std::string
): The desired polynomial type: Roots, Arnoldi, or Gmres. Default: "Roots"MagnitudeType
): The level that residual norms must reach to decide convergence. Default: 1e-8.int
): Requested maximum degree for the polynomial. Default: 25bool
): to generate the polynomial using a random vector. Default: truebool
): to add roots to the polynomial as needed for stability. Default: truebool
): to damp polynomial. Default: falsestd::string
): The desired orthogonalization method to create polynomial. Default: "ICGS".std::string
): Name of the outer solver in Belos solver factory.Teuchos::parameterList
): List of parameters for the outer solverstd::string
): Label for timers with polynomial solve.This solver manager provides three different implementations of the same polynomial preconditioner. The polynomial is the minimum residual polynomial from GMRES. The "Roots" version is default. It is the only implementation which provides the option of added roots for stability. These added roots can allow for high-degree polynomials. The "Arnoldi" version typically gives similar results to the "Roots" version but is slightly more expensive to apply. Both of these polynomials can be "damped", which is sometimes useful for indefinite or other ill-conditioned problems. The "Gmres" version is based on a power-basis implementation and is only stable for well-conditioned problems and low-degree polynomials. For more information on the implementation and formulas, see the following references: "Roots" version: https://arxiv.org/abs/1806.08020 (Includes explanation of root-adding and damping.) "Arnoldi" version: https://scholarship.rice.edu/handle/1911/17630 "Gmres" version: https://epubs.siam.org/doi/pdf/10.1137/140968276
Like all Belos solvers, parameters have relative or "delta" semantics. This means the following:
Definition at line 150 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 153 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 154 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 155 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 156 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 157 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 355 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:
std::string
specifying the type of polynomial: Roots, Arnoldi, or Gmres. Default: "Roots"int
specifying the maximum degree of the polynomial. Default: 25bool
indicates whether to generate polynomial using a random vector. Default: truebool
to add roots to the polynomial as needed for stability. Default: truebool
to damp polynomial. Default: falsestd::string
specifying the desired orthogonalization to create the polynomial: DGKS, ICGS, and IMGS. Default: "ICGS"MagnitudeType
specifying the polynomial tolerance (sometimes) used to generate polynomial. Default: 1e-8std::string
specifying name of outer solver in Belos solver factory. Default: ""Teuchos::ParameterList
giving parameters for the outer solver.std::string
specifying the label on polynomial solve timers. Definition at line 377 of file BelosGmresPolySolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 193 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
clone for Inverted Injection (DII)
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 196 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Get current linear problem being solved for in this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 206 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 413 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 216 of file BelosGmresPolySolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 223 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 228 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 235 of file BelosGmresPolySolMgr.hpp.
|
inlineoverridevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 243 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 452 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 260 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 606 of file BelosGmresPolySolMgr.hpp.
|
overridevirtual |
Method to return description of the hybrid block GMRES solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 713 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 304 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 307 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 310 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 311 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 314 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 315 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 316 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 317 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 318 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 319 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 320 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 321 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 322 of file BelosGmresPolySolMgr.hpp.
|
staticprivate |
Definition at line 323 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 326 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 327 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 327 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 328 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 329 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 330 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 331 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 332 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 333 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 334 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 335 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 338 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 339 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 342 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 343 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 346 of file BelosGmresPolySolMgr.hpp.
|
private |
Definition at line 347 of file BelosGmresPolySolMgr.hpp.
|
mutableprivate |
Cached default (valid) parameters.
Definition at line 350 of file BelosGmresPolySolMgr.hpp.