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

Simple struct that defines the requested solution criteria for a solve. More...

#include <Thyra_SolveSupportTypes.hpp>

List of all members.

Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
Public Member Functions
	SolveCriteria ()
	Default construction to use default solve criteria.
	SolveCriteria (SolveMeasureType _solveMeasureType, ScalarMag _requestedTol, const Teuchos::RefCountPtr< Teuchos::ParameterList > &_extraParameters=Teuchos::null)
	Construct with a specified solve criteria.
Static Public Member Functions
ScalarMag	unspecifiedTolerance ()
Public Attributes
SolveMeasureType	solveMeasureType
	The type of solve tolerance requested as given in this->requestedTol.
ScalarMag	requestedTol
	The requested solve tolerance (what the client would like to see). Only significant if !this->solveMeasureType.useDefault().
Teuchos::RefCountPtr< Teuchos::ParameterList >	extraParameters
	Any extra control parameters. Note that the contents of this parameter list is totally undefined and any client that uses this does so at their own peril!

---

Detailed Description

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

Simple struct that defines the requested solution criteria for a solve.

Definition at line 129 of file Thyra_SolveSupportTypes.hpp.

---

Member Typedef Documentation

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

Definition at line 131 of file Thyra_SolveSupportTypes.hpp.

---

Constructor & Destructor Documentation

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

Default construction to use default solve criteria. Definition at line 145 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> Thyra::SolveCriteria< Scalar >::SolveCriteria (  SolveMeasureType  _solveMeasureType, ScalarMag  _requestedTol, const Teuchos::RefCountPtr< Teuchos::ParameterList > &  _extraParameters = Teuchos::null )  [inline]

Construct with a specified solve criteria. Definition at line 150 of file Thyra_SolveSupportTypes.hpp.

---

Member Function Documentation

template<class Scalar> ScalarMag Thyra::SolveCriteria< Scalar >::unspecifiedTolerance (   )  [inline, static]

Definition at line 133 of file Thyra_SolveSupportTypes.hpp.

---

Member Data Documentation

template<class Scalar> SolveMeasureType Thyra::SolveCriteria< Scalar >::solveMeasureType

The type of solve tolerance requested as given in this->requestedTol. Definition at line 136 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> ScalarMag Thyra::SolveCriteria< Scalar >::requestedTol

The requested solve tolerance (what the client would like to see). Only significant if !this->solveMeasureType.useDefault(). Definition at line 139 of file Thyra_SolveSupportTypes.hpp.

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

Any extra control parameters. Note that the contents of this parameter list is totally undefined and any client that uses this does so at their own peril! Definition at line 143 of file Thyra_SolveSupportTypes.hpp.

---

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

• Thyra_SolveSupportTypes.hpp

---