Thyra::SolveCriteria< Scalar > Struct Template Reference

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::RCP< Teuchos::ParameterList > &_extraParameters=Teuchos::null)
 Construct with a specified solve criteria.

Static Public Member Functions

static 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::RCP
< 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 136 of file Thyra_SolveSupportTypes.hpp.


Member Typedef Documentation

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

Definition at line 138 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 152 of file Thyra_SolveSupportTypes.hpp.

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

Construct with a specified solve criteria.

Definition at line 157 of file Thyra_SolveSupportTypes.hpp.


Member Function Documentation

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

Definition at line 140 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 143 of file Thyra_SolveSupportTypes.hpp.

Referenced by Thyra::DampenedNewtonNonlinearSolver< Scalar >::solve().

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

Referenced by Thyra::DampenedNewtonNonlinearSolver< Scalar >::solve().

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

Referenced by Thyra::DampenedNewtonNonlinearSolver< Scalar >::solve().


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:04:35 2011 for Thyra Package Browser (Single Doxygen Collection) by  doxygen 1.6.3