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

#include <BelosPseudoBlockCGSolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 PseudoBlockCGSolMgr ()
 Empty constructor for BlockCGSolMgr. 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...
 
 PseudoBlockCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for PseudoBlockCGSolMgr. More...
 
virtual ~PseudoBlockCGSolMgr ()
 Destructor. More...
 
Accessor methods
const LinearProblem< ScalarType, MV, OP > & getProblem () const
 Return a reference to the linear problem being solved by this solver manager. 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...
 
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...
 
ScalarType getConditionEstimate () const
 Gets the estimated condition number. More...
 
Teuchos::RCP< StatusTestGenResNorm< ScalarType, MV, OP > > getResidualStatusTest () const
 Return the residual status test. 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 ()
 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
 Method to return description of the block CG solver manager. 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...
 

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP, true >

Definition at line 139 of file BelosPseudoBlockCGSolMgr.hpp.

Constructor & Destructor Documentation

◆ PseudoBlockCGSolMgr() [1/2]

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

Empty constructor for BlockCGSolMgr. 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 399 of file BelosPseudoBlockCGSolMgr.hpp.

◆ PseudoBlockCGSolMgr() [2/2]

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

Basic constructor for PseudoBlockCGSolMgr.

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:

  • "Maximum Iterations" - a int specifying the maximum number of iterations the underlying solver is allowed to perform.
  • "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.
    Parameters
    pl[in] ParameterList with construction information

Definition at line 420 of file BelosPseudoBlockCGSolMgr.hpp.

◆ ~PseudoBlockCGSolMgr()

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

Destructor.

Definition at line 180 of file BelosPseudoBlockCGSolMgr.hpp.

Member Function Documentation

◆ getProblem()

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

Return a reference to the linear problem being solved by this solver manager.

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

Definition at line 186 of file BelosPseudoBlockCGSolMgr.hpp.

◆ getValidParameters()

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

◆ getCurrentParameters()

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

◆ getTimers()

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 203 of file BelosPseudoBlockCGSolMgr.hpp.

◆ achievedTol()

template<class ScalarType , class MV , class OP >
MagnitudeType Belos::PseudoBlockCGSolMgr< 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.

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 218 of file BelosPseudoBlockCGSolMgr.hpp.

◆ getNumIters()

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGSolMgr< 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 223 of file BelosPseudoBlockCGSolMgr.hpp.

◆ isLOADetected()

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

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 230 of file BelosPseudoBlockCGSolMgr.hpp.

◆ getConditionEstimate()

template<class ScalarType , class MV , class OP >
ScalarType Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP, true >::getConditionEstimate ( ) const
inline

Gets the estimated condition number.

Note
Only works if "Estimate Condition Number" is set on parameterlist

Definition at line 235 of file BelosPseudoBlockCGSolMgr.hpp.

◆ getResidualStatusTest()

template<class ScalarType , class MV , class OP >
Teuchos::RCP<StatusTestGenResNorm<ScalarType,MV,OP> > Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP, true >::getResidualStatusTest ( ) const
inline

Return the residual status test.

Definition at line 239 of file BelosPseudoBlockCGSolMgr.hpp.

◆ setProblem()

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGSolMgr< 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 247 of file BelosPseudoBlockCGSolMgr.hpp.

◆ setParameters()

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGSolMgr< 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 454 of file BelosPseudoBlockCGSolMgr.hpp.

◆ reset()

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGSolMgr< 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 260 of file BelosPseudoBlockCGSolMgr.hpp.

◆ solve()

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

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

A return from PseudoBlockCGIter::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 772 of file BelosPseudoBlockCGSolMgr.hpp.

◆ description()

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

Method to return description of the block CG solver manager.

Definition at line 1006 of file BelosPseudoBlockCGSolMgr.hpp.


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

Generated for Belos by doxygen 1.8.14