Belos Version of the Day
Belos::LSQRSolMgr< ScalarType, MV, OP > Class Template Reference

The LSQRSolMgr managers the LSQR linear least squares solver. More...

#include <BelosLSQRSolMgr.hpp>

Inheritance diagram for Belos::LSQRSolMgr< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

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().
 LSQRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for LSQRSolMgr.
virtual ~LSQRSolMgr ()
 Destructor.
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Get current linear problem being solved for in this object.
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 Get a parameter list containing the valid parameters for this object.
Teuchos::RCP< const
Teuchos::ParameterList
getCurrentParameters () const
 Get a parameter list containing the current parameters for this object.
Teuchos::Array< Teuchos::RCP
< Teuchos::Time > > 
getTimers () const
 Return the timers for this object.
int getNumIters () const
 Get the iteration count for the most recent call to solve().
bool isLOADetected () const
 Return whether a loss of accuracy was detected by this solver during the most current solve.
Set methods
void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
 Set the linear problem that needs to be solved.
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver manager should use to solve the linear problem.
Reset methods
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.
Solver application methods
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.
Overridden from Teuchos::Describable
std::string description () const
 Method to return description of the LSQR solver manager.

Detailed Description

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

The LSQRSolMgr managers the LSQR linear least squares solver.

Author:
David Day

Definition at line 119 of file BelosLSQRSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::LSQRSolMgr< ScalarType, MV, OP >::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 378 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Belos::LSQRSolMgr< ScalarType, MV, OP >::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" - an int specifying the maximum number of iterations the underlying 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 convergence is declared.
  • "Rel RHS Err" - an estimate of the error in the data defining the RHS.
  • "Rel Mat Err" - an estimate of the error in the data defining the matrix.
  • "Orthogonalization" - a std::string specifying the desired orthogonalization: DGKS ,ICGS, and IMGS. Default: "DGKS" LSQR without any orthogonalization is not yet supported.
  • "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 specifying ... the regularization parameter ... probably.

Definition at line 400 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::LSQRSolMgr< ScalarType, MV, OP >::~LSQRSolMgr ( ) [inline, virtual]

Destructor.

Definition at line 165 of file BelosLSQRSolMgr.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::LSQRSolMgr< ScalarType, MV, OP >::getProblem ( ) const [inline, virtual]

Get current linear problem being solved for in this object.

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

Definition at line 173 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::LSQRSolMgr< ScalarType, MV, OP >::getValidParameters ( ) const [virtual]

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

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

Definition at line 433 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::LSQRSolMgr< ScalarType, MV, OP >::getCurrentParameters ( ) const [inline, virtual]

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

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

Definition at line 183 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::LSQRSolMgr< ScalarType, MV, OP >::getTimers ( ) const [inline]

Return the timers for this object.

The timers are ordered as follows:

Definition at line 190 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::LSQRSolMgr< ScalarType, MV, OP >::getNumIters ( ) const [inline, virtual]

Get the iteration count for the most recent call to solve().

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

Definition at line 195 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::LSQRSolMgr< ScalarType, MV, OP >::isLOADetected ( ) const [inline, virtual]

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

template<class ScalarType , class MV , class OP >
void Belos::LSQRSolMgr< ScalarType, MV, OP >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem) [inline, virtual]

Set the linear problem that needs to be solved.

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

Definition at line 209 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::LSQRSolMgr< ScalarType, MV, OP >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params) [virtual]

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

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

Definition at line 480 of file BelosLSQRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::LSQRSolMgr< ScalarType, MV, OP >::reset ( const ResetType  type) [inline, virtual]

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

template<class ScalarType , class MV , class OP >
Belos::ReturnType Belos::LSQRSolMgr< ScalarType, MV, OP >::solve ( ) [virtual]

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

template<class ScalarType , class MV , class OP >
std::string Belos::LSQRSolMgr< ScalarType, MV, OP >::description ( ) const [virtual]

Method to return description of the LSQR solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 841 of file BelosLSQRSolMgr.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines