fe_face.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2009 - 2018 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------

#ifndef dealii_fe_face_h
#define dealii_fe_face_h

#include <deal.II/base/config.h>

#include <deal.II/base/polynomial_space.h>
#include <deal.II/base/tensor_product_polynomials.h>

#include <deal.II/fe/fe_poly_face.h>

DEAL_II_NAMESPACE_OPEN


template <int dim, int spacedim = dim>
class FE_FaceQ
  : public FE_PolyFace<TensorProductPolynomials<dim - 1>, dim, spacedim>
{
public:
  FE_FaceQ(const unsigned int p);

  virtual std::unique_ptr<FiniteElement<dim, spacedim>>
  clone() const override;

  virtual std::string
  get_name() const override;

  virtual void
  convert_generalized_support_point_values_to_dof_values(
    const std::vector<Vector<double>> &support_point_values,
    std::vector<double> &              nodal_values) const override;

  virtual void
  get_face_interpolation_matrix(const FiniteElement<dim, spacedim> &source,
                                FullMatrix<double> &matrix) const override;

  virtual void
  get_subface_interpolation_matrix(const FiniteElement<dim, spacedim> &source,
                                   const unsigned int                  subface,
                                   FullMatrix<double> &matrix) const override;

  virtual bool
  has_support_on_face(const unsigned int shape_index,
                      const unsigned int face_index) const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_vertex_dof_identities(
    const FiniteElement<dim, spacedim> &fe_other) const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_line_dof_identities(
    const FiniteElement<dim, spacedim> &fe_other) const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_quad_dof_identities(
    const FiniteElement<dim, spacedim> &fe_other) const override;

  virtual bool
  hp_constraints_are_implemented() const override;

  virtual FiniteElementDomination::Domination
  compare_for_face_domination(
    const FiniteElement<dim, spacedim> &fe_other) const override;
  virtual std::pair<Table<2, bool>, std::vector<unsigned int>>
  get_constant_modes() const override;

private:
  static std::vector<unsigned int>
  get_dpo_vector(const unsigned int deg);
};



template <int spacedim>
class FE_FaceQ<1, spacedim> : public FiniteElement<1, spacedim>
{
public:
  FE_FaceQ(const unsigned int p);

  virtual std::unique_ptr<FiniteElement<1, spacedim>>
  clone() const override;

  virtual std::string
  get_name() const override;

  // for documentation, see the FiniteElement base class
  virtual UpdateFlags
  requires_update_flags(const UpdateFlags update_flags) const override;

  virtual void
  get_face_interpolation_matrix(const FiniteElement<1, spacedim> &source,
                                FullMatrix<double> &matrix) const override;

  virtual void
  get_subface_interpolation_matrix(const FiniteElement<1, spacedim> &source,
                                   const unsigned int                subface,
                                   FullMatrix<double> &matrix) const override;

  virtual bool
  has_support_on_face(const unsigned int shape_index,
                      const unsigned int face_index) const override;

  virtual bool
  hp_constraints_are_implemented() const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_vertex_dof_identities(
    const FiniteElement<1, spacedim> &fe_other) const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_line_dof_identities(
    const FiniteElement<1, spacedim> &fe_other) const override;

  virtual std::vector<std::pair<unsigned int, unsigned int>>
  hp_quad_dof_identities(
    const FiniteElement<1, spacedim> &fe_other) const override;

  virtual FiniteElementDomination::Domination
  compare_for_face_domination(
    const FiniteElement<1, spacedim> &fe_other) const override;

  virtual std::pair<Table<2, bool>, std::vector<unsigned int>>
  get_constant_modes() const override;

protected:
  /*
   * NOTE: The following functions have their definitions inlined into the class
   * declaration because we otherwise run into a compiler error with MS Visual
   * Studio.
   */


  virtual std::unique_ptr<typename FiniteElement<1, spacedim>::InternalDataBase>
  get_data(
    const UpdateFlags /*update_flags*/,
    const Mapping<1, spacedim> & /*mapping*/,
    const Quadrature<1> & /*quadrature*/,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      & /*output_data*/) const override
  {
    return std_cxx14::make_unique<
      typename FiniteElement<1, spacedim>::InternalDataBase>();
  }

