Belos
Version of the Day
|
The Belos::FixedPointSolMgr provides a powerful and fully-featured solver manager over the FixedPoint linear solver. More...
#include <BelosFixedPointSolMgr.hpp>
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... | |
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... | |
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 > ¶ms) |
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... | |
![]() | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual void | setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest) |
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... | |
The Belos::FixedPointSolMgr provides a powerful and fully-featured solver manager over the FixedPoint linear solver.
Definition at line 93 of file BelosFixedPointSolMgr.hpp.
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 340 of file BelosFixedPointSolMgr.hpp.
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:
int
specifying the block size to be used by the underlying block conjugate-gradient solver. Default: 1int
specifying how often convergence information should be outputted. Default: -1 (never)bool
specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: falsestd::string
to use as a prefix for the timer labels. Default: "Belos" Definition at line 359 of file BelosFixedPointSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 135 of file BelosFixedPointSolMgr.hpp.
|
inlinevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 141 of file BelosFixedPointSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 552 of file BelosFixedPointSolMgr.hpp.
|
inlinevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 151 of file BelosFixedPointSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 158 of file BelosFixedPointSolMgr.hpp.
|
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 167 of file BelosFixedPointSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 172 of file BelosFixedPointSolMgr.hpp.
|
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 178 of file BelosFixedPointSolMgr.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 186 of file BelosFixedPointSolMgr.hpp.
|
virtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 389 of file BelosFixedPointSolMgr.hpp.
|
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 199 of file BelosFixedPointSolMgr.hpp.
|
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 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:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 593 of file BelosFixedPointSolMgr.hpp.
std::string Belos::FixedPointSolMgr< ScalarType, MV, OP >::description | ( | ) | const |
Method to return description of the block CG solver manager.
Definition at line 847 of file BelosFixedPointSolMgr.hpp.