Thyra Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Related Symbols | List of all members
Thyra::SolveStatus< Scalar > Struct Template Reference
Thyra interfaces » Thyra operator solve interfaces » Thyra operator solve fundamental interfaces

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.

(Note that these are not member symbols.)

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.

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

Member Typedef Documentation

◆ ScalarMag

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

Definition at line 393 of file Thyra_SolveSupportTypes.hpp.

Constructor & Destructor Documentation

◆ SolveStatus()

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

Definition at line 408 of file Thyra_SolveSupportTypes.hpp.

Member Function Documentation

◆ unknownTolerance()

template<class Scalar>
ScalarMag Thyra::SolveStatus< Scalar >::unknownTolerance ( )
inlinestatic

Definition at line 395 of file Thyra_SolveSupportTypes.hpp.

◆ achievedTolToString()

template<class Scalar>
std::string Thyra::SolveStatus< Scalar >::achievedTolToString ( const ScalarMag & achievedTol)
inlinestatic

Output the achieveTol field.

Definition at line 413 of file Thyra_SolveSupportTypes.hpp.

◆ operator<<()

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

◆ accumulateSolveStatusInit()

template<class Scalar>
void accumulateSolveStatusInit ( const Ptr< SolveStatus< Scalar > > & overallSolveStatus)
related

Initial overallSolveStatus before calling accumulateSolveStatus().

Definition at line 480 of file Thyra_SolveSupportTypes.hpp.

◆ accumulateSolveStatus()

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

Member Data Documentation

◆ solveStatus

template<class Scalar>
ESolveStatus Thyra::SolveStatus< Scalar >::solveStatus

The return status of the solve.

Definition at line 397 of file Thyra_SolveSupportTypes.hpp.

◆ achievedTol

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

◆ message

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

◆ extraParameters

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

The documentation for this struct was generated from the following file:
Generated on for Thyra by doxygen 1.15.0