#include <AnasaziBlockKrylovSchurSolMgr.hpp>
Public Member Functions | |
Constructors/Destructor | |
BlockKrylovSchurSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl) | |
Basic constructor for BlockKrylovSchurSolMgr. | |
virtual | ~BlockKrylovSchurSolMgr () |
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() . | |
std::vector< Value< ScalarType > > | getRitzValues () const |
Return the Ritz values from the most recent 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 | 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. |
The solver manager provides to the solver a StatusTestCombo object constructed as follows:
combo = globaltest OR debugtest
where
globaltest
terminates computation when global convergence has been detected.debugtest
allows a user to specify additional monitoring of the iteration, encapsulated in a StatusTest objectdebugtest
is ignored.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 BlockKrylovSchurSolMgr().
Definition at line 107 of file AnasaziBlockKrylovSchurSolMgr.hpp.
Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::BlockKrylovSchurSolMgr | ( | const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > & | problem, | |
Teuchos::ParameterList & | pl | |||
) | [inline] |
Basic constructor for BlockKrylovSchurSolMgr.
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: "LM""Block Size"
- a int
specifying the block size to be used by the underlying block Krylov-Schur solver. Default: 1"Num Blocks"
- a int
specifying the number of blocks allocated for the Krylov basis. Default: 3*nev"Extra NEV Blocks"
- a int
specifying the number of extra blocks the solver should keep in addition to those required to compute the number of eigenvalues requested. Default: 0"Maximum Restarts"
- a int
specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 20"Orthogonalization"
- a string
specifying the desired orthogonalization: DGKS and SVQB. Default: "SVQB""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 Definition at line 242 of file AnasaziBlockKrylovSchurSolMgr.hpp.
virtual Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::~BlockKrylovSchurSolMgr | ( | ) | [inline, virtual] |
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::getDebugStatusTest | ( | ) | const [inline] |
Get the status test for debugging.
Definition at line 781 of file AnasaziBlockKrylovSchurSolMgr.hpp.
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::getGlobalStatusTest | ( | ) | const [inline] |
Get the status test defining global convergence.
Definition at line 766 of file AnasaziBlockKrylovSchurSolMgr.hpp.
int Anasazi::BlockKrylovSchurSolMgr< 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 154 of file AnasaziBlockKrylovSchurSolMgr.hpp.
const Eigenproblem<ScalarType,MV,OP>& Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::getProblem | ( | ) | const [inline, virtual] |
Return the eigenvalue problem.
Implements Anasazi::SolverManager< ScalarType, MV, OP >.
Definition at line 149 of file AnasaziBlockKrylovSchurSolMgr.hpp.
std::vector<Value<ScalarType> > Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::getRitzValues | ( | ) | const [inline] |
Return the Ritz values from the most recent solve.
Definition at line 160 of file AnasaziBlockKrylovSchurSolMgr.hpp.
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::getTimers | ( | ) | const [inline] |
Return the timers for this object.
The timers are ordered as follows:
Definition at line 171 of file AnasaziBlockKrylovSchurSolMgr.hpp.
void Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::setDebugStatusTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | debug | ) | [inline] |
Set the status test for debugging.
Definition at line 773 of file AnasaziBlockKrylovSchurSolMgr.hpp.
void Anasazi::BlockKrylovSchurSolMgr< ScalarType, MV, OP >::setGlobalStatusTest | ( | const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > & | global | ) | [inline] |
Set the status test defining global convergence.
Definition at line 758 of file AnasaziBlockKrylovSchurSolMgr.hpp.
ReturnType Anasazi::BlockKrylovSchurSolMgr< 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 BlockKrylovSchur::iterate(), which will return either because a specially constructed status test evaluates to Passed or an exception is thrown.
A return from BlockKrylovSchur::iterate() signifies one of the following scenarios:
Implements Anasazi::SolverManager< ScalarType, MV, OP >.
Definition at line 353 of file AnasaziBlockKrylovSchurSolMgr.hpp.