Gedim::ILinearSolver Class Reference

Interface used for algebra linear solvers. More...

#include <ILinearSolver.hpp>

Inheritance diagram for Gedim::ILinearSolver:

Classes
struct	Configuration
struct	SolutionInfo

Public Member Functions
virtual	~ILinearSolver ()
virtual void	Initialize (const ISparseArray &matrix, const IArray &rightHandSide, IArray &solution, const Configuration &config={100, 1e-6})=0
	Initialize the linear solver Ax = b.
virtual SolutionInfo	Solve () const =0
	Compute the solution.
virtual void	Initialize (const ISparseArray &matrix, const Configuration &config={100, 1e-6})=0
	Initialize the linear solver for system Ax = b.
virtual SolutionInfo	Solve (const IArray &rightHandSide, IArray &solution) const =0
	Compute the solution for system Ax = b.

Detailed Description

Interface used for algebra linear solvers.

Constructor & Destructor Documentation

~ILinearSolver()

virtual Gedim::ILinearSolver::~ILinearSolver ( )

inlinevirtual

Member Function Documentation

Initialize() [1/2]

virtual void Gedim::ILinearSolver::Initialize ( const ISparseArray &  matrix, const Configuration &  config = {100, 1e-6}  )

pure virtual

Initialize the linear solver for system Ax = b.

Parameters

matrix

The matrix A

Implemented in Gedim::Eigen_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >, Gedim::Eigen_BiCGSTABSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_PCGSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Pardiso_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType >, and Gedim::Pardiso_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >.

Initialize() [2/2]

virtual void Gedim::ILinearSolver::Initialize ( const ISparseArray &  matrix, const IArray &  rightHandSide, IArray &  solution, const Configuration &  config = {100, 1e-6}  )

pure virtual

Initialize the linear solver Ax = b.

Parameters

matrix	The matrix A
rightHandSide	The right-hand side b
solution	The solution x

Implemented in Gedim::Eigen_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >, Gedim::Eigen_BiCGSTABSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_PCGSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Pardiso_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >, and Gedim::Pardiso_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType >.

Solve() [1/2]

virtual SolutionInfo Gedim::ILinearSolver::Solve ( ) const

pure virtual

Compute the solution.

Implemented in Gedim::Eigen_BiCGSTABSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >, Gedim::Eigen_PCGSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Pardiso_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType >, and Gedim::Pardiso_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >.

Solve() [2/2]

virtual SolutionInfo Gedim::ILinearSolver::Solve ( const IArray &  rightHandSide, IArray &  solution  ) const

pure virtual

Compute the solution for system Ax = b.

Parameters

rightHandSide	The right-hand side b
solution	The solution x

Implemented in Gedim::Eigen_BiCGSTABSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Eigen_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >, Gedim::Eigen_PCGSolver< Eigen_ArrayType, Eigen_SparseArrayType, Eigen_SolverType >, Gedim::Pardiso_CholeskySolver< Eigen_ArrayType, Eigen_SparseArrayType >, and Gedim::Pardiso_LUSolver< Eigen_ArrayType, Eigen_SparseArrayType >.

---

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

• ILinearSolver.hpp