dof_handler_policy.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 1998 - 2019 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_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 <map>
#  include <set>
#  include <vector>

DEAL_II_NAMESPACE_OPEN

// Forward declaration
#  ifndef DOXYGEN
template <int, int>
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 <class DoFHandlerType>
      class Sequential : public PolicyBase<DoFHandlerType::dimension,
                                           DoFHandlerType::space_dimension>
      {
      public:
        Sequential(DoFHandlerType &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:
        SmartPointer<DoFHandlerType> dof_handler;
      };



      template <class DoFHandlerType>
      class ParallelShared : public PolicyBase<DoFHandlerType::dimension,
                                               DoFHandlerType::space_dimension>
      {
      public:
        ParallelShared(DoFHandlerType &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:
        SmartPointer<DoFHandlerType> dof_handler;
      };


      template <class DoFHandlerType>
      class ParallelDistributed
        : public PolicyBase<DoFHandlerType::dimension,
                            DoFHandlerType::space_dimension>
      {
      public:
        ParallelDistributed(DoFHandlerType &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:
        SmartPointer<DoFHandlerType> dof_handler;
      };
    } // namespace Policy
  }   // namespace DoFHandlerImplementation
} // namespace internal



DEAL_II_NAMESPACE_CLOSE

#endif
/*--------------------------   dof_handler_policy.h -------------------------*/