Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP > Class Template Reference

The Belos::PseudoBlockGmresSolMgr provides a powerful and fully-featured solver manager over the pseudo-block GMRES iteration. More...

#include <BelosPseudoBlockGmresSolMgr.hpp>

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

List of all members.

Public Member Functions

Constructors/Destructor

 PseudoBlockGmresSolMgr ()
 Empty constructor for BlockGmresSolMgr. 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().
 PseudoBlockGmresSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for PseudoBlockGmresSolMgr.
virtual ~PseudoBlockGmresSolMgr ()
 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.
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)
 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.
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 block GMRES solver manager.

Detailed Description

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

The Belos::PseudoBlockGmresSolMgr provides a powerful and fully-featured solver manager over the pseudo-block GMRES iteration.

Author:
Heidi Thornquist, Chris Baker, and Teri Barth

Definition at line 97 of file BelosPseudoBlockGmresSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::PseudoBlockGmresSolMgr (  )  [inline]

Empty constructor for BlockGmresSolMgr. 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 353 of file BelosPseudoBlockGmresSolMgr.hpp.

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

Basic constructor for PseudoBlockGmresSolMgr.

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 the number of blocks allocated for the Krylov basis.
  • "Maximum Iterations" - a int specifying the maximum number of iterations the underlying solver is allowed to perform.
  • "Maximum Restarts" - a int specifying the maximum number of restarts the underlying solver is allowed to perform.
  • "Orthogonalization" - a std::string specifying the desired orthogonalization: DGKS, ICGS, and IMGS. Default: "DGKS"
  • "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.

Definition at line 378 of file BelosPseudoBlockGmresSolMgr.hpp.

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

Destructor.

Definition at line 134 of file BelosPseudoBlockGmresSolMgr.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::PseudoBlockGmresSolMgr< 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 140 of file BelosPseudoBlockGmresSolMgr.hpp.

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

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

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

Definition at line 695 of file BelosPseudoBlockGmresSolMgr.hpp.

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

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 157 of file BelosPseudoBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockGmresSolMgr< 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 162 of file BelosPseudoBlockGmresSolMgr.hpp.

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

Return whether a loss of accuracy was detected by this solver during the most current solve.

Note:
This flag will be reset the next time solve() is called.

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

Definition at line 169 of file BelosPseudoBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockGmresSolMgr< 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 177 of file BelosPseudoBlockGmresSolMgr.hpp.

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

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

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

Definition at line 413 of file BelosPseudoBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockGmresSolMgr< 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.

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

Definition at line 190 of file BelosPseudoBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::solve (  )  [inline, 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 PseudoBlockGmresIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

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

  • the maximum number of restarts 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 824 of file BelosPseudoBlockGmresSolMgr.hpp.

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

Method to return description of the block GMRES solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1167 of file BelosPseudoBlockGmresSolMgr.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:09 2011 for Belos by  doxygen 1.6.3