Belos
Version of the Day
|
Partial specialization for ScalarType types for which Teuchos::LAPACK has a valid implementation. More...
#include <BelosGCRODRSolMgr.hpp>
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::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 () |
Attempt to solve the linear system. More... | |
Implementation of Teuchos::Describable | |
std::string | description () const |
Return a one-line description of this object. More... | |
![]() | |
SolverManagerRequiresLapack () | |
virtual | ~SolverManagerRequiresLapack () |
![]() | |
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... | |
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.
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.
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:
int
specifying the number of blocks allocated for the Krylov basis. Default: 50.int
specifying the number of blocks allocated for the Krylov basis. Default: 5.int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 5000.int
specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 100.std::string
specifying the desired orthogonalization. Currently supported values: "DGKS", "ICGS", "IMGS", and "TSQR" (if Belos was built with TSQR support). Default: "DGKS".MagnitudeType
specifying the level that residual norms must reach to decide convergence. Default: 1e-8.Other supported options:
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.
|
inlinevirtual |
Destructor.
Definition at line 275 of file BelosGCRODRSolMgr.hpp.
|
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.
|
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.
|
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.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 302 of file BelosGCRODRSolMgr.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 311 of file BelosGCRODRSolMgr.hpp.
|
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.
|
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.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 330 of file BelosGCRODRSolMgr.hpp.
|
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.
|
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.
|
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:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 1346 of file BelosGCRODRSolMgr.hpp.
std::string Belos::GCRODRSolMgr< ScalarType, MV, OP, true >::description | ( | ) | const |
Return a one-line description of this object.
Definition at line 2418 of file BelosGCRODRSolMgr.hpp.