  std::unique_ptr<typename FiniteElement<1, spacedim>::InternalDataBase>
  get_face_data(
    const UpdateFlags update_flags,
    const Mapping<1, spacedim> & /*mapping*/,
    const Quadrature<0> &quadrature,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      & /*output_data*/) const override
  {
    // generate a new data object and initialize some fields
    auto data = std_cxx14::make_unique<
      typename FiniteElement<1, spacedim>::InternalDataBase>();
    data->update_each = requires_update_flags(update_flags);

    const unsigned int n_q_points = quadrature.size();
    AssertDimension(n_q_points, 1);
    (void)n_q_points;

    // No derivatives of this element are implemented.
    if (data->update_each & update_gradients ||
        data->update_each & update_hessians)
      {
        Assert(false, ExcNotImplemented());
      }

    return std::move(data);
  }

  std::unique_ptr<typename FiniteElement<1, spacedim>::InternalDataBase>
  get_subface_data(
    const UpdateFlags           update_flags,
    const Mapping<1, spacedim> &mapping,
    const Quadrature<0> &       quadrature,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      &output_data) const override
  {
    return get_face_data(update_flags, mapping, quadrature, output_data);
  }

  virtual void
  fill_fe_values(
    const typename Triangulation<1, spacedim>::cell_iterator &cell,
    const CellSimilarity::Similarity                          cell_similarity,
    const Quadrature<1> &                                     quadrature,
    const Mapping<1, spacedim> &                              mapping,
    const typename Mapping<1, spacedim>::InternalDataBase &   mapping_internal,
    const ::internal::FEValuesImplementation::MappingRelatedData<1,
                                                                       spacedim>
      &                                                          mapping_data,
    const typename FiniteElement<1, spacedim>::InternalDataBase &fe_internal,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      &output_data) const override;

  virtual void
  fill_fe_face_values(
    const typename Triangulation<1, spacedim>::cell_iterator &cell,
    const unsigned int                                        face_no,
    const Quadrature<0> &                                     quadrature,
    const Mapping<1, spacedim> &                              mapping,
    const typename Mapping<1, spacedim>::InternalDataBase &   mapping_internal,
    const ::internal::FEValuesImplementation::MappingRelatedData<1,
                                                                       spacedim>
      &                                                          mapping_data,
    const typename FiniteElement<1, spacedim>::InternalDataBase &fe_internal,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      &output_data) const override;

  virtual void
  fill_fe_subface_values(
    const typename Triangulation<1, spacedim>::cell_iterator &cell,
    const unsigned int                                        face_no,
    const unsigned int                                        sub_no,
    const Quadrature<0> &                                     quadrature,
    const Mapping<1, spacedim> &                              mapping,
    const typename Mapping<1, spacedim>::InternalDataBase &   mapping_internal,
    const ::internal::FEValuesImplementation::MappingRelatedData<1,
                                                                       spacedim>
      &                                                          mapping_data,
    const typename FiniteElement<1, spacedim>::InternalDataBase &fe_internal,
    ::internal::FEValuesImplementation::FiniteElementRelatedData<1,
                                                                       spacedim>
      &output_data) const override;

private:
  static std::vector<unsigned int>
  get_dpo_vector(const unsigned int deg);
};



template <int dim, int spacedim = dim>
class FE_FaceP : public FE_PolyFace<PolynomialSpace<dim - 1>, dim, spacedim>
{
public:
  FE_FaceP(unsigned int p);

  virtual std::unique_ptr<FiniteElement<dim, spacedim>>
  clone() const override;

  virtual std::string
  get_name() const override;

  virtual void
  get_face_interpolation_matrix(const FiniteElement<dim, spacedim> &source,
                                FullMatrix<double> &matrix) const override;

  virtual void
  get_subface_interpolation_matrix(const FiniteElement<dim, spacedim> &source,
                                   const unsigned int                  subface,
                                   FullMatrix<double> &matrix) const override;

  virtual bool
  has_support_on_face(const unsigned int shape_index,
                      const unsigned int face_index) const override;

  virtual bool
  hp_constraints_are_implemented() const override;

  virtual FiniteElementDomination::Domination
  compare_for_face_domination(
    const FiniteElement<dim, spacedim> &fe_other) const override;

  virtual std::pair<Table<2, bool>, std::vector<unsigned int>>
  get_constant_modes() const override;

private:
  static std::vector<unsigned int>
  get_dpo_vector(const unsigned int deg);
};



template <int spacedim>
class FE_FaceP<1, spacedim> : public FE_FaceQ<1, spacedim>
{
public:
  FE_FaceP(const unsigned int p);

  std::string
  get_name() const override;
};


DEAL_II_NAMESPACE_CLOSE

#endif