Thyra::SolveStatus< Scalar > Struct Template Reference
[Equation solve foundational code]

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

#include <Thyra_SolveSupportTypes.hpp>

List of all members.

Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
Public Member Functions
	SolveStatus ()
Static Public Member Functions
ScalarMag	unknownTolerance ()
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.
Teuchos::RefCountPtr< Teuchos::ParameterList >	extraParameters
	Any extra status parameters. Note that the contents of this parameter list is totally undefined.

---

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 215 of file Thyra_SolveSupportTypes.hpp.

---

Member Typedef Documentation

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

Definition at line 217 of file Thyra_SolveSupportTypes.hpp.

---

Constructor & Destructor Documentation

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

Definition at line 232 of file Thyra_SolveSupportTypes.hpp.

---

Member Function Documentation

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

Definition at line 219 of file Thyra_SolveSupportTypes.hpp.

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

Output the achieveTol field. Definition at line 237 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 221 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 225 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 227 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> Teuchos::RefCountPtr<Teuchos::ParameterList> Thyra::SolveStatus< Scalar >::extraParameters

Any extra status parameters. Note that the contents of this parameter list is totally undefined. Definition at line 230 of file Thyra_SolveSupportTypes.hpp.

---

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

• Thyra_SolveSupportTypes.hpp

---