EigenMatrix.h

// Copyright (C) 2015 Chris Richardson and Garth N. Wells
//
// This file is part of DOLFIN.
//
// DOLFIN 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 3 of the License, or
// (at your option) any later version.
//
// DOLFIN 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 DOLFIN. If not, see <http://www.gnu.org/licenses/>.

#ifndef __DOLFIN_EIGEN_MATRIX_H
#define __DOLFIN_EIGEN_MATRIX_H

#include <iomanip>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include <Eigen/Sparse>

#include <dolfin/common/MPI.h>
#include <dolfin/common/types.h>
#include "EigenVector.h"
#include "GenericMatrix.h"
#include "GenericVector.h"
#include "TensorLayout.h"

namespace dolfin
{


  class EigenMatrix : public GenericMatrix
  {
  public:

    typedef Eigen::SparseMatrix<double, Eigen::RowMajor, int> eigen_matrix_type;

    EigenMatrix();

    EigenMatrix(std::size_t M, std::size_t N);

    EigenMatrix(const EigenMatrix& A);

    virtual ~EigenMatrix();

    //--- Implementation of the GenericTensor interface ---

    virtual void init(const TensorLayout& tensor_layout);

    virtual bool empty() const
    { return size(0) == 0; }

    virtual std::size_t size(std::size_t dim) const;

    virtual std::pair<std::int64_t, std::int64_t>
      local_range(std::size_t dim) const
    { return {0, size(dim)}; }

    std::size_t nnz() const;

    virtual void zero();

    virtual void apply(std::string mode);

    virtual MPI_Comm mpi_comm() const
    { return _mpi_comm.comm(); }

    virtual std::string str(bool verbose) const;

    //--- Implementation of the GenericMatrix interface ---

    virtual std::shared_ptr<GenericMatrix> copy() const;

    virtual void resize(std::size_t M, std::size_t N);

    virtual void init_vector(GenericVector& z, std::size_t dim) const;

    virtual void get(double* block, std::size_t m, const dolfin::la_index* rows,
                     std::size_t n, const dolfin::la_index* cols) const;

    virtual void set(const double* block, std::size_t m,
                     const dolfin::la_index* rows, std::size_t n,
                     const dolfin::la_index* cols);

    virtual void set_local(const double* block, std::size_t m,
                           const dolfin::la_index* rows, std::size_t n,
                           const dolfin::la_index* cols)
    { set(block, m, rows, n, cols); }

    virtual void add(const double* block, std::size_t m,
                     const dolfin::la_index* rows, std::size_t n,
                     const dolfin::la_index* cols);

    virtual void add_local(const double* block, std::size_t m,
                           const dolfin::la_index* rows, std::size_t n,
                           const dolfin::la_index* cols)
    { add(block, m, rows, n, cols); }

    virtual void axpy(double a, const GenericMatrix& A,
                      bool same_nonzero_pattern);

    virtual double norm(std::string norm_type) const;

    virtual void getrow(std::size_t row, std::vector<std::size_t>& columns,
                        std::vector<double>& values) const;

    virtual void setrow(std::size_t row_idx,
                        const std::vector<std::size_t>& columns,
                        const std::vector<double>& values);

    virtual void zero(std::size_t m, const dolfin::la_index* rows);

    virtual void zero_local(std::size_t m, const dolfin::la_index* rows)
    { zero(m, rows); }

    virtual void ident(std::size_t m, const dolfin::la_index* rows);

    virtual void ident_local(std::size_t m, const dolfin::la_index* rows)
    { ident(m, rows); }

    virtual void mult(const GenericVector& x, GenericVector& y) const;

    virtual void transpmult(const GenericVector& x, GenericVector& y) const;

    virtual void get_diagonal(GenericVector& x) const;

    virtual void set_diagonal(const GenericVector& x);

    virtual const EigenMatrix& operator*= (double a);

    virtual const EigenMatrix& operator/= (double a);

    virtual const GenericMatrix& operator= (const GenericMatrix& A);

    virtual std::tuple<const int*, const int*, const double*, std::size_t>
      data() const;

    //--- Special functions ---

    virtual GenericLinearAlgebraFactory& factory() const;

    //--- Special Eigen functions ---

    const eigen_matrix_type& mat() const
    { return _matA; }

    eigen_matrix_type& mat()
    { return _matA; }

    void compress()
    {  _matA.makeCompressed(); }

    double operator() (dolfin::la_index i, dolfin::la_index j) const
    { return _matA.coeff(i, j); }

    const EigenMatrix& operator= (const EigenMatrix& A);

  private:

    // MPI communicator
    dolfin::MPI::Comm _mpi_comm;

    // Eigen matrix object - row major access
    eigen_matrix_type _matA;

  };
}

#endif