PETScVector.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 "utils.h"
#include <array>
#include <cstdint>
#include <functional>
#include <petscvec.h>
#include <vector>
#include <xtl/xspan.hpp>
 
namespace dolfinx::common
{
class IndexMap;
}
namespace dolfinx::la
{
 
Vec create_ghosted_vector(const common::IndexMap& map, int bs,
                          xtl::span<PetscScalar> x);
 
void petsc_error(int error_code, std::string filename,
                 std::string petsc_function);
 
std::vector<IS> create_petsc_index_sets(
    const std::vector<
        std::pair<std::reference_wrapper<const common::IndexMap>, int>>& maps);
 
Vec create_petsc_vector(const common::IndexMap& map, int bs);
 
Vec create_petsc_vector(MPI_Comm comm, std::array<std::int64_t, 2> range,
                        const std::vector<std::int64_t>& ghosts, int bs);
 
std::vector<std::vector<PetscScalar>> get_local_vectors(
    const Vec x,
    const std::vector<
        std::pair<std::reference_wrapper<const common::IndexMap>, int>>& maps);
 
void scatter_local_vectors(
    Vec x, const std::vector<xtl::span<const PetscScalar>>& x_b,
    const std::vector<
        std::pair<std::reference_wrapper<const common::IndexMap>, int>>& maps);
 
class PETScVector
{
public:
  PETScVector(const common::IndexMap& map, int bs);
 
  // Delete copy constructor to avoid accidental copying of 'heavy' data
  PETScVector(const PETScVector& x) = delete;
 
  PETScVector(PETScVector&& x);
 
  PETScVector(Vec x, bool inc_ref_count);
 
  virtual ~PETScVector();
 
  // Assignment operator (disabled)
  PETScVector& operator=(const PETScVector& x) = delete;
 
  PETScVector& operator=(PETScVector&& x);
 
  PETScVector copy() const;
 
  std::int64_t size() const;
 
  std::int32_t local_size() const;
 
  std::array<std::int64_t, 2> local_range() const;
 
  MPI_Comm mpi_comm() const;
 
  PetscReal norm(la::Norm type) const;
 
  void set_options_prefix(std::string options_prefix);
 
  std::string get_options_prefix() const;
 
  void set_from_options();
 
  Vec vec() const;
 
private:
  // PETSc Vec pointer
  Vec _x;
};
} // namespace dolfinx::la