vector_tools_interpolate.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2020 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_vector_tools_interpolate_h
#define dealii_vector_tools_interpolate_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/template_constraints.h>
#include <deal.II/base/types.h>
 
#include <deal.II/fe/component_mask.h>
 
#include <map>
 
DEAL_II_NAMESPACE_OPEN
 
template <typename number>
class AffineConstraints;
 
template <int dim, int spacedim>
DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
class DoFHandler;
 
template <typename number>
class FullMatrix;
template <int dim, typename Number>
class Function;
template <typename MeshType>
DEAL_II_CXX20_REQUIRES(concepts::is_triangulation_or_dof_handler<MeshType>)
class InterGridMap;
template <int dim, int spacedim>
class Mapping;
 
namespace hp
{
  template <int dim, int spacedim>
  class MappingCollection;
}
 
namespace VectorTools
{
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate(
    const Mapping<dim, spacedim>                              &mapping,
    const DoFHandler<dim, spacedim>                           &dof,
    const Function<spacedim, typename VectorType::value_type> &function,
    VectorType                                                &vec,
    const ComponentMask &component_mask = {},
    const unsigned int   level          = numbers::invalid_unsigned_int);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate(
    const hp::MappingCollection<dim, spacedim>                &mapping,
    const DoFHandler<dim, spacedim>                           &dof,
    const Function<spacedim, typename VectorType::value_type> &function,
    VectorType                                                &vec,
    const ComponentMask &component_mask = {},
    const unsigned int   level          = numbers::invalid_unsigned_int);
 
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate(
    const DoFHandler<dim, spacedim>                           &dof,
    const Function<spacedim, typename VectorType::value_type> &function,
    VectorType                                                &vec,
    const ComponentMask &component_mask = {},
    const unsigned int   level          = numbers::invalid_unsigned_int);
 
  template <int dim, class InVector, class OutVector, int spacedim>
  DEAL_II_CXX20_REQUIRES(concepts::is_dealii_vector_type<InVector> &&
                           concepts::is_writable_dealii_vector_type<OutVector>)
  void interpolate(const DoFHandler<dim, spacedim> &dof_1,
                   const DoFHandler<dim, spacedim> &dof_2,
                   const FullMatrix<double>        &transfer,
                   const InVector                  &data_1,
                   OutVector                       &data_2);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_based_on_material_id(
    const Mapping<dim, spacedim>    &mapping,
    const DoFHandler<dim, spacedim> &dof_handler,
    const std::map<types::material_id,
                   const Function<spacedim, typename VectorType::value_type> *>
                        &function_map,
    VectorType          &dst,
    const ComponentMask &component_mask = {});
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_to_different_mesh(
    const DoFHandler<dim, spacedim> &dof_handler_1,
    const VectorType                &u1,
    const DoFHandler<dim, spacedim> &dof_handler_2,
    VectorType                      &u2);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_to_different_mesh(
    const DoFHandler<dim, spacedim>                          &dof_handler_1,
    const VectorType                                         &u1,
    const DoFHandler<dim, spacedim>                          &dof_handler_2,
    const AffineConstraints<typename VectorType::value_type> &constraints,
    VectorType                                               &u2);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_to_different_mesh(
    const InterGridMap<DoFHandler<dim, spacedim>>            &intergridmap,
    const VectorType                                         &u1,
    const AffineConstraints<typename VectorType::value_type> &constraints,
    VectorType                                               &u2);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_to_coarser_mesh(
    const DoFHandler<dim, spacedim> &dof_handler_fine,
    const VectorType                &u_fine,
    const DoFHandler<dim, spacedim> &dof_handler_coarse,
    const AffineConstraints<typename VectorType::value_type>
               &constraints_coarse,
    VectorType &u_coarse);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void interpolate_to_finer_mesh(
    const DoFHandler<dim, spacedim> &dof_handler_coarse,
    const VectorType                &u_coarse,
    const DoFHandler<dim, spacedim> &dof_handler_fine,
    const AffineConstraints<typename VectorType::value_type> &constraints_fine,
    VectorType                                               &u_fine);
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void get_position_vector(const DoFHandler<dim, spacedim> &dh,
                           VectorType                      &vector,
                           const ComponentMask             &mask = {});
 
  template <int dim, int spacedim, typename VectorType>
  DEAL_II_CXX20_REQUIRES(concepts::is_writable_dealii_vector_type<VectorType>)
  void get_position_vector(const Mapping<dim, spacedim>    &mapping,
                           const DoFHandler<dim, spacedim> &dh,
                           VectorType                      &vector,
                           const ComponentMask             &mask = {});
 
} // namespace VectorTools
 
DEAL_II_NAMESPACE_CLOSE
 
#endif // dealii_vector_tools_interpolate_h