Playa::LinearSolverBase< Scalar > Class Template Reference

Inheritance diagram for Playa::LinearSolverBase< Scalar >:

List of all members.

Public Member Functions
	LinearSolverBase (const ParameterList &params)
virtual	~LinearSolverBase ()
virtual SolverState< Scalar >	solve (const LinearOperator< Scalar > &op, const Vector< Scalar > &rhs, Vector< Scalar > &soln) const =0
virtual void	updateTolerance (const double &tol)
virtual void	setUserPrec (const PreconditionerFactory< Scalar > &pf)
virtual void	setUserPrec (const LinearOperator< Scalar > &P, const LinearSolver< Scalar > &pSolver)
const ParameterList &	parameters () const
ParameterList &	parameters ()
std::string	verbosityParam () const
Static Public Member Functions
template<typename T >
static void	setParameter (const ParameterList &params, T *valuePtr, const std::string &paramName)
Private Attributes
ParameterList	params_

---

Detailed Description

template<class Scalar>
class Playa::LinearSolverBase< Scalar >

Definition at line 31 of file PlayaLinearSolverBaseDecl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Playa::LinearSolverBase< Scalar >::LinearSolverBase

(

const ParameterList &

params

)

[inline]

Definition at line 25 of file PlayaLinearSolverBaseImpl.hpp.

References Playa::LinearSolverBase< Scalar >::parameters(), Playa::ObjectWithVerbosity::setVerb(), and Playa::LinearSolverBase< Scalar >::verbosityParam().

template<class Scalar>

virtual Playa::LinearSolverBase< Scalar >::~LinearSolverBase

(

)

[inline, virtual]

Definition at line 38 of file PlayaLinearSolverBaseDecl.hpp.

---

Member Function Documentation

template<class Scalar >

ParameterList & Playa::LinearSolverBase< Scalar >::parameters

(

)

[inline]

Definition at line 35 of file PlayaLinearSolverBaseImpl.hpp.

template<class Scalar >

const ParameterList & Playa::LinearSolverBase< Scalar >::parameters

(

)

const [inline]

Definition at line 21 of file PlayaLinearSolverBaseImpl.hpp.

Referenced by Playa::LinearSolverBase< Scalar >::LinearSolverBase().

template<class Scalar >

template<typename T >

void Playa::LinearSolverBase< Scalar >::setParameter	(	const ParameterList &	params,
		T *	valuePtr,
		const std::string &	paramName
	)			[inline, static]

Definition at line 43 of file PlayaLinearSolverBaseImpl.hpp.

template<class Scalar>

void Playa::LinearSolverBase< Scalar >::setUserPrec	(	const LinearOperator< Scalar > &	P,
		const LinearSolver< Scalar > &	pSolver
	)			[inline, virtual]

Set a user-defined preconditioning operator. Default is an error.

Reimplemented in Playa::AztecSolver.

Definition at line 64 of file PlayaLinearSolverBaseImpl.hpp.

template<class Scalar>

void Playa::LinearSolverBase< Scalar >::setUserPrec

(

const PreconditionerFactory< Scalar > &

pf

)

[inline, virtual]

Set a user-defined preconditioning operator. Default is an error.

Reimplemented in Playa::BelosSolver.

Definition at line 56 of file PlayaLinearSolverBaseImpl.hpp.

template<class Scalar>

virtual SolverState<Scalar> Playa::LinearSolverBase< Scalar >::solve	(	const LinearOperator< Scalar > &	op,
		const Vector< Scalar > &	rhs,
		Vector< Scalar > &	soln
	)			const [pure virtual]

Implemented in Playa::AmesosSolver, Playa::AztecSolver, Playa::BelosSolver, Playa::BlockTriangularSolver< Scalar >, Playa::BlockTriangularSolver< Scalar >, Playa::DenseLUSolver, Playa::KrylovSolver< Scalar >, and Playa::KrylovSolver< Scalar >.

template<class Scalar>

virtual void Playa::LinearSolverBase< Scalar >::updateTolerance

(

const double &

tol

)

[inline, virtual]

Change the convergence tolerance. Default does nothing.

Reimplemented in Playa::AztecSolver, Playa::IterativeSolver< Scalar >, and Playa::IterativeSolver< Scalar >.

Definition at line 46 of file PlayaLinearSolverBaseDecl.hpp.

template<class Scalar >

string Playa::LinearSolverBase< Scalar >::verbosityParam

(

)

const [inline]

Definition at line 39 of file PlayaLinearSolverBaseImpl.hpp.

Referenced by Playa::LinearSolverBase< Scalar >::LinearSolverBase().

---

Member Data Documentation

template<class Scalar>

ParameterList Playa::LinearSolverBase< Scalar >::params_ [private]

Definition at line 70 of file PlayaLinearSolverBaseDecl.hpp.