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

#include <BelosFixedPointSolMgr.hpp>

Inheritance diagram for Belos::FixedPointSolMgr< ScalarType, MV, OP >:

[legend]

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_
	The linear problem to solve. More...

Teuchos::RCP< OutputManager < ScalarType > >	printer_
	Output manager, that handles printing of different kinds of messages. More...

Teuchos::RCP< std::ostream >	outputStream_
	Output stream to which the output manager prints. More...

Teuchos::RCP< StatusTest < ScalarType, MV, OP > >	sTest_
	Aggregate stopping criterion. More...

Teuchos::RCP < StatusTestMaxIters < ScalarType, MV, OP > >	maxIterTest_
	Maximum iteration count stopping criterion. More...

Teuchos::RCP < StatusTestResNorm < ScalarType, MV, OP > >	convTest_
	Convergence stopping criterion. More...

Teuchos::RCP< StatusTestOutput < ScalarType, MV, OP > >	outputTest_
	Output "status test" that controls all the other status tests. More...

Teuchos::RCP < Teuchos::ParameterList >	params_
	Current parameter list. More...

MagnitudeType	convtol_
	Convergence tolerance (read from parameter list). More...

MagnitudeType	achievedTol_
	Tolerance achieved by the last `solve()` invocation. More...

int	maxIters_
	Maximum iteration count (read from parameter list). More...

int	numIters_
	Number of iterations taken by the last `solve()` invocation. More...

int	blockSize_

int	verbosity_

int	outputStyle_

int	outputFreq_

bool	showMaxResNormOnly_

std::string	label_
	Prefix label for all the timers. More...

Teuchos::RCP< Teuchos::Time >	timerSolve_
	Solve timer. More...

bool	isSet_
	Whether or not the parameters have been set (via `setParameters()`). More...

Static Private Attributes
static constexpr int	maxIters_default_ = 1000

static constexpr bool	showMaxResNormOnly_default_ = false

static constexpr int	blockSize_default_ = 1

static constexpr int	verbosity_default_ = Belos::Errors

static constexpr int	outputStyle_default_ = Belos::General

static constexpr int	outputFreq_default_ = -1

static constexpr const char *	label_default_ = "Belos"

Constructors/Destructor
	FixedPointSolMgr ()
	Empty constructor for FixedPointSolMgr. 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...

	FixedPointSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
	Basic constructor for FixedPointSolMgr. More...

virtual	~FixedPointSolMgr ()
	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
	Return whether a loss of accuracy was detected by this solver during the most current solve. 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...

void	replaceUserConvStatusTest (const Teuchos::RCP< StatusTestResNorm< ScalarType, MV, OP > > &userConvStatusTest)
	Set user-defined convergence status test. 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 block CG 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::FixedPointSolMgr< ScalarType, MV, OP >

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

Definition at line 59 of file BelosFixedPointSolMgr.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

typedef MultiVecTraits<ScalarType,MV> Belos::FixedPointSolMgr< ScalarType, MV, OP >::MVT

private

Definition at line 62 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef OperatorTraits<ScalarType,MV,OP> Belos::FixedPointSolMgr< ScalarType, MV, OP >::OPT

private

Definition at line 63 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType> Belos::FixedPointSolMgr< ScalarType, MV, OP >::SCT

private

Definition at line 64 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::FixedPointSolMgr< ScalarType, MV, OP >::MagnitudeType

private

Definition at line 65 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<MagnitudeType> Belos::FixedPointSolMgr< ScalarType, MV, OP >::MT

private

Definition at line 66 of file BelosFixedPointSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::FixedPointSolMgr< ScalarType, MV, OP >::FixedPointSolMgr ( )

Empty constructor for FixedPointSolMgr. 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 293 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Belos::FixedPointSolMgr< ScalarType, MV, OP >::FixedPointSolMgr	(	const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &	problem,
		const Teuchos::RCP< Teuchos::ParameterList > &	pl
	)

Basic constructor for FixedPointSolMgr.

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:

