adaptation_strategies.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) 2020 - 2023 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_adaptation_strategies_h
#define dealii_adaptation_strategies_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
 
#include <deal.II/grid/tria_accessor.h>
 
#include <algorithm>
#include <numeric>
#include <typeinfo>
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace AdaptationStrategies
{
  namespace Refinement
  {
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    preserve(const typename ::Triangulation<dim, spacedim>::cell_iterator
                             &parent,
             const value_type parent_value);
 
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    split(const typename ::Triangulation<dim, spacedim>::cell_iterator
                          &parent,
          const value_type parent_value);
 
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    l2_norm(const typename ::Triangulation<dim, spacedim>::cell_iterator
                            &parent,
            const value_type parent_value);
  } // namespace Refinement
 
  namespace Coarsening
  {
    template <int dim, int spacedim, typename value_type>
    value_type
    check_equality(
      const typename ::Triangulation<dim, spacedim>::cell_iterator
                                    &parent,
      const std::vector<value_type> &children_values);
 
    template <int dim, int spacedim, typename value_type>
    value_type
    sum(const typename ::Triangulation<dim, spacedim>::cell_iterator
                                      &parent,
        const std::vector<value_type> &children_values);
 
    template <int dim, int spacedim, typename value_type>
    value_type
    l2_norm(const typename ::Triangulation<dim, spacedim>::cell_iterator
                                          &parent,
            const std::vector<value_type> &children_values);
 
    template <int dim, int spacedim, typename value_type>
    value_type
    mean(const typename ::Triangulation<dim, spacedim>::cell_iterator
                                       &parent,
         const std::vector<value_type> &children_values);
 
    template <int dim, int spacedim, typename value_type>
    value_type
    max(const typename ::Triangulation<dim, spacedim>::cell_iterator
                                      &parent,
        const std::vector<value_type> &children_values);
  } // namespace Coarsening
} // namespace AdaptationStrategies
 
 
 
/* ---------------- template functions ---------------- */
 
#ifndef DOXYGEN
 
namespace AdaptationStrategies
{
  namespace Refinement
  {
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    preserve(const typename ::Triangulation<dim, spacedim>::cell_iterator
                             &parent,
             const value_type parent_value)
    {
      Assert(parent->n_children() > 0, ExcInternalError());
      return std::vector<value_type>(parent->n_children(), parent_value);
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    split(const typename ::Triangulation<dim, spacedim>::cell_iterator
                          &parent,
          const value_type parent_value)
    {
      static_assert(std::is_arithmetic_v<value_type> &&
                      !std::is_same_v<value_type, bool>,
                    "The provided value_type may not meet the requirements "
                    "of this function.");
 
      Assert(parent->n_children() > 0, ExcInternalError());
      return std::vector<value_type>(parent->n_children(),
                                     parent_value / parent->n_children());
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    std::vector<value_type>
    l2_norm(const typename ::Triangulation<dim, spacedim>::cell_iterator
                            &parent,
            const value_type parent_value)
    {
      static_assert(std::is_arithmetic_v<value_type> &&
                      !std::is_same_v<value_type, bool>,
                    "The provided value_type may not meet the requirements "
                    "of this function.");
 
      Assert(parent->n_children() > 0, ExcInternalError());
      return std::vector<value_type>(parent->n_children(),
                                     parent_value /
                                       std::sqrt(parent->n_children()));
    }
  } // namespace Refinement
 
 
 
  namespace Coarsening
  {
    template <int dim, int spacedim, typename value_type>
    value_type
    check_equality(
      const typename ::Triangulation<dim, spacedim>::cell_iterator &,
      const std::vector<value_type> &children_values)
    {
      Assert(!children_values.empty(), ExcInternalError());
 
      const auto first_child = children_values.cbegin();
      for (auto other_child = first_child + 1;
           other_child != children_values.cend();
           ++other_child)
        Assert(*first_child == *other_child,
               ExcMessage(
                 "Values on cells that will be coarsened are not equal!"));
 
      return *first_child;
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    value_type
    sum(const typename ::Triangulation<dim, spacedim>::cell_iterator &,
        const std::vector<value_type> &children_values)
    {
      static_assert(std::is_arithmetic_v<value_type> &&
                      !std::is_same_v<value_type, bool>,
                    "The provided value_type may not meet the requirements "
                    "of this function.");
 
      Assert(!children_values.empty(), ExcInternalError());
      return std::accumulate(children_values.cbegin(),
                             children_values.cend(),
                             static_cast<value_type>(0));
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    value_type
    l2_norm(
      const typename ::Triangulation<dim, spacedim>::cell_iterator &,
      const std::vector<value_type> &children_values)
    {
      static_assert(std::is_arithmetic_v<value_type> &&
                      !std::is_same_v<value_type, bool>,
                    "The provided value_type may not meet the requirements "
                    "of this function.");
 
      Assert(!children_values.empty(), ExcInternalError());
      return std::sqrt(std::inner_product(children_values.cbegin(),
                                          children_values.cend(),
                                          children_values.cbegin(),
                                          static_cast<value_type>(0)));
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    value_type
    mean(const typename ::Triangulation<dim, spacedim>::cell_iterator
                                       &parent,
         const std::vector<value_type> &children_values)
    {
      return sum<dim, spacedim, value_type>(parent, children_values) /
             children_values.size();
    }
 
 
 
    template <int dim, int spacedim, typename value_type>
    value_type
    max(const typename ::Triangulation<dim, spacedim>::cell_iterator &,
        const std::vector<value_type> &children_values)
    {
      Assert(!children_values.empty(), ExcInternalError());
      return *std::max_element(children_values.cbegin(),
                               children_values.cend());
    }
  } // namespace Coarsening
} // namespace AdaptationStrategies
 
#endif
 
DEAL_II_NAMESPACE_CLOSE
 
#endif /* dealii_adaptation_strategies_h */