OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Public Member Functions | Protected Attributes | List of all members
BottomSolver< Matrix, Vector, Level > Class Template Referenceabstract

Abstract base class for all base level solvers. More...

#include <BottomSolver.h>

Public Member Functions

 BottomSolver ()
 
virtual ~BottomSolver ()
 
virtual void solve (const Vector &x, const Vector &b)=0
 
virtual void setOperator (const Matrix &A, Level *level_p=nullptr)=0
 
virtual std::size_t getNumIters ()=0
 
bool hasOperator () const
 

Protected Attributes

bool isInitialized_m
 

Detailed Description

template<class Matrix, class Vector, class Level>
class BottomSolver< Matrix, Vector, Level >

Abstract base class for all base level solvers.

Definition at line 8 of file BottomSolver.h.

Constructor & Destructor Documentation

template<class Matrix, class Vector, class Level>
BottomSolver< Matrix, Vector, Level >::BottomSolver ( )
inline

Definition at line 12 of file BottomSolver.h.

template<class Matrix, class Vector, class Level>
virtual BottomSolver< Matrix, Vector, Level >::~BottomSolver ( )
inlinevirtual

Definition at line 14 of file BottomSolver.h.

Member Function Documentation

template<class Matrix, class Vector, class Level>
virtual std::size_t BottomSolver< Matrix, Vector, Level >::getNumIters ( )
pure virtual
Returns
the number of required iterations

Implemented in MueLuBottomSolver< Level >, BelosBottomSolver< Level >, and Amesos2BottomSolver< Level >.

template<class Matrix , class Vector , class Level >
bool BottomSolver< Matrix, Vector, Level >::hasOperator ( ) const

Definition at line 49 of file BottomSolver.h.

template<class Matrix, class Vector, class Level>
virtual void BottomSolver< Matrix, Vector, Level >::setOperator ( const Matrix A,
Level *  level_p = nullptr 
)
pure virtual

Set the system matrix

Parameters
Asystem matrix
template<class Matrix, class Vector, class Level>
virtual void BottomSolver< Matrix, Vector, Level >::solve ( const Vector x,
const Vector b 
)
pure virtual

Solves

\[ Ax = b \]

Parameters
xleft-hand side
bright-hand side

Member Data Documentation

template<class Matrix, class Vector, class Level>
bool BottomSolver< Matrix, Vector, Level >::isInitialized_m
protected

Definition at line 44 of file BottomSolver.h.


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