Belos::TFQMRSolMgr< ScalarType, MV, OP > Class Template Reference

The Belos::TFQMRSolMgr provides a powerful and fully-featured solver manager over the TFQMR linear solver. More...

#include <BelosTFQMRSolMgr.hpp>

Inheritance diagram for Belos::TFQMRSolMgr< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

Private Types

typedef MultiVecTraits
< ScalarType, MV > 
MVT
typedef OperatorTraits
< ScalarType, MV, OP > 
OPT
typedef Teuchos::ScalarTraits
< ScalarType > 
SCT
typedef Teuchos::ScalarTraits
< ScalarType >::magnitudeType 
MagnitudeType
typedef Teuchos::ScalarTraits
< MagnitudeType
MT

Private Member Functions

Belos::ScaleType convertStringToScaleType (std::string &scaleType)

Private Attributes

Teuchos::RCP< LinearProblem
< ScalarType, MV, OP > > 
problem_
Teuchos::RCP< OutputManager
< ScalarType > > 
printer_
Teuchos::RCP< std::ostream > outputStream_
Teuchos::RCP< StatusTest
< ScalarType, MV, OP > > 
sTest_
Teuchos::RCP
< StatusTestMaxIters
< ScalarType, MV, OP > > 
maxIterTest_
Teuchos::RCP< StatusTest
< ScalarType, MV, OP > > 
convTest_
Teuchos::RCP
< StatusTestGenResNorm
< ScalarType, MV, OP > > 
expConvTest_
Teuchos::RCP
< StatusTestGenResNorm
< ScalarType, MV, OP > > 
impConvTest_
Teuchos::RCP< StatusTestOutput
< ScalarType, MV, OP > > 
outputTest_
Teuchos::RCP< ParameterListparams_
MagnitudeType convtol_
int maxIters_
int numIters_
int verbosity_
int outputStyle_
int outputFreq_
int blockSize_
bool expResTest_
std::string impResScale_
std::string expResScale_
std::string label_
Teuchos::RCP< Teuchos::TimetimerSolve_
bool isSet_
bool isSTSet_

TFQMRSolMgr Exceptions



static const MagnitudeType convtol_default_ = 1e-8
static const int maxIters_default_ = 1000
static const bool expResTest_default_ = false
static const int verbosity_default_ = Belos::Errors
static const int outputStyle_default_ = Belos::General
static const int outputFreq_default_ = -1
static const std::string impResScale_default_ = "Norm of Preconditioned Initial Residual"
static const std::string expResScale_default_ = "Norm of Initial Residual"
static const std::string label_default_ = "Belos"
static const Teuchos::RCP
< std::ostream > 
outputStream_default_ = Teuchos::rcp(&std::cout,false)
bool checkStatusTest ()

Constructors/Destructor



 TFQMRSolMgr ()
 Empty constructor for TFQMRSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters().
 TFQMRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
 Basic constructor for TFQMRSolMgr.
virtual ~TFQMRSolMgr ()
 Destructor.

Accessor methods



const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Return a reference to the linear problem being solved by this solver manager.
Teuchos::RCP< const
Teuchos::ParameterList
getValidParameters () const
 Get a parameter list containing the valid parameters for this object.
Teuchos::RCP< const
Teuchos::ParameterList
getCurrentParameters () const
 Get a parameter list containing the current parameters for this object.
Teuchos::Array< Teuchos::RCP
< Teuchos::Time > > 
getTimers () const
 Return the timers for this object.
int getNumIters () const
 Get the iteration count for the most recent call to solve().
bool isLOADetected () const
 Return whether a loss of accuracy was detected by this solver during the most current solve.

Set methods



void setProblem (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem)
 Set the linear problem that needs to be solved.
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set the parameters the solver manager should use to solve the linear problem.

Reset methods



void reset (const ResetType type)
 Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.

Solver application methods



ReturnType solve ()
 This method performs possibly repeated calls to the underlying linear solver's iterate() routine until the problem has been solved (as decided by the solver manager) or the solver manager decides to quit.

Overridden from Teuchos::Describable



