cell_data_transfer.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) 2019 - 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_distributed_cell_data_transfer_h
#define dealii_distributed_cell_data_transfer_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/observer_pointer.h>
 
#include <deal.II/distributed/tria.h>
 
#include <deal.II/numerics/adaptation_strategies.h>
 
#include <boost/range/iterator_range.hpp>
 
#include <functional>
 
 
DEAL_II_NAMESPACE_OPEN
 
namespace parallel
{
  namespace distributed
  {
    template <int dim, int spacedim = dim, typename VectorType = Vector<double>>
    class CellDataTransfer
    {
    private:
      using value_type = typename VectorType::value_type;
 
    public:
      CellDataTransfer(
        const parallel::distributed::Triangulation<dim, spacedim>
                                         &triangulation,
        const bool                        transfer_variable_size_data = false,
        const std::function<std::vector<value_type>(
          const typename ::Triangulation<dim, spacedim>::cell_iterator
                          &parent,
          const value_type parent_value)> refinement_strategy =
          &::AdaptationStrategies::Refinement::
            preserve<dim, spacedim, value_type>,
        const std::function<value_type(
          const typename ::Triangulation<dim, spacedim>::cell_iterator
                                        &parent,
          const std::vector<value_type> &children_values)> coarsening_strategy =
          &::AdaptationStrategies::Coarsening::
            check_equality<dim, spacedim, value_type>);
 
      void
      prepare_for_coarsening_and_refinement(const VectorType &in);
 
      void
      prepare_for_coarsening_and_refinement(
        const std::vector<const VectorType *> &all_in);
 
      void
      prepare_for_serialization(const VectorType &in);
 
      void
      prepare_for_serialization(const std::vector<const VectorType *> &all_in);
 
      void
      unpack(VectorType &out);
 
      void
      unpack(std::vector<VectorType *> &all_out);
 
      void
      deserialize(VectorType &out);
 
      void
      deserialize(std::vector<VectorType *> &all_out);
 
    private:
      ObserverPointer<const parallel::distributed::Triangulation<dim, spacedim>,
                      CellDataTransfer<dim, spacedim, VectorType>>
        triangulation;
 
      const bool transfer_variable_size_data;
 
      const std::function<std::vector<value_type>(
        const typename Triangulation<dim, spacedim>::cell_iterator &parent,
        const value_type parent_value)>
        refinement_strategy;
 
      const std::function<value_type(
        const typename Triangulation<dim, spacedim>::cell_iterator &parent,
        const std::vector<value_type> &children_values)>
        coarsening_strategy;
 
      std::vector<const VectorType *> input_vectors;
 
      unsigned int handle;
 
      void
      register_data_attach();
 
      std::vector<char>
      pack_callback(const typename parallel::distributed::
                      Triangulation<dim, spacedim>::cell_iterator &cell,
                    const CellStatus                               status);
 
      void
      unpack_callback(
        const typename parallel::distributed::Triangulation<dim, spacedim>::
          cell_iterator &cell,
        const CellStatus status,
        const boost::iterator_range<std::vector<char>::const_iterator>
                                  &data_range,
        std::vector<VectorType *> &all_out);
    };
  } // namespace distributed
} // namespace parallel
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif /* dealii_distributed_cell_data_transfer_h */