mapping_manifold.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) 2016 - 2026 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_mapping_manifold_h
#define dealii_mapping_manifold_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/array_view.h>
#include <deal.II/base/derivative_form.h>
#include <deal.II/base/quadrature.h>
 
#include <deal.II/fe/mapping.h>
 
#include <cmath>
 
DEAL_II_NAMESPACE_OPEN
 
template <int dim, int spacedim = dim>
class MappingManifold : public Mapping<dim, spacedim>
{
public:
  MappingManifold() = default;
 
  MappingManifold(const MappingManifold<dim, spacedim> &mapping);
 
  // for documentation, see the Mapping base class
  virtual std::unique_ptr<Mapping<dim, spacedim>>
  clone() const override;
 
  virtual bool
  preserves_vertex_locations() const override;
 
  virtual bool
  is_compatible_with(const ReferenceCell<dim> &cell_type) const override;
 
  // for documentation, see the Mapping base class
  virtual Point<spacedim>
  transform_unit_to_real_cell(
    const typename Triangulation<dim, spacedim>::cell_iterator &cell,
    const Point<dim> &p) const override;
 
  // for documentation, see the Mapping base class
  virtual Point<dim>
  transform_real_to_unit_cell(
    const typename Triangulation<dim, spacedim>::cell_iterator &cell,
    const Point<spacedim> &p) const override;
 
  // for documentation, see the Mapping base class
  virtual void
  transform(const ArrayView<const Tensor<1, dim>>                   &input,
            const MappingKind                                        kind,
            const typename Mapping<dim, spacedim>::InternalDataBase &internal,
            const ArrayView<Tensor<1, spacedim>> &output) const override;
 
  // for documentation, see the Mapping base class
  virtual void
  transform(const ArrayView<const DerivativeForm<1, dim, spacedim>> &input,
            const MappingKind                                        kind,
            const typename Mapping<dim, spacedim>::InternalDataBase &internal,
            const ArrayView<Tensor<2, spacedim>> &output) const override;
 
  // for documentation, see the Mapping base class
  virtual void
  transform(const ArrayView<const Tensor<2, dim>>                   &input,
            const MappingKind                                        kind,
            const typename Mapping<dim, spacedim>::InternalDataBase &internal,
            const ArrayView<Tensor<2, spacedim>> &output) const override;
 
  // for documentation, see the Mapping base class
  virtual void
  transform(const ArrayView<const DerivativeForm<2, dim, spacedim>> &input,
            const MappingKind                                        kind,
            const typename Mapping<dim, spacedim>::InternalDataBase &internal,
            const ArrayView<Tensor<3, spacedim>> &output) const override;
 
  // for documentation, see the Mapping base class
  virtual void
  transform(const ArrayView<const Tensor<3, dim>>                   &input,
            const MappingKind                                        kind,
            const typename Mapping<dim, spacedim>::InternalDataBase &internal,
            const ArrayView<Tensor<3, spacedim>> &output) const override;
 
  class InternalData : public Mapping<dim, spacedim>::InternalDataBase
  {
  public:
    InternalData() = default;
 
    // Documentation see Mapping::InternalDataBase.
    virtual void
    reinit(const UpdateFlags      update_flags,
           const Quadrature<dim> &quadrature) override;
 
    void
    initialize_face(const UpdateFlags      update_flags,
                    const Quadrature<dim> &quadrature,
                    const unsigned int     n_original_q_points);
 
    void
    compute_manifold_quadrature_weights(const Quadrature<dim> &quadrature);
 
    void
    store_vertices(
      const typename Triangulation<dim, spacedim>::cell_iterator &cell) const;
 
    virtual std::size_t
    memory_consumption() const override;
 
    mutable std::array<Point<spacedim>, GeometryInfo<dim>::vertices_per_cell>
      vertices;
 
    mutable typename Triangulation<dim, spacedim>::cell_iterator cell;
 
    Quadrature<dim> quad;
 
    std::vector<std::array<double, GeometryInfo<dim>::vertices_per_cell>>
      cell_manifold_quadrature_weights;
 
