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

The Anasazi::LOBPCGSolMgr provides a powerful and fully-featured solver manager over the LOBPCG eigensolver. More...

#include <AnasaziLOBPCGSolMgr.hpp>

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

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

Public Member Functions

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

The Anasazi::LOBPCGSolMgr provides a powerful and fully-featured solver manager over the LOBPCG eigensolver.

This solver manager exists to provide a flexible manager over the Anasazi::LOBPCG eigensolver intended for general use. Features provided by this solver manager include:

These options are all driven by a list of parameters handed to the solver manager at construction. For more information, see Anasazi::LOBPCGSolMgr::LOBPCGSolMgr().

Author:
Chris Baker, Ulrich Hetmaniuk, Rich Lehoucq, Heidi Thornquist
Examples:

LOBPCG/LOBPCGEpetraEx.cpp, and LOBPCG/LOBPCGEpetraExGen.cpp.

Definition at line 86 of file AnasaziLOBPCGSolMgr.hpp.


Constructor & Destructor Documentation

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

Basic constructor for LOBPCGSolMgr.

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 188 of file AnasaziLOBPCGSolMgr.hpp.

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

Destructor.

Definition at line 123 of file AnasaziLOBPCGSolMgr.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
ReturnType Anasazi::LOBPCGSolMgr< 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.

This method calls LOBPCG::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.

A return from LOBPCG::iterate() signifies one of the following scenarios:

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 282 of file AnasaziLOBPCGSolMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Tue Oct 20 12:45:19 2009 for Anasazi by doxygen 1.4.7