#include <BelosPseudoBlockGmresSolMgr.hpp>
Inheritance diagram for Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >:
Public Member Functions | |
Constructors/Destructor | |
| PseudoBlockGmresSolMgr () | |
| Empty constructor for BlockGmresSolMgr. 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(). | |
| PseudoBlockGmresSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl) | |
| Basic constructor for PseudoBlockGmresSolMgr. | |
| virtual | ~PseudoBlockGmresSolMgr () |
| Destructor. | |
Accessor methods | |
| const LinearProblem< ScalarType, MV, OP > & | getProblem () const |
| Return a reference to the linear problem being solved by this solver manager. | |
| Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
| Get a parameter list containing the valid parameters for this object. | |
| Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const |
| Get a parameter list containing the current parameters for this object. | |
| Teuchos::Array< Teuchos::RCP< Teuchos::Time > > | getTimers () const |
| Return the timers for this object. | |
| int | getNumIters () const |
Get the iteration count for the most recent call to solve(). | |
| bool | isLOADetected () const |
| Return whether a loss of accuracy was detected by this solver during the most current solve. | |
Set methods | |
| void | setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) |
| Set the linear problem that needs to be solved. | |
| void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) |
| Set the parameters the solver manager should use to solve the linear problem. | |
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. | |
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. | |
Overridden from Teuchos::Describable | |
| std::string | description () const |
| Method to return description of the block GMRES solver manager. | |
Definition at line 96 of file BelosPseudoBlockGmresSolMgr.hpp.
| Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::PseudoBlockGmresSolMgr | ( | ) |
Empty constructor for BlockGmresSolMgr. 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 351 of file BelosPseudoBlockGmresSolMgr.hpp.
| Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::PseudoBlockGmresSolMgr | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem, | |
| const Teuchos::RCP< Teuchos::ParameterList > & | pl | |||
| ) |
Basic constructor for PseudoBlockGmresSolMgr.
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 number of blocks allocated for the Krylov basis.int specifying the maximum number of iterations the underlying solver is allowed to perform.int specifying the maximum number of restarts the underlying solver is allowed to perform.std::string specifying the desired orthogonalization: DGKS, ICGS, and IMGS. Default: "DGKS"MagnitudeType specifying the level that residual norms must reach to decide convergence. Definition at line 376 of file BelosPseudoBlockGmresSolMgr.hpp.
| virtual Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::~PseudoBlockGmresSolMgr | ( | ) | [inline, virtual] |
| const LinearProblem<ScalarType,MV,OP>& Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::getProblem | ( | ) | const [inline, virtual] |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 138 of file BelosPseudoBlockGmresSolMgr.hpp.
| Teuchos::RCP< const Teuchos::ParameterList > Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::getValidParameters | ( | ) | const [virtual] |
Get a parameter list containing the valid parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 687 of file BelosPseudoBlockGmresSolMgr.hpp.
| Teuchos::RCP<const Teuchos::ParameterList> Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::getCurrentParameters | ( | ) | const [inline, virtual] |
Get a parameter list containing the current parameters for this object.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 148 of file BelosPseudoBlockGmresSolMgr.hpp.
| Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::getTimers | ( | ) | const [inline] |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 155 of file BelosPseudoBlockGmresSolMgr.hpp.
| int Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::getNumIters | ( | ) | const [inline, virtual] |
Get the iteration count for the most recent call to solve().
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 160 of file BelosPseudoBlockGmresSolMgr.hpp.
| bool Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::isLOADetected | ( | ) | const [inline, virtual] |
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 167 of file BelosPseudoBlockGmresSolMgr.hpp.
| void Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::setProblem | ( | const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > & | problem | ) | [inline, virtual] |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 175 of file BelosPseudoBlockGmresSolMgr.hpp.
| void Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::setParameters | ( | const Teuchos::RCP< Teuchos::ParameterList > & | params | ) | [virtual] |
Set the parameters the solver manager should use to solve the linear problem.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 411 of file BelosPseudoBlockGmresSolMgr.hpp.
| void Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::reset | ( | const ResetType | type | ) | [inline, virtual] |
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 188 of file BelosPseudoBlockGmresSolMgr.hpp.
| ReturnType Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::solve | ( | ) | [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 PseudoBlockGmresIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.
A return from PseudoBlockGmresIter::iterate() signifies one of the following scenarios:
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 817 of file BelosPseudoBlockGmresSolMgr.hpp.
| std::string Belos::PseudoBlockGmresSolMgr< ScalarType, MV, OP >::description | ( | ) | const [virtual] |
Method to return description of the block GMRES solver manager.
Reimplemented from Teuchos::Describable.
Definition at line 1181 of file BelosPseudoBlockGmresSolMgr.hpp.
1.4.7