trilinos_epetra_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_TRILINOS_EPETRA_MATRIX_H
#define LIBMESH_TRILINOS_EPETRA_MATRIX_H

#include "libmesh/libmesh_common.h"

#ifdef LIBMESH_TRILINOS_HAVE_EPETRA

// Trilinos includes
#include "libmesh/ignore_warnings.h"
#include <Epetra_FECrsMatrix.h>
#include <Epetra_Map.h>
#include <Epetra_MpiComm.h>

// The EpetraExt interface is only needed for EpetraMatrix::add()
#ifdef LIBMESH_TRILINOS_HAVE_EPETRAEXT
#  include <EpetraExt_MatrixMatrix.h>
#endif
#include "libmesh/restore_warnings.h"

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

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

namespace libMesh
{

// Forward Declarations
template <typename T> class DenseMatrix;



template <typename T>
class EpetraMatrix final : public SparseMatrix<T>
{
public:
  EpetraMatrix (const Parallel::Communicator & comm);

  EpetraMatrix (Epetra_FECrsMatrix * m,
                const Parallel::Communicator & comm);

  EpetraMatrix (EpetraMatrix &&) = delete;
  EpetraMatrix (const EpetraMatrix &) = delete;
  EpetraMatrix & operator= (const EpetraMatrix &) = delete;
  EpetraMatrix & operator= (EpetraMatrix &&) = delete;
  virtual ~EpetraMatrix ();
  virtual SparseMatrix<T> & operator=(const SparseMatrix<T> &) override
  {
    libmesh_not_implemented();
    return *this;
  }

  virtual SolverPackage solver_package() override
  {
    return TRILINOS_SOLVERS;
  }

  virtual bool need_full_sparsity_pattern () const override
  { return true; }

  virtual void update_sparsity_pattern (const SparsityPattern::Graph &) override;

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

  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;

  virtual void print_personal(std::ostream & os=libMesh::out) const override;

  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;

  void swap (EpetraMatrix<T> &);

  Epetra_FECrsMatrix * mat () { libmesh_assert(_mat); return _mat; }

  const Epetra_FECrsMatrix * mat () const { libmesh_assert(_mat); return _mat; }


private:

  Epetra_FECrsMatrix * _mat;

  Epetra_Map * _map;

  Epetra_CrsGraph * _graph;

  bool _destroy_mat_on_exit;

  bool _use_transpose;
};

} // namespace libMesh

#endif // LIBMESH_TRILINOS_HAVE_EPETRA
#endif // LIBMESH_TRILINOS_EPETRA_MATRIX_H