matrix_tools.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 1998 - 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_matrix_tools_h
#define dealii_matrix_tools_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/function.h>
 
#include <deal.II/lac/affine_constraints.h>
 
#include <deal.II/numerics/matrix_creator.h>
 
#include <map>
 
#ifdef DEAL_II_WITH_PETSC
#  include <petscsys.h>
#endif
 
DEAL_II_NAMESPACE_OPEN
 
 
// forward declarations
#ifndef DOXYGEN
template <int dim>
class Quadrature;
 
 
template <typename number>
class Vector;
template <typename number>
class FullMatrix;
template <typename number>
class SparseMatrix;
 
template <typename number>
class BlockSparseMatrix;
template <typename Number>
class BlockVector;
 
template <int dim, int spacedim>
class Mapping;
template <int dim, int spacedim>
DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
class DoFHandler;
 
namespace hp
{
  template <int>
  class QCollection;
  template <int, int>
  class MappingCollection;
} // namespace hp
 
 
#  ifdef DEAL_II_WITH_PETSC
namespace PETScWrappers
{
  class MatrixBase;
  class VectorBase;
  namespace MPI
  {
    class BlockSparseMatrix;
    class BlockVector;
  } // namespace MPI
} // namespace PETScWrappers
#  endif
 
#  ifdef DEAL_II_WITH_TRILINOS
namespace TrilinosWrappers
{
  class SparseMatrix;
  class BlockSparseMatrix;
  namespace MPI
  {
    class Vector;
    class BlockVector;
  } // namespace MPI
} // namespace TrilinosWrappers
#  endif
#endif
 
 
 
namespace MatrixTools
{
  using namespace MatrixCreator;
 
  template <typename number>
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, number> &boundary_values,
    SparseMatrix<number>                            &matrix,
    Vector<number>                                  &solution,
    Vector<number>                                  &right_hand_side,
    const bool                                       eliminate_columns = true);
 
  template <typename number>
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, number> &boundary_values,
    BlockSparseMatrix<number>                       &matrix,
    BlockVector<number>                             &solution,
    BlockVector<number>                             &right_hand_side,
    const bool                                       eliminate_columns = true);
 
#ifdef DEAL_II_WITH_PETSC
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, PetscScalar> &boundary_values,
    PETScWrappers::MatrixBase                            &matrix,
    PETScWrappers::VectorBase                            &solution,
    PETScWrappers::VectorBase                            &right_hand_side,
    const bool eliminate_columns = true);
 
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, PetscScalar> &boundary_values,
    PETScWrappers::MPI::BlockSparseMatrix                &matrix,
    PETScWrappers::MPI::BlockVector                      &solution,
    PETScWrappers::MPI::BlockVector                      &right_hand_side,
    const bool eliminate_columns = true);
 
#endif
 
#ifdef DEAL_II_WITH_TRILINOS
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, TrilinosScalar> &boundary_values,
    TrilinosWrappers::SparseMatrix                          &matrix,
    TrilinosWrappers::MPI::Vector                           &solution,
    TrilinosWrappers::MPI::Vector                           &right_hand_side,
    const bool eliminate_columns = true);
 
  void
  apply_boundary_values(
    const std::map<types::global_dof_index, TrilinosScalar> &boundary_values,
    TrilinosWrappers::BlockSparseMatrix                     &matrix,
    TrilinosWrappers::MPI::BlockVector                      &solution,
    TrilinosWrappers::MPI::BlockVector                      &right_hand_side,
    const bool eliminate_columns = true);
#endif
 
  template <typename number>
  void
  local_apply_boundary_values(
    const std::map<types::global_dof_index, number> &boundary_values,
    const std::vector<types::global_dof_index>      &local_dof_indices,
    FullMatrix<number>                              &local_matrix,
    Vector<number>                                  &local_rhs,
    const bool                                       eliminate_columns);
 
  DeclExceptionMsg(ExcBlocksDontMatch,
                   "You are providing a matrix whose subdivision into "
                   "blocks in either row or column direction does not use "
                   "the same blocks sizes as the solution vector or "
                   "right hand side vectors, respectively.");
} // namespace MatrixTools
 
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif