#include <AnasaziLOBPCGSolMgr.hpp>
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. |
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
maxiters
terminates computation when a maximum number of iterations have been performedmaxiters
is a StatusTestMaxIters objectglobaltest
terminates computation when global convergence has been detected.globaltest
is a StatusTestResNorm object which tests the M-norms of the direct residuals relative to the Ritz values.lockingtest
halts LOBPCG::iterate() in order to deflate converged eigenpairs for locking.lockingtest
is a StatusTestResNorm object.debugtest
allows a user to specify additional monitoring of the iteration, encapsulated in a StatusTest objectdebugtest
is ignored.Much of this behavior is controlled via parameters and options passed to the solver manager. For more information, see LOBPCGSolMgr().
Definition at line 109 of file AnasaziLOBPCGSolMgr.hpp.
Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::LOBPCGSolMgr | ( | const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > & | problem, | |
Teuchos::ParameterList & | pl | |||
) | [inline] |
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:
"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 LOBPCG solver. Default: problem->getNEV()"Full Ortho"
- a bool
specifying whether the underlying solver should employ the full orthogonalization scheme. Default: true"Recover"
- a bool
specifying whether the solver manager should attempt to recover in the case of a LOBPCGRitzFailure when full orthogonalization is disabled. Default: true"Verbosity"
- a sum of MsgType specifying the verbosity. Default: Errors"Init"
- a LOBPCGState<ScalarType,MV> struct used to initialize the LOBPCG eigensolver."Maximum Iterations"
- a int
specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 100"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""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 259 of file AnasaziLOBPCGSolMgr.hpp.
virtual Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::~LOBPCGSolMgr | ( | ) | [inline, virtual] |
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getDebugStatusTest | ( | ) | const [inline] |
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getGlobalStatusTest | ( | ) | const [inline] |
Get the status test defining global convergence.
Definition at line 975 of file AnasaziLOBPCGSolMgr.hpp.
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::getLockingStatusTest | ( | ) | const [inline] |
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.
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.
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.
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setDebugStatusTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | debug | ) | [inline] |
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setGlobalStatusTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | global | ) | [inline] |
Set the status test defining global convergence.
Definition at line 967 of file AnasaziLOBPCGSolMgr.hpp.
void Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::setLockingStatusTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | locking | ) | [inline] |
ReturnType Anasazi::LOBPCGSolMgr< ScalarType, MV, OP >::solve | ( | ) | [inline, 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:
Implements Anasazi::SolverManager< ScalarType, MV, OP >.
Definition at line 389 of file AnasaziLOBPCGSolMgr.hpp.