Playa::SolverState< Scalar > Class Template Reference

#include <PlayaSolverState.hpp>

List of all members.

Public Member Functions
	SolverState (SolverStatusCode finalState, const std::string &msg, int finalIters, const Scalar &finalResid)
	SolverState ()
const Scalar &	finalResid () const
int	finalIters () const
const SolverStatusCode &	finalState () const
const std::string &	finalMsg () const
std::string	stateDescription () const

---

Detailed Description

template<class Scalar>
class Playa::SolverState< Scalar >

SolverState provides information about the result of a linear or nonlinear solve

Definition at line 27 of file PlayaSolverState.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Playa::SolverState< Scalar >::SolverState	(	SolverStatusCode	finalState,
		const std::string &	msg,
		int	finalIters,
		const Scalar &	finalResid
	)			[inline]

Definition at line 31 of file PlayaSolverState.hpp.

template<class Scalar>

Playa::SolverState< Scalar >::SolverState

(

)

[inline]

Definition at line 40 of file PlayaSolverState.hpp.

---

Member Function Documentation

template<class Scalar>

const Scalar& Playa::SolverState< Scalar >::finalResid

(

)

const [inline]

Definition at line 43 of file PlayaSolverState.hpp.

template<class Scalar>

int Playa::SolverState< Scalar >::finalIters

(

)

const [inline]

Definition at line 46 of file PlayaSolverState.hpp.

template<class Scalar>

const SolverStatusCode& Playa::SolverState< Scalar >::finalState

(

)

const [inline]

Definition at line 49 of file PlayaSolverState.hpp.

template<class Scalar>

const std::string& Playa::SolverState< Scalar >::finalMsg

(

)

const [inline]

Definition at line 52 of file PlayaSolverState.hpp.

template<class Scalar>

std::string Playa::SolverState< Scalar >::stateDescription

(

)

const [inline]

Definition at line 55 of file PlayaSolverState.hpp.

---

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

• PlayaSolverState.hpp