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

The Belos::FixedPointSolMgr provides a powerful and fully-featured solver manager over the FixedPoint linear solver. More...

#include <BelosFixedPointSolMgr.hpp>

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

Public Member Functions

Constructors/Destructor
 FixedPointSolMgr ()
 Empty constructor for FixedPointSolMgr. 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...
 
 FixedPointSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for FixedPointSolMgr. More...
 
virtual ~FixedPointSolMgr ()
 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
 Return a reference to the linear problem being solved by this solver manager. 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 replaceUserConvStatusTest (const Teuchos::RCP< StatusTestResNorm< ScalarType, MV, OP > > &userConvStatusTest)
 Set user-defined convergence 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
std::string description () const override
 Method to return description of the block CG solver manager. 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...
 
virtual void setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &)
 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 ()
 
 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::FixedPointSolMgr< ScalarType, MV, OP >

The Belos::FixedPointSolMgr provides a powerful and fully-featured solver manager over the FixedPoint linear solver.

Definition at line 93 of file BelosFixedPointSolMgr.hpp.

Constructor & Destructor Documentation

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

Empty constructor for FixedPointSolMgr. 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 328 of file BelosFixedPointSolMgr.hpp.

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

Basic constructor for FixedPointSolMgr.

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" - an int specifying the block size to be used by the underlying block conjugate-gradient solver. Default: 1
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
  • "Output Style" - a OutputType specifying the style of output. Default: Belos::General
  • "Output Stream" - a reference-counted pointer to the output stream where all solver output is sent. Default: Teuchos::rcp(&std::cout,false)
  • "Output Frequency" - an int specifying how often convergence information should be outputted. Default: -1 (never)
  • "Show Maximum Residual Norm Only" - a bool specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: false
  • "Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 347 of file BelosFixedPointSolMgr.hpp.

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

Destructor.

Definition at line 135 of file BelosFixedPointSolMgr.hpp.

Member Function Documentation

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

clone for Inverted Injection (DII)

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

Definition at line 138 of file BelosFixedPointSolMgr.hpp.

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

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

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

Definition at line 146 of file BelosFixedPointSolMgr.hpp.

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

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

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 163 of file BelosFixedPointSolMgr.hpp.

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

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

Definition at line 172 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
int Belos::FixedPointSolMgr< 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 177 of file BelosFixedPointSolMgr.hpp.

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

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 183 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::FixedPointSolMgr< 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 190 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::FixedPointSolMgr< 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 377 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::FixedPointSolMgr< ScalarType, MV, OP >::replaceUserConvStatusTest ( const Teuchos::RCP< StatusTestResNorm< ScalarType, MV, OP > > &  userConvStatusTest)
inline

Set user-defined convergence status test.

Definition at line 196 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::FixedPointSolMgr< 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 219 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::FixedPointSolMgr< 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 FixedPointIter::iterate() or CGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

A return from FixedPointIter::iterate() signifies one of the following scenarios:

  • the maximum number of iterations 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 589 of file BelosFixedPointSolMgr.hpp.

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

Method to return description of the block CG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 839 of file BelosFixedPointSolMgr.hpp.

The documentation for this class was generated from the following file:
Generated on Fri Jun 5 2020 10:20:57 for Belos by doxygen 1.8.5