tria_base.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2008 - 2023 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_tria_base_h
#define dealii_distributed_tria_base_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/mpi_stub.h>
#include <deal.II/base/partitioner.h>
#include <deal.II/base/smartpointer.h>
#include <deal.II/base/subscriptor.h>
#include <deal.II/base/template_constraints.h>
 
#include <deal.II/grid/tria.h>
 
#include <functional>
#include <list>
#include <set>
#include <utility>
#include <vector>
 
 
DEAL_II_NAMESPACE_OPEN
 
namespace parallel
{
  template <int dim, int spacedim = dim>
  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
  class TriangulationBase : public ::Triangulation<dim, spacedim>
  {
  public:
    TriangulationBase(
      const MPI_Comm mpi_communicator,
      const typename ::Triangulation<dim, spacedim>::MeshSmoothing
                 smooth_grid = (::Triangulation<dim, spacedim>::none),
      const bool check_for_distorted_cells = false);
 
    virtual ~TriangulationBase() override;
 
    virtual MPI_Comm
    get_communicator() const override;
 
    virtual bool
    is_multilevel_hierarchy_constructed() const = 0;
 
    virtual void
    copy_triangulation(
      const ::Triangulation<dim, spacedim> &old_tria) override;
 
    unsigned int
    n_locally_owned_active_cells() const;
 
    virtual types::global_cell_index
    n_global_active_cells() const override;
 
    virtual std::size_t
    memory_consumption() const override;
 
 
    virtual unsigned int
    n_global_levels() const override;
 
    types::subdomain_id
    locally_owned_subdomain() const override;
 
    const std::set<types::subdomain_id> &
    ghost_owners() const;
 
    const std::set<types::subdomain_id> &
    level_ghost_owners() const;
 
    const std::weak_ptr<const Utilities::MPI::Partitioner>
    global_active_cell_index_partitioner() const override;
 
    const std::weak_ptr<const Utilities::MPI::Partitioner>
    global_level_cell_index_partitioner(
      const unsigned int level) const override;
 
    virtual std::vector<types::boundary_id>
    get_boundary_ids() const override;
 
    virtual std::vector<types::manifold_id>
    get_manifold_ids() const override;
 
    void
    communicate_locally_moved_vertices(
      const std::vector<bool> &vertex_locally_moved);
 
    virtual types::coarse_cell_id
    n_global_coarse_cells() const override;
 
  protected:
    const MPI_Comm mpi_communicator;
 
    types::subdomain_id my_subdomain;
 
    types::subdomain_id n_subdomains;
 
    struct NumberCache
    {
      unsigned int n_locally_owned_active_cells;
 
      types::global_cell_index n_global_active_cells;
 
      types::coarse_cell_id number_of_global_coarse_cells;
 
      unsigned int n_global_levels;
 
      std::set<types::subdomain_id> ghost_owners;
 
      std::set<types::subdomain_id> level_ghost_owners;
 
      std::shared_ptr<const Utilities::MPI::Partitioner>
        active_cell_index_partitioner;
 
      std::vector<std::shared_ptr<const Utilities::MPI::Partitioner>>
        level_cell_index_partitioners;
 
      NumberCache();
    };
 
    NumberCache number_cache;
 
    virtual void
    update_number_cache();
 
    void
    update_reference_cells() override;
 
    void
    reset_global_cell_indices();
  };
 
 
 
