Anasazi::RTRSolMgr< ScalarType, MV, OP > Class Template Reference

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 >:

Public Member Functions
Constructors/Destructor
	RTRSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
	Basic constructor for RTRSolMgr. More...
virtual	~RTRSolMgr ()
	Destructor. More...
Accessor methods
const Eigenproblem< ScalarType, MV, OP > &	getProblem () const
	Return the eigenvalue problem. More...
Teuchos::Array< Teuchos::RCP < Teuchos::Time > >	getTimers () const
	Return the timers for this object. More...
int	getNumIters () const
	Get the iteration count for the most recent call to solve. More...
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. More...
Public Member Functions inherited from Anasazi::SolverManager< ScalarType, MV, OP >
	SolverManager ()
	Empty constructor. More...
virtual	~SolverManager ()
	Destructor. More...

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

Definition at line 52 of file AnasaziRTRSolMgr.hpp.

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:

• Solver parameters
  • "Skinny Solver" - a bool specifying whether a non-caching ("skinny") solver implementation is used. Determines whether the underlying solver is IRTR or SIRTR.
  • "Which" - a string specifying the desired eigenvalues: SR or LR, i.e., smallest or largest algebraic eigenvalues.
  • "Block Size" - an int specifying the block size to be used by the underlying RTR solver. Default: problem->getNEV()
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Errors
  • "Output Stream" - a reference-counted pointer to the formatted output stream where all solver output is sent. Default: Teuchos::getFancyOStream ( Teuchos::rcpFromRef (std::cout) )
  • "Output Processor" - an int specifying the MPI processor that will print solver/timer details. Default: 0
• Convergence parameters
  • "Maximum Iterations" - an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 100
  • "Convergence Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence. Default: machine precision.
  • "Relative Convergence Tolerance" - a bool specifying whether residuals norms should be scaled by their eigenvalues for the purposing of deciding convergence. Default: true
  • "Convergence Norm" - a string specifying the norm for convergence testing: "2" or "M"

Definition at line 152 of file AnasaziRTRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

virtual Anasazi::RTRSolMgr< ScalarType, MV, OP >::~RTRSolMgr ( )

inlinevirtual

Destructor.

Definition at line 88 of file AnasaziRTRSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

const Eigenproblem<ScalarType,MV,OP>& Anasazi::RTRSolMgr< ScalarType, MV, OP >::getProblem ( ) const

inlinevirtual

Return the eigenvalue problem.

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

Definition at line 95 of file AnasaziRTRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Anasazi::RTRSolMgr< ScalarType, MV, OP >::getTimers ( ) const

inlinevirtual

Return the timers for this object.

The timers are ordered as follows:

• time spent in solve() routine

Reimplemented from Anasazi::SolverManager< ScalarType, MV, OP >.

Definition at line 104 of file AnasaziRTRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Anasazi::RTRSolMgr< ScalarType, MV, OP >::getNumIters ( ) const

inlinevirtual

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

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

Definition at line 109 of file AnasaziRTRSolMgr.hpp.

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 >.

Definition at line 236 of file AnasaziRTRSolMgr.hpp.

---

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

• AnasaziRTRSolMgr.hpp