Simple struct for the return status from a solve. More...

#include <Thyra_SolveSupportTypes.hpp>

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Public Member Functions
	SolveStatus ()

Static Public Member Functions
static ScalarMag	unknownTolerance ()

static std::string	achievedTolToString (const ScalarMag &achievedTol)
	Output the achieveTol field.
Public Attributes
ESolveStatus	solveStatus
	The return status of the solve.
ScalarMag	achievedTol
	The maximum final tolerance actually achieved by the (block) linear solve. A value of `unknownTolerance()` means that even an estimate of the the final value of the tolerance is unknown.
std::string	message
	A simple one-line message (i.e. no newlines) returned from the solver.
RCP< ParameterList >	extraParameters
	Any extra status parameters. Note that the contents of this parameter list is totally undefined.
Related Functions
(Note that these are not member functions.)
template<class Scalar >
std::ostream &	operator<< (std::ostream &out_arg, const SolveStatus< Scalar > &solveStatus)
	Print the solve status to a stream.
template<class Scalar >
void	accumulateSolveStatusInit (const Ptr< SolveStatus< Scalar > > &overallSolveStatus)
	Initial overallSolveStatus before calling accumulateSolveStatus().
template<class Scalar >
void	accumulateSolveStatus (const SolveCriteria< Scalar >, const SolveStatus< Scalar > &solveStatus, const Ptr< SolveStatus< Scalar > > &overallSolveStatus)
	Accumulate solve status objects for solving a block of RHSs is smaller sub-blocks.
template<class Scalar >
THYRA_DEPRECATED void	accumulateSolveStatus (const SolveCriteria< Scalar >, const SolveStatus< Scalar > &solveStatus, SolveStatus< Scalar > *overallSolveStatus)
	Deprecated.

Detailed Description

template<class Scalar>
struct Thyra::SolveStatus< Scalar >

Simple struct for the return status from a solve.

In the future, more fields may be added to aid in user diagnostics.

Definition at line 444 of file Thyra_SolveSupportTypes.hpp.

Member Typedef Documentation

template<class Scalar>

typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::SolveStatus< Scalar >::ScalarMag

Definition at line 446 of file Thyra_SolveSupportTypes.hpp.

Constructor & Destructor Documentation

template<class Scalar>

Thyra::SolveStatus< Scalar >::SolveStatus ( ) [inline]

Definition at line 461 of file Thyra_SolveSupportTypes.hpp.

Member Function Documentation

template<class Scalar>

static ScalarMag Thyra::SolveStatus< Scalar >::unknownTolerance ( ) [inline, static]

Definition at line 448 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar>

static std::string Thyra::SolveStatus< Scalar >::achievedTolToString ( const ScalarMag & achievedTol ) [inline, static]

Output the achieveTol field.

Definition at line 466 of file Thyra_SolveSupportTypes.hpp.

Friends And Related Function Documentation

template<class Scalar >

std::ostream & operator<<	(	std::ostream &	out_arg,
		const SolveStatus< Scalar > &	solveStatus
	)		`[related]`

Print the solve status to a stream.

Definition at line 479 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar >

void accumulateSolveStatusInit ( const Ptr< SolveStatus< Scalar > > & overallSolveStatus ) [related]

Initial overallSolveStatus before calling accumulateSolveStatus().

Definition at line 533 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar >

void accumulateSolveStatus	(	const SolveCriteria< Scalar >	,
		const SolveStatus< Scalar > &	solveStatus,
		const Ptr< SolveStatus< Scalar > > &	overallSolveStatus
	)		`[related]`

Accumulate solve status objects for solving a block of RHSs is smaller sub-blocks.

Parameters:

overallSolveCriteria	[in] The overall solve criteria for the overall blocks.
solveStatus	[in] The solve status for a sub-block (or a single RHS)
overallSolveStatus	[in/out] The accumulated solve status for all the sub-blocks of RHS.

Before the first initialize with accumulateSolveStatusInit(overallSolveStatus).

Definition at line 558 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar >

THYRA_DEPRECATED void accumulateSolveStatus	(	const SolveCriteria< Scalar >	,
		const SolveStatus< Scalar > &	solveStatus,
		SolveStatus< Scalar > *	overallSolveStatus
	)		`[related]`

Deprecated.

Definition at line 625 of file Thyra_SolveSupportTypes.hpp.

Member Data Documentation

template<class Scalar>

ESolveStatus Thyra::SolveStatus< Scalar >::solveStatus

The return status of the solve.

Definition at line 450 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar>

ScalarMag Thyra::SolveStatus< Scalar >::achievedTol

The maximum final tolerance actually achieved by the (block) linear solve. A value of unknownTolerance() means that even an estimate of the the final value of the tolerance is unknown.

Definition at line 454 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar>

std::string Thyra::SolveStatus< Scalar >::message

A simple one-line message (i.e. no newlines) returned from the solver.

Definition at line 456 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar>

RCP<ParameterList> Thyra::SolveStatus< Scalar >::extraParameters

Any extra status parameters. Note that the contents of this parameter list is totally undefined.

Definition at line 459 of file Thyra_SolveSupportTypes.hpp.

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