error_predictor.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2019 - 2020 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_distributed_error_predictor_h
#define dealii_distributed_error_predictor_h

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

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

#include <boost/range/iterator_range.hpp>

#include <vector>


DEAL_II_NAMESPACE_OPEN


// forward declarations
#ifndef DOXYGEN
template <typename Number>
class Vector;

namespace parallel
{
  namespace distributed
  {
    template <int dim, int spacedim>
    class Triangulation;
  }
} // namespace parallel

namespace hp
{
  template <int dim, int spacedim>
  class DoFHandler;
}
#endif


namespace parallel
{
  namespace distributed
  {
    template <int dim, int spacedim = dim>
    class ErrorPredictor
    {
    public:
      ErrorPredictor(const hp::DoFHandler<dim, spacedim> &dof);

      void
      prepare_for_coarsening_and_refinement(
        const std::vector<const Vector<float> *> &all_in,
        const double                              gamma_p = std::sqrt(0.4),
        const double                              gamma_h = 2.,
        const double                              gamma_n = 1.);

      void
      prepare_for_coarsening_and_refinement(
        const Vector<float> &in,
        const double         gamma_p = std::sqrt(0.4),
        const double         gamma_h = 2.,
        const double         gamma_n = 1.);

      void
      unpack(std::vector<Vector<float> *> &all_out);

      void
      unpack(Vector<float> &out);

    private:
      SmartPointer<const hp::DoFHandler<dim, spacedim>,
                   ErrorPredictor<dim, spacedim>>
        dof_handler;

      std::vector<const Vector<float> *> error_indicators;

      unsigned int handle;

      double gamma_p, gamma_h, gamma_n;

      std::vector<char>
      pack_callback(
        const typename Triangulation<dim, spacedim>::cell_iterator &cell,
        const typename Triangulation<dim, spacedim>::CellStatus     status);

      void
      unpack_callback(
        const typename Triangulation<dim, spacedim>::cell_iterator &cell,
        const typename Triangulation<dim, spacedim>::CellStatus     status,
        const boost::iterator_range<std::vector<char>::const_iterator>
          &                           data_range,
        std::vector<Vector<float> *> &all_out);


      void
      register_data_attach();
    };
  } // namespace distributed
} // namespace parallel


DEAL_II_NAMESPACE_CLOSE

#endif