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

The Belos::PseudoBlockCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration. More...

#include <BelosPseudoBlockCGSolMgr.hpp>

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

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructors/Destructor
 PseudoBlockCGSolMgr ()
 Empty constructor for BlockCGSolMgr. 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().
 PseudoBlockCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for PseudoBlockCGSolMgr.
virtual ~PseudoBlockCGSolMgr ()
 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::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)
 Set the linear problem that needs to be solved.
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 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 CG solver manager.

Detailed Description

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

The Belos::PseudoBlockCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration.

Author:
Heidi Thornquist, Chris Baker, and Teri Barth

Definition at line 92 of file BelosPseudoBlockCGSolMgr.hpp.


Constructor & Destructor Documentation

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

Empty constructor for BlockCGSolMgr. 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 310 of file BelosPseudoBlockCGSolMgr.hpp.

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

Basic constructor for PseudoBlockCGSolMgr.

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 326 of file BelosPseudoBlockCGSolMgr.hpp.

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

Destructor.

Definition at line 125 of file BelosPseudoBlockCGSolMgr.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
const LinearProblem<ScalarType,MV,OP>& Belos::PseudoBlockCGSolMgr< 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 131 of file BelosPseudoBlockCGSolMgr.hpp.

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

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

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 148 of file BelosPseudoBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::PseudoBlockCGSolMgr< 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 153 of file BelosPseudoBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::PseudoBlockCGSolMgr< ScalarType, MV, OP >::isLOADetected (  )  const [inline, virtual]

Return whether a loss of accuracy was detected by this solver during the most current solve.

Note:
This flag will be reset the next time solve() is called.

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

Definition at line 160 of file BelosPseudoBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::PseudoBlockCGSolMgr< 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 168 of file BelosPseudoBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::PseudoBlockCGSolMgr< 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 352 of file BelosPseudoBlockCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::PseudoBlockCGSolMgr< 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 181 of file BelosPseudoBlockCGSolMgr.hpp.

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

A return from PseudoBlockCGIter::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.

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

Definition at line 563 of file BelosPseudoBlockCGSolMgr.hpp.

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

Method to return description of the block CG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 761 of file BelosPseudoBlockCGSolMgr.hpp.


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