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 >:

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 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 < Teuchos::ParameterList >	params_
MagnitudeType	convtol_
MagnitudeType	impTolScale_
MagnitudeType	achievedTol_
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::Time >	timerSolve_
bool	isSet_
bool	isSTSet_

Static Private Attributes
static constexpr int	maxIters_default_ = 1000
static constexpr bool	expResTest_default_ = false
static constexpr int	verbosity_default_ = Belos::Errors
static constexpr int	outputStyle_default_ = Belos::General
static constexpr int	outputFreq_default_ = -1
static constexpr const char *	impResScale_default_ = "Norm of Preconditioned Initial Residual"
static constexpr const char *	expResScale_default_ = "Norm of Initial Residual"
static constexpr const char *	label_default_ = "Belos"

TFQMRSolMgr Exceptions
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(). More...
	TFQMRSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
	Basic constructor for TFQMRSolMgr. More...
virtual	~TFQMRSolMgr ()
	Destructor. More...
Teuchos::RCP< SolverManager < ScalarType, MV, OP > >	clone () const override
	clone for Inverted Injection (DII) More...

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

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

Reset methods
void	reset (const ResetType type) override
	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. More...

Solver application methods
ReturnType	solve () override
	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. More...

Overridden from Teuchos::Describable
std::string	description () const override
	Method to return description of the TFQMR solver manager. More...

Additional Inherited Members
Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
	SolverManager ()
	Empty constructor. More...
virtual	~SolverManager ()
	Destructor. More...
virtual void	setUserConvStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &, const typename StatusTestCombo< ScalarType, MV, OP >::ComboType &=StatusTestCombo< ScalarType, MV, OP >::SEQ)
	Set user-defined convergence status test. More...
virtual void	setDebugStatusTest (const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &)
	Set user-defined debug status test. More...
Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
virtual	~Describable ()
	LabeledObject ()
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
virtual std::string	getObjectLabel () const
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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 65 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 68 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 69 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 70 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 71 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 72 of file BelosTFQMRSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::TFQMRSolMgr< ScalarType, MV, OP >::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().

Definition at line 263 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
	)

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 285 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

virtual Belos::TFQMRSolMgr< ScalarType, MV, OP >::~TFQMRSolMgr ( )

inlinevirtual

Destructor.

Definition at line 106 of file BelosTFQMRSolMgr.hpp.

Member Function Documentation

template<class ScalarType, class MV, class OP>

Teuchos::RCP<SolverManager<ScalarType, MV, OP> > Belos::TFQMRSolMgr< ScalarType, MV, OP >::clone ( ) const

inlineoverridevirtual

clone for Inverted Injection (DII)

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

Definition at line 109 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

const LinearProblem<ScalarType,MV,OP>& Belos::TFQMRSolMgr< ScalarType, MV, OP >::getProblem ( ) const

inlineoverridevirtual

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

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

Definition at line 117 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP< const Teuchos::ParameterList > Belos::TFQMRSolMgr< ScalarType, MV, OP >::getValidParameters ( ) const

overridevirtual

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

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

Definition at line 561 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

Teuchos::RCP<const Teuchos::ParameterList> Belos::TFQMRSolMgr< ScalarType, MV, OP >::getCurrentParameters ( ) const

inlineoverridevirtual

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

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

Definition at line 127 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:

• time spent in solve() routine

Definition at line 134 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::achievedTol ( ) const

inlineoverridevirtual

Tolerance achieved by the last solve() invocation.

This is the maximum over all right-hand sides' achieved convergence tolerances, and is set whether or not the solve actually managed to achieve the desired convergence tolerance.

Reimplemented from Belos::SolverManager< ScalarType, MV, OP >.

Definition at line 143 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::getNumIters ( ) const

inlineoverridevirtual

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

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

Definition at line 148 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isLOADetected ( ) const

inlineoverridevirtual

Whether loss of accuracy was detected during the last solve() invocation.

In solvers that can detect a loss of accuracy, this method would say whether the solver detected it in the most recent solve() invocation. However, our TFQMR implementation does not currently detect a loss of accuracy, so this method always returns false.

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

Definition at line 159 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 )

inlineoverridevirtual

Set the linear problem that needs to be solved.

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 >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params )

overridevirtual

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

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

Definition at line 315 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

void Belos::TFQMRSolMgr< ScalarType, MV, OP >::reset ( const ResetType  type )

inlineoverridevirtual

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 179 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

ReturnType Belos::TFQMRSolMgr< ScalarType, MV, OP >::solve ( )

overridevirtual

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 608 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::description ( ) const

overridevirtual

Method to return description of the TFQMR solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 833 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::checkStatusTest ( )

private

Definition at line 502 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 218 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 221 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 222 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 225 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 226 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 227 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 228 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 228 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 229 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

Teuchos::RCP<Teuchos::ParameterList> Belos::TFQMRSolMgr< ScalarType, MV, OP >::params_

private

Definition at line 232 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr int Belos::TFQMRSolMgr< ScalarType, MV, OP >::maxIters_default_ = 1000

staticprivate

Definition at line 235 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResTest_default_ = false

staticprivate

Definition at line 236 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr int Belos::TFQMRSolMgr< ScalarType, MV, OP >::verbosity_default_ = Belos::Errors

staticprivate

Definition at line 237 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStyle_default_ = Belos::General

staticprivate

Definition at line 238 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputFreq_default_ = -1

staticprivate

Definition at line 239 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr const char* Belos::TFQMRSolMgr< ScalarType, MV, OP >::impResScale_default_ = "Norm of Preconditioned Initial Residual"

staticprivate

Definition at line 240 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr const char* Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResScale_default_ = "Norm of Initial Residual"

staticprivate

Definition at line 241 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

constexpr const char* Belos::TFQMRSolMgr< ScalarType, MV, OP >::label_default_ = "Belos"

staticprivate

Definition at line 242 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::convtol_

private

Definition at line 245 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::impTolScale_

private

Definition at line 245 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

MagnitudeType Belos::TFQMRSolMgr< ScalarType, MV, OP >::achievedTol_

private

Definition at line 245 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::maxIters_

private

Definition at line 246 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::numIters_

private

Definition at line 246 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::verbosity_

private

Definition at line 247 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputStyle_

private

Definition at line 247 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::outputFreq_

private

Definition at line 247 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMRSolMgr< ScalarType, MV, OP >::blockSize_

private

Definition at line 248 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResTest_

private

Definition at line 249 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::impResScale_

private

Definition at line 250 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::expResScale_

private

Definition at line 250 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

std::string Belos::TFQMRSolMgr< ScalarType, MV, OP >::label_

private

Definition at line 253 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 254 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isSet_

private

Definition at line 257 of file BelosTFQMRSolMgr.hpp.

template<class ScalarType, class MV, class OP>

bool Belos::TFQMRSolMgr< ScalarType, MV, OP >::isSTSet_

private

Definition at line 257 of file BelosTFQMRSolMgr.hpp.

---

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

• BelosTFQMRSolMgr.hpp