OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
BottomSolver< Matrix, Vector, Level > Class Template Referenceabstract

#include <BottomSolver.h>

Inheritance diagram for BottomSolver< Matrix, Vector, Level >:
Collaboration diagram for BottomSolver< Matrix, Vector, Level >:

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 >

Definition at line 27 of file BottomSolver.h.

Constructor & Destructor Documentation

◆ BottomSolver()

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

Definition at line 31 of file BottomSolver.h.

◆ ~BottomSolver()

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

Definition at line 33 of file BottomSolver.h.

Member Function Documentation

◆ getNumIters()

template<class Matrix, class Vector, class Level>
virtual std::size_t BottomSolver< Matrix, Vector, Level >::getNumIters ( )
pure virtual

◆ hasOperator()

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

Definition at line 68 of file BottomSolver.h.

References isInitialized_m.

◆ setOperator()

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

◆ solve()

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

◆ isInitialized_m

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

Definition at line 63 of file BottomSolver.h.

Referenced by hasOperator().


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