mapping_collection.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 - 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_mapping_collection_h
#define dealii_mapping_collection_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/enable_observer_pointer.h>
 
#include <deal.II/fe/fe.h>
#include <deal.II/fe/mapping.h>
#include <deal.II/fe/mapping_q1.h>
 
#include <deal.II/hp/collection.h>
 
#include <memory>
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace hp
{
  template <int dim, int spacedim = dim>
  class MappingCollection : public Collection<Mapping<dim, spacedim>>
  {
  public:
    MappingCollection() = default;

    explicit MappingCollection(const Mapping<dim, spacedim> &mapping);

    template <class... MappingTypes>
    explicit MappingCollection(const MappingTypes &...mappings);

    MappingCollection(
      const MappingCollection<dim, spacedim> &mapping_collection);

    MappingCollection(MappingCollection<dim, spacedim> &&) noexcept(
      std::is_nothrow_move_constructible_v<
        std::vector<std::shared_ptr<const Mapping<dim, spacedim>>>>
        &&std::is_nothrow_move_constructible_v<std::function<
          unsigned int(const typename hp::MappingCollection<dim, spacedim> &,
                       const unsigned int)>>) = default;

    MappingCollection<dim, spacedim> &
    operator=(MappingCollection<dim, spacedim> &&) = default; // NOLINT

    void
    push_back(const Mapping<dim, spacedim> &new_mapping);
  };
 

  template <int dim, int spacedim = dim>
  struct StaticMappingQ1
  {
  public:
    static MappingCollection<dim, spacedim> mapping_collection;
  };
 
 
 
  /* --------------- inline functions ------------------- */
 
  template <int dim, int spacedim>
  template <class... MappingTypes>
  MappingCollection<dim, spacedim>::MappingCollection(
    const MappingTypes &...mappings)
  {
    static_assert(
      is_base_of_all<Mapping<dim, spacedim>, MappingTypes...>::value,
      "Not all of the input arguments of this function "
      "are derived from Mapping<dim, spacedim>!");
 
    // loop over all of the given arguments and add the mappings to
    // this collection. Inlining the definition of mapping_pointers causes
    // internal compiler errors on GCC 7.1.1 so we define it separately:
    const auto mapping_pointers = {
      (static_cast<const Mapping<dim, spacedim> *>(&mappings))...};
    for (const auto p : mapping_pointers)
      push_back(*p);
  }
 
 
 
  template <int dim, int spacedim>
  MappingCollection<dim, spacedim>
    StaticMappingQ1<dim, spacedim>::mapping_collection =
      MappingCollection<dim, spacedim>(MappingQ1<dim, spacedim>{});
 
 
#ifndef DOXYGEN
// Declare the existence of explicit instantiations of the class
// above. This is not strictly necessary, but tells the compiler to
// avoid instantiating templates that we know are instantiated in
// .cc files and so can be referenced without implicit
// instantiations. In the current case, this also avoids certain
// warnings issues by clang and newer (LLVM-based) Intel compilers.
//
// Unfortunately, this does not seem to work when building modules
// because the compiler (well, Clang at least) then just doesn't
// instantiate these classes at all, even though their members are
// defined and explicitly instantiated in a .cc file.
#  ifndef DEAL_II_BUILDING_CXX20_MODULE
  extern template struct StaticMappingQ1<1, 1>;
  extern template struct StaticMappingQ1<1, 2>;
  extern template struct StaticMappingQ1<1, 3>;
  extern template struct StaticMappingQ1<2, 2>;
  extern template struct StaticMappingQ1<2, 3>;
  extern template struct StaticMappingQ1<3, 3>;
 
#    ifndef _MSC_VER
  extern template MappingCollection<1, 1>
    StaticMappingQ1<1, 1>::mapping_collection;
  extern template MappingCollection<1, 2>
    StaticMappingQ1<1, 2>::mapping_collection;
  extern template MappingCollection<1, 3>
    StaticMappingQ1<1, 3>::mapping_collection;
  extern template MappingCollection<2, 2>
    StaticMappingQ1<2, 2>::mapping_collection;
  extern template MappingCollection<2, 3>
    StaticMappingQ1<2, 3>::mapping_collection;
  extern template MappingCollection<3, 3>
    StaticMappingQ1<3, 3>::mapping_collection;
#    endif
#  endif
#endif
 
} // namespace hp
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif