petsc_matrix_shell_matrix.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_SHELL_MATRIX_H
#define LIBMESH_PETSC_MATRIX_SHELL_MATRIX_H
 
#include "libmesh/libmesh_config.h"
 
#ifdef LIBMESH_HAVE_PETSC
 
#include "libmesh/petsc_matrix_base.h"
#include "libmesh/petsc_shell_matrix.h"
 
namespace libMesh
{
 
template <typename T>
class PetscMatrixShellMatrix : public PetscMatrixBase<T>
{
public:
  explicit PetscMatrixShellMatrix(const Parallel::Communicator & comm_in);
 
  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 = 30,
                    const numeric_index_type = 10,
                    const numeric_index_type blocksize = 1) override;
 
  virtual void init(ParallelType = PARALLEL) override;
 
  virtual SparseMatrix<T> & operator=(const SparseMatrix<T> &) override;
 
  virtual bool require_sparsity_pattern() const override { return false; }
 
  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 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 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;
 
private:
  // Make this private because we mark as initialized after we've done our initialization, and we
  // don't want derived classes to mistakenly register their data as initialized (or not)
  using PetscMatrixBase<T>::_is_initialized;
 
  const bool _omit_constrained_dofs;
 
  friend void init_shell_mat<PetscMatrixShellMatrix<T>>(PetscMatrixShellMatrix<T> & obj);
  friend void init_shell_mat<PetscMatrixShellMatrix<T>>(PetscMatrixShellMatrix<T> & obj,
                                                        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 blocksize_in);
};
 
//-----------------------------------------------------------------------
// PetscMatrixShellMatrix inline members
template <typename T>
PetscMatrixShellMatrix<T>::PetscMatrixShellMatrix(const Parallel::Communicator & comm_in)
  : PetscMatrixBase<T>(comm_in), _omit_constrained_dofs(false)
{
}
 
} // namespace libMesh
 
#endif // LIBMESH_HAVE_PETSC
#endif // LIBMESH_SPARSE_SHELL_MATRIX_H