Belos::GCRODRSolMgr< ScalarType, MV, OP > Class Template Reference

The Belos::GCRODRSolMgr provides a powerful and fully-featured solver manager over the GCRODR linear solver. More...

#include <BelosGCRODRSolMgr.hpp>

Inheritance diagram for Belos::GCRODRSolMgr< ScalarType, MV, OP >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructors/Destructor
 GCRODRSolMgr ()
 Empty constructor for GCRODRSolMgr. 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().
 GCRODRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for GCRODRSolMgr.
virtual ~GCRODRSolMgr ()
 Destructor.
Accessor methods
const LinearProblem< ScalarType,
MV, OP > & 
getProblem () const
 Get current linear problem being solved for in this object.
Teuchos::RCP< const Teuchos::ParameterListgetValidParameters () const
 Get a parameter list containing the valid parameters for this object.
Teuchos::RCP< const Teuchos::ParameterListgetCurrentParameters () 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)
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
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.

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::GCRODRSolMgr< ScalarType, MV, OP >

The Belos::GCRODRSolMgr provides a powerful and fully-featured solver manager over the GCRODR linear solver.

Author:
Michael Parks and Heidi Thornquist

Definition at line 121 of file BelosGCRODRSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Belos::GCRODRSolMgr< ScalarType, MV, OP >::GCRODRSolMgr (  ) 

Empty constructor for GCRODRSolMgr. 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 374 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Belos::GCRODRSolMgr< ScalarType, MV, OP >::GCRODRSolMgr ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Teuchos::ParameterList > &  pl 
)

Basic constructor for GCRODRSolMgr.

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:

Definition at line 394 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
virtual Belos::GCRODRSolMgr< ScalarType, MV, OP >::~GCRODRSolMgr (  )  [inline, virtual]

Destructor.

Definition at line 158 of file BelosGCRODRSolMgr.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
const LinearProblem<ScalarType,MV,OP>& Belos::GCRODRSolMgr< ScalarType, MV, OP >::getProblem (  )  const [inline, virtual]

Get current linear problem being solved for in this object.

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

Definition at line 166 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP< const Teuchos::ParameterList > Belos::GCRODRSolMgr< 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 703 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<const Teuchos::ParameterList> Belos::GCRODRSolMgr< 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 176 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::GCRODRSolMgr< ScalarType, MV, OP >::getTimers (  )  const [inline]

Return the timers for this object.

The timers are ordered as follows:

Definition at line 183 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::GCRODRSolMgr< 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 188 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::GCRODRSolMgr< 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 194 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::GCRODRSolMgr< ScalarType, MV, OP >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem  )  [inline, virtual]

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

Definition at line 201 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::GCRODRSolMgr< ScalarType, MV, OP >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params  )  [virtual]

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

Definition at line 423 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
ReturnType Belos::GCRODRSolMgr< 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 GCRODRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.

A return from GCRODRIter::iterate() signifies one of the following scenarios:

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.

Dimension of current recycled subspace, if one exists.

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

Definition at line 752 of file BelosGCRODRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::GCRODRSolMgr< ScalarType, MV, OP >::description (  )  const [virtual]

Method to return description of the block GMRES solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 1675 of file BelosGCRODRSolMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:45:52 2010 for Belos by  doxygen 1.4.7