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

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

#include <AnasaziSimpleLOBPCGSolMgr.hpp>

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

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

Public Member Functions

Constructors/Destructor
 SimpleLOBPCGSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
 Basic constructor for SimpleLOBPCGSolMgr.
virtual ~SimpleLOBPCGSolMgr ()
 Destructor.
Accessor methods
const Eigenproblem< ScalarType,
MV, OP > & 
getProblem () const
 Return the eigenvalue problem.
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::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:

LOBPCG/LOBPCGEpetraExSimple.cpp.

Definition at line 86 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:

Definition at line 156 of file AnasaziSimpleLOBPCGSolMgr.hpp.

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

Destructor.

Definition at line 113 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 [inline, virtual]

Return the eigenvalue problem.

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

Definition at line 119 of file AnasaziSimpleLOBPCGSolMgr.hpp.

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

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

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

Definition at line 123 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 205 of file AnasaziSimpleLOBPCGSolMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:22:48 2010 for Anasazi by  doxygen 1.4.7