Playa::LinearSolver< Scalar > Class Template Reference

User-level linear solver object. More...

#include <PlayaLinearSolverDecl.hpp>

Inheritance diagram for Playa::LinearSolver< Scalar >:

Playa::Handle< LinearSolverBase< 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 37 of file PlayaLinearSolverDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Playa::LinearSolver< Scalar >::LinearSolver (  )  [inline]

Definition at line 41 of file PlayaLinearSolverDecl.hpp.

template<class Scalar>
Playa::LinearSolver< Scalar >::LinearSolver ( Playa::Handleable< LinearSolverBase< Scalar > > *  rawPtr  )  [inline]

Definition at line 43 of file PlayaLinearSolverDecl.hpp.

template<class Scalar>
Playa::LinearSolver< Scalar >::LinearSolver ( const RCP< LinearSolverBase< Scalar > > &  smartPtr  )  [inline]

Definition at line 46 of file PlayaLinearSolverDecl.hpp.


Member Function Documentation

template<class Scalar>
void Playa::LinearSolver< Scalar >::updateTolerance ( const double &  tol  )  [inline]

Change the convergence tolerance. Default does nothing.

Definition at line 51 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 24 of file PlayaLinearSolverImpl.hpp.

template<class Scalar>
void LinearSolver::setUserPrec ( const PreconditionerFactory< Scalar > &  pf  )  [inline]

Set a user-defined preconditioner

Definition at line 18 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 78 of file PlayaLinearSolverDecl.hpp.

template<class Scalar >
const ParameterList & Playa::LinearSolver< Scalar >::parameters (  )  const [inline]

Definition at line 109 of file PlayaLinearSolverDecl.hpp.

template<class Scalar >
ParameterList & Playa::LinearSolver< Scalar >::parameters (  )  [inline]

Definition at line 117 of file PlayaLinearSolverDecl.hpp.


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

doxygen