"Block Size" - an int specifying the block size to be used by the underlying block conjugate-gradient solver. Default: 1
"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)
"Show Maximum Residual Norm Only" - a bool specifying whether that only the maximum relative residual norm is printed if convergence information is printed. Default: false
"Timer Label" - a std::string to use as a prefix for the timer labels. Default: "Belos"

Definition at line 312 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Destructor.

Definition at line 101 of file BelosFixedPointSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

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

inlineoverridevirtual

clone for Inverted Injection (DII)

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

Definition at line 104 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

const LinearProblem<ScalarType,MV,OP>& Belos::FixedPointSolMgr< 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 112 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP< const Teuchos::ParameterList > Belos::FixedPointSolMgr< 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 511 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<const Teuchos::ParameterList> Belos::FixedPointSolMgr< 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 122 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::FixedPointSolMgr< 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 129 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

MagnitudeType Belos::FixedPointSolMgr< 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 138 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::FixedPointSolMgr< 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 143 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

inlineoverridevirtual

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 149 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointSolMgr< 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 156 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointSolMgr< 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 342 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointSolMgr< ScalarType, MV, OP >::replaceUserConvStatusTest ( const Teuchos::RCP< StatusTestResNorm< ScalarType, MV, OP > > & userConvStatusTest )

inline

Set user-defined convergence status test.

Definition at line 162 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointSolMgr< 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 185 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

ReturnType Belos::FixedPointSolMgr< 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 FixedPointIter::iterate() or CGIter::iterate(), which will return either because a specially constructed status test evaluates to Passed or an std::exception is thrown.

A return from FixedPointIter::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 554 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

overridevirtual

Method to return description of the block CG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 810 of file BelosFixedPointSolMgr.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::problem_

private

The linear problem to solve.

Definition at line 221 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<OutputManager<ScalarType> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::printer_

private

Output manager, that handles printing of different kinds of messages.

Definition at line 224 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<std::ostream> Belos::FixedPointSolMgr< ScalarType, MV, OP >::outputStream_

private

Output stream to which the output manager prints.

Definition at line 226 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::sTest_

private

Aggregate stopping criterion.

This is an OR combination of the maximum iteration count test (maxIterTest_) and convergence test (convTest_).

Definition at line 232 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestMaxIters<ScalarType,MV,OP> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::maxIterTest_

private

Maximum iteration count stopping criterion.

Definition at line 235 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestResNorm<ScalarType,MV,OP> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::convTest_

private

Convergence stopping criterion.

Definition at line 238 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestOutput<ScalarType,MV,OP> > Belos::FixedPointSolMgr< ScalarType, MV, OP >::outputTest_

private

Output "status test" that controls all the other status tests.

Definition at line 241 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Current parameter list.

Definition at line 244 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 249 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

constexpr bool Belos::FixedPointSolMgr< ScalarType, MV, OP >::showMaxResNormOnly_default_ = false

staticprivate

Definition at line 250 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

constexpr int Belos::FixedPointSolMgr< ScalarType, MV, OP >::blockSize_default_ = 1

staticprivate

Definition at line 251 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 252 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 253 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 254 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 255 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Convergence tolerance (read from parameter list).

Definition at line 262 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

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.

Definition at line 269 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Maximum iteration count (read from parameter list).

Definition at line 272 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Number of iterations taken by the last solve() invocation.

Definition at line 275 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 277 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 277 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 277 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 277 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::FixedPointSolMgr< ScalarType, MV, OP >::showMaxResNormOnly_

private

Definition at line 278 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Prefix label for all the timers.

Definition at line 281 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::Time> Belos::FixedPointSolMgr< ScalarType, MV, OP >::timerSolve_

private

Solve timer.

Definition at line 284 of file BelosFixedPointSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Whether or not the parameters have been set (via setParameters()).

Definition at line 287 of file BelosFixedPointSolMgr.hpp.

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

BelosFixedPointSolMgr.hpp

Private Types

Private Attributes

Static Private Attributes

Constructors/Destructor

Accessor methods

Set methods

Reset methods

Solver application methods

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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