Playa::BICGSTABSolver< Scalar > Class Template Reference

Inheritance diagram for Playa::BICGSTABSolver< Scalar >:

Playa::KrylovSolver< Scalar > Playa::Handleable< LinearSolverBase< Scalar > > Playa::Printable Playa::IterativeSolver< Scalar > Playa::LinearSolverBase< Scalar > Playa::ObjectWithVerbosity

List of all members.

Public Member Functions

 BICGSTABSolver (const ParameterList &params=ParameterList())
 BICGSTABSolver (const ParameterList &params, const PreconditionerFactory< Scalar > &precond)
virtual ~BICGSTABSolver ()
Printable interface


void print (std::ostream &os) const
Describable interface


std::string description () const
Handleable interface


virtual RCP< LinearSolverBase
< Scalar > > 		getRcp ()

Protected Member Functions

virtual SolverState< Scalar > solveUnprec (const LinearOperator< Scalar > &op, const Vector< Scalar > &rhs, Vector< Scalar > &soln) const

Detailed Description

template<class Scalar>
class Playa::BICGSTABSolver< Scalar >

Definition at line 24 of file PlayaBICGSTABSolverDecl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Playa::BICGSTABSolver< Scalar >::BICGSTABSolver ( const ParameterList &  params = ParameterList()  )  [inline]

Definition at line 31 of file PlayaBICGSTABSolverImpl.hpp.

template<class Scalar >
Playa::BICGSTABSolver< Scalar >::BICGSTABSolver ( const ParameterList &  params,
const PreconditionerFactory< Scalar > &  precond 
) [inline]

Definition at line 36 of file PlayaBICGSTABSolverImpl.hpp.

template<class Scalar >
virtual Playa::BICGSTABSolver< Scalar >::~BICGSTABSolver (  )  [inline, virtual]

Definition at line 38 of file PlayaBICGSTABSolverDecl.hpp.

Member Function Documentation

template<class Scalar >
std::string Playa::BICGSTABSolver< Scalar >::description (  )  const [inline]

Write a brief description

Definition at line 49 of file PlayaBICGSTABSolverDecl.hpp.

Referenced by Playa::BICGSTABSolver< Scalar >::print().

template<class Scalar >
virtual RCP<LinearSolverBase<Scalar> > Playa::BICGSTABSolver< Scalar >::getRcp (  )  [inline, virtual]

Return a ref count pointer to a newly created object

Implements Playa::Handleable< LinearSolverBase< Scalar > >.

Definition at line 55 of file PlayaBICGSTABSolverDecl.hpp.

template<class Scalar >
void Playa::BICGSTABSolver< Scalar >::print ( std::ostream &  os  )  const [inline, virtual]

Write to a stream

Implements Playa::Printable.

Definition at line 42 of file PlayaBICGSTABSolverImpl.hpp.

References Playa::BICGSTABSolver< Scalar >::description(), and Playa::LinearSolverBase< Scalar >::parameters().

template<class Scalar >
SolverState< Scalar > Playa::BICGSTABSolver< Scalar >::solveUnprec ( const LinearOperator< Scalar > &  op,
const Vector< Scalar > &  rhs,
Vector< Scalar > &  soln 
) const [inline, protected, virtual]

Implements Playa::KrylovSolver< Scalar >.

Definition at line 52 of file PlayaBICGSTABSolverImpl.hpp.

References Playa::LinearOperator< Scalar >::apply(), Playa::Vector< Scalar >::copy(), Playa::Vector< Scalar >::dot(), Playa::MPIComm::getRank(), Playa::Vector< Scalar >::norm2(), Playa::Out::os(), Playa::SolveConverged, Playa::SolveCrashed, Playa::SolveFailedToConverge, Playa::Vector< Scalar >::space(), Playa::MPIComm::world(), and Playa::Vector< Scalar >::zero().

Site Contact