petsc_matrix_base.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_BASE_H
#define LIBMESH_PETSC_MATRIX_BASE_H

#include "libmesh/libmesh_common.h"

#ifdef LIBMESH_HAVE_PETSC

// Local includes
#include "libmesh/sparse_matrix.h"
#include "libmesh/petsc_macro.h"
#include "libmesh/petsc_solver_exception.h"
#include "libmesh/wrapped_petsc.h"

// Petsc include files.
#ifdef I
# define LIBMESH_SAW_I
#endif
#include <petscmat.h>
#ifndef LIBMESH_SAW_I
# undef I // Avoid complex.h contamination
#endif

// Macro to identify and debug functions which should be called in
// parallel on parallel matrices but which may be called in serial on
// serial matrices.  This macro will only be valid inside non-static
// PetscMatrix methods
#undef semiparallel_only
#undef exceptionless_semiparallel_only
#ifndef NDEBUG
#include <cstring>

#define semiparallel_only() do { if (this->initialized()) { const char * mytype; \
      LibmeshPetscCall(MatGetType(this->_mat,&mytype));                 \
      if (!strcmp(mytype, MATSEQAIJ))                                   \
        parallel_object_only(); } } while (0)
#define exceptionless_semiparallel_only() do { if (this->initialized()) { const char * mytype; \
      auto semiparallel_only_ierr = MatGetType(this->_mat,&mytype);     \
      libmesh_ignore(semiparallel_only_ierr);                           \
      if (!strcmp(mytype, MATSEQAIJ))                                   \
        exceptionless_parallel_object_only(); } } while (0)
#else
#define semiparallel_only()
#define exceptionless_semiparallel_only()
#endif


namespace libMesh
{

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

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

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

  virtual SolverPackage solver_package() override
  {
    return PETSC_SOLVERS;
  }

  Mat mat () { libmesh_assert (_mat); return _mat; }
  Mat mat() const { libmesh_assert(_mat); return _mat; }

  virtual void clear() noexcept override;

  void set_destroy_mat_on_exit(bool destroy = true);

  void swap (PetscMatrixBase<T> &);

  using SparseMatrix<T>::operator=;

  void set_context();

  static PetscMatrixBase<T> * get_context(Mat mat, const TIMPI::Communicator & comm);

  virtual numeric_index_type m () const override;

  virtual numeric_index_type local_m () const final;

  virtual numeric_index_type n () const override;

  virtual numeric_index_type local_n () const final;

  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 close () override;

  virtual bool closed() const override;

protected:

  Mat _mat;

  bool _destroy_mat_on_exit;
};

} // namespace libMesh

#endif // #ifdef LIBMESH_HAVE_PETSC
#endif // LIBMESH_PETSC_MATRIX_BASE_H