Anasazi Version of the Day
Anasazi::BlockDavidsonSolMgr< ScalarType, MV, OP > Class Template Reference

The BlockDavidsonSolMgr provides a powerful solver manager over the BlockDavidson eigensolver. More...

#include <AnasaziBlockDavidsonSolMgr.hpp>

Inheritance diagram for Anasazi::BlockDavidsonSolMgr< ScalarType, MV, OP >:
Anasazi::SolverManager< ScalarType, MV, OP >

List of all members.

Public Member Functions

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

The BlockDavidsonSolMgr provides a powerful solver manager over the BlockDavidson eigensolver.

This solver manager implements a hard-locking mechanism, whereby eigenpairs designated to be locked are moved from the eigensolver and placed in auxilliary storage. The eigensolver is then restarted and continues to iterate, orthogonal to the locked eigenvectors.

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

Additionally, the solver manager will terminate solve() after a specified number of restarts.

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

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

BlockDavidson/BlockDavidsonEpetraEx.cpp, BlockDavidson/BlockDavidsonEpetraExGen.cpp, and BlockDavidson/BlockDavidsonEpetraExGenPrecIfpack.cpp.

Definition at line 113 of file AnasaziBlockDavidsonSolMgr.hpp.


Constructor & Destructor Documentation

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

Basic constructor for BlockDavidsonSolMgr.

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
    • "Which" - a string specifying the desired eigenvalues: SM, LM, SR or LR. Default: "SR"
    • "Block Size" - a int specifying the block size to be used by the underlying block Davidson solver. Default: problem->getNEV()
    • "Num Blocks" - a int specifying the number of blocks allocated for the Krylov basis. Default: 2
    • "Maximum Restarts" - a int specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 20
    • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Errors
  • Convergence parameters (if using default convergence test; see setGlobalStatusTest())
    • "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"
  • Locking parameters (if using default locking test; see setLockingStatusTest())
    • "Use Locking" - a bool specifying whether the algorithm should employ locking of converged eigenpairs. Default: false
    • "Max Locked" - a int specifying the maximum number of eigenpairs to be locked. Default: problem->getNEV()
    • "Locking Quorum" - a int specifying the number of eigenpairs that must meet the locking criteria before locking actually occurs. Default: 1
    • "Locking Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide locking. Default: 0.1*convergence tolerance
    • "Relative Locking Tolerance" - a bool specifying whether residuals norms should be scaled by their eigenvalues for the purposing of deciding locking. Default: true
    • "Locking Norm" - a string specifying the norm for locking testing: "2" or "M"

Definition at line 256 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Destructor.

Definition at line 153 of file AnasaziBlockDavidsonSolMgr.hpp.


Member Function Documentation

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

Return the eigenvalue problem.

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

Definition at line 160 of file AnasaziBlockDavidsonSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Anasazi::BlockDavidsonSolMgr< 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 165 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Return the timers for this object.

The timers are ordered as follows:

  • time spent in solve() routine
  • time spent restarting
  • time spent locking converged eigenvectors

Definition at line 176 of file AnasaziBlockDavidsonSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Anasazi::BlockDavidsonSolMgr< 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 BlockDavidson::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.

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

  • the maximum number of restarts has been exceeded. In this scenario, the solver manager will place
    all converged eigenpairs into the eigenproblem and return Unconverged.
  • the locking conditions have been met. In this scenario, some of the current eigenpairs will be removed
    from the eigensolver and placed into auxiliary storage. The eigensolver will be restarted with the remaining part of the Krylov subspace
    and some random information to replace the removed subspace.
  • global convergence has been met. In this case, the most significant NEV eigenpairs in the solver and locked storage
    have met the convergence criterion. (Here, NEV refers to the number of eigenpairs requested by the Eigenproblem.)
    In this scenario, the solver manager will return Converged.
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 446 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Set the status test defining global convergence.

Definition at line 1275 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Get the status test defining global convergence.

Definition at line 1283 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Set the status test defining locking.

Definition at line 1305 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Get the status test defining locking.

Definition at line 1313 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Set the status test for debugging.

Definition at line 1290 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Get the status test for debugging.

Definition at line 1298 of file AnasaziBlockDavidsonSolMgr.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends