qprojector.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) 2005 - 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_qprojector_h
#define dealii_qprojector_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/geometry_info.h>
#include <deal.II/base/quadrature.h>
 
#include <deal.II/hp/q_collection.h>
 
DEAL_II_NAMESPACE_OPEN
 
#ifndef DOXYGEN
template <int dim>
class ReferenceCell;
#endif


template <int dim>
class QProjector
{
public:
  using SubQuadrature = Quadrature<dim - 1>;

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of this function which takes a combined_orientation "
    "argument instead.")
  static void
  project_to_face(const ReferenceCell<dim> &reference_cell,
                  const SubQuadrature      &quadrature,
                  const unsigned int        face_no,
                  std::vector<Point<dim>>  &q_points);

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of this function which takes a combined_orientation "
    "argument instead.")
  static Quadrature<dim>
  project_to_face(const ReferenceCell<dim> &reference_cell,
                  const SubQuadrature      &quadrature,
                  const unsigned int        face_no);

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of project_to_face() which takes a combined_orientation "
    "argument instead.")
  static Quadrature<dim>
  project_to_oriented_face(const ReferenceCell<dim> &reference_cell,
                           const SubQuadrature      &quadrature,
                           const unsigned int        face_no,
                           const bool                face_orientation,
                           const bool                face_flip,
                           const bool                face_rotation);

  static Quadrature<dim>
  project_to_face(const ReferenceCell<dim>          &reference_cell,
                  const SubQuadrature               &quadrature,
                  const unsigned int                 face_no,
                  const types::geometric_orientation combined_orientation);

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of project_to_subface() which takes a "
    "combined_orientation argument instead.")
  static void
  project_to_subface(const ReferenceCell<dim>      &reference_cell,
                     const SubQuadrature           &quadrature,
                     const unsigned int             face_no,
                     const unsigned int             subface_no,
                     std::vector<Point<dim>>       &q_points,
                     const RefinementCase<dim - 1> &ref_case =
                       RefinementCase<dim - 1>::isotropic_refinement);

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of project_to_subface() which takes a "
    "combined_orientation argument instead.")
  static Quadrature<dim>
  project_to_subface(const ReferenceCell<dim>      &reference_cell,
                     const SubQuadrature           &quadrature,
                     const unsigned int             face_no,
                     const unsigned int             subface_no,
                     const RefinementCase<dim - 1> &ref_case =
                       RefinementCase<dim - 1>::isotropic_refinement);

  DEAL_II_DEPRECATED_WITH_COMMENT(
    "Use the version of project_to_subface() which takes a "
    "combined_orientation argument instead.")
  static Quadrature<dim>
  project_to_oriented_subface(const ReferenceCell<dim>        &reference_cell,
                              const SubQuadrature             &quadrature,
                              const unsigned int               face_no,
                              const unsigned int               subface_no,
                              const bool                       face_orientation,
                              const bool                       face_flip,
                              const bool                       face_rotation,
                              const internal::SubfaceCase<dim> ref_case);

  static Quadrature<dim>
  project_to_subface(const ReferenceCell<dim>          &reference_cell,
                     const SubQuadrature               &quadrature,
                     const unsigned int                 face_no,
                     const unsigned int                 subface_no,
                     const types::geometric_orientation combined_orientation,
                     const RefinementCase<dim - 1>     &ref_case);

  static Quadrature<dim>
  project_to_all_faces(const ReferenceCell<dim>       &reference_cell,
                       const hp::QCollection<dim - 1> &quadrature);

  static Quadrature<dim>
  project_to_all_faces(const ReferenceCell<dim>  &reference_cell,
                       const Quadrature<dim - 1> &quadrature);

  static Quadrature<dim>
  project_to_all_subfaces(const ReferenceCell<dim> &reference_cell,
                          const SubQuadrature      &quadrature);

  static Quadrature<dim>
  project_to_child(const ReferenceCell<dim> &reference_cell,
                   const Quadrature<dim>    &quadrature,
                   const unsigned int        child_no);

  static Quadrature<dim>
  project_to_all_children(const ReferenceCell<dim> &reference_cell,
                          const Quadrature<dim>    &quadrature);

  static Quadrature<dim>
  project_to_line(const ReferenceCell<dim> &reference_cell,
                  const Quadrature<1>      &quadrature,
                  const Point<dim>         &p1,
                  const Point<dim>         &p2);

  class DataSetDescriptor
  {
  public:
    DataSetDescriptor();

    static DataSetDescriptor
    cell();

    DEAL_II_DEPRECATED_WITH_COMMENT(
      "Use the version of this function which takes a combined_orientation "
      "argument instead.")
    static DataSetDescriptor
    face(const ReferenceCell<dim> &reference_cell,
         const unsigned int        face_no,
         const bool                face_orientation,
         const bool                face_flip,
         const bool                face_rotation,
         const unsigned int        n_quadrature_points);

    static DataSetDescriptor
    face(const ReferenceCell<dim>          &reference_cell,
         const unsigned int                 face_no,
         const types::geometric_orientation combined_orientation,
         const unsigned int                 n_quadrature_points);

    DEAL_II_DEPRECATED_WITH_COMMENT(
      "Use the version of this function which takes a combined_orientation "
      "argument instead.")
    static DataSetDescriptor
    face(const ReferenceCell<dim>       &reference_cell,
         const unsigned int              face_no,
         const bool                      face_orientation,
         const bool                      face_flip,
         const bool                      face_rotation,
         const hp::QCollection<dim - 1> &quadrature);

    static DataSetDescriptor
    face(const ReferenceCell<dim>          &reference_cell,
         const unsigned int                 face_no,
         const types::geometric_orientation combined_orientation,
         const hp::QCollection<dim - 1>    &quadrature);

    DEAL_II_DEPRECATED_WITH_COMMENT(
      "Use the version of this function which takes a combined_orientation "
      "argument instead.")
    static DataSetDescriptor
    subface(const ReferenceCell<dim>        &reference_cell,
            const unsigned int               face_no,
            const unsigned int               subface_no,
            const bool                       face_orientation,
            const bool                       face_flip,
            const bool                       face_rotation,
            const unsigned int               n_quadrature_points,
            const internal::SubfaceCase<dim> ref_case =
              internal::SubfaceCase<dim>::case_isotropic);

    static DataSetDescriptor
    subface(const ReferenceCell<dim>          &reference_cell,
            const unsigned int                 face_no,
            const unsigned int                 subface_no,
            const types::geometric_orientation combined_orientation,
            const unsigned int                 n_quadrature_points,
            const internal::SubfaceCase<dim>   ref_case =
              internal::SubfaceCase<dim>::case_isotropic);

    operator unsigned int() const;
 
  private:
    const unsigned int dataset_offset;

    DataSetDescriptor(const unsigned int dataset_offset);
  };
};

 
 
