Anasazi::Experimental::TraceMinSolMgr< ScalarType, MV, OP > Class Template Reference

The Anasazi::TraceMinSolMgr provides a flexible solver manager over the TraceMin eigensolver. More...

#include <AnasaziTraceMinSolMgr.hpp>

Inheritance diagram for Anasazi::Experimental::TraceMinSolMgr< ScalarType, MV, OP >:

Public Member Functions
Constructors
	TraceMinSolMgr (const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
	Basic constructor for TraceMinSolMgr. More...
Public Member Functions inherited from Anasazi::Experimental::TraceMinBaseSolMgr< ScalarType, MV, OP >
	TraceMinBaseSolMgr (const RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
	Basic constructor for TraceMinBaseSolMgr. More...
virtual	~TraceMinBaseSolMgr ()
	Destructor. More...
const Eigenproblem< ScalarType, MV, OP > &	getProblem () const
	Return the eigenvalue problem. More...
int	getNumIters () const
	Get the iteration count for the most recent call to solve(). More...
Teuchos::Array< RCP < Teuchos::Time > >	getTimers () const
	Return the timers for this object. More...
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. More...
void	setGlobalStatusTest (const RCP< StatusTest< ScalarType, MV, OP > > &global)
	Set the status test defining global convergence. More...
const RCP< StatusTest < ScalarType, MV, OP > > &	getGlobalStatusTest () const
	Get the status test defining global convergence. More...
void	setLockingStatusTest (const RCP< StatusTest< ScalarType, MV, OP > > &locking)
	Set the status test defining locking. More...
const RCP< StatusTest < ScalarType, MV, OP > > &	getLockingStatusTest () const
	Get the status test defining locking. More...
void	setDebugStatusTest (const RCP< StatusTest< ScalarType, MV, OP > > &debug)
	Set the status test for debugging. More...
const RCP< StatusTest < ScalarType, MV, OP > > &	getDebugStatusTest () const
	Get the status test for debugging. More...
Public Member Functions inherited from Anasazi::SolverManager< ScalarType, MV, OP >
	SolverManager ()
	Empty constructor. More...
virtual	~SolverManager ()
	Destructor. More...

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::Experimental::TraceMinSolMgr< ScalarType, MV, OP >

The Anasazi::TraceMinSolMgr provides a flexible solver manager over the TraceMin 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

• globaltest terminates computation when global convergence has been detected.
  It is encapsulated in a StatusTestWithOrdering object, to ensure that computation is terminated only after the most significant eigenvalues/eigenvectors have met the convergence criteria.
  If not specified via setGlobalStatusTest(), globaltest is a StatusTestResNorm object which tests the 2-norms of the direct residuals relative to the Ritz values.
• lockingtest halts TraceMin::iterate() in order to deflate converged eigenpairs for locking.
  It will query the underlying TraceMin eigensolver to determine when eigenvectors should be locked.
  If not specified via setLockingStatusTest(), lockingtest is a StatusTestResNorm object.
• debugtest allows a user to specify additional monitoring of the iteration, encapsulated in a StatusTest object
  If not specified via setDebugStatusTest(), debugtest is ignored.
  In most cases, it should return Failed; if it returns Passed, solve() will throw an AnasaziError exception.

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

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

Author

Alicia Klinvex

Definition at line 81 of file AnasaziTraceMinSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Anasazi::Experimental::TraceMinSolMgr< ScalarType, MV, OP >::TraceMinSolMgr	(	const Teuchos::RCP< Eigenproblem< ScalarType, MV, OP > > &	problem,
		Teuchos::ParameterList &	pl
	)

Basic constructor for TraceMinSolMgr.

This constructor accepts the Eigenproblem to be solved in addition to a parameter list of options for the solver manager. Since this class inherits from TraceMinBaseSolMgr, it accepts the same options as TraceMinBaseSolMgr(), with a few additions:

• "Block Size" - an int specifying the block size to be used by the underlying solver. A larger block size means more work per iteration, but it may also decrease the number of iterations required. Default: 2*problem->getNEV()
• "Maximum Iterations" - an int specifying the maximum number of TraceMin iterations to be performed. Default: 100

Definition at line 156 of file AnasaziTraceMinSolMgr.hpp.

---

The documentation for this class was generated from the following file:

• AnasaziTraceMinSolMgr.hpp