Belos
Version of the Day
|
#include <BelosSolverManager.hpp>
Public Member Functions | |
RealSolverManager () | |
virtual | ~RealSolverManager () |
virtual const LinearProblem < ScalarType, MV, OP > & | getProblem () const |
Return a reference to the linear problem being solved by this solver manager. More... | |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getValidParameters () const |
Return the valid parameters for this solver manager. More... | |
virtual Teuchos::RCP< const Teuchos::ParameterList > | getCurrentParameters () const |
Return the current parameters being used for this solver manager. More... | |
virtual int | getNumIters () const |
Get the iteration count for the most recent call to solve() . More... | |
virtual bool | isLOADetected () const |
Returns whether a loss of accuracy was detected in the solver. More... | |
virtual void | setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem) |
Set the linear problem that needs to be solved. More... | |
virtual void | setParameters (const Teuchos::RCP< Teuchos::ParameterList > ¶ms) |
Set the parameters to use when solving the linear problem. More... | |
virtual void | reset (const ResetType type) |
Reset the solver manager. More... | |
virtual ReturnType | solve () |
Iterate until the status test tells us to stop. More... | |
Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP > | |
SolverManager () | |
Empty constructor. More... | |
virtual | ~SolverManager () |
Destructor. More... | |
virtual Teuchos::RCP < SolverManager< ScalarType, MV, OP > > | clone () const =0 |
clone the solver manager. 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 > > &, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &=StatusTestCombo< ScalarType, MV, OP >::SEQ) |
Set user-defined convergence status test. More... | |
virtual void | setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &) |
Set user-defined debug status test. More... | |
Public Member Functions inherited from Teuchos::Describable | |
virtual std::string | description () const |
virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Additional Inherited Members | |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Definition at line 210 of file BelosSolverManager.hpp.
|
inline |
Definition at line 213 of file BelosSolverManager.hpp.
|
inlinevirtual |
Definition at line 217 of file BelosSolverManager.hpp.
|
inlinevirtual |
Return a reference to the linear problem being solved by this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 219 of file BelosSolverManager.hpp.
|
inlinevirtual |
Return the valid parameters for this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 223 of file BelosSolverManager.hpp.
|
inlinevirtual |
Return the current parameters being used for this solver manager.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 227 of file BelosSolverManager.hpp.
|
inlinevirtual |
Get the iteration count for the most recent call to solve()
.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 231 of file BelosSolverManager.hpp.
|
inlinevirtual |
Returns whether a loss of accuracy was detected in the solver.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 235 of file BelosSolverManager.hpp.
|
inlinevirtual |
Set the linear problem that needs to be solved.
Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 239 of file BelosSolverManager.hpp.
|
inlinevirtual |
Set the parameters to use when solving the linear problem.
params | [in/out] List of parameters to use when solving the linear problem. This list will be modified as necessary to include default parameters that need not be provided. If params is null, then this method uses default parameters. |
getValidParameters()
has all the parameters that the solver understands, possibly including human-readable documentation and validators. Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 243 of file BelosSolverManager.hpp.
|
inlinevirtual |
Reset the solver manager.
Reset the solver manager in a way specified by the ResetType
parameter. 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 247 of file BelosSolverManager.hpp.
|
inlinevirtual |
Iterate until the status test tells us to stop.
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 via the status test(s)), or the solver manager decides to quit.
Belos::ReturnType
enum specifying:Implements Belos::SolverManager< ScalarType, MV, OP >.
Definition at line 251 of file BelosSolverManager.hpp.