sparsity_pattern_base.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2022 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_sparsity_pattern_base_h
#define dealii_sparsity_pattern_base_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/array_view.h>
#include <deal.II/base/enable_observer_pointer.h>
#include <deal.II/base/exceptions.h>
 
#include <utility>
 
DEAL_II_NAMESPACE_OPEN
 
class SparsityPatternBase : public EnableObserverPointer
{
public:
  using size_type = types::global_dof_index;
 
  SparsityPatternBase();
 
  SparsityPatternBase(const size_type rows, const size_type cols);
 
  SparsityPatternBase(const SparsityPatternBase &sparsity_pattern) = default;
 
  SparsityPatternBase(SparsityPatternBase &&sparsity_pattern) noexcept =
    default;
 
  SparsityPatternBase &
  operator=(const SparsityPatternBase &sparsity_pattern) = default;
 
  SparsityPatternBase &
  operator=(SparsityPatternBase &&sparsity_pattern) noexcept = default;
 
  size_type
  n_rows() const;
 
  size_type
  n_cols() const;
 
  virtual void
  add_row_entries(const size_type                  &row,
                  const ArrayView<const size_type> &columns,
                  const bool indices_are_sorted = false) = 0;
 
  virtual void
  add_entries(const ArrayView<const std::pair<size_type, size_type>> &entries);
 
protected:
  virtual void
  resize(const size_type rows, const size_type cols);
 
  size_type rows;
 
  size_type cols;
};
 
/* ---------------------------- Inline functions ---------------------------- */
 
#ifndef DOXYGEN
 
inline SparsityPatternBase::SparsityPatternBase()
  : rows(0)
  , cols(0)
{}
 
 
 
inline SparsityPatternBase::SparsityPatternBase(const size_type rows,
                                                const size_type cols)
  : rows(rows)
  , cols(cols)
{}
 
 
 
inline SparsityPatternBase::size_type
SparsityPatternBase::n_rows() const
{
  return rows;
}
 
 
 
inline SparsityPatternBase::size_type
SparsityPatternBase::n_cols() const
{
  return cols;
}
 
 
 
inline void
SparsityPatternBase::resize(const size_type rows, const size_type cols)
{
  this->rows = rows;
  this->cols = cols;
}
#endif
 
DEAL_II_NAMESPACE_CLOSE
 
#endif