#include <BelosLSQRSolMgr.hpp>

Inheritance diagram for Belos::LSQRSolMgr< ScalarType, MV, OP, false >:

Public Member Functions
Construct/Destroy
	LSQRSolMgr ()
	Empty constructor for LSQRSolMgr. 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...

	LSQRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
	Basic constructor for LSQRSolMgr. More...

virtual	~LSQRSolMgr ()
	Destructor (declared virtual for memory safety of base classes). 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
	Iteration count from the last solve. More...

MagnitudeType	getMatCondNum () const
	Estimated matrix condition number from the last solve. More...

MagnitudeType	getMatNorm () const
	Estimated matrix Frobenius norm from the last solve. More...

MagnitudeType	getResNorm () const
	Estimated residual norm from the last solve. More...

MagnitudeType	getMatResNorm () const
	Estimate of (residual vector ) from the last solve. More...

bool	isLOADetected () const override
	Whether a loss of accuracy was detected during the last 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 > &params) 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 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...

Solver application methods
ReturnType	solve () override
	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...

Overridden from Teuchos::Describable
std::string	description () const override
	One-line description of this solver. More...

Public Member Functions inherited from Belos::Details::RealSolverManager< ScalarType, MV, OP, false >
	RealSolverManager ()

virtual	~RealSolverManager ()

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
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

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Additional Inherited Members
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::LSQRSolMgr< ScalarType, MV, OP, false >

Definition at line 247 of file BelosLSQRSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::LSQRSolMgr< ScalarType, MV, OP, false >::LSQRSolMgr ( )

Empty constructor for LSQRSolMgr. 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 493 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Belos::LSQRSolMgr< ScalarType, MV, OP, false >::LSQRSolMgr	(	const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &	problem,
		const Teuchos::RCP< Teuchos::ParameterList > &	pl
	)

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 514 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

virtual Belos::LSQRSolMgr< ScalarType, MV, OP, false >::~LSQRSolMgr ( )

inlinevirtual

Destructor (declared virtual for memory safety of base classes).

Definition at line 300 of file BelosLSQRSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

Teuchos::RCP<SolverManager<ScalarType, MV, OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::clone ( ) const

inlineoverridevirtual

clone for Inverted Injection (DII)

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 303 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

const LinearProblem<ScalarType,MV,OP>& Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getProblem ( ) const

inlineoverridevirtual

Get current linear problem being solved for in this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 312 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP< const Teuchos::ParameterList > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getValidParameters ( ) const

overridevirtual

Get a parameter list containing the valid parameters for this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 549 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<const Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getCurrentParameters ( ) const

inlineoverridevirtual

Get a parameter list containing the current parameters for this object.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 322 of file BelosLSQRSolMgr.hpp.

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:

time spent in solve() routine

Definition at line 331 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getNumIters ( ) const

inlineoverridevirtual

Iteration count from the last solve.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 336 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getMatCondNum ( ) const

inline

Estimated matrix condition number from the last solve.

LSQR computes a running condition number estimate of the (preconditioned, if applicable) operator.

Definition at line 344 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getMatNorm ( ) const

inline

Estimated matrix Frobenius norm from the last solve.

LSQR computes a running Frobenius norm estimate of the (preconditioned, if applicable) operator.

Definition at line 352 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getResNorm ( ) const

inline

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 364 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::getMatResNorm ( ) const

inline

Estimate of $A^* r$ (residual vector $r$ ) from the last solve.

Definition at line 369 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::LSQRSolMgr< ScalarType, MV, OP, false >::isLOADetected ( ) const

inlineoverridevirtual

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 381 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRSolMgr< ScalarType, MV, OP, false >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & problem )

inlineoverridevirtual

Set the linear problem that needs to be solved.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 389 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRSolMgr< ScalarType, MV, OP, false >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > & params )

overridevirtual

Set the parameters the solver manager should use to solve the linear problem.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 610 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::LSQRSolMgr< ScalarType, MV, OP, false >::reset ( const ResetType type )

inlineoverridevirtual

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.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 404 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Belos::ReturnType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::solve ( )

overridevirtual

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 850 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

std::string Belos::LSQRSolMgr< ScalarType, MV, OP, false >::description ( ) const

overridevirtual

One-line description of this solver.

Reimplemented from Teuchos::Describable.

Definition at line 996 of file BelosLSQRSolMgr.hpp.

The documentation for this class was generated from the following file:

BelosLSQRSolMgr.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<class ScalarType, class MV, class OP> class Belos::LSQRSolMgr< ScalarType, MV, OP, false >

Constructor & Destructor Documentation

Member Function Documentation

template<class ScalarType, class MV, class OP>
class Belos::LSQRSolMgr< ScalarType, MV, OP, false >