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

The Anasazi::SimpleLOBPCGSolMgr provides a simple solver manager over the LOBPCG eigensolver. More...

#include <AnasaziSimpleLOBPCGSolMgr.hpp>

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

Public Member Functions
Constructors/Destructor
	SimpleLOBPCGSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
	Basic constructor for SimpleLOBPCGSolMgr. More...
virtual	~SimpleLOBPCGSolMgr ()
	Destructor. More...
Accessor methods
const Eigenproblem< ScalarType, MV, OP > &	getProblem () const
	Return the eigenvalue problem. 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...
virtual Teuchos::Array < Teuchos::RCP< Teuchos::Time > >	getTimers () const
	Return the timers for this object. More...

Detailed Description

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

The Anasazi::SimpleLOBPCGSolMgr provides a simple solver manager over the LOBPCG eigensolver.

Anasazi::SimpleLOBPCGSolMgr allows the user to specify convergence tolerance, verbosity level and block size. When block size is less than the number of requested eigenvalues specified in the eigenproblem, checkpointing is activated.

The purpose of this solver manager was to provide an example of a simple solver manager, useful for demonstration as well as a jumping-off point for solvermanager development. Also, the solver manager is useful for testing some of the features of the Anasazi::LOBPCG eigensolver, principally the use of auxiliary vectors.

This solver manager does not verify before quitting that the nev eigenvectors that have converged are also the smallest nev eigenvectors that are known.

Author

Chris Baker, Ulrich Hetmaniuk, Rich Lehoucq, Heidi Thornquist

Examples:

LOBPCGEpetraExSimple.cpp.

Definition at line 105 of file AnasaziSimpleLOBPCGSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

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

Basic constructor for SimpleLOBPCGSolMgr.

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:

• "Which" - a string specifying the desired eigenvalues: SM, LM, SR or LR. Default: SR
• "Block Size" - an int specifying the block size to be used by the underlying LOBPCG solver. Default: problem->getNEV()
• "Maximum Iterations" - an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 100
• "Verbosity" - a sum of MsgType specifying the verbosity. Default: Anasazi::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 Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence. Default: machine precision

Definition at line 180 of file AnasaziSimpleLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>

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

inlinevirtual

Destructor.

Definition at line 135 of file AnasaziSimpleLOBPCGSolMgr.hpp.

Member Function Documentation

template<class ScalarType, class MV, class OP>

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

inlinevirtual

Return the eigenvalue problem.

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

Definition at line 141 of file AnasaziSimpleLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Anasazi::SimpleLOBPCGSolMgr< 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 145 of file AnasaziSimpleLOBPCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

ReturnType Anasazi::SimpleLOBPCGSolMgr< 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 242 of file AnasaziSimpleLOBPCGSolMgr.hpp.

---

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

• AnasaziSimpleLOBPCGSolMgr.hpp