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

The LOBPCGSolMgr provides a powerful 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
 Return the eigenvalue problem.
int getNumIters () const
 Get the iteration count for the most recent call to solve().
Teuchos::Array< Teuchos::RCP<
Teuchos::Time > > 
getTimers () const
 Return the timers for this object.
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.
void setGlobalStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &global)
 Set the status test defining global convergence.
const Teuchos::RCP< StatusTest<
ScalarType, MV, OP > > & 
getGlobalStatusTest () const
 Get the status test defining global convergence.
void setLockingStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &locking)
 Set the status test defining locking.
const Teuchos::RCP< StatusTest<
ScalarType, MV, OP > > & 
getLockingStatusTest () const
 Get the status test defining locking.
void setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &debug)
 Set the status test for debugging.
const Teuchos::RCP< StatusTest<
ScalarType, MV, OP > > & 
getDebugStatusTest () const
 Get the status test for debugging.

Detailed Description

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

The LOBPCGSolMgr provides a powerful solver manager over the LOBPCG eigensolver.

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

The solver manager provides to the solver a StatusTestCombo object constructed as follows:
   combo = maxiterstest OR globaltest OR lockingtest OR debugtest
where

Much of this behavior is controlled via parameters and options passed to the solver manager. For more information, see LOBPCGSolMgr().

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

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

Definition at line 109 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 259 of file AnasaziLOBPCGSolMgr.hpp.

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

Destructor.

Definition at line 151 of file AnasaziLOBPCGSolMgr.hpp.


Member Function Documentation

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

Return the eigenvalue problem.

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

Definition at line 158 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Anasazi::LOBPCGSolMgr< 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 163 of file AnasaziLOBPCGSolMgr.hpp.

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

Return the timers for this object.

The timers are ordered as follows:

Definition at line 173 of file AnasaziLOBPCGSolMgr.hpp.

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

template<class ScalarType, class MV, class OP>
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setGlobalStatusTest ( const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &  global  ) 

Set the status test defining global convergence.

Definition at line 967 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getGlobalStatusTest (  )  const

Get the status test defining global convergence.

Definition at line 975 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setLockingStatusTest ( const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &  locking  ) 

Set the status test defining locking.

Definition at line 997 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getLockingStatusTest (  )  const

Get the status test defining locking.

Definition at line 1005 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setDebugStatusTest ( const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &  debug  ) 

Set the status test for debugging.

Definition at line 982 of file AnasaziLOBPCGSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getDebugStatusTest (  )  const

Get the status test for debugging.

Definition at line 990 of file AnasaziLOBPCGSolMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:40:24 2010 for Anasazi by  doxygen 1.4.7