eigen_sparse_matrix.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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 : public SparseMatrix<T>
{

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

  ~EigenSparseMatrix ();

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

  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);

  void init ();

  void clear ();

  void zero ();

  void close () const { const_cast<EigenSparseMatrix<T>*>(this)->_closed = true; }

  numeric_index_type m () const;

  numeric_index_type n () const;

  numeric_index_type row_start () const;

  numeric_index_type row_stop () const;

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

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

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

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

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

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

  Real l1_norm () const { libmesh_not_implemented(); return 0.; }

  Real linfty_norm () const { libmesh_not_implemented(); return 0.; }

  bool closed() const { return _closed; }

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

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

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

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