Belos Package Browser (Single Doxygen Collection)  Development
Private Types | Private Attributes | Static Private Attributes | List of all members
Belos::GmresPolySolMgr< ScalarType, MV, OP > Class Template Reference

The GMRES polynomial can be created in conjunction with any standard preconditioner. More...

#include <BelosGmresPolySolMgr.hpp>

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

Private Types

typedef MultiVecTraits< ScalarType, MV > MVT
 
typedef Teuchos::ScalarTraits< ScalarType > STS
 
typedef Teuchos::ScalarTraits< ScalarType >::magnitudeType MagnitudeType
 
typedef Belos::GmresPolyOp< ScalarType, MV, OP > gmres_poly_t
 
typedef Belos::GmresPolyMv< ScalarType, MV > gmres_poly_mv_t
 

Private Attributes

Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > problem_
 
Teuchos::RCP< std::ostream > outputStream_
 
Teuchos::RCP< Teuchos::ParameterList > params_
 
Teuchos::RCP< Teuchos::ParameterList > outerParams_
 
MagnitudeType polyTol_
 
int maxDegree_
 
int numIters_
 
int verbosity_
 
bool hasOuterSolver_
 
bool randomRHS_
 
bool damp_
 
bool addRoots_
 
std::string polyType_
 
std::string outerSolverType_
 
std::string orthoType_
 
int poly_dim_
 
Teuchos::RCP< gmres_poly_tpoly_Op_
 
std::string label_
 
Teuchos::RCP< Teuchos::Time > timerPoly_
 
bool isSet_
 
bool loaDetected_
 
Teuchos::RCP< const Teuchos::ParameterList > validPL_
 Cached default (valid) parameters. More...
 

Static Private Attributes

static constexpr int maxDegree_default_ = 25
 
static constexpr int verbosity_default_ = Belos::Errors
 
static constexpr const char * label_default_ = "Belos"
 
static constexpr const char * outerSolverType_default_ = ""
 
static constexpr const char * polyType_default_ = "Arnoldi"
 
static constexpr const char * orthoType_default_ = "ICGS"
 
static constexpr bool addRoots_default_ = true
 
static constexpr bool dampPoly_default_ = false
 
static constexpr bool randomRHS_default_ = true
 
static constexpr std::ostream * outputStream_default_ = &std::cout
 

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::ParameterList > getValidParameters () const override
 Get a parameter list containing the valid parameters for this object. More...
 
Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters () 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...
 

Additional Inherited Members

- 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 > > &, 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...
 

Detailed Description

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

The GMRES polynomial can be created in conjunction with any standard preconditioner.

Hybrid block GMRES iterative linear solver.

Simply pass the preconditioner to the LinearProblem before calling the GmresPolySolMgr and your preconditioner will be combined with the polynomial automatically.

Here is a list of all the parameters that this solver accepts:

This solver manager provides three different implementations of the same polynomial preconditioner. The polynomial is the minimum residual polynomial from GMRES. The "Roots" version is default. It is the only implementation which provides the option of added roots for stability. These added roots can allow for high-degree polynomials.

The "Arnoldi" version typically gives similar results to the "Roots" version but is slightly more expensive to apply. Both of these polynomials can be "damped", which is sometimes useful for indefinite or other ill-conditioned problems. The "Gmres" version is based on a power-basis implementation and is only stable for well-conditioned problems and low-degree polynomials. For more information on the implementation and formulas, see the following references: "Roots" version: https://arxiv.org/abs/1806.08020 (Includes explanation of root-adding and damping.) "Arnoldi" version: https://scholarship.rice.edu/handle/1911/17630 "Gmres" version: https://epubs.siam.org/doi/pdf/10.1137/140968276

Like all Belos solvers, parameters have relative or "delta" semantics. This means the following:

Author
Heidi Thornquist and Jennifer Loe

Definition at line 152 of file BelosGmresPolySolMgr.hpp.

Member Typedef Documentation

◆ MVT

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

Definition at line 155 of file BelosGmresPolySolMgr.hpp.

◆ STS

template<class ScalarType , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType> Belos::GmresPolySolMgr< ScalarType, MV, OP >::STS
private

Definition at line 156 of file BelosGmresPolySolMgr.hpp.

◆ MagnitudeType

template<class ScalarType , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::GmresPolySolMgr< ScalarType, MV, OP >::MagnitudeType
private

Definition at line 157 of file BelosGmresPolySolMgr.hpp.

◆ gmres_poly_t

