Public Member Functions | Static Public Member Functions | Private Attributes
TSFExtended::LinearSolverBase< Scalar > Class Template Reference
Inheritance diagram for TSFExtended::LinearSolverBase< Scalar >:
Sundance::DefaultObjectWithVerbosity Sundance::NamedObject Sundance::ObjectWithVerbosityBase TSFExtended::BlockTriangularSolver< Scalar > TSFExtended::BlockTriangularSolver< Scalar > TSFExtended::IterativeSolver< Scalar > TSFExtended::KrylovSolver< Scalar > TSFExtended::BICGSTABSolver< Scalar > TSFExtended::GMRESSolver< 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)
 Change the convergence tolerance.
virtual void setUserPrec (const PreconditionerFactory< Scalar > &pf)
 Set a user-defined preconditioning operator.
virtual void setUserPrec (const LinearOperator< Scalar > &P, const LinearSolver< Scalar > &pSolver)
 Set a user-defined preconditioning operator.
const ParameterList & parameters () const
ParameterList & parameters ()

Static Public Member Functions

static std::string verbosityParam ()
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 TSFExtended::LinearSolverBase< Scalar >

Definition at line 56 of file TSFLinearSolverBaseDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
TSFExtended::LinearSolverBase< Scalar >::LinearSolverBase ( const ParameterList &  params) [inline]

Definition at line 49 of file TSFLinearSolverBaseImpl.hpp.

template<class Scalar>
virtual TSFExtended::LinearSolverBase< Scalar >::~LinearSolverBase ( ) [inline, virtual]

Definition at line 64 of file TSFLinearSolverBaseDecl.hpp.


Member Function Documentation

template<class Scalar >
const ParameterList & TSFExtended::LinearSolverBase< Scalar >::parameters ( ) const [inline]
template<class Scalar >
ParameterList & TSFExtended::LinearSolverBase< Scalar >::parameters ( ) [inline]

Definition at line 55 of file TSFLinearSolverBaseImpl.hpp.

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

Definition at line 63 of file TSFLinearSolverBaseImpl.hpp.

template<class Scalar>
void TSFExtended::LinearSolverBase< Scalar >::setUserPrec ( const PreconditionerFactory< Scalar > &  pf) [inline, virtual]

Set a user-defined preconditioning operator.

Default is an error.

Reimplemented in TSFExtended::BelosSolver.

Definition at line 76 of file TSFLinearSolverBaseImpl.hpp.

template<class Scalar>
void TSFExtended::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 TSFExtended::AztecSolver.

Definition at line 84 of file TSFLinearSolverBaseImpl.hpp.

template<class Scalar>
virtual SolverState<Scalar> TSFExtended::LinearSolverBase< Scalar >::solve ( const LinearOperator< Scalar > &  op,
const Vector< Scalar > &  rhs,
Vector< Scalar > &  soln 
) const [pure virtual]
template<class Scalar>
virtual void TSFExtended::LinearSolverBase< Scalar >::updateTolerance ( const double &  tol) [inline, virtual]

Change the convergence tolerance.

Default does nothing.

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

Definition at line 72 of file TSFLinearSolverBaseDecl.hpp.

template<class Scalar >
string TSFExtended::LinearSolverBase< Scalar >::verbosityParam ( ) [inline, static]

Definition at line 59 of file TSFLinearSolverBaseImpl.hpp.


Member Data Documentation

template<class Scalar>
ParameterList TSFExtended::LinearSolverBase< Scalar >::params_ [private]

Definition at line 96 of file TSFLinearSolverBaseDecl.hpp.

Site Contact