Belos  Version of the Day
List of all members
Belos::GmresPolySolMgr< ScalarType, MV, OP > Class Template Reference

Hybrid block GMRES iterative linear solver. More...

#include <BelosGmresPolySolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 GmresPolySolMgr ()
 Empty constructor for GmresPolySolMgr. 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(). More...
 
 GmresPolySolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for GmresPolySolMgr. More...
 
virtual ~GmresPolySolMgr ()
 Destructor. More...
 
Teuchos::RCP< SolverManager< ScalarType, MV, OP > > clone () const override
 clone for Inverted Injection (DII) More...
 
Accessor methods
const LinearProblem< ScalarType, MV, OP > & getProblem () const override
 Get current linear problem being solved for in this object. More...
 
Teuchos::RCP< const Teuchos::ParameterListgetValidParameters () const override
 Get a parameter list containing the valid parameters for this object. More...
 
Teuchos::RCP< const Teuchos::ParameterListgetCurrentParameters () const override
 Get a parameter list containing the current parameters for this object. More...
 
Teuchos::Array< Teuchos::RCP< Teuchos::Time > > getTimers () const
 Return the timers for this object. More...
 
int getNumIters () const override
 Get the iteration count for the most recent call to solve(). More...
 
bool isLOADetected () const override
 Return whether a loss of accuracy was detected by this solver during the most current solve. More...
 
Set methods
void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) override
 Set the linear problem that needs to be solved. More...
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params) override
 Set the parameters the solver manager should use to solve the linear problem. More...
 
Reset methods
void reset (const ResetType type) override
 Reset the solver. More...
 
Solver application methods
ReturnType solve () override
 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. More...
 
Overridden from Teuchos::Describable
std::string description () const override
 Method to return description of the hybrid block GMRES solver manager. More...
 
- Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
 SolverManager ()
 Empty constructor. More...
 
virtual ~SolverManager ()
 Destructor. More...
 
virtual Teuchos::ScalarTraits< ScalarType >::magnitudeType achievedTol () const
 Tolerance achieved by the last solve() invocation. More...
 
virtual void setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &comboType=StatusTestCombo< ScalarType, MV, OP >::SEQ)
 Set user-defined convergence status test. More...
 
virtual void setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debugStatusTest)
 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 ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 

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::GmresPolySolMgr< ScalarType, MV, OP >

Hybrid block GMRES iterative linear solver.

Author
Heidi Thornquist
Examples:
BlockGmres/BlockGmresPolyEpetraExFile.cpp.

Definition at line 155 of file BelosGmresPolySolMgr.hpp.

Constructor & Destructor Documentation

◆ GmresPolySolMgr() [1/2]

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

Empty constructor for GmresPolySolMgr. 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 373 of file BelosGmresPolySolMgr.hpp.

◆ GmresPolySolMgr() [2/2]

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

Basic constructor for GmresPolySolMgr.

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:

  • "Block Size" - a int specifying the block size to be used by the underlying block GMRES solver. Default: 1
  • "Num Blocks" - a int specifying the number of blocks allocated for the Krylov basis. Default: 300
  • "Maximum Iterations" - a int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000
  • "Maximum Restarts" - a int specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 20
  • "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. Default: 1e-8

Definition at line 404 of file BelosGmresPolySolMgr.hpp.

◆ ~GmresPolySolMgr()

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

Destructor.

Definition at line 192 of file BelosGmresPolySolMgr.hpp.

Member Function Documentation

◆ clone()

template<class ScalarType , class MV , class OP >
Teuchos::RCP<SolverManager<ScalarType, MV, OP> > Belos::GmresPolySolMgr< ScalarType, MV, OP >::clone ( ) const
inlineoverridevirtual

clone for Inverted Injection (DII)

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

Definition at line 195 of file BelosGmresPolySolMgr.hpp.

◆ getProblem()

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

Get current linear problem being solved for in this object.

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

Definition at line 205 of file BelosGmresPolySolMgr.hpp.

◆ getValidParameters()

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::GmresPolySolMgr< ScalarType, MV, OP >::getValidParameters ( ) const
overridevirtual

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

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

Definition at line 449 of file BelosGmresPolySolMgr.hpp.

◆ getCurrentParameters()

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

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

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

Definition at line 215 of file BelosGmresPolySolMgr.hpp.

◆ getTimers()

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 222 of file BelosGmresPolySolMgr.hpp.

◆ getNumIters()

template<class ScalarType , class MV , class OP >
int Belos::GmresPolySolMgr< ScalarType, MV, OP >::getNumIters ( ) const
inlineoverridevirtual

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

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

Definition at line 227 of file BelosGmresPolySolMgr.hpp.

◆ isLOADetected()

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::isLOADetected ( ) const
inlineoverridevirtual

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 234 of file BelosGmresPolySolMgr.hpp.

◆ setProblem()

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

Set the linear problem that needs to be solved.

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

Definition at line 242 of file BelosGmresPolySolMgr.hpp.

◆ setParameters()

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

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

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

Definition at line 512 of file BelosGmresPolySolMgr.hpp.

◆ reset()

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

Reset the solver.

Parameters
type[in] How to reset the solver.

If type includes Belos::Problem, then reset the solver's state. This clears out the stored coefficients, so that the next call to solve() actually computes a full block GMRES solve, instead of just reusing the coefficients from the first solve.

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

Definition at line 259 of file BelosGmresPolySolMgr.hpp.

◆ solve()

template<class ScalarType , class MV , class OP >
ReturnType Belos::GmresPolySolMgr< ScalarType, MV, OP >::solve ( )
overridevirtual

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

A return from BlockGmresIter::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 1039 of file BelosGmresPolySolMgr.hpp.

◆ description()

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

Method to return description of the hybrid block GMRES solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1393 of file BelosGmresPolySolMgr.hpp.


The documentation for this class was generated from the following file:

Generated for Belos by doxygen 1.8.14