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

The Anasazi::BlockDavidsonSolMgr provides a powerful and fully-featured 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::RefCountPtr< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
 Basic constructor for BlockDavidsonSolMgr.
virtual ~BlockDavidsonSolMgr ()
 Destructor.
Accessor methods
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::BlockDavidsonSolMgr< ScalarType, MV, OP >

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

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

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

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

Definition at line 79 of file AnasaziBlockDavidsonSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Anasazi::BlockDavidsonSolMgr< ScalarType, MV, OP >::BlockDavidsonSolMgr const Teuchos::RefCountPtr< 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:

  • "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: Anasazi::Errors
  • "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
  • "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

Definition at line 171 of file AnasaziBlockDavidsonSolMgr.hpp.

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

Destructor.

Definition at line 114 of file AnasaziBlockDavidsonSolMgr.hpp.


Member Function Documentation

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 257 of file AnasaziBlockDavidsonSolMgr.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:31:38 2008 for Anasazi by doxygen 1.3.9.1