// -------------------  inline and template functions ----------------
 
 
 
template <int dim>
inline QProjector<dim>::DataSetDescriptor::DataSetDescriptor(
  const unsigned int dataset_offset)
  : dataset_offset(dataset_offset)
{}
 
 
template <int dim>
inline QProjector<dim>::DataSetDescriptor::DataSetDescriptor()
  : dataset_offset(numbers::invalid_unsigned_int)
{}
 
 
 
template <int dim>
typename QProjector<dim>::DataSetDescriptor
QProjector<dim>::DataSetDescriptor::cell()
{
  return 0;
}
 
 
 
template <int dim>
inline QProjector<dim>::DataSetDescriptor::operator unsigned int() const
{
  return dataset_offset;
}
 
 
 
template <int dim>
Quadrature<dim> inline QProjector<dim>::project_to_all_faces(
  const ReferenceCell<dim>  &reference_cell,
  const Quadrature<dim - 1> &quadrature)
{
  return project_to_all_faces(reference_cell,
                              hp::QCollection<dim - 1>(quadrature));
}
 
 
/* -------------- declaration of explicit specializations ------------- */
 
#ifndef DOXYGEN
 
 
template <>
void
QProjector<1>::project_to_face(const ReferenceCell<1> &reference_cell,
                               const Quadrature<0> &,
                               const unsigned int,
                               std::vector<Point<1>> &);
template <>
void
QProjector<2>::project_to_face(const ReferenceCell<2> &reference_cell,
                               const Quadrature<1>    &quadrature,
                               const unsigned int      face_no,
                               std::vector<Point<2>>  &q_points);
template <>
void
QProjector<3>::project_to_face(const ReferenceCell<3> &reference_cell,
                               const Quadrature<2>    &quadrature,
                               const unsigned int      face_no,
                               std::vector<Point<3>>  &q_points);
 
template <>
void
QProjector<1>::project_to_subface(const ReferenceCell<1> &reference_cell,
                                  const Quadrature<0> &,
                                  const unsigned int,
                                  const unsigned int,
                                  std::vector<Point<1>> &,
                                  const RefinementCase<0> &);
template <>
void
QProjector<2>::project_to_subface(const ReferenceCell<2> &reference_cell,
                                  const Quadrature<1>    &quadrature,
                                  const unsigned int      face_no,
                                  const unsigned int      subface_no,
                                  std::vector<Point<2>>  &q_points,
                                  const RefinementCase<1> &);
template <>
void
QProjector<3>::project_to_subface(const ReferenceCell<3>  &reference_cell,
                                  const Quadrature<2>     &quadrature,
                                  const unsigned int       face_no,
                                  const unsigned int       subface_no,
                                  std::vector<Point<3>>   &q_points,
                                  const RefinementCase<2> &face_ref_case);
 
 
#endif // DOXYGEN
DEAL_II_NAMESPACE_CLOSE
 
#endif