psblas_sparse_matrix.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2019 - 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_psblas_matrix_h
#define dealii_psblas_matrix_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/array_view.h>
 
#include <deal.II/lac/dynamic_sparsity_pattern.h>
#include <deal.II/lac/full_matrix.h>
#include <deal.II/lac/vector.h>
 
 
#ifdef DEAL_II_WITH_PSBLAS
#  include <deal.II/lac/psblas_sparsity_pattern.h>
#  include <deal.II/lac/psblas_vector.h>
#endif
 
DEAL_II_NAMESPACE_OPEN
 
#ifdef DEAL_II_WITH_PSBLAS
namespace PSCToolkitWrappers
{
 
  class SparseMatrix : public EnableObserverPointer
  {
  public:
    using size_type = ::types::global_dof_index;
 
    using value_type = double;
 
    SparseMatrix();
 
    ~SparseMatrix();
 
    SparseMatrix(const SparsityPattern &psblas_sparsity_pattern,
                 const MPI_Comm         communicator = MPI_COMM_WORLD);
 
    SparseMatrix(const SparseMatrix &) = delete;
 
    SparseMatrix &
    operator=(const SparseMatrix &) = delete;
 
    SparseMatrix &
    operator=(const value_type d) = delete;
 
    void
    copy_from(const SparseMatrix &other);
 
 
    void
    reinit(const IndexSet &parallel_partitioning,
           const MPI_Comm  communicator = MPI_COMM_WORLD);
 
    void
    reinit(const SparsityPattern &psblas_sparsity_pattern,
           const MPI_Comm         communicator = MPI_COMM_WORLD);
 
    void
    reinit(const IndexSet               &local_rows,
           const DynamicSparsityPattern &sparsity_pattern,
           const MPI_Comm                communicator = MPI_COMM_WORLD);
 
    size_type
    m() const;
 
    size_type
    n() const;
 
    size_type
    local_size() const;
 
    std::pair<size_type, size_type>
    local_range() const;
 
    bool
    in_local_range(const size_type index) const;
 
    size_type
    n_nonzero_elements() const;
 
    value_type
    el(const size_type i, const size_type j) const;
 
    value_type
    diag_element(const size_type i) const;
 
    value_type
    operator()(const size_type i, const size_type j) const;
 
    void
    set(const size_type i, const size_type j, const value_type value);
 
    void
    set(const std::vector<size_type> &indices,
        const FullMatrix<double>     &matrix);
 
    void
    add(const size_type i, const size_type j, const value_type value);
 
    void
    add(const size_type                row,
        const std::vector<size_type>  &col_indices,
        const std::vector<value_type> &values,
        const bool = false);
 
    void
    add(const size_type               row,
        const size_type               ncols,
        const std::vector<size_type> &col_indices,
        const value_type             *values,
        const bool = false,
        const bool = false);
 
    void
    add(const size_type                row,
        const size_type                ncols,
        const std::vector<size_type>  &col_indices,
        const std::vector<value_type> &values,
        const bool = false,
        const bool = false);
 
    void
    add(const size_type   row,
        const size_type   n_cols,
        const size_type  *col_indices,
        const value_type *values,
        const bool        elide_zero_values      = true,
        const bool        col_indices_are_sorted = false);
 
    void
    compress();
 
    void
    vmult(Vector &dst, const Vector &src) const;
 
    void
    vmult_add(Vector &dst, const Vector &src) const;
 
 
    void
    Tvmult(Vector &dst, const Vector &src) const;
 
    void
    Tvmult_add(Vector &dst, const Vector &src) const;
 
    value_type
    l1_norm() const;
 
    value_type
    linfty_norm() const;
 
    value_type
    frobenius_norm() const;
 
    value_type
    trace() const;
 
    psb_c_dspmat *
    get_psblas_matrix() const;
 
    psb_c_descriptor *
    get_psblas_descriptor() const;
 
    MPI_Comm
    get_mpi_communicator() const;
 
 
  private:
    MPI_Comm communicator;
 
    psb_c_dspmat *psblas_sparse_matrix;
 
    std::shared_ptr<psb_c_descriptor> psblas_descriptor;
 
    psb_c_ctxt *psblas_context;
 
    internal::State state;
 
    friend class PreconditionAMG;
  };
 
 
} // namespace PSCToolkitWrappers
#endif // DEAL_II_WITH_PSBLAS
DEAL_II_NAMESPACE_CLOSE
 
#endif