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

Interface to Block GMRES and Flexible GMRES. More...

#include <BelosBlockGmresSolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 BlockGmresSolMgr ()
 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(). More...
 
 BlockGmresSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for BlockGmresSolMgr. More...
 
virtual ~BlockGmresSolMgr ()
 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...
 
MagnitudeType achievedTol () const override
 Tolerance achieved by the last solve() invocation. 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...
 
void setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debugStatusTest) override
 Set a debug status test that will be checked at the same time as the top-level status test. More...
 
Reset methods
void reset (const ResetType type) override
 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. 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
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const override
 Print the object with the given verbosity level to a FancyOStream. More...
 
std::string description () const override
 Return a one-line description of this object. More...
 
- Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
 SolverManager ()
 Empty constructor. More...
 
virtual ~SolverManager ()
 Destructor. 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...
 
- Public Member Functions inherited from Teuchos::Describable
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::BlockGmresSolMgr< ScalarType, MV, OP >

Interface to Block GMRES and Flexible GMRES.

Author
Heidi Thornquist, Chris Baker, and Teri Barth

This class provides an interface to Block GMRES, for solving linear systems with one or more right-hand sides. Our Block GMRES implementation also has an option (the Boolean "Flexible Gmres" parameter) to use the Flexible variant of GMRES. Flexible GMRES allows the preconditioner (which must be a right preconditioner) to change from iteration to iteration.

If you are a new Belos user and just want standard GMRES, use PseudoBlockGmresSolMgr. If you want Flexible GMRES, use this class with the "Flexible Gmres" parameter set to true.

Examples:
epetra/example/BlockGmres/BlockFlexGmresEpetraExFile.cpp, epetra/example/BlockGmres/BlockGmresEpetraExFile.cpp, epetra/example/BlockGmres/BlockPrecGmresEpetraExFile.cpp, tpetra/example/BlockGmres/BlockGmresTpetraExFile.cpp, and tpetra/example/BlockGmres/BlockGmresTpetraGaleriEx.cpp.

Definition at line 96 of file BelosBlockGmresSolMgr.hpp.

Constructor & Destructor Documentation

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

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 330 of file BelosBlockGmresSolMgr.hpp.

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

Basic constructor for BlockGmresSolMgr.

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
  • "Adaptive Block Size" - a bool specifying whether the block size can be modified throughout the solve. Default: true
  • "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: "ICGS"
  • "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
    Parameters
    pl[in] ParameterList with construction information

Definition at line 360 of file BelosBlockGmresSolMgr.hpp.

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

Destructor.

Definition at line 141 of file BelosBlockGmresSolMgr.hpp.

Member Function Documentation

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

clone for Inverted Injection (DII)

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

Definition at line 144 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::BlockGmresSolMgr< 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 154 of file BelosBlockGmresSolMgr.hpp.

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

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

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 171 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::BlockGmresSolMgr< ScalarType, MV, OP >::achievedTol ( ) const
inlineoverridevirtual

Tolerance achieved by the last solve() invocation.

This is the maximum over all right-hand sides' achieved convergence tolerances, and is set whether or not the solve actually managed to achieve the desired convergence tolerance.

Warning
This result may not be meaningful if there was a loss of accuracy during the solve. You should first call isLOADetected() to check for a loss of accuracy during the last solve.

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

Definition at line 185 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::BlockGmresSolMgr< 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 190 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::BlockGmresSolMgr< 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 197 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGmresSolMgr< 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 205 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGmresSolMgr< 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 464 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGmresSolMgr< ScalarType, MV, OP >::setDebugStatusTest ( const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &  debugStatusTest)
overridevirtual

Set a debug status test that will be checked at the same time as the top-level status test.

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

Definition at line 846 of file BelosBlockGmresSolMgr.hpp.

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

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 221 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::BlockGmresSolMgr< 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 856 of file BelosBlockGmresSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockGmresSolMgr< ScalarType, MV, OP >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const
overridevirtual

Print the object with the given verbosity level to a FancyOStream.

Parameters
out[out] Output stream to which to print.
verbLevel[in] Verbosity level. The default verbosity (verbLevel=Teuchos::VERB_DEFAULT) is Teuchos::VERB_LOW.

Reimplemented from Teuchos::Describable.

Definition at line 1274 of file BelosBlockGmresSolMgr.hpp.

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

Return a one-line description of this object.

Reimplemented from Teuchos::Describable.

Definition at line 1254 of file BelosBlockGmresSolMgr.hpp.

The documentation for this class was generated from the following file:
Generated on Thu Nov 21 2024 09:25:07 for Belos by doxygen 1.8.5