Playa::SolverState< Scalar > Class Template Reference

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
Private Attributes
SolverStatusCode	finalState_
Scalar	finalResid_
int	finalIters_
std::string	msg_

---

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>

int Playa::SolverState< Scalar >::finalIters

(

)

const [inline]

Definition at line 46 of file PlayaSolverState.hpp.

References Playa::SolverState< Scalar >::finalIters_.

Referenced by Playa::operator<<().

template<class Scalar>

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

(

)

const [inline]

Definition at line 52 of file PlayaSolverState.hpp.

References Playa::SolverState< Scalar >::msg_.

Referenced by Playa::operator<<(), and Playa::NewtonArmijoSolver< Scalar >::solve().

template<class Scalar>

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

(

)

const [inline]

Definition at line 43 of file PlayaSolverState.hpp.

References Playa::SolverState< Scalar >::finalResid_.

Referenced by Playa::operator<<().

template<class Scalar>

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

(

)

const [inline]

Definition at line 49 of file PlayaSolverState.hpp.

References Playa::SolverState< Scalar >::finalState_.

Referenced by Playa::InverseOperator< Scalar >::apply(), Epetra::Epetra_PlayaOperator::ApplyInverse(), NOX::NOXPlaya::Group::applyJacobianInverse(), main(), Sundance::LPTestBase::solve(), Playa::NewtonArmijoSolver< Scalar >::solve(), Playa::KrylovSolver< Scalar >::solve(), Playa::BlockTriangularSolver< Scalar >::solve(), Sundance::NonlinearPDEConstrainedObj::solveState(), Sundance::LinearPDEConstrainedObj::solveState(), Sundance::NonlinearPDEConstrainedObj::solveStateAndAdjoint(), Sundance::LinearPDEConstrainedObj::solveStateAndAdjoint(), and Sundance::TransientStepProblem::step().

template<class Scalar>

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

(

)

const [inline]

Definition at line 55 of file PlayaSolverState.hpp.

References Playa::SolverState< Scalar >::finalState_, Playa::SolveConverged, Playa::SolveCrashed, and Playa::SolveFailedToConverge.

Referenced by Playa::InverseOperator< Scalar >::apply(), Playa::operator<<(), Sundance::LinearPDEConstrainedObj::solveState(), Sundance::NonlinearPDEConstrainedObj::solveStateAndAdjoint(), and Sundance::LinearPDEConstrainedObj::solveStateAndAdjoint().

---

Member Data Documentation

template<class Scalar>

int Playa::SolverState< Scalar >::finalIters_ [private]

Definition at line 75 of file PlayaSolverState.hpp.

Referenced by Playa::SolverState< Scalar >::finalIters().

template<class Scalar>

Scalar Playa::SolverState< Scalar >::finalResid_ [private]

Definition at line 73 of file PlayaSolverState.hpp.

Referenced by Playa::SolverState< Scalar >::finalResid().

template<class Scalar>

SolverStatusCode Playa::SolverState< Scalar >::finalState_ [private]

Definition at line 71 of file PlayaSolverState.hpp.

Referenced by Playa::SolverState< Scalar >::finalState(), and Playa::SolverState< Scalar >::stateDescription().

template<class Scalar>

std::string Playa::SolverState< Scalar >::msg_ [private]

Definition at line 77 of file PlayaSolverState.hpp.

Referenced by Playa::SolverState< Scalar >::finalMsg().