Playa::LinearSolver< Scalar > Class Template Reference

User-level linear solver object. More...

Inheritance diagram for Playa::LinearSolver< Scalar >:

List of all members.

Public Member Functions
	LinearSolver ()
	LinearSolver (Playa::Handleable< LinearSolverBase< Scalar > > *rawPtr)
	LinearSolver (const RCP< LinearSolverBase< Scalar > > &smartPtr)
void	updateTolerance (const double &tol)
void	setUserPrec (const LinearOperator< Scalar > &op, const LinearSolver< Scalar > &pSolver)
void	setUserPrec (const PreconditionerFactory< Scalar > &pf)
SolverState< Scalar >	solve (const LinearOperator< Scalar > &op, const Vector< Scalar > &rhs, Vector< Scalar > &soln) const
const ParameterList &	parameters () const
ParameterList &	parameters ()

---

Detailed Description

template<class Scalar>
class Playa::LinearSolver< Scalar >

User-level linear solver object.

Definition at line 74 of file PlayaLinearSolverDecl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Playa::LinearSolver< Scalar >::LinearSolver

(

)

[inline]

Definition at line 78 of file PlayaLinearSolverDecl.hpp.

template<class Scalar>

Playa::LinearSolver< Scalar >::LinearSolver

(

Playa::Handleable< LinearSolverBase< Scalar > > *

rawPtr

)

[inline]

Definition at line 80 of file PlayaLinearSolverDecl.hpp.

template<class Scalar>

Playa::LinearSolver< Scalar >::LinearSolver

(

const RCP< LinearSolverBase< Scalar > > &

smartPtr

)

[inline]

Definition at line 83 of file PlayaLinearSolverDecl.hpp.

---

Member Function Documentation

template<class Scalar >

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

(

)

const [inline]

Definition at line 146 of file PlayaLinearSolverDecl.hpp.

template<class Scalar >

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

(

)

[inline]

Definition at line 154 of file PlayaLinearSolverDecl.hpp.

template<class Scalar>

void LinearSolver::setUserPrec	(	const LinearOperator< Scalar > &	op,
		const LinearSolver< Scalar > &	pSolver
	)		[inline]

Set a user-defined preconditioner

Definition at line 61 of file PlayaLinearSolverImpl.hpp.

template<class Scalar>

void LinearSolver::setUserPrec

(

const PreconditionerFactory< Scalar > &

pf

)

[inline]

Set a user-defined preconditioner

Definition at line 55 of file PlayaLinearSolverImpl.hpp.

template<class Scalar>

SolverState< Scalar > Playa::LinearSolver< Scalar >::solve	(	const LinearOperator< Scalar > &	op,
		const Vector< Scalar > &	rhs,
		Vector< Scalar > &	soln
	)		const [inline]

Definition at line 115 of file PlayaLinearSolverDecl.hpp.

References PLAYA_MSG1, PLAYA_MSG2, Playa::Handle< VectorBase< Scalar > >::ptr(), Playa::Handle< LinearOperatorBase< Scalar > >::ptr(), solveTimer(), and Playa::MPIComm::world().

Referenced by Epetra::Epetra_PlayaOperator::ApplyInverse(), Sundance::StochBlockJacobiSolver::solve(), and Sundance::LinearSolveDriver::solve().

template<class Scalar>

void Playa::LinearSolver< Scalar >::updateTolerance

(

const double &

tol

)

[inline]

Change the convergence tolerance. Default does nothing.

Definition at line 88 of file PlayaLinearSolverDecl.hpp.