template<class ScalarType , class MV , class OP >
typedef Belos::GmresPolyOp<ScalarType,MV,OP> Belos::GmresPolySolMgr< ScalarType, MV, OP >::gmres_poly_t
private

Definition at line 158 of file BelosGmresPolySolMgr.hpp.

◆ gmres_poly_mv_t

template<class ScalarType , class MV , class OP >
typedef Belos::GmresPolyMv<ScalarType,MV> Belos::GmresPolySolMgr< ScalarType, MV, OP >::gmres_poly_mv_t
private

Definition at line 159 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 363 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:

  • "Polynomial Type" -a std::string specifying the type of polynomial: Roots, Arnoldi, or Gmres. Default: "Roots"
  • "Maximum Degree" - a int specifying the maximum degree of the polynomial. Default: 25
  • "Random RHS" - a bool indicates whether to generate polynomial using a random vector. Default: true
  • "Add Roots" - a bool to add roots to the polynomial as needed for stability. Default: true
  • "Damp Poly" - a bool to damp polynomial. Default: false
  • "Orthogonalization" - a std::string specifying the desired orthogonalization to create the polynomial: DGKS, ICGS, and IMGS. Default: "ICGS"
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
  • "Polynomial Tolerance" - a MagnitudeType specifying the polynomial tolerance (sometimes) used to generate polynomial. Default: 1e-8
  • "Outer Solver" -a std::string specifying name of outer solver in Belos solver factory. Default: ""
  • "Outer Solver Params" -a Teuchos::ParameterList giving parameters for the outer solver.
  • "Timer Label" -a std::string specifying the label on polynomial solve timers.

Definition at line 385 of file BelosGmresPolySolMgr.hpp.

◆ ~GmresPolySolMgr()

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

Destructor.

Definition at line 195 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 198 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 208 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 421 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 218 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 225 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 230 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 237 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 245 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 460 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 262 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 614 of file BelosGmresPolySolMgr.hpp.

◆ description()

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

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

Definition at line 721 of file BelosGmresPolySolMgr.hpp.

Member Data Documentation

◆ problem_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::GmresPolySolMgr< ScalarType, MV, OP >::problem_
private

Definition at line 306 of file BelosGmresPolySolMgr.hpp.

◆ outputStream_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<std::ostream> Belos::GmresPolySolMgr< ScalarType, MV, OP >::outputStream_
private

Definition at line 309 of file BelosGmresPolySolMgr.hpp.

◆ params_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::ParameterList> Belos::GmresPolySolMgr< ScalarType, MV, OP >::params_
private

Definition at line 312 of file BelosGmresPolySolMgr.hpp.

◆ outerParams_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::ParameterList> Belos::GmresPolySolMgr< ScalarType, MV, OP >::outerParams_
private

Definition at line 313 of file BelosGmresPolySolMgr.hpp.

◆ maxDegree_default_

template<class ScalarType , class MV , class OP >
constexpr int Belos::GmresPolySolMgr< ScalarType, MV, OP >::maxDegree_default_ = 25
staticprivate

Definition at line 316 of file BelosGmresPolySolMgr.hpp.

◆ verbosity_default_

template<class ScalarType , class MV , class OP >
constexpr int Belos::GmresPolySolMgr< ScalarType, MV, OP >::verbosity_default_ = Belos::Errors
staticprivate

Definition at line 317 of file BelosGmresPolySolMgr.hpp.

◆ label_default_

template<class ScalarType , class MV , class OP >
constexpr const char* Belos::GmresPolySolMgr< ScalarType, MV, OP >::label_default_ = "Belos"
staticprivate

Definition at line 318 of file BelosGmresPolySolMgr.hpp.

◆ outerSolverType_default_

template<class ScalarType , class MV , class OP >
constexpr const char* Belos::GmresPolySolMgr< ScalarType, MV, OP >::outerSolverType_default_ = ""
staticprivate

Definition at line 319 of file BelosGmresPolySolMgr.hpp.

◆ polyType_default_

template<class ScalarType , class MV , class OP >
constexpr const char* Belos::GmresPolySolMgr< ScalarType, MV, OP >::polyType_default_ = "Arnoldi"
staticprivate

Definition at line 320 of file BelosGmresPolySolMgr.hpp.

◆ orthoType_default_

template<class ScalarType , class MV , class OP >
constexpr const char* Belos::GmresPolySolMgr< ScalarType, MV, OP >::orthoType_default_ = "ICGS"
staticprivate

Definition at line 321 of file BelosGmresPolySolMgr.hpp.

◆ addRoots_default_

