dof_handler_policy.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) 2010 - 2024 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_dof_handler_policy_h
#define dealii_dof_handler_policy_h
 
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/template_constraints.h>
 
#include <deal.II/dofs/dof_renumbering.h>
#include <deal.II/dofs/dof_tools.h>
 
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declaration
#ifndef DOXYGEN
template <int dim, int spacedim>
DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
class DoFHandler;
#endif
 
namespace internal
{
  namespace DoFHandlerImplementation
  {
    struct NumberCache;
 
    namespace Policy
    {
      struct Implementation;
 
      template <int dim, int spacedim>
      class PolicyBase
      {
      public:
        virtual ~PolicyBase() = default;
 
        virtual NumberCache
        distribute_dofs() const = 0;
 
        virtual std::vector<NumberCache>
        distribute_mg_dofs() const = 0;
 
        virtual NumberCache
        renumber_dofs(
          const std::vector<types::global_dof_index> &new_numbers) const = 0;
 
        virtual NumberCache
        renumber_mg_dofs(
          const unsigned int                          level,
          const std::vector<types::global_dof_index> &new_numbers) const = 0;
      };
 
 
      template <int dim, int spacedim>
      class Sequential : public PolicyBase<dim, spacedim>
      {
      public:
        Sequential(DoFHandler<dim, spacedim> &dof_handler);
 
        // documentation is inherited
        virtual NumberCache
        distribute_dofs() const override;
 
        // documentation is inherited
        virtual std::vector<NumberCache>
        distribute_mg_dofs() const override;
 
        // documentation is inherited
        virtual NumberCache
        renumber_dofs(const std::vector<types::global_dof_index> &new_numbers)
          const override;
 
        // documentation is inherited
        virtual NumberCache
        renumber_mg_dofs(const unsigned int level,
                         const std::vector<types::global_dof_index>
                           &new_numbers) const override;
 
      protected:
        ObserverPointer<DoFHandler<dim, spacedim>> dof_handler;
      };
 
 
 
      template <int dim, int spacedim>
      class ParallelShared : public PolicyBase<dim, spacedim>
      {
      public:
        ParallelShared(DoFHandler<dim, spacedim> &dof_handler);
 
        virtual NumberCache
        distribute_dofs() const override;
 
        virtual std::vector<NumberCache>
        distribute_mg_dofs() const override;
 
        virtual NumberCache
        renumber_dofs(const std::vector<types::global_dof_index> &new_numbers)
          const override;
 
        // documentation is inherited
        virtual NumberCache
        renumber_mg_dofs(const unsigned int level,
                         const std::vector<types::global_dof_index>
                           &new_numbers) const override;
 
      private:
        ObserverPointer<DoFHandler<dim, spacedim>> dof_handler;
      };
 
 
      template <int dim, int spacedim>
      class ParallelDistributed : public PolicyBase<dim, spacedim>
      {
      public:
        ParallelDistributed(DoFHandler<dim, spacedim> &dof_handler);
 
        // documentation is inherited
        virtual NumberCache
        distribute_dofs() const override;
 
        // documentation is inherited
        virtual std::vector<NumberCache>
        distribute_mg_dofs() const override;
 
        // documentation is inherited
        virtual NumberCache
        renumber_dofs(const std::vector<types::global_dof_index> &new_numbers)
          const override;
 
        // documentation is inherited
        virtual NumberCache
        renumber_mg_dofs(const unsigned int level,
                         const std::vector<types::global_dof_index>
                           &new_numbers) const override;
 
      private:
        ObserverPointer<DoFHandler<dim, spacedim>> dof_handler;
      };
    } // namespace Policy
  }   // namespace DoFHandlerImplementation
} // namespace internal
 
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif