linearsolver.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021-2024 The Ikarus Developers mueller@ibb.uni-stuttgart.de
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
#include <memory>
#include <type_traits>
#include <variant>
 
#include <dune/common/exceptions.hh>
 
#include <Eigen/Core>
#include <Eigen/SparseCore>
 
#include <ikarus/utils/makeenum.hh>
namespace Ikarus {
 
MAKE_ENUM(SolverTypeTag, none, si_ConjugateGradient, si_LeastSquaresConjugateGradient, si_BiCGSTAB, sd_SimplicialLLT,
          sd_SimplicialLDLT, sd_SparseLU, sd_SparseQR, sd_CholmodSupernodalLLT, sd_UmfPackLU, sd_SuperLU,
          d_PartialPivLU, d_FullPivLU, d_HouseholderQR, d_ColPivHouseholderQR, d_FullPivHouseholderQR,
          d_CompleteOrthogonalDecomposition, d_LLT, d_LDLT);
 
enum class MatrixTypeTag
{
  Dense,
  Sparse
};
 
template <typename ST = double>
class LinearSolverTemplate
{
public:
  using ScalarType       = ST;
  using SparseMatrixType = Eigen::SparseMatrix<ScalarType>;
  using DenseMatrixType  = Eigen::MatrixX<ScalarType>;
 
  LinearSolverTemplate() = default;
 
  explicit LinearSolverTemplate(const SolverTypeTag& solverTypeTag);
 
  ~LinearSolverTemplate() = default;
 
  friend void swap(LinearSolverTemplate& lhs, LinearSolverTemplate& rhs) noexcept {
    std::swap(lhs.solverimpl_, rhs.solverimpl_);
    std::swap(lhs.solverTypeTag_, rhs.solverTypeTag_);
  }
  LinearSolverTemplate& operator=(const LinearSolverTemplate& other) {
    LinearSolverTemplate tmp(other);
    swap(*this, tmp);
    return *this;
  }
 
  LinearSolverTemplate(const LinearSolverTemplate& other) { *this = LinearSolverTemplate(other.solverTypeTag_); }
  LinearSolverTemplate(LinearSolverTemplate&& other) noexcept = default;
  LinearSolverTemplate& operator=(LinearSolverTemplate&& other) noexcept = default;
 
private:
  struct SolverBase
  {
    virtual ~SolverBase() = default;
    virtual void analyzePattern(const DenseMatrixType&) const {}
    virtual void analyzePattern(const SparseMatrixType&)                                         = 0;
    virtual void factorize(const DenseMatrixType&)                                               = 0;
    virtual void factorize(const SparseMatrixType&)                                              = 0;
    virtual void compute(const SparseMatrixType&)                                                = 0;
    virtual void compute(const DenseMatrixType&)                                                 = 0;
    virtual void solve(Eigen::VectorX<ScalarType>& x, const Eigen::VectorX<ScalarType>&) const   = 0;
    virtual void solve(Eigen::MatrixX2<ScalarType>& x, const Eigen::MatrixX2<ScalarType>&) const = 0;
    virtual void solve(Eigen::MatrixX3<ScalarType>& x, const Eigen::MatrixX3<ScalarType>&) const = 0;
    virtual void solve(Eigen::MatrixX<ScalarType>& x, const Eigen::MatrixX<ScalarType>&) const   = 0;
  };
 
  template <typename Solver>
  struct SolverImpl : public SolverBase
  {
    using SolverBase::analyzePattern; // forward use of analyzePattern(DenseMatrixType)
 
    void analyzePattern(const SparseMatrixType& A) final {
      if constexpr (requires(Solver sol) { sol.analyzePattern(A); })
        solver.analyzePattern(A);
    }
 
    void factorize(const SparseMatrixType& A) final {
      if constexpr (requires(Solver sol) { sol.factorize(A); })
        solver.factorize(A);
    }
 
    // Dense Solvers do not have a factorize method therefore
    // our interface we just call compute for dense matrices
    void factorize(const DenseMatrixType& A) final {
      if constexpr (requires(Solver sol) { sol.compute(A); } && std::is_base_of_v<Eigen::SolverBase<Solver>, Solver>)
        solver.compute(A);
    }
    void compute(const SparseMatrixType& A) final {
      if constexpr (std::is_base_of_v<Eigen::SparseSolverBase<Solver>, Solver>)
        solver.compute(A);
      else
        DUNE_THROW(Dune::NotImplemented, "This solver does not support solving with sparse matrices.");
    }
 
    void compute(const DenseMatrixType& A) final {
      if constexpr (std::is_base_of_v<Eigen::SolverBase<Solver>, Solver>)
        solver.compute(A);
      else
        DUNE_THROW(Dune::NotImplemented, "This solver does not support solving with dense matrices.");
    }
 
    void solve(Eigen::VectorX<ScalarType>& x, const Eigen::VectorX<ScalarType>& b) const final { x = solver.solve(b); }
 
    void solve(Eigen::MatrixX2<ScalarType>& x, const Eigen::MatrixX2<ScalarType>& b) const final {
      x = solver.solve(b);
    }
 
    void solve(Eigen::MatrixX3<ScalarType>& x, const Eigen::MatrixX3<ScalarType>& b) const final {
      x = solver.solve(b);
    }
 
    void solve(Eigen::MatrixX<ScalarType>& x, const Eigen::MatrixX<ScalarType>& b) const final { x = solver.solve(b); }
 
    Solver solver;
  };
 
  std::unique_ptr<SolverBase> solverimpl_;
  SolverTypeTag solverTypeTag_{SolverTypeTag::none};
 
public:
  template <typename MatrixType>
  requires std::is_same_v<MatrixType, DenseMatrixType> || std::is_same_v<MatrixType, SparseMatrixType>
  inline LinearSolverTemplate& compute(const MatrixType& A) {
    solverimpl_->compute(A);
    return *this;
  }
 
  template <typename MatrixType>
  requires std::is_same_v<MatrixType, DenseMatrixType> || std::is_same_v<MatrixType, SparseMatrixType>
  inline void analyzePattern(const MatrixType& A) {
    solverimpl_->analyzePattern(A);
  }
 
  template <typename MatrixType>
  requires std::is_same_v<MatrixType, DenseMatrixType> || std::is_same_v<MatrixType, SparseMatrixType>
  inline void factorize(const MatrixType& A) {
    solverimpl_->factorize(A);
  }
 
  void solve(Eigen::VectorX<ScalarType>& x, const Eigen::VectorX<ScalarType>& b) { solverimpl_->solve(x, b); }
 
  void solve(Eigen::MatrixX3<ScalarType>& x, const Eigen::MatrixX3<ScalarType>& b) { solverimpl_->solve(x, b); }
  void solve(Eigen::MatrixX2<ScalarType>& x, const Eigen::MatrixX2<ScalarType>& b) { solverimpl_->solve(x, b); }
 
  void solve(Eigen::MatrixX<ScalarType>& x, const Eigen::MatrixX<ScalarType>& b) { solverimpl_->solve(x, b); }
};
 
using LinearSolver = LinearSolverTemplate<double>;
extern template class LinearSolverTemplate<double>;
} // namespace Ikarus