Belos Version of the Day
Public Types
Belos::LSQRIter< ScalarType, MV, OP > Class Template Reference

Implementation of the LSQR iteration. More...

#include <BelosLSQRIter.hpp>

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

List of all members.

Public Types

typedef Belos::MultiVecTraits
< ScalarType, MV > 
MVT
typedef Belos::OperatorTraits
< ScalarType, MV, OP > 
OPT
typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
typedef SCT::magnitudeType MagnitudeType

Public Member Functions

Constructors/Destructor
 LSQRIter (const Teuchos::RCP< Belos::LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Belos::OutputManager< ScalarType > > &printer, const Teuchos::RCP< Belos::StatusTest< ScalarType, MV, OP > > &tester, Teuchos::ParameterList &params)
 LSQRIter constructor with linear problem, solver utilities, and parameter list of solver options.
virtual ~LSQRIter ()
 Destructor.
Solver methods
void iterate ()
 This method performs LSQR iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
void initializeLSQR (LSQRIterationState< ScalarType, MV > newstate)
 Initialize the solver to an iterate, completing the initial state.
void initialize ()
 The solver is initialized using initializeLSQR.
LSQRIterationState< ScalarType,
MV > 
getState () const
 Get the current state of the linear solver.
Status methods
int getNumIters () const
 Get the current iteration count.
void resetNumIters (int iter=0)
 Reset the iteration count.
Teuchos::RCP< const MV > getNativeResiduals (std::vector< MagnitudeType > *norms) const
 Get the norms of the residuals native to the solver.
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system.
Accessor methods
const Belos::LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Get a constant reference to the linear problem.
int getBlockSize () const
 Get the blocksize to be used by the iterative solver in solving this linear problem.
void setBlockSize (int blockSize)
 Set the blocksize to be used by the iterative solver to solve this linear problem.
bool isInitialized ()
 States whether the solver has been initialized or not.

Detailed Description

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

Implementation of the LSQR iteration.

Author:
David Day

Definition at line 77 of file BelosLSQRIter.hpp.


Member Typedef Documentation

template<class ScalarType, class MV, class OP>
typedef Belos::MultiVecTraits<ScalarType,MV> Belos::LSQRIter< ScalarType, MV, OP >::MVT

Definition at line 84 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
typedef Belos::OperatorTraits<ScalarType,MV,OP> Belos::LSQRIter< ScalarType, MV, OP >::OPT

Definition at line 85 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType> Belos::LSQRIter< ScalarType, MV, OP >::SCT

Definition at line 86 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
typedef SCT::magnitudeType Belos::LSQRIter< ScalarType, MV, OP >::MagnitudeType

Definition at line 87 of file BelosLSQRIter.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::LSQRIter< ScalarType, MV, OP >::LSQRIter ( const Teuchos::RCP< Belos::LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Belos::OutputManager< ScalarType > > &  printer,
const Teuchos::RCP< Belos::StatusTest< ScalarType, MV, OP > > &  tester,
Teuchos::ParameterList params 
)

LSQRIter constructor with linear problem, solver utilities, and parameter list of solver options.

This constructor takes pointers required by the linear solver iteration, in addition to a parameter list of options for the linear solver.

Definition at line 289 of file BelosLSQRIter.hpp.

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

Destructor.

Definition at line 108 of file BelosLSQRIter.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
void Belos::LSQRIter< ScalarType, MV, OP >::iterate ( ) [virtual]

This method performs LSQR iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

iterate() first determine whether the solver is initialized; if not, it will call initialize() without arguments. After initialization, iterate() iterates LSQR until the status test is Passed, and then returns to the caller.

The status test is queried at the beginning of the iteration.

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

Definition at line 429 of file BelosLSQRIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::LSQRIter< ScalarType, MV, OP >::initializeLSQR ( LSQRIterationState< ScalarType, MV >  newstate)

Initialize the solver to an iterate, completing the initial state.

The LSQRIter contains a certain amount of state, consisting of two bidiagonalization vectors, a descent direction, a damping value, and various estimates of errors and the like.

Note:
For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

Definition at line 340 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::LSQRIter< ScalarType, MV, OP >::initialize ( ) [inline, virtual]

The solver is initialized using initializeLSQR.

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

Definition at line 141 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
LSQRIterationState<ScalarType,MV> Belos::LSQRIter< ScalarType, MV, OP >::getState ( ) const [inline]

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns:
A LSQRIterationState object containing const pointers to the current solver state.

Definition at line 154 of file BelosLSQRIter.hpp.

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

Get the current iteration count.

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

Definition at line 176 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::LSQRIter< ScalarType, MV, OP >::resetNumIters ( int  iter = 0) [inline, virtual]

Reset the iteration count.

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

Definition at line 179 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<const MV> Belos::LSQRIter< ScalarType, MV, OP >::getNativeResiduals ( std::vector< MagnitudeType > *  norms) const [inline]

Get the norms of the residuals native to the solver.

Returns:
This method returns a null pointer because residuals aren't used with LSQR.

Definition at line 183 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<MV> Belos::LSQRIter< ScalarType, MV, OP >::getCurrentUpdate ( ) const [inline, virtual]

Get the current update to the linear system.

Note:
This method returns a null pointer because the linear problem is current.

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

Definition at line 188 of file BelosLSQRIter.hpp.

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

Get a constant reference to the linear problem.

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

Definition at line 196 of file BelosLSQRIter.hpp.

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

Get the blocksize to be used by the iterative solver in solving this linear problem.

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

Definition at line 199 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
void Belos::LSQRIter< ScalarType, MV, OP >::setBlockSize ( int  blockSize) [inline, virtual]

Set the blocksize to be used by the iterative solver to solve this linear problem.

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

Definition at line 204 of file BelosLSQRIter.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::LSQRIter< ScalarType, MV, OP >::isInitialized ( ) [inline, virtual]

States whether the solver has been initialized or not.

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

Definition at line 210 of file BelosLSQRIter.hpp.


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