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 is for a default solve.
	SolveCriteria (ESolveTolType _solveTolType, ScalarMag _requestedTol, int _maxIterations=unspecifiedMaxIterations())
	Construct with a specified solve criteria.
Static Public Member Functions
ScalarMag	unspecifiedTolerance ()
int	unspecifiedMaxIterations ()
Public Attributes
ESolveTolType	solveTolType
	The type of solve tolerance requested as given in this->requestedTol.
ScalarMag	requestedTol
	The requested solve tolerance (what the client would like to see).
int	maxIterations
	The maximum number of iterations the solver is allowed to take.

---

Detailed Description

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

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

Examples:

ComplexFFTLinearOp.hpp.

Definition at line 69 of file Thyra_SolveSupportTypes.hpp.

---

Member Typedef Documentation

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

Definition at line 71 of file Thyra_SolveSupportTypes.hpp.

---

Constructor & Destructor Documentation

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

Default construction is for a default solve. Definition at line 94 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> Thyra::SolveCriteria< Scalar >::SolveCriteria (  ESolveTolType  _solveTolType, ScalarMag  _requestedTol, int  _maxIterations = unspecifiedMaxIterations() )  [inline]

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

---

Member Function Documentation

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

Definition at line 73 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> int Thyra::SolveCriteria< Scalar >::unspecifiedMaxIterations (   )  [inline, static]

Definition at line 75 of file Thyra_SolveSupportTypes.hpp.

---

Member Data Documentation

template<class Scalar> ESolveTolType Thyra::SolveCriteria< Scalar >::solveTolType

The type of solve tolerance requested as given in this->requestedTol. Definition at line 79 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->solveTolType!=SOLVE_TOL_DEFAULT Definition at line 84 of file Thyra_SolveSupportTypes.hpp.

template<class Scalar> int Thyra::SolveCriteria< Scalar >::maxIterations

The maximum number of iterations the solver is allowed to take. Note that the interpretation of this integer is 100% implementation defined and should not be used in the most general setting. This argument may be significant regardless of the value of this->solveTolType. Definition at line 92 of file Thyra_SolveSupportTypes.hpp.

---

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

• Thyra_SolveSupportTypes.hpp

---