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

Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation. More...

#include <BelosGCRODRSolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 GCRODRSolMgr ()
 Empty constructor for GCRODRSolMgr. 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...
 
 GCRODRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for GCRODRSolMgr. More...
 
virtual ~GCRODRSolMgr ()
 Destructor. 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::ParameterListgetValidParameters () const
 Get a parameter list containing the valid parameters for this object. More...
 
Teuchos::RCP< const Teuchos::ParameterListgetCurrentParameters () const
 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
 Tolerance achieved by the last solve() invocation. More...
 
int getNumIters () const
 Get the iteration count for the most recent call to solve(). More...
 
bool isLOADetected () const
 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)
 Set the linear problem that needs to be solved. More...
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver manager 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. 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 ()
 Attempt to solve the linear system. More...
 
Implementation of Teuchos::Describable
std::string description () const
 Return a one-line description of this object. More...
 
- Public Member Functions inherited from Belos::Details::SolverManagerRequiresLapack< ScalarType, MV, OP, true >
 SolverManagerRequiresLapack ()
 
virtual ~SolverManagerRequiresLapack ()
 
- 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 > > &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::GCRODRSolMgr< ScalarType, MV, OP, true >

Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation.

This contains the actual working implementation of GCRODR.

Definition at line 180 of file BelosGCRODRSolMgr.hpp.

Constructor & Destructor Documentation

◆ GCRODRSolMgr() [1/2]

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

Empty constructor for GCRODRSolMgr. 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 575 of file BelosGCRODRSolMgr.hpp.

◆ GCRODRSolMgr() [2/2]

template<class ScalarType , class MV , class OP >
Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::GCRODRSolMgr ( 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.
  • "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 sublist 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 (means 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 586 of file BelosGCRODRSolMgr.hpp.

◆ ~GCRODRSolMgr()

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

Destructor.

Definition at line 275 of file BelosGCRODRSolMgr.hpp.

Member Function Documentation

◆ getProblem()

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

Get current linear problem being solved for in this object.

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

Definition at line 283 of file BelosGCRODRSolMgr.hpp.

◆ getValidParameters()

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::getValidParameters ( ) const
virtual

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

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

Definition at line 1147 of file BelosGCRODRSolMgr.hpp.

◆ getCurrentParameters()

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

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

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

Definition at line 293 of file BelosGCRODRSolMgr.hpp.

◆ getTimers()

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 302 of file BelosGCRODRSolMgr.hpp.

◆ achievedTol()

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

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.

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

Definition at line 311 of file BelosGCRODRSolMgr.hpp.

◆ getNumIters()

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

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

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

Definition at line 316 of file BelosGCRODRSolMgr.hpp.

◆ isLOADetected()

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

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

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

Definition at line 322 of file BelosGCRODRSolMgr.hpp.

◆ setProblem()

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

Set the linear problem that needs to be solved.

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

Definition at line 330 of file BelosGCRODRSolMgr.hpp.

◆ setParameters()

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

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

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

Definition at line 649 of file BelosGCRODRSolMgr.hpp.

◆ reset()

template<class ScalarType , class MV , class OP >
void Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::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 345 of file BelosGCRODRSolMgr.hpp.

◆ solve()

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

Attempt to solve the linear system.

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 GCRODRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown. A return from GCRODRIter::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 1346 of file BelosGCRODRSolMgr.hpp.

◆ description()

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

Return a one-line description of this object.

Reimplemented from Teuchos::Describable.

Definition at line 2418 of file BelosGCRODRSolMgr.hpp.


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

Generated for Belos by doxygen 1.8.14