The Belos::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration. More...

#include <BelosPseudoBlockStochasticCGSolMgr.hpp>

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

[legend]

Public Member Functions
Teuchos::RCP< MV >	getStochasticVector ()
	Get a copy of the final stochastic vector. More...

Public Member Functions inherited from Belos::SolverManager< ScalarType, MV, OP >
	SolverManager ()
	Empty constructor. More...

virtual	~SolverManager ()
	Destructor. More...

virtual Teuchos::ScalarTraits < ScalarType >::magnitudeType	achievedTol () const
	Tolerance achieved by the last `solve()` invocation. 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

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 < StatusTestGenResNorm < ScalarType, MV, OP > >	convTest_

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

Teuchos::RCP < Teuchos::ParameterList >	params_

Teuchos::RCP< const Teuchos::ParameterList >	validParams_
	List of valid parameters and their default values. More...

MagnitudeType	convtol_

int	maxIters_

int	numIters_

int	verbosity_

int	outputStyle_

int	outputFreq_

int	defQuorum_

bool	assertPositiveDefiniteness_

bool	showMaxResNormOnly_

std::string	resScale_

std::string	label_

Teuchos::RCP< Teuchos::Time >	timerSolve_

bool	isSet_

Teuchos::RCP< MV >	Y_

Static Private Attributes
static constexpr int	maxIters_default_ = 1000

static constexpr bool	assertPositiveDefiniteness_default_ = true

static constexpr bool	showMaxResNormOnly_default_ = false

static constexpr int	verbosity_default_ = Belos::Errors

static constexpr int	outputStyle_default_ = Belos::General

static constexpr int	outputFreq_default_ = -1

static constexpr int	defQuorum_default_ = 1

static constexpr const char *	resScale_default_ = "Norm of Initial Residual"

static constexpr const char *	label_default_ = "Belos"

static constexpr std::ostream *	outputStream_default_ = &std::cout

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

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

virtual	~PseudoBlockStochasticCGSolMgr ()
	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...

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

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
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

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

The Belos::PseudoBlockStochasticCGSolMgr provides a powerful and fully-featured solver manager over the pseudo-block CG iteration.

Author: Chris Siefert, Heidi Thornquist, Chris Baker, and Teri Barth

Definition at line 101 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

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

private

Definition at line 104 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 105 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 106 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 107 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 108 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

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

Empty constructor for BlockStochasticCGSolMgr. 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 BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

Basic constructor for PseudoBlockStochasticCGSolMgr.

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" - a int specifying the maximum number of iterations the underlying solver is allowed to perform.
"Verbosity" - a sum of MsgType specifying the verbosity. Default: Belos::Errors
"Output Style" - a OutputType specifying the style of output. Default: Belos::General
"Convergence Tolerance" - a MagnitudeType specifying the level that residual norms must reach to decide convergence.

Definition at line 312 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Destructor.

Definition at line 135 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

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

inlineoverridevirtual

clone for Inverted Injection (DII)

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

Definition at line 138 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

const LinearProblem<ScalarType,MV,OP>& Belos::PseudoBlockStochasticCGSolMgr< 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 146 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP< const Teuchos::ParameterList > Belos::PseudoBlockStochasticCGSolMgr< 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 566 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<const Teuchos::ParameterList> Belos::PseudoBlockStochasticCGSolMgr< 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 156 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::Array<Teuchos::RCP<Teuchos::Time> > Belos::PseudoBlockStochasticCGSolMgr< 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 163 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

int Belos::PseudoBlockStochasticCGSolMgr< 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 168 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

inlineoverridevirtual

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

Note: This flag will be reset the next time solve() is called.

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

Definition at line 175 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::PseudoBlockStochasticCGSolMgr< 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 183 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::PseudoBlockStochasticCGSolMgr< 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 BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

void Belos::PseudoBlockStochasticCGSolMgr< 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 196 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

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

the maximum number of restarts 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 625 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::getStochasticVector ( )

inline

Get a copy of the final stochastic vector.

Definition at line 224 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

overridevirtual

Method to return description of the block CG solver manager.

Reimplemented from Teuchos::Describable.

Definition at line 837 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

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

private

Definition at line 237 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 240 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 241 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 244 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 245 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<StatusTestGenResNorm<ScalarType,MV,OP> > Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::convTest_

private

Definition at line 246 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 247 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 250 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<const Teuchos::ParameterList> Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::validParams_

mutableprivate

List of valid parameters and their default values.

This is declared "mutable" because the SolverManager interface requires that getValidParameters() be declared const, yet we want to create the valid parameter list only on demand.

Definition at line 257 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate

Definition at line 260 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

constexpr bool Belos::PseudoBlockStochasticCGSolMgr< ScalarType, MV, OP >::assertPositiveDefiniteness_default_ = true

staticprivate

Definition at line 261 of file BelosPseudoBlockStochasticCGSolMgr.hpp.

template<class ScalarType , class MV , class OP >

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

staticprivate