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

The Belos::RCGSolMgr provides a powerful and fully-featured solver manager over the RCG (Recycling Conjugate Gradient) linear solver. More...

#include <BelosRCGSolMgr.hpp>

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

List of all members.

Public Member Functions

Constructors/Destructor
 RCGSolMgr ()
 Empty constructor for RCGSolMgr. 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().
 RCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for RCGSolMgr.
virtual ~RCGSolMgr ()
 Destructor.
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Return a reference to the linear problem being solved by this solver manager.
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.
MagnitudeType achievedTol () const
 Tolerance achieved by the last solve() invocation.
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 method
void reset (const ResetType type)
 Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy. Belos::Problem forces a call to setProblem on the linear problem, and Belos::RecycleSubspace causes the solver manager to "forget" the recycle space generated by previous calls to the solver. In the latter case, the next call to solve() will act as if the solver has never been called before.
Solver application methods
ReturnType solve ()
 This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided 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 RCG solver manager.

Detailed Description

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

The Belos::RCGSolMgr provides a powerful and fully-featured solver manager over the RCG (Recycling Conjugate Gradient) linear solver.

Author:
Michael Parks and Heidi Thornquist

Definition at line 118 of file BelosRCGSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::RCGSolMgr< ScalarType, MV, OP >::RCGSolMgr ( )

Empty constructor for RCGSolMgr. 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 442 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Belos::RCGSolMgr< ScalarType, MV, OP >::RCGSolMgr ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Teuchos::ParameterList > &  pl 
)

Basic constructor for RCGSolMgr.

This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:

  • "Num Blocks" - a int specifying length of a cycle (and thus number of max number of search vectors kept). Default: 25
  • "Num Recycled Blocks" - a int specifying the number of vectors selected for recycling. Default: 3
  • "Maximum Iterations" - an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
  • "Output Style" - a OutputType specifying the style of output. Default: Belos::General
  • "Convergence Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence. Default: 1e-8.
  • "Output Stream" - a reference-counted pointer to the output stream where all solver output is sent. Default: Teuchos::rcp(&std::cout,false)
  • "Output Frequency" - an int specifying how often convergence information should be outputted. Default: -1 (never)
  • "Show Maximum Residual Norm Only" - a bool specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: false
  • "Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 448 of file BelosRCGSolMgr.hpp.

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

Destructor.

Definition at line 165 of file BelosRCGSolMgr.hpp.


Member Function Documentation

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

Return a reference to the linear problem being solved by this solver manager.

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

Definition at line 171 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::RCGSolMgr< 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 690 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::RCGSolMgr< 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 179 of file BelosRCGSolMgr.hpp.

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 186 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::RCGSolMgr< ScalarType, MV, OP >::achievedTol ( ) const [inline, virtual]

Tolerance achieved by the last solve() invocation.

This is set whether or not the solve actually managed to achieve the desired convergence tolerance.

Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 194 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::RCGSolMgr< 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 199 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::RCGSolMgr< 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 204 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::RCGSolMgr< 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 212 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::RCGSolMgr< 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 515 of file BelosRCGSolMgr.hpp.

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

Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy. Belos::Problem forces a call to setProblem on the linear problem, and Belos::RecycleSubspace causes the solver manager to "forget" the recycle space generated by previous calls to the solver. In the latter case, the next call to solve() will act as if the solver has never been called before.

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

Definition at line 227 of file BelosRCGSolMgr.hpp.

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

This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

This method calls RCGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

A return from RCGIter::iterate() signifies one of the following scenarios:

  • the maximum number of iterations has been exceeded. In this scenario, the current solutions to the linear system will be placed in the linear problem and return Unconverged.
  • global convergence has been met. In this case, the current solutions to the linear system will be placed in the linear problem and the solver manager will return Converged
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 1021 of file BelosRCGSolMgr.hpp.

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

Method to return description of the RCG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1961 of file BelosRCGSolMgr.hpp.


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