#include <BelosLSQRSolMgr.hpp>

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

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

Private Attributes
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_

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

Additional Inherited Members
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
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

Detailed Description

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

Definition at line 264 of file BelosLSQRSolMgr.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

typedef MultiVecTraits<ScalarType,MV> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::MVT

private

Definition at line 267 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef OperatorTraits<ScalarType,MV,OP> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::OPT

private

Definition at line 268 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::STS

private

Definition at line 269 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::MagnitudeType

private

Definition at line 270 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<MagnitudeType> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::STM

private

Definition at line 271 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 510 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 531 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 317 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 320 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 329 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 566 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 339 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 348 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 353 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 361 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 369 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 381 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 386 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 398 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 406 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 627 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 421 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 867 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 1013 of file BelosLSQRSolMgr.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::problem_

private

The linear problem to solve.

Definition at line 463 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<OutputManager<ScalarType> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::printer_

private

The output manager.

Definition at line 465 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<std::ostream> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::outputStream_

private

Output stream to which to write status output.

Definition at line 467 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::sTest_

private

The "master" status test (that includes all status tests).

Definition at line 470 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestMaxIters<ScalarType,MV,OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::maxIterTest_

private

Definition at line 471 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<LSQRStatusTest<ScalarType,MV,OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::convTest_

private

Definition at line 472 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > Belos::LSQRSolMgr< ScalarType, MV, OP, false >::outputTest_

private

Definition at line 473 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::params_

private

Current parameter list.

Definition at line 476 of file BelosLSQRSolMgr.hpp.

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

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::lambda_

private

Definition at line 486 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::relRhsErr_

private

Definition at line 487 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::relMatErr_

private

Definition at line 488 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::condMax_

private

Definition at line 489 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::maxIters_

private

Definition at line 490 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::termIterMax_

private

Definition at line 490 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::verbosity_

private

Definition at line 491 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::outputStyle_

private

Definition at line 491 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::outputFreq_

private

Definition at line 491 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::LSQRSolMgr< ScalarType, MV, OP, false >::numIters_

private

Definition at line 494 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::matCondNum_

private

Definition at line 495 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::matNorm_

private

Definition at line 496 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::resNorm_

private

Definition at line 497 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::LSQRSolMgr< ScalarType, MV, OP, false >::matResNorm_

private

Definition at line 498 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

std::string Belos::LSQRSolMgr< ScalarType, MV, OP, false >::label_

private

Definition at line 501 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::Time> Belos::LSQRSolMgr< ScalarType, MV, OP, false >::timerSolve_

private

Definition at line 502 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::LSQRSolMgr< ScalarType, MV, OP, false >::isSet_

private

Definition at line 505 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::LSQRSolMgr< ScalarType, MV, OP, false >::loaDetected_

private

Definition at line 506 of file BelosLSQRSolMgr.hpp.

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

BelosLSQRSolMgr.hpp

Private Types

Private Attributes

Construct/Destroy

Accessor methods

Set methods

Reset methods

Solver application methods

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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