Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Belos::Details::RealSolverManager< ScalarType, MV, OP, true > Class Template Reference

#include <BelosSolverManager.hpp>

Inheritance diagram for Belos::Details::RealSolverManager< ScalarType, MV, OP, true >:
Inheritance graph
[legend]

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 > &params)
 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
 

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::Details::RealSolverManager< ScalarType, MV, OP, true >

Definition at line 211 of file BelosSolverManager.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::RealSolverManager ( )
inline

Definition at line 214 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::~RealSolverManager ( )
inlinevirtual

Definition at line 218 of file BelosSolverManager.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual const LinearProblem<ScalarType,MV,OP>& Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getProblem ( ) const
inlinevirtual

Return a reference to the linear problem being solved by this solver manager.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 220 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual Teuchos::RCP<const Teuchos::ParameterList> Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getValidParameters ( ) const
inlinevirtual

Return the valid parameters for this solver manager.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 224 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual Teuchos::RCP<const Teuchos::ParameterList> Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getCurrentParameters ( ) const
inlinevirtual

Return the current parameters being used for this solver manager.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 228 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual int Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::getNumIters ( ) const
inlinevirtual

Get the iteration count for the most recent call to solve().

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 232 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual bool Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::isLOADetected ( ) const
inlinevirtual

Returns whether a loss of accuracy was detected in the solver.

Note
This method is normally applicable to GMRES-type solvers.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 236 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem)
inlinevirtual

Set the linear problem that needs to be solved.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 240 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params)
inlinevirtual

Set the parameters to use when solving the linear problem.

Parameters
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.
Note
The ParameterList returned by 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 244 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual void Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::reset ( const ResetType  type)
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 248 of file BelosSolverManager.hpp.

template<class ScalarType , class MV , class OP >
virtual ReturnType Belos::Details::RealSolverManager< ScalarType, MV, OP, true >::solve ( )
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.

Returns
A Belos::ReturnType enum specifying:
  • Belos::Converged: the linear problem was solved to the specification required by the solver manager.
  • Belos::Unconverged: the linear problem was not solved to the specification desired by the solver manager.

Implements Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 252 of file BelosSolverManager.hpp.


The documentation for this class was generated from the following file:

Generated on Mon Jul 15 2024 09:24:25 for Belos by doxygen 1.8.5