template<class ScalarType , class MV , class OP >
constexpr bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::addRoots_default_ = true
staticprivate

Definition at line 322 of file BelosGmresPolySolMgr.hpp.

◆ dampPoly_default_

template<class ScalarType , class MV , class OP >
constexpr bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::dampPoly_default_ = false
staticprivate

Definition at line 323 of file BelosGmresPolySolMgr.hpp.

◆ randomRHS_default_

template<class ScalarType , class MV , class OP >
constexpr bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::randomRHS_default_ = true
staticprivate

Definition at line 324 of file BelosGmresPolySolMgr.hpp.

◆ outputStream_default_

template<class ScalarType , class MV , class OP >
constexpr std::ostream* Belos::GmresPolySolMgr< ScalarType, MV, OP >::outputStream_default_ = &std::cout
staticprivate

Definition at line 330 of file BelosGmresPolySolMgr.hpp.

◆ polyTol_

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::GmresPolySolMgr< ScalarType, MV, OP >::polyTol_
private

Definition at line 334 of file BelosGmresPolySolMgr.hpp.

◆ maxDegree_

template<class ScalarType , class MV , class OP >
int Belos::GmresPolySolMgr< ScalarType, MV, OP >::maxDegree_
private

Definition at line 335 of file BelosGmresPolySolMgr.hpp.

◆ numIters_

template<class ScalarType , class MV , class OP >
int Belos::GmresPolySolMgr< ScalarType, MV, OP >::numIters_
private

Definition at line 335 of file BelosGmresPolySolMgr.hpp.

◆ verbosity_

template<class ScalarType , class MV , class OP >
int Belos::GmresPolySolMgr< ScalarType, MV, OP >::verbosity_
private

Definition at line 336 of file BelosGmresPolySolMgr.hpp.

◆ hasOuterSolver_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::hasOuterSolver_
private

Definition at line 337 of file BelosGmresPolySolMgr.hpp.

◆ randomRHS_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::randomRHS_
private

Definition at line 338 of file BelosGmresPolySolMgr.hpp.

◆ damp_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::damp_
private

Definition at line 339 of file BelosGmresPolySolMgr.hpp.

◆ addRoots_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::addRoots_
private

Definition at line 340 of file BelosGmresPolySolMgr.hpp.

◆ polyType_

template<class ScalarType , class MV , class OP >
std::string Belos::GmresPolySolMgr< ScalarType, MV, OP >::polyType_
private

Definition at line 341 of file BelosGmresPolySolMgr.hpp.

◆ outerSolverType_

template<class ScalarType , class MV , class OP >
std::string Belos::GmresPolySolMgr< ScalarType, MV, OP >::outerSolverType_
private

Definition at line 342 of file BelosGmresPolySolMgr.hpp.

◆ orthoType_

template<class ScalarType , class MV , class OP >
std::string Belos::GmresPolySolMgr< ScalarType, MV, OP >::orthoType_
private

Definition at line 343 of file BelosGmresPolySolMgr.hpp.

◆ poly_dim_

template<class ScalarType , class MV , class OP >
int Belos::GmresPolySolMgr< ScalarType, MV, OP >::poly_dim_
private

Definition at line 346 of file BelosGmresPolySolMgr.hpp.

◆ poly_Op_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<gmres_poly_t> Belos::GmresPolySolMgr< ScalarType, MV, OP >::poly_Op_
private

Definition at line 347 of file BelosGmresPolySolMgr.hpp.

◆ label_

template<class ScalarType , class MV , class OP >
std::string Belos::GmresPolySolMgr< ScalarType, MV, OP >::label_
private

Definition at line 350 of file BelosGmresPolySolMgr.hpp.

◆ timerPoly_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<Teuchos::Time> Belos::GmresPolySolMgr< ScalarType, MV, OP >::timerPoly_
private

Definition at line 351 of file BelosGmresPolySolMgr.hpp.

◆ isSet_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::isSet_
private

Definition at line 354 of file BelosGmresPolySolMgr.hpp.

◆ loaDetected_

template<class ScalarType , class MV , class OP >
bool Belos::GmresPolySolMgr< ScalarType, MV, OP >::loaDetected_
private

Definition at line 355 of file BelosGmresPolySolMgr.hpp.

◆ validPL_

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const Teuchos::ParameterList> Belos::GmresPolySolMgr< ScalarType, MV, OP >::validPL_
mutableprivate

Cached default (valid) parameters.

Definition at line 358 of file BelosGmresPolySolMgr.hpp.


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