std::string description () const
 Method to return description of the TFQMR solver manager.

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::TFQMRSolMgr< ScalarType, MV, OP >

The Belos::TFQMRSolMgr provides a powerful and fully-featured solver manager over the TFQMR linear solver.

Author:
Heidi Thornquist

Definition at line 91 of file BelosTFQMRSolMgr.hpp.


Member Typedef Documentation

template<class ScalarType, class MV, class OP>
typedef MultiVecTraits<ScalarType,MV> Belos::TFQMRSolMgr< ScalarType, MV, OP >::MVT [private]

Definition at line 94 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef OperatorTraits<ScalarType,MV,OP> Belos::TFQMRSolMgr< ScalarType, MV, OP >::OPT [private]

Definition at line 95 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType> Belos::TFQMRSolMgr< ScalarType, MV, OP >::SCT [private]

Definition at line 96 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::MagnitudeType [private]

Definition at line 97 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
typedef Teuchos::ScalarTraits<MagnitudeType> Belos::TFQMRSolMgr< ScalarType, MV, OP >::MT [private]

Definition at line 98 of file BelosTFQMRSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::TFQMRSolMgr< ScalarType, MV, OP >::TFQMRSolMgr (  )  [inline]

Empty constructor for TFQMRSolMgr. This constructor takes no arguments and sets the default values for the solver. The linear problem must be passed in using setProblem() before solve() is called on this object. The solver values can be changed using setParameters().

Definition at line 322 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Belos::TFQMRSolMgr< ScalarType, MV, OP >::TFQMRSolMgr ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Teuchos::ParameterList > &  pl 
) [inline]

Basic constructor for TFQMRSolMgr.

This constructor accepts the LinearProblem to be solved in addition to a parameter list of options for the solver manager. These options include the following:

  • "Maximum Iterations" - an int specifying the maximum number of iterations the underlying solver is allowed to perform. Default: 1000
  • "Convergence Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence. Default: 1e-8.
  • "Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
  • "Output Style" - a OutputType specifying the style of output. Default: Belos::General
  • "Output Stream" - a reference-counted pointer to the output stream where all solver output is sent. Default: Teuchos::rcp(&std::cout,false)
  • "Output Frequency" - an int specifying how often convergence information should be outputted. Default: -1 (never)
  • "Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 341 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
virtual Belos::TFQMRSolMgr< ScalarType, MV, OP >::~TFQMRSolMgr (  )  [inline, virtual]

Destructor.

Definition at line 132 of file BelosTFQMRSolMgr.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
const LinearProblem<ScalarType,MV,OP>& Belos::TFQMRSolMgr< ScalarType, MV, OP >::getProblem (  )  const [inline, virtual]

Return a reference to the linear problem being solved by this solver manager.

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

Definition at line 138 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Belos::TFQMRSolMgr< ScalarType, MV, OP >::getValidParameters (  )  const [inline, virtual]

Get a parameter list containing the valid parameters for this object.

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

Definition at line 604 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<const Teuchos::ParameterList> Belos::TFQMRSolMgr< ScalarType, MV, OP >::getCurrentParameters (  )  const [inline, virtual]

Get a parameter list containing the current parameters for this object.

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

Definition at line 148 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::getTimers (  )  const [inline]

Return the timers for this object.

The timers are ordered as follows:

Definition at line 155 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::getNumIters (  )  const [inline, virtual]

Get the iteration count for the most recent call to solve().

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

Definition at line 160 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isLOADetected (  )  const [inline, virtual]

Return whether a loss of accuracy was detected by this solver during the most current solve.

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

Definition at line 166 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::TFQMRSolMgr< ScalarType, MV, OP >::setProblem ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem  )  [inline, virtual]

Set the linear problem that needs to be solved.

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

Definition at line 174 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
void Belos::TFQMRSolMgr< ScalarType, MV, OP >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params  )  [inline, virtual]

Set the parameters the solver manager should use to solve the linear problem.

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

Definition at line 368 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
void Belos::TFQMRSolMgr< ScalarType, MV, OP >::reset ( const ResetType  type  )  [inline, virtual]

