linearAlgebraSolverLib
Loading...
Searching...
No Matches
linearAlgebraLib::LinearAlgebraSolverBase Class Referenceabstract

A class defining an interface for linear algebra solvers to implement. More...

#include <linearAlgebraSolverBase.hpp>

Inheritance diagram for linearAlgebraLib::LinearAlgebraSolverBase:
Collaboration diagram for linearAlgebraLib::LinearAlgebraSolverBase:

Public Member Functions

Constructors and destructors
 LinearAlgebraSolverBase (unsigned numberOfCells)
 
API interface that exposes behaviour to the caller
void setCoefficientMatrix (const SparseMatrixCSR &matrix)
 
void setRightHandSide (const Vector &rhs)
 
virtual Vector solve (unsigned maxIterations, double convergenceThreshold)=0
 

Protected Attributes

Private or protected implementation details, not exposed to the caller
SparseMatrixCSR _coefficientMatrix
 
Vector _rightHandSide
 

Detailed Description

A class defining an interface for linear algebra solvers to implement.

This class defines the interface for a linear algebra solver to implement. Here, the linear algebra solver will be used to solve the linear system of equations of the form \(\mathbf{Ax}=\mathbf{b}\). Therefore, it exposes functionality to set the coefficient matrix \(\mathbf{A}\) and the right hand side vector \(\mathbf{b}\), while the solver will return the solution vector \(\mathbf{x}\) using the solve() method.


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