  template <int dim, int spacedim = dim>
  DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
  class DistributedTriangulationBase
    : public ::parallel::TriangulationBase<dim, spacedim>
  {
  public:
    DistributedTriangulationBase(
      const MPI_Comm mpi_communicator,
      const typename ::Triangulation<dim, spacedim>::MeshSmoothing
                 smooth_grid = (::Triangulation<dim, spacedim>::none),
      const bool check_for_distorted_cells = false);
 
    virtual void
    clear() override;
 
    using cell_iterator =
      typename ::Triangulation<dim, spacedim>::cell_iterator;
 
    using CellStatus =
      typename ::Triangulation<dim, spacedim>::CellStatus;
 
    virtual bool
    has_hanging_nodes() const override;
 
    virtual void
    save(const std::string &filename) const = 0;
 
    virtual void
    load(const std::string &filename) = 0;
 
    DEAL_II_DEPRECATED
    virtual void
    load(const std::string &filename, const bool autopartition) = 0;
 
    unsigned int
    register_data_attach(
      const std::function<std::vector<char>(const cell_iterator &,
                                            const CellStatus)> &pack_callback,
      const bool returns_variable_size_data);
 
    void
    notify_ready_to_unpack(
      const unsigned int handle,
      const std::function<
        void(const cell_iterator &,
             const CellStatus,
             const boost::iterator_range<std::vector<char>::const_iterator> &)>
        &unpack_callback);
 
  protected:
    void
    save_attached_data(const unsigned int global_first_cell,
                       const unsigned int global_num_cells,
                       const std::string &filename) const;
 
    void
    load_attached_data(const unsigned int global_first_cell,
                       const unsigned int global_num_cells,
                       const unsigned int local_num_cells,
                       const std::string &filename,
                       const unsigned int n_attached_deserialize_fixed,
                       const unsigned int n_attached_deserialize_variable);
 
    virtual void
    update_cell_relations() = 0;
 
    using cell_relation_t = typename std::pair<cell_iterator, CellStatus>;
 
    std::vector<cell_relation_t> local_cell_relations;
 
    struct CellAttachedData
    {
      unsigned int n_attached_data_sets;
 
      unsigned int n_attached_deserialize;
 
      using pack_callback_t = std::function<std::vector<char>(
        typename ::Triangulation<dim, spacedim>::cell_iterator,
        typename ::Triangulation<dim, spacedim>::CellStatus)>;
 
      std::vector<pack_callback_t> pack_callbacks_fixed;
      std::vector<pack_callback_t> pack_callbacks_variable;
    };
 
    CellAttachedData cell_attached_data;
 
    class DataTransfer
    {
    public:
      DataTransfer(const MPI_Comm mpi_communicator);
 
      void
      pack_data(const std::vector<cell_relation_t> &cell_relations,
                const std::vector<typename CellAttachedData::pack_callback_t>
                  &pack_callbacks_fixed,
                const std::vector<typename CellAttachedData::pack_callback_t>
                  &pack_callbacks_variable);
 
 
 
      void
      unpack_cell_status(std::vector<cell_relation_t> &cell_relations) const;
 
      void
      unpack_data(
        const std::vector<cell_relation_t> &cell_relations,
        const unsigned int                  handle,
        const std::function<void(
          const typename ::Triangulation<dim, spacedim>::cell_iterator &,
          const typename ::Triangulation<dim, spacedim>::CellStatus &,
          const boost::iterator_range<std::vector<char>::const_iterator> &)>
          &unpack_callback) const;
 
      void
      save(const unsigned int global_first_cell,
           const unsigned int global_num_cells,
           const std::string &filename) const;
 
      void
      load(const unsigned int global_first_cell,
           const unsigned int global_num_cells,
           const unsigned int local_num_cells,
           const std::string &filename,
           const unsigned int n_attached_deserialize_fixed,
           const unsigned int n_attached_deserialize_variable);
 
      void
      clear();
 
      bool variable_size_data_stored;
 
      std::vector<unsigned int> sizes_fixed_cumulative;
 
      std::vector<char> src_data_fixed;
      std::vector<char> dest_data_fixed;
 
      std::vector<int>  src_sizes_variable;
      std::vector<int>  dest_sizes_variable;
      std::vector<char> src_data_variable;
      std::vector<char> dest_data_variable;
 
    private:
      MPI_Comm mpi_communicator;
    };
 
    DataTransfer data_transfer;
  };
 
} // namespace parallel
 
DEAL_II_NAMESPACE_CLOSE
 
#endif