Anasazi Version of the Day
Public Member Functions
Anasazi::GeneralizedDavidsonSolMgr< ScalarType, MV, OP > Class Template Reference

Solver Manager for GeneralizedDavidson. More...

#include <AnasaziGeneralizedDavidsonSolMgr.hpp>

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

List of all members.

Public Member Functions

 GeneralizedDavidsonSolMgr (const RCP< Eigenproblem< ScalarType, MV, OP > > &problem, Teuchos::ParameterList &pl)
 Basic constructor for GeneralizedDavidsonSolMgr.
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()
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 StatusTest) or the solver manager decides to quit.

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::GeneralizedDavidsonSolMgr< ScalarType, MV, OP >

Solver Manager for GeneralizedDavidson.

This class provides a simple interface to the GeneralizedDavidson eigensolver. This manager creates appropriate orthogonalization/sort/output managers based on user specified ParameterList entries (or selects suitable defaults), provides access to solver functionality, and manages the restarting process.

This class is currently only implemented for real scalar types (i.e. float, double).

Author:
Steven Hamilton
Examples:

GeneralizedDavidson/GeneralizedDavidsonEpetraExFileIfpack.cpp.

Definition at line 78 of file AnasaziGeneralizedDavidsonSolMgr.hpp.


Constructor & Destructor Documentation

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

Basic constructor for GeneralizedDavidsonSolMgr.

This constructor accepts the Eigenproblem to be solved and a parameter list of options for the solver. The following options control the behavior of the solver:

  • "Which" -- a string specifying the desired eigenvalues: SM, LM, SR, LR, SI, or LI. Default: "LM."
  • "Block Size" -- block size used by algorithm. Default: 1.
  • "Maximum Subspace Dimension" -- maximum number of basis vectors for subspace. Two (for standard eigenvalue problems) or three (for generalized eigenvalue problems) sets of basis vectors of this size will be required. Default: 3*problem->getNEV()*"Block Size"
  • "Restart Dimension" -- Number of vectors retained after a restart. Default: NEV
  • "Maximum Restarts" -- an int specifying the maximum number of restarts the underlying solver is allowed to perform. Default: 20
  • "Orthogonalization" -- a string specifying the desired orthogonalization: DGKS, SVQB, ICGS. Default: "SVQB"
  • "Verbosity" -- a sum of MsgType specifying the verbosity. Default: AnasaziErrors
  • "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 residual norms should be scaled by the magnitude of the corresponding Ritz value. Care should be taken when performing scaling for problems where the eigenvalue can be very large or very small. Default: "false".
  • "Initial Guess" -- how should initial vector be selected: "Random" or "User". If "User," the value in problem->getInitVec() will be used. Default: "Random".
  • "Print Number of Ritz Values" -- an int specifying how many Ritz values should be printed at each iteration. Default: "NEV".

Definition at line 175 of file AnasaziGeneralizedDavidsonSolMgr.hpp.


Member Function Documentation

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

Return the eigenvalue problem.

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

Definition at line 116 of file AnasaziGeneralizedDavidsonSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Anasazi::GeneralizedDavidsonSolMgr< 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 121 of file AnasaziGeneralizedDavidsonSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Anasazi::GeneralizedDavidsonSolMgr< 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 StatusTest) or the solver manager decides to quit.

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

Definition at line 294 of file AnasaziGeneralizedDavidsonSolMgr.hpp.


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