The Belos::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration.
More...
#include <BelosPseudoBlockStochasticCGSolMgr.hpp>
|
Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > | problem_ |
|
Teuchos::RCP< OutputManager< ScalarType > > | printer_ |
|
Teuchos::RCP< std::ostream > | outputStream_ |
|
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | sTest_ |
|
Teuchos::RCP< StatusTestMaxIters< ScalarType, MV, OP > > | maxIterTest_ |
|
Teuchos::RCP< StatusTestGenResNorm< ScalarType, MV, OP > > | convTest_ |
|
Teuchos::RCP< StatusTestOutput< ScalarType, MV, OP > > | outputTest_ |
|
Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > | ortho_ |
|
Teuchos::RCP< Teuchos::ParameterList > | params_ |
|
Teuchos::RCP< const Teuchos::ParameterList > | validParams_ |
| List of valid parameters and their default values. More...
|
|
MagnitudeType | convtol_ |
|
int | maxIters_ |
|
int | numIters_ |
|
int | verbosity_ |
|
int | outputStyle_ |
|
int | outputFreq_ |
|
int | defQuorum_ |
|
bool | assertPositiveDefiniteness_ |
|
bool | showMaxResNormOnly_ |
|
std::string | resScale_ |
|
std::string | label_ |
|
Teuchos::RCP< Teuchos::Time > | timerSolve_ |
|
bool | isSet_ |
|
Teuchos::RCP< MV > | Y_ |
|
|
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...
|
|
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...
|
|
|
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...
|
|
|
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...
|
|
|
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...
|
|
|
std::string | description () const |
| Method to return description of the block CG solver manager. More...
|
|
template<class ScalarType, class MV, class OP>
class Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >
The Belos::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration.
- Author
- Chris Siefert, Heidi Thornquist, Chris Baker, and Teri Barth
Definition at line 101 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
◆ MVT
template<class ScalarType, class MV, class OP>
◆ OPT
template<class ScalarType, class MV, class OP>
◆ SCT
template<class ScalarType, class MV, class OP>
◆ MagnitudeType
template<class ScalarType, class MV, class OP>
◆ MT
template<class ScalarType, class MV, class OP>
◆ PseudoBlockStochasticCGSolMgr() [1/2]
template<class ScalarType , class MV , class OP >
◆ PseudoBlockStochasticCGSolMgr() [2/2]
template<class ScalarType , class MV , class OP >
Basic constructor for PseudoBlockStochasticCGSolMgr.
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.
Definition at line 346 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
◆ ~PseudoBlockStochasticCGSolMgr()
template<class ScalarType, class MV, class OP>
◆ getProblem()
template<class ScalarType, class MV, class OP>
◆ getValidParameters()
template<class ScalarType , class MV , class OP >
◆ getCurrentParameters()
template<class ScalarType, class MV, class OP>
◆ getTimers()
template<class ScalarType, class MV, class OP>
◆ getNumIters()
template<class ScalarType, class MV, class OP>
◆ isLOADetected()
template<class ScalarType, class MV, class OP>
◆ setProblem()
template<class ScalarType, class MV, class OP>
◆ setParameters()
template<class ScalarType , class MV , class OP >
◆ reset()
template<class ScalarType, class MV, class OP>
◆ solve()
template<class ScalarType , class MV , class OP >
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 PseudoBlockStochasticCGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from PseudoBlockStochasticCGIter::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 654 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
◆ getStochasticVector()
template<class ScalarType, class MV, class OP>
◆ description()
template<class ScalarType , class MV , class OP >
◆ problem_
template<class ScalarType, class MV, class OP>
◆ printer_
template<class ScalarType, class MV, class OP>
◆ outputStream_
template<class ScalarType, class MV, class OP>
◆ sTest_
template<class ScalarType, class MV, class OP>
◆ maxIterTest_
template<class ScalarType, class MV, class OP>
◆ convTest_
template<class ScalarType, class MV, class OP>
◆ outputTest_
template<class ScalarType, class MV, class OP>
◆ ortho_
template<class ScalarType, class MV, class OP>
◆ params_
template<class ScalarType, class MV, class OP>
◆ validParams_
template<class ScalarType, class MV, class OP>
◆ convtol_default_
template<class ScalarType, class MV, class OP>
◆ maxIters_default_
template<class ScalarType, class MV, class OP>
◆ assertPositiveDefiniteness_default_
template<class ScalarType, class MV, class OP>
◆ showMaxResNormOnly_default_
template<class ScalarType, class MV, class OP>
◆ verbosity_default_
template<class ScalarType, class MV, class OP>
◆ outputStyle_default_
template<class ScalarType, class MV, class OP>
◆ outputFreq_default_
template<class ScalarType, class MV, class OP>
◆ defQuorum_default_
template<class ScalarType, class MV, class OP>
◆ resScale_default_
template<class ScalarType, class MV, class OP>
◆ label_default_
template<class ScalarType, class MV, class OP>
◆ outputStream_default_
template<class ScalarType, class MV, class OP>
◆ convtol_
template<class ScalarType, class MV, class OP>
◆ maxIters_
template<class ScalarType, class MV, class OP>
◆ numIters_
template<class ScalarType, class MV, class OP>
◆ verbosity_
template<class ScalarType, class MV, class OP>
◆ outputStyle_
template<class ScalarType, class MV, class OP>
◆ outputFreq_
template<class ScalarType, class MV, class OP>
◆ defQuorum_
template<class ScalarType, class MV, class OP>
◆ assertPositiveDefiniteness_
template<class ScalarType, class MV, class OP>
◆ showMaxResNormOnly_
template<class ScalarType, class MV, class OP>
◆ resScale_
template<class ScalarType, class MV, class OP>
◆ label_
template<class ScalarType, class MV, class OP>
◆ timerSolve_
template<class ScalarType, class MV, class OP>
◆ isSet_
template<class ScalarType, class MV, class OP>
◆ Y_
template<class ScalarType, class MV, class OP>
The documentation for this class was generated from the following file: