Bempp::SolutionBase< BasisFunctionType, ResultType > Class Template Reference

The base class for the Solution and BlockedSolution container classes. More...

#include </home/wojtek/Projects/BEM/bempp-sven/bempp/lib/linalg/solution_base.hpp>

Inheritance diagram for Bempp::SolutionBase< BasisFunctionType, ResultType >:

Public Types
typedef ScalarTraits < ResultType >::RealType	MagnitudeType

Public Member Functions
	SolutionBase (const Thyra::SolveStatus< MagnitudeType > status)
	Constructor.
	SolutionBase (SolutionStatus::Status status, MagnitudeType achievedTolerance=unknownTolerance(), std::string message="")
	Constructor.
SolutionStatus::Status	status () const
	Return status of the linear solve.
MagnitudeType	achievedTolerance () const
	Maximum final tolerance achieved by the linear solve. More...
int	iterationCount () const
	Iteration count if iterative solver is used. If a direct solver is used, this defaults to -1.
std::string	solverMessage () const
	Message returned by the solver.
Teuchos::RCP < Teuchos::ParameterList >	extraParameters () const
	Extra status parameter returned by the solver. More...

Static Public Member Functions
static MagnitudeType	unknownTolerance ()

Private Attributes
SolutionStatus::Status	m_status
MagnitudeType	m_achievedTolerance
std::string	m_message
int	m_iterationCount
Teuchos::RCP < Teuchos::ParameterList >	m_extraParameters

Detailed Description

template<typename BasisFunctionType, typename ResultType>
class Bempp::SolutionBase< BasisFunctionType, ResultType >

The base class for the Solution and BlockedSolution container classes.

This class holds various information about the solution of a BEM computation. It derives from Thyra::SolveStatus if Trilinos is enabled.

MagnitudeType is identical to float if ResultType is float or complex<float>. It is double if ResultType is double or complex<double>

Member Function Documentation

template<typename BasisFunctionType , typename ResultType >

SolutionBase< BasisFunctionType, ResultType >::MagnitudeType Bempp::SolutionBase< BasisFunctionType, ResultType >::achievedTolerance

(

)

const

Maximum final tolerance achieved by the linear solve.

A value of unknownTolerance() means that even an estimate of the the final value of the tolerance is unknown. This is the typical value returned by direct solvers.

template<typename BasisFunctionType , typename ResultType >

Thyra::RCP< Teuchos::ParameterList > Bempp::SolutionBase< BasisFunctionType, ResultType >::extraParameters

(

)

const

Extra status parameter returned by the solver.

Note

Contents of this list are solver-dependent.

---

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

• /home/wojtek/Projects/BEM/bempp-sven/bempp/lib/linalg/solution_base.hpp
• /home/wojtek/Projects/BEM/bempp-sven/bempp/lib/linalg/solution_base.cpp