Belos
Version of the Day
|
The Belos::PseudoBlockTFQMRSolMgr provides a powerful and fully-featured solver manager over the pseudo-block TFQMR linear solver. More...
#include <BelosPseudoBlockTFQMRSolMgr.hpp>
Public Member Functions | |
Constructors/Destructor | |
PseudoBlockTFQMRSolMgr () | |
Empty constructor for PseudoBlockTFQMRSolMgr. 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... | |
PseudoBlockTFQMRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for PseudoBlockTFQMRSolMgr. More... | |
virtual | ~PseudoBlockTFQMRSolMgr () |
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 |
Whether loss of accuracy was detected during the last solve() invocation. 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 pseudo-block TFQMR 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::PseudoBlockTFQMRSolMgr provides a powerful and fully-featured solver manager over the pseudo-block TFQMR linear solver.
Definition at line 104 of file BelosPseudoBlockTFQMRSolMgr.hpp.
Belos::PseudoBlockTFQMRSolMgr< ScalarType, MV, OP >::PseudoBlockTFQMRSolMgr | ( | ) |
Empty constructor for PseudoBlockTFQMRSolMgr. 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 337 of file BelosPseudoBlockTFQMRSolMgr.hpp.
Belos::PseudoBlockTFQMRSolMgr< ScalarType, MV, OP >::PseudoBlockTFQMRSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
Basic constructor for PseudoBlockTFQMRSolMgr.
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 maximum number of iterations the underlying solver is allowed to perform. Default: 1000MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8.int
specifying how often convergence information should be outputted. Default: -1 (never)std::string
to use as a prefix for the timer labels. Default: "Belos" Definition at line 358 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 145 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 151 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 629 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 161 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 168 of file BelosPseudoBlockTFQMRSolMgr.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 177 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 182 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Whether loss of accuracy was detected during the last solve()
invocation.
In solvers that can detect a loss of accuracy, this method would say whether the solver detected it in the most recent solve()
invocation. However, our TFQMR implementation does not currently detect a loss of accuracy, so this method always returns false.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 193 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 201 of file BelosPseudoBlockTFQMRSolMgr.hpp.
|
virtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 387 of file BelosPseudoBlockTFQMRSolMgr.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 214 of file BelosPseudoBlockTFQMRSolMgr.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 PseudoBlockTFQMRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from PseudoBlockTFQMRIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 673 of file BelosPseudoBlockTFQMRSolMgr.hpp.
std::string Belos::PseudoBlockTFQMRSolMgr< ScalarType, MV, OP >::description | ( | ) | const |
Method to return description of the pseudo-block TFQMR solver manager.
Definition at line 935 of file BelosPseudoBlockTFQMRSolMgr.hpp.