Anasazi::RTRSolMgr< ScalarType, MV, OP > Class Template Reference
[Anasazi Eigensolver Framework]

The Anasazi::RTRSolMgr provides a simple solver manager over the RTR eigensolver. For more information, see the discussion for RTRBase. More...

#include <AnasaziRTRSolMgr.hpp>

Inheritance diagram for Anasazi::RTRSolMgr< ScalarType, MV, OP >:

Anasazi::SolverManager< ScalarType, MV, OP > List of all members.

Public Member Functions

Constructors/Destructor
 RTRSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
 Basic constructor for RTRSolMgr.
virtual ~RTRSolMgr ()
 Destructor.
Accessor methods
const Eigenproblem< ScalarType,
MV, OP > & 
getProblem () const
 Return the eigenvalue problem.
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.
Solver application methods
ReturnType solve ()
 This method performs possibly repeated calls to the underlying eigensolver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::RTRSolMgr< ScalarType, MV, OP >

The Anasazi::RTRSolMgr provides a simple solver manager over the RTR eigensolver. For more information, see the discussion for RTRBase.

Author:
Chris Baker


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Anasazi::RTRSolMgr< ScalarType, MV, OP >::RTRSolMgr ( const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &  problem,
Teuchos::ParameterList pl 
)

Basic constructor for RTRSolMgr.

This constructor accepts the Eigenproblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:

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

Destructor.


Member Function Documentation

template<class ScalarType, class MV, class OP>
const Eigenproblem<ScalarType,MV,OP>& Anasazi::RTRSolMgr< ScalarType, MV, OP >::getProblem (  )  const [inline, virtual]

Return the eigenvalue problem.

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

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

Return the timers for this object.

The timers are ordered as follows:

template<class ScalarType, class MV, class OP>
int Anasazi::RTRSolMgr< ScalarType, MV, OP >::getNumIters (  )  const [inline, virtual]

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

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

template<class ScalarType, class MV, class OP>
ReturnType Anasazi::RTRSolMgr< ScalarType, MV, OP >::solve (  )  [virtual]

This method performs possibly repeated calls to the underlying eigensolver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

Returns:
ReturnType specifying:
  • Converged: the eigenproblem was solved to the specification required by the solver manager.
  • Unconverged: the eigenproblem was not solved to the specification desired by the solver manager.

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


The documentation for this class was generated from the following file:
Generated on Sat Nov 21 01:07:53 2009 for Anasazi by  doxygen 1.4.7