Performs a reset of the solver manager specified by the ResetType. This informs the solver manager that the solver should prepare for the next call to solve by resetting certain elements of the iterative solver strategy.

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

Definition at line 187 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
ReturnType Belos::TFQMRSolMgr< ScalarType, MV, OP >::solve (  )  [inline, virtual]

This method performs possibly repeated calls to the underlying linear solver'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 TFQMRIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

A return from TFQMRIter::iterate() signifies one of the following scenarios:

  • the maximum number of iterations has been exceeded. In this scenario, the current solutions to the linear system will be placed in the linear problem and return Unconverged.
  • global convergence has been met. In this case, the current solutions to the linear system will be placed in the linear problem and the solver manager will return Converged
Returns:
ReturnType specifying:
  • Converged: the linear problem was solved to the specification required by the solver manager.
  • Unconverged: the linear problem was not solved to the specification desired by the solver manager.

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

Definition at line 646 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::description (  )  const [inline, virtual]

Method to return description of the TFQMR solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 817 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Belos::ScaleType Belos::TFQMRSolMgr< ScalarType, MV, OP >::convertStringToScaleType ( std::string &  scaleType  )  [inline, private]

Definition at line 225 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::checkStatusTest (  )  [inline, private]

Definition at line 545 of file BelosTFQMRSolMgr.hpp.


Member Data Documentation

template<class ScalarType, class MV, class OP>
Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::problem_ [private]

Definition at line 243 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<OutputManager<ScalarType> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::printer_ [private]

Definition at line 246 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<std::ostream> Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStream_ [private]

Definition at line 247 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::sTest_ [private]

Definition at line 250 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestMaxIters<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::maxIterTest_ [private]

Definition at line 251 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::convTest_ [private]

Definition at line 252 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestGenResNorm<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::expConvTest_ [private]

Definition at line 253 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestGenResNorm<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::impConvTest_ [private]

Definition at line 253 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputTest_ [private]

Definition at line 254 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<ParameterList> Belos::TFQMRSolMgr< ScalarType, MV, OP >::params_ [private]

Definition at line 257 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const TFQMRSolMgr< ScalarType, MV, OP >::MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::convtol_default_ = 1e-8 [inline, static, private]

Definition at line 260 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::TFQMRSolMgr< ScalarType, MV, OP >::maxIters_default_ = 1000 [inline, static, private]

Definition at line 261 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResTest_default_ = false [inline, static, private]

Definition at line 262 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::TFQMRSolMgr< ScalarType, MV, OP >::verbosity_default_ = Belos::Errors [inline, static, private]

Definition at line 263 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStyle_default_ = Belos::General [inline, static, private]

Definition at line 264 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputFreq_default_ = -1 [inline, static, private]

Definition at line 265 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::impResScale_default_ = "Norm of Preconditioned Initial Residual" [inline, static, private]

Definition at line 266 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResScale_default_ = "Norm of Initial Residual" [inline, static, private]

Definition at line 267 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::label_default_ = "Belos" [inline, static, private]

Definition at line 268 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
const Teuchos::RCP< std::ostream > Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStream_default_ = Teuchos::rcp(&std::cout,false) [inline, static, private]

Definition at line 269 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::convtol_ [private]

Definition at line 272 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::maxIters_ [private]

Definition at line 273 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::numIters_ [private]

Definition at line 273 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::verbosity_ [private]

Definition at line 274 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStyle_ [private]

Definition at line 274 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputFreq_ [private]

Definition at line 274 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
int Belos::TFQMRSolMgr< ScalarType, MV, OP >::blockSize_ [private]

Definition at line 275 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResTest_ [private]

Definition at line 276 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::impResScale_ [private]

Definition at line 277 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResScale_ [private]

Definition at line 277 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::label_ [private]

Definition at line 280 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
Teuchos::RCP<Teuchos::Time> Belos::TFQMRSolMgr< ScalarType, MV, OP >::timerSolve_ [private]

Definition at line 281 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isSet_ [private]

Definition at line 284 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isSTSet_ [private]

Definition at line 284 of file BelosTFQMRSolMgr.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:19 2011 for Belos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3