Eigen_PCGSolver.hpp

Go to the documentation of this file.

// _LICENSE_HEADER_
//
// Copyright (C) 2019 - 2025.
// Terms register on the GPL-3.0 license.
//
// This file can be redistributed and/or modified under the license terms.
//
// See top level LICENSE file for more details.
//
// This file can be used citing references in CITATION.cff file.
 
#ifndef __EIGENPCGSOLVER_H
#define __EIGENPCGSOLVER_H
 
#include "Eigen/Eigen"
#include "ILinearSolver.hpp"
 
namespace Gedim
{
template <typename Eigen_ArrayType = Eigen::VectorXd,
          typename Eigen_SparseArrayType = Eigen::SparseMatrix<double>,
          typename Eigen_SolverType = Eigen::ConjugateGradient<Eigen_SparseArrayType, Eigen::Lower, Eigen::DiagonalPreconditioner<double>>>
class Eigen_PCGSolver final : public ILinearSolver
{
  private:
    Eigen_SolverType linearSolver; 
    const IArray *_rightHandSide;  
    IArray *_solution;             
    Configuration _config;
 
  public:
    Eigen_PCGSolver()
    {
        _rightHandSide = nullptr;
        _solution = nullptr;
    }
    ~Eigen_PCGSolver()
    {
        _rightHandSide = nullptr;
        _solution = nullptr;
    }
 
    void Initialize(const ISparseArray &matrix, const IArray &rightHandSide, IArray &solution, const Configuration &config = {100, 1e-6});
 
    void Initialize(const IArray &rightHandSide, IArray &solution, const Configuration &config = {100, 1e-6});
 
    ILinearSolver::SolutionInfo Solve() const;
 
    void Initialize(const ISparseArray &matrix, const Configuration &config = {100, 1e-6});
    ILinearSolver::SolutionInfo Solve(const IArray &rightHandSide, IArray &solution) const;
};
} // namespace Gedim
 
#endif // __EIGENPCGSOLVER_H