eigen_sparse_matrix.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_EIGEN_SPARSE_MATRIX_H
#define LIBMESH_EIGEN_SPARSE_MATRIX_H

#include "libmesh/libmesh_config.h"

#ifdef LIBMESH_HAVE_EIGEN

// Local includes
#include "libmesh/sparse_matrix.h"
#include "libmesh/eigen_core_support.h"

// Eigen includes

// C++ includes
#include <algorithm>
#include <cstddef>

namespace libMesh
{

// Forward declarations
template <typename T> class DenseMatrix;
template <typename T> class EigenSparseVector;
template <typename T> class EigenSparseLinearSolver;

template <typename T>
class EigenSparseMatrix final : public SparseMatrix<T>
{

public:
  EigenSparseMatrix (const Parallel::Communicator & comm);

  EigenSparseMatrix (EigenSparseMatrix &&) = default;
  EigenSparseMatrix (const EigenSparseMatrix &) = default;
  EigenSparseMatrix & operator= (const EigenSparseMatrix &) = default;
  EigenSparseMatrix & operator= (EigenSparseMatrix &&) = default;
  virtual ~EigenSparseMatrix () = default;

  virtual SolverPackage solver_package() override
  {
    return EIGEN_SOLVERS;
  }

  virtual SparseMatrix<T> & operator=(const SparseMatrix<T> & v) override
  {
    *this = cast_ref<const EigenSparseMatrix<T> &>(v);
    return *this;
  }

  typedef EigenSM DataType;
  typedef Eigen::Triplet<T,eigen_idx_type> TripletType;

  virtual void init (const numeric_index_type m,
                     const numeric_index_type n,
                     const numeric_index_type m_l,
                     const numeric_index_type n_l,
                     const numeric_index_type nnz=30,
                     const numeric_index_type noz=10,
                     const numeric_index_type blocksize=1) override;

  virtual void init (ParallelType = PARALLEL) override;

  virtual void clear () override;

  virtual void zero () override;

  virtual std::unique_ptr<SparseMatrix<T>> zero_clone () const override;

  virtual std::unique_ptr<SparseMatrix<T>> clone () const override;

  virtual void close () override { this->_closed = true; }

  virtual numeric_index_type m () const override;

  virtual numeric_index_type n () const override;

  virtual numeric_index_type row_start () const override;

  virtual numeric_index_type row_stop () const override;

  virtual numeric_index_type col_start () const override;

  virtual numeric_index_type col_stop () const override;

  virtual void set (const numeric_index_type i,
                    const numeric_index_type j,
                    const T value) override;

  virtual void add (const numeric_index_type i,
                    const numeric_index_type j,
                    const T value) override;

  virtual void add_matrix (const DenseMatrix<T> & dm,
                           const std::vector<numeric_index_type> & rows,
                           const std::vector<numeric_index_type> & cols) override;

  virtual void add_matrix (const DenseMatrix<T> & dm,
                           const std::vector<numeric_index_type> & dof_indices) override;

  virtual void add (const T a, const SparseMatrix<T> & X) override;

  virtual T operator () (const numeric_index_type i,
                         const numeric_index_type j) const override;

  virtual Real l1_norm () const override;

  virtual Real linfty_norm () const override;

  virtual bool closed() const override { return _closed; }

  virtual void print_personal(std::ostream & os=libMesh::out) const override { this->print(os); }

  virtual void get_diagonal (NumericVector<T> & dest) const override;

  virtual void get_transpose (SparseMatrix<T> & dest) const override;

  virtual void get_row(numeric_index_type i,
                       std::vector<numeric_index_type> & indices,
                       std::vector<T> & values) const override;
private:

  DataType _mat;

  bool _closed;

  friend class EigenSparseVector<T>;
  friend class EigenSparseLinearSolver<T>;
};

} // namespace libMesh

#endif // #ifdef LIBMESH_HAVE_EIGEN
#endif // #ifdef LIBMESH_EIGEN_SPARSE_MATRIX_H