Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Belos::BlockGCRODRSolMgr< ScalarType, MV, OP > Class Template Reference

A solver manager for the Block GCRO-DR (Block Recycling GMRES) linear solver. More...

#include <BelosBlockGCRODRSolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 BlockGCRODRSolMgr ()
 Default constructor. More...
 
 BlockGCRODRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for GCRODRSolMgr. More...
 
virtual ~BlockGCRODRSolMgr ()
 Destructor. More...
 
Implementation of the Teuchos::Describable interface
std::string description () const
 A description of the Block GCRODR solver manager. More...
 
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 		getProblem () const
 Get current linear problem being solved for in this object. More...
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getValidParameters () const
 Get a parameter list containing the valid parameters for this object. More...
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getCurrentParameters () const
 Get a parameter list containing the current parameters for this object. More...
 
MagnitudeType achievedTol () const
 Get the residual for the most recent call to solve(). More...
 
int getNumIters () const
 Get the iteration count for the most recent call to solve(). More...
 
bool isLOADetected () const
 Whether a loss of accuracy was detected during the most recent solve. More...
 
Set methods
void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
 Set the linear problem to solve on the next call to solve(). More...
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver should use to solve the linear problem. More...
 
Reset methods
void reset (const ResetType type)
 Performs a reset of the solver manager specified by the ResetType. More...
 
Solver application methods
ReturnType solve ()
 Solve the current linear problem. More...
 
- Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
 SolverManager ()
 Empty constructor. More...
 
virtual ~SolverManager ()
 Destructor. More...
 
virtual Teuchos::RCP
< SolverManager< ScalarType,
MV, OP > > 		clone () const =0
 clone the solver manager. 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
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
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

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

A solver manager for the Block GCRO-DR (Block Recycling GMRES) linear solver.

Author
Kirk M. Soodhalter and Michael L. Parks

GCRO-DR (also called Recycling GMRES) is a variant of GMRES that can more efficiently solve sequences linear systems. It does so by "recycling" Krylov basis information from previous solves.

The original GCRO-DR algorithm can only solve one right-hand side at a time. Block GCRO-DR extends GCRO-DR so that it can solve multiple right-hand sides at a time; thus, it can solve sequences of block systems.

Definition at line 127 of file BelosBlockGCRODRSolMgr.hpp.

Constructor & Destructor Documentation

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

Default constructor.

This constructor sets up the solver with default parameters. 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 438 of file BelosBlockGCRODRSolMgr.hpp.

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

Basic constructor for GCRODRSolMgr.

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

  • "Num Blocks": an int specifying the number of blocks allocated for the Krylov basis. Default: 50.
  • "Block Size": an int specifying the number of right hand sides being solved at a time.
  • "Num Recycled Blocks": an int specifying the number of blocks allocated for the Krylov basis. Default: 5.
  • "Maximum Iterations": an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 5000.
  • "Maximum Restarts": an int specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 100.
  • "Orthogonalization": an std::string specifying the desired orthogonalization. Currently supported values: "DGKS", "ICGS", "IMGS", and "TSQR" (if Belos was built with TSQR support). Default: "DGKS".
  • "Orthogonalization Parameters": a ParameterList or RCP<(const) ParameterList> of parameters specific to the type of orthogonalization used. Defaults are set automatically.
  • "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.

Other supported options:

  • "Output Frequency": an int specifying how often (in terms of number of iterations) convergence information should be output to the output stream. Default: -1 (never output convergence information).
  • "Output Stream": a reference-counted pointer to the output stream where all solver output is sent. Default stream is std::cout (stdout, in C terms). For stderr, supply Teuchos::rcp(&std::cerr, false).
  • "Implicit Residual Scaling": the type of scaling used in the implicit residual convergence test. Default: "Norm of Preconditioned Initial Residual".
  • "Explicit Residual Scaling": the type of scaling used in the explicit residual convergence test. Default: "Norm of Initial Residual".
  • "Timer Label": the string to use as a prefix for the timer labels. Default: "Belos"
  • "Orthogonalization Constant": a MagnitudeType corresponding to the "depTol" parameter of DGKS orthogonalization. Ignored unless DGKS orthogonalization is used. DGKS decides the default value.

Definition at line 445 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::~BlockGCRODRSolMgr ( )
inlinevirtual

Destructor.

Definition at line 180 of file BelosBlockGCRODRSolMgr.hpp.

Member Function Documentation

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

A description of the Block GCRODR solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 541 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::getProblem ( ) const
inlinevirtual

Get current linear problem being solved for in this object.

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

Definition at line 196 of file BelosBlockGCRODRSolMgr.hpp.

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

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::getCurrentParameters ( ) const
inlinevirtual

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

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

Definition at line 204 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::achievedTol ( ) const
inlinevirtual

Get the residual for the most recent call to solve().

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

Definition at line 207 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::getNumIters ( ) const
inlinevirtual

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

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

Definition at line 212 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::isLOADetected ( ) const
inlinevirtual

Whether a loss of accuracy was detected during the most recent solve.

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

Definition at line 215 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem)
inlinevirtual

Set the linear problem to solve on the next call to solve().

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

Definition at line 223 of file BelosBlockGCRODRSolMgr.hpp.

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

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

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

Definition at line 643 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::reset ( const ResetType  type)
inlinevirtual

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 252 of file BelosBlockGCRODRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::BlockGCRODRSolMgr< ScalarType, MV, OP >::solve ( )
virtual

Solve the current linear problem.

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 BlockGCRODRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.

A return from BlockGCRODRIter::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.- 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 1801 of file BelosBlockGCRODRSolMgr.hpp.

The documentation for this class was generated from the following file:
Generated on Fri Aug 14 2020 10:48:34 for Belos by doxygen 1.8.5