#include <BelosLSQRSolMgr.hpp>
|
Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > | problem_ |
| The linear problem to solve. More...
|
|
Teuchos::RCP< OutputManager< ScalarType > > | printer_ |
| The output manager. More...
|
|
Teuchos::RCP< std::ostream > | outputStream_ |
| Output stream to which to write status output. More...
|
|
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | sTest_ |
| The "master" status test (that includes all status tests). More...
|
|
Teuchos::RCP< StatusTestMaxIters< ScalarType, MV, OP > > | maxIterTest_ |
|
Teuchos::RCP< LSQRStatusTest< ScalarType, MV, OP > > | convTest_ |
|
Teuchos::RCP< StatusTestOutput< ScalarType, MV, OP > > | outputTest_ |
|
Teuchos::RCP< Teuchos::ParameterList > | params_ |
| Current parameter list. More...
|
|
Teuchos::RCP< const Teuchos::ParameterList > | validParams_ |
| Default parameter list. More...
|
|
MagnitudeType | lambda_ |
|
MagnitudeType | relRhsErr_ |
|
MagnitudeType | relMatErr_ |
|
MagnitudeType | condMax_ |
|
int | maxIters_ |
|
int | termIterMax_ |
|
int | verbosity_ |
|
int | outputStyle_ |
|
int | outputFreq_ |
|
int | numIters_ |
|
MagnitudeType | matCondNum_ |
|
MagnitudeType | matNorm_ |
|
MagnitudeType | resNorm_ |
|
MagnitudeType | matResNorm_ |
|
std::string | label_ |
|
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
|
bool | isSet_ |
|
bool | loaDetected_ |
|
|
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...
|
|
|
void | reset (const ResetType type) |
| reset the solver manager as specified by the ResetType , 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...
|
|
|
ReturnType | solve () |
| method that performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as defined by the solver manager) or the solver manager decides to quit. More...
|
|
template<class ScalarType, class MV, class OP>
class Belos::LSQRSolMgr< ScalarType, MV, OP, false >
Definition at line 259 of file BelosLSQRSolMgr.hpp.
◆ MVT
template<class ScalarType , class MV , class OP >
◆ OPT
template<class ScalarType , class MV , class OP >
◆ STS
template<class ScalarType , class MV , class OP >
◆ MagnitudeType
template<class ScalarType , class MV , class OP >
◆ STM
template<class ScalarType , class MV , class OP >
◆ LSQRSolMgr() [1/2]
template<class ScalarType , class MV , class OP >
◆ LSQRSolMgr() [2/2]
template<class ScalarType , class MV , class OP >
Basic constructor for LSQRSolMgr.
This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. Blocks of size > 1 are not implemented. The options are otherwise the BlockGmres options.
- "Maximum Iterations" - the maximum number of iterations the LSQR solver is allowed to perform. Default: 1000
- "Condition Limit" - a
MagnitudeType
specifying the upper limit of the estimate of the norm of Abar to decide convergence. Default: 0.
- "Term Iter Max": The number of consecutive successful iterations required before LSQR considers the problem converged. Default: 1.
- "Rel RHS Err" (or "Convergence Tolerance"): an estimate of the error in the data defining the right-hand side. Default: 10*sqrt(eps).
- "Rel Mat Err" - an estimate of the error in the data defining the matrix. Default: 10*sqrt(eps).
- "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
- "Output Style" - a OutputType specifying the style of output. Default: Belos::General
- "Lambda" - a
MagnitudeType
that specifies the regularization parameter.
This LSQR implementation only supports block size 1. Like CG, LSQR is a short recurrence method that, in finite precision arithmetic and without reorthogonalization, does not have the "n" step convergence property. Without either blocks or reorthogonalization, there is nothing to "Orthogonalize."
Definition at line 522 of file BelosLSQRSolMgr.hpp.
◆ ~LSQRSolMgr()
template<class ScalarType , class MV , class OP >
Destructor (declared virtual for memory safety of base classes).
Definition at line 312 of file BelosLSQRSolMgr.hpp.
◆ getProblem()
template<class ScalarType , class MV , class OP >
◆ getValidParameters()
template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getValidParameters |
( |
| ) |
const |
|
virtual |
◆ getCurrentParameters()
template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getCurrentParameters |
( |
| ) |
const |
|
inlinevirtual |
◆ getTimers()
template<class ScalarType , class MV , class OP >
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getTimers |
( |
| ) |
const |
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 339 of file BelosLSQRSolMgr.hpp.
◆ getNumIters()
template<class ScalarType , class MV , class OP >
◆ getMatCondNum()
template<class ScalarType , class MV , class OP >
Estimated matrix condition number from the last solve.
LSQR computes a running condition number estimate of the (preconditioned, if applicable) operator.
Definition at line 352 of file BelosLSQRSolMgr.hpp.
◆ getMatNorm()
template<class ScalarType , class MV , class OP >
Estimated matrix Frobenius norm from the last solve.
LSQR computes a running Frobenius norm estimate of the (preconditioned, if applicable) operator.
Definition at line 360 of file BelosLSQRSolMgr.hpp.
◆ getResNorm()
template<class ScalarType , class MV , class OP >
Estimated residual norm from the last solve.
LSQR computes the current residual norm. LSQR can solve inconsistent linear systems in a least-squares sense, so the residual norm may not necessarily be small, even if LSQR converges. (LSQR defines "convergence" to allow for possibly inconsistent systems. See the documentation of LSQRStatusTest
for details.)
Definition at line 372 of file BelosLSQRSolMgr.hpp.
◆ getMatResNorm()
template<class ScalarType , class MV , class OP >
◆ isLOADetected()
template<class ScalarType , class MV , class OP >
Whether a loss of accuracy was detected during the last solve.
The "loss of accuracy" concept is not yet implemented here, becuase it is unclear what this means for linear least squares. LSQR solves a possibly inconsistent linear system in a least-squares sense. "Loss of accuracy" would correspond to the difference between the preconditioned residual and the unpreconditioned residual.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 389 of file BelosLSQRSolMgr.hpp.
◆ setProblem()
template<class ScalarType , class MV , class OP >
◆ setParameters()
template<class ScalarType , class MV , class OP >
void Belos::LSQRSolMgr< ScalarType, MV, OP, false >::setParameters |
( |
const Teuchos::RCP< Teuchos::ParameterList > & |
params | ) |
|
|
virtual |
◆ reset()
template<class ScalarType , class MV , class OP >
◆ solve()
template<class ScalarType , class MV , class OP >
method that performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as defined by the solver manager) or the solver manager decides to quit.
This method calls LSQRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from LSQRIter::iterate() signifies that either
- the maximum number of iterations has been exceeded ... "return ::Unconverged".
- ... or convergence ... "solver manager will return ::Converged" In either case the current solution is in the linear problem
- Returns
- ReturnType specifying:
- Converged: the linear problem was solved to the specification required by the solver manager.
- Unconverged: the linear problem was not solved to the specification desired by the solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 859 of file BelosLSQRSolMgr.hpp.
◆ description()
template<class ScalarType , class MV , class OP >
◆ problem_
template<class ScalarType , class MV , class OP >
◆ printer_
template<class ScalarType , class MV , class OP >
◆ outputStream_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<std::ostream> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::outputStream_ |
|
private |
◆ sTest_
template<class ScalarType , class MV , class OP >
The "master" status test (that includes all status tests).
Definition at line 461 of file BelosLSQRSolMgr.hpp.
◆ maxIterTest_
template<class ScalarType , class MV , class OP >
◆ convTest_
template<class ScalarType , class MV , class OP >
◆ outputTest_
template<class ScalarType , class MV , class OP >
◆ params_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::params_ |
|
private |
◆ validParams_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::validParams_ |
|
mutableprivate |
Default parameter list.
Cached per instance, rather than per class, for more thread safety. It's "mutable" because getValidParameters()
has to create it if it hasn't been created yet.
Definition at line 474 of file BelosLSQRSolMgr.hpp.
◆ lambda_
template<class ScalarType , class MV , class OP >
◆ relRhsErr_
template<class ScalarType , class MV , class OP >
◆ relMatErr_
template<class ScalarType , class MV , class OP >
◆ condMax_
template<class ScalarType , class MV , class OP >
◆ maxIters_
template<class ScalarType , class MV , class OP >
◆ termIterMax_
template<class ScalarType , class MV , class OP >
◆ verbosity_
template<class ScalarType , class MV , class OP >
◆ outputStyle_
template<class ScalarType , class MV , class OP >
◆ outputFreq_
template<class ScalarType , class MV , class OP >
◆ numIters_
template<class ScalarType , class MV , class OP >
◆ matCondNum_
template<class ScalarType , class MV , class OP >
◆ matNorm_
template<class ScalarType , class MV , class OP >
◆ resNorm_
template<class ScalarType , class MV , class OP >
◆ matResNorm_
template<class ScalarType , class MV , class OP >
◆ label_
template<class ScalarType , class MV , class OP >
◆ timerSolve_
template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::Time> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::timerSolve_ |
|
private |
◆ isSet_
template<class ScalarType , class MV , class OP >
◆ loaDetected_
template<class ScalarType , class MV , class OP >
The documentation for this class was generated from the following file: