Belos
Version of the Day
|
The Belos::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration. More...
#include <BelosPseudoBlockStochasticCGSolMgr.hpp>
Public Member Functions | |
Teuchos::RCP< MV > | getStochasticVector () |
Get a copy of the final stochastic vector. More... | |
Constructors/Destructor | |
PseudoBlockStochasticCGSolMgr () | |
Empty constructor for BlockStochasticCGSolMgr. 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... | |
PseudoBlockStochasticCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
Basic constructor for PseudoBlockStochasticCGSolMgr. More... | |
virtual | ~PseudoBlockStochasticCGSolMgr () |
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... | |
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 Teuchos::ScalarTraits< ScalarType >::magnitudeType | achievedTol () const |
Tolerance achieved by the last solve() invocation. More... | |
virtual void | setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &userConvStatusTest, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &comboType=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
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::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration.
Definition at line 101 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::PseudoBlockStochasticCGSolMgr | ( | ) |
Empty constructor for BlockStochasticCGSolMgr. 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 327 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::PseudoBlockStochasticCGSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, |
const Teuchos::RCP< Teuchos::ParameterList > & | pl | ||
) |
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:
int
specifying the maximum number of iterations the underlying solver is allowed to perform.MagnitudeType
specifying the level that residual norms must reach to decide convergence. Definition at line 346 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
|
inlinevirtual |
Destructor.
Definition at line 135 of file BelosPseudoBlockStochasticCGSolMgr.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 BelosPseudoBlockStochasticCGSolMgr.hpp.
|
virtual |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 597 of file BelosPseudoBlockStochasticCGSolMgr.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 BelosPseudoBlockStochasticCGSolMgr.hpp.
|
inline |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 158 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 163 of file BelosPseudoBlockStochasticCGSolMgr.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 170 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 178 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
|
virtual |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 376 of file BelosPseudoBlockStochasticCGSolMgr.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 191 of file BelosPseudoBlockStochasticCGSolMgr.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 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:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 654 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
|
inline |
Get a copy of the final stochastic vector.
Definition at line 219 of file BelosPseudoBlockStochasticCGSolMgr.hpp.
std::string Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::description | ( | ) | const |
Method to return description of the block CG solver manager.
Definition at line 866 of file BelosPseudoBlockStochasticCGSolMgr.hpp.