    mutable std::array<double, GeometryInfo<dim>::vertices_per_cell>
      vertex_weights;
 
    std::array<std::vector<Tensor<1, dim>>,
               GeometryInfo<dim>::faces_per_cell *(dim - 1)>
      unit_tangentials;
 
    mutable std::vector<DerivativeForm<1, dim, spacedim>> covariant;
 
    mutable std::vector<DerivativeForm<1, dim, spacedim>> contravariant;
 
    mutable std::vector<std::vector<Tensor<1, spacedim>>> aux;
 
    mutable std::vector<double> volume_elements;
 
    mutable ObserverPointer<const Manifold<dim, spacedim>> manifold;
  };
 
private:
  // documentation can be found in Mapping::requires_update_flags()
  virtual UpdateFlags
  requires_update_flags(const UpdateFlags update_flags) const override;
 
  // documentation can be found in Mapping::get_data()
  virtual std::unique_ptr<typename Mapping<dim, spacedim>::InternalDataBase>
  get_data(const UpdateFlags, const Quadrature<dim> &quadrature) const override;
 
  using Mapping<dim, spacedim>::get_face_data;
 
  // documentation can be found in Mapping::get_face_data()
  virtual std::unique_ptr<typename Mapping<dim, spacedim>::InternalDataBase>
  get_face_data(const UpdateFlags,
                const hp::QCollection<dim - 1> &quadrature) const override;
 
  // documentation can be found in Mapping::get_subface_data()
  virtual std::unique_ptr<typename Mapping<dim, spacedim>::InternalDataBase>
  get_subface_data(const UpdateFlags,
                   const Quadrature<dim - 1> &quadrature) const override;
 
  // documentation can be found in Mapping::fill_fe_values()
  virtual CellSimilarity::Similarity
  fill_fe_values(
    const typename Triangulation<dim, spacedim>::cell_iterator &cell,
    const CellSimilarity::Similarity                            cell_similarity,
    const Quadrature<dim>                                      &quadrature,
    const typename Mapping<dim, spacedim>::InternalDataBase    &internal_data,
    internal::FEValuesImplementation::MappingRelatedData<dim, spacedim>
      &output_data) const override;
 
  using Mapping<dim, spacedim>::fill_fe_face_values;
 
  // documentation can be found in Mapping::fill_fe_face_values()
  virtual void
  fill_fe_face_values(
    const typename Triangulation<dim, spacedim>::cell_iterator &cell,
    const unsigned int                                          face_no,
    const hp::QCollection<dim - 1>                             &quadrature,
    const typename Mapping<dim, spacedim>::InternalDataBase    &internal_data,
    internal::FEValuesImplementation::MappingRelatedData<dim, spacedim>
      &output_data) const override;
 
  // documentation can be found in Mapping::fill_fe_subface_values()
  virtual void
  fill_fe_subface_values(
    const typename Triangulation<dim, spacedim>::cell_iterator &cell,
    const unsigned int                                          face_no,
    const unsigned int                                          subface_no,
    const Quadrature<dim - 1>                                  &quadrature,
    const typename Mapping<dim, spacedim>::InternalDataBase    &internal_data,
    internal::FEValuesImplementation::MappingRelatedData<dim, spacedim>
      &output_data) const override;
 
};
 
 
 
/*----------------------------------------------------------------------*/
 
#ifndef DOXYGEN
 
template <int dim, int spacedim>
inline bool
MappingManifold<dim, spacedim>::preserves_vertex_locations() const
{
  return true;
}
 
 
template <int dim, int spacedim>
bool
MappingManifold<dim, spacedim>::is_compatible_with(
  const ReferenceCell<dim> &cell_type) const
{
  if (cell_type.get_dimension() != dim)
    return false; // TODO: or is this an error?
 
  if (cell_type.is_hyper_cube())
    return true;
 
  return false;
}
 
 
 
#endif // DOXYGEN
 
/* -------------- declaration of explicit specializations ------------- */
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif