petsc_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_PETSC_MATRIX_H
#define LIBMESH_PETSC_MATRIX_H

#include "libmesh/libmesh_common.h"

#ifdef LIBMESH_HAVE_PETSC

// Local includes
#include "libmesh/petsc_matrix_base.h"
#include "libmesh/petsc_macro.h"
#include "libmesh/petsc_solver_exception.h"

// C++ includes
#include <algorithm>
#ifdef LIBMESH_HAVE_CXX11_THREAD
#include <atomic>
#include <mutex>
#endif

class PetscMatrixTest;

namespace libMesh
{

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

enum PetscMatrixType : int {
                 AIJ=0,
                 HYPRE};

template <typename T>
class PetscMatrix final : public PetscMatrixBase<T>
{
public:
  explicit
  PetscMatrix (const Parallel::Communicator & comm_in);

  explicit
  PetscMatrix (Mat m,
               const Parallel::Communicator & comm_in,
               bool destroy_on_exit = false);

  explicit
  PetscMatrix (const Parallel::Communicator & comm_in,
               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 n_nz=30,
               const numeric_index_type n_oz=10,
               const numeric_index_type blocksize=1);

  PetscMatrix (PetscMatrix &&) = delete;
  PetscMatrix (const PetscMatrix &) = delete;
  PetscMatrix & operator= (PetscMatrix &&) = delete;
  virtual ~PetscMatrix ();

  PetscMatrix & operator= (const PetscMatrix &);
  virtual SparseMatrix<T> & operator= (const SparseMatrix<T> & v) 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 n_nz=30,
                     const numeric_index_type n_oz=10,
                     const numeric_index_type blocksize=1) override;

  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 std::vector<numeric_index_type> & n_nz,
             const std::vector<numeric_index_type> & n_oz,
             const numeric_index_type blocksize=1);

  virtual void init (ParallelType = PARALLEL) override;

  void update_preallocation_and_zero();

  void reset_preallocation();

  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 zero_rows (std::vector<numeric_index_type> & rows, T diag_value = 0.0) override;

  virtual void flush () 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_block_matrix (const DenseMatrix<T> & dm,
                                 const std::vector<numeric_index_type> & brows,
                                 const std::vector<numeric_index_type> & bcols) override;

  virtual void add_block_matrix (const DenseMatrix<T> & dm,
                                 const std::vector<numeric_index_type> & dof_indices) override
  { this->add_block_matrix (dm, dof_indices, dof_indices); }

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

  virtual void matrix_matrix_mult (SparseMatrix<T> & X, SparseMatrix<T> & Y, bool reuse = false) override;

  virtual
  void add_sparse_matrix (const SparseMatrix<T> & spm,
                          const std::map<numeric_index_type,numeric_index_type> & row_ltog,
                          const std::map<numeric_index_type,numeric_index_type> & col_ltog,
                          const T scalar) override;

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

  virtual Real l1_norm () const override;

  virtual Real frobenius_norm () const;

  virtual Real linfty_norm () const override;

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

  virtual void print_matlab(const std::string & name = "") const override;

  virtual void print_petsc_binary(const std::string & filename) override;

  virtual void print_petsc_hdf5(const std::string & filename) override;

  virtual void read_petsc_binary(const std::string & filename) override;

  virtual void read_petsc_hdf5(const std::string & filename) 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;

   virtual void create_submatrix_nosort(SparseMatrix<T> & submatrix,
                                        const std::vector<numeric_index_type> & rows,
                                        const std::vector<numeric_index_type> & cols) const override;

  virtual void scale(const T scale) override;

#if PETSC_RELEASE_GREATER_EQUALS(3, 23, 0)

  std::unique_ptr<PetscMatrix<T>> copy_from_hash();
#endif

  virtual bool supports_hash_table() const override;

  virtual void restore_original_nonzero_pattern() override;

protected:
  void init_without_preallocation (numeric_index_type m,
                                   numeric_index_type n,
                                   numeric_index_type m_l,
                                   numeric_index_type n_l,
                                   numeric_index_type blocksize);

  /*
   * Performs matrix preallcation
   * \param m_l The local number of rows.
   * \param n_nz array containing the number of nonzeros in each row of the DIAGONAL portion of the local submatrix.
   * \param n_oz Array containing the number of nonzeros in each row of the OFF-DIAGONAL portion of the local submatrix.
   * \param blocksize Optional value indicating dense coupled blocks for systems with multiple variables all of the same    */
  void preallocate(numeric_index_type m_l,
                   const std::vector<numeric_index_type> & n_nz,
                   const std::vector<numeric_index_type> & n_oz,
                   numeric_index_type blocksize);

  void finish_initialization();

  virtual void _get_submatrix(SparseMatrix<T> & submatrix,
                              const std::vector<numeric_index_type> & rows,
                              const std::vector<numeric_index_type> & cols,
                              const bool reuse_submatrix) const override;

  void _petsc_viewer(const std::string & filename,
                     PetscViewerType viewertype,
                     PetscFileMode filemode);

  PetscMatrixType _mat_type;

private:
#ifdef LIBMESH_HAVE_CXX11_THREAD
  mutable std::mutex _petsc_matrix_mutex;
#else
  mutable Threads::spin_mutex _petsc_matrix_mutex;
#endif

  template <NormType N> Real norm () const;

  friend class ::PetscMatrixTest;
};

} // namespace libMesh

#endif // #ifdef LIBMESH_HAVE_PETSC
#endif // LIBMESH_PETSC_MATRIX_H