PETScMatrix.h

// Copyright (C) 2004-2018 Johan Hoffman, Johan Jansson, Anders Logg and Garth
// N. Wells
//
// This file is part of DOLFINx (https://www.fenicsproject.org)
//
// SPDX-License-Identifier:    LGPL-3.0-or-later
 
#pragma once
 
#include "PETScOperator.h"
#include "utils.h"
#include <functional>
#include <petscmat.h>
#include <string>
 
namespace dolfinx::la
{
class SparsityPattern;
class VectorSpaceBasis;
 
Mat create_petsc_matrix(MPI_Comm comm, const SparsityPattern& sparsity_pattern,
                        const std::string& type = std::string());
 
MatNullSpace create_petsc_nullspace(MPI_Comm comm,
                                    const VectorSpaceBasis& nullspace);
 
 
class PETScMatrix : public PETScOperator
{
public:
  static std::function<int(std::int32_t, const std::int32_t*, std::int32_t,
                           const std::int32_t*, const PetscScalar*)>
  set_fn(Mat A, InsertMode mode);
 
  static std::function<int(std::int32_t, const std::int32_t*, std::int32_t,
                           const std::int32_t*, const PetscScalar*)>
  set_block_fn(Mat A, InsertMode mode);
 
  static std::function<int(std::int32_t, const std::int32_t*, std::int32_t,
                           const std::int32_t*, const PetscScalar*)>
  set_block_expand_fn(Mat A, int bs0, int bs1, InsertMode mode);
 
  PETScMatrix(MPI_Comm comm, const SparsityPattern& sparsity_pattern,
              const std::string& type = std::string());
 
  PETScMatrix(Mat A, bool inc_ref_count);
 
  // Copy constructor (deleted)
  PETScMatrix(const PETScMatrix& A) = delete;
 
  PETScMatrix(PETScMatrix&& A) = default;
 
  ~PETScMatrix() = default;
 
  PETScMatrix& operator=(const PETScMatrix& A) = delete;
 
  PETScMatrix& operator=(PETScMatrix&& A) = default;
 
  enum class AssemblyType : std::int32_t
  {
    FINAL,
    FLUSH
  };
 
  void apply(AssemblyType type);
 
  double norm(la::Norm norm_type) const;
 
  //--- Special PETSc Functions ---
 
  void set_options_prefix(std::string options_prefix);
 
  std::string get_options_prefix() const;
 
  void set_from_options();
 
  void set_nullspace(const la::VectorSpaceBasis& nullspace);
 
  void set_near_nullspace(const la::VectorSpaceBasis& nullspace);
};
} // namespace dolfinx::la