grid_tools_cache.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) 2017 - 2025 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_grid_grid_tools_cache_h
#define dealii_grid_grid_tools_cache_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/enable_observer_pointer.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/point.h>
 
#include <deal.II/fe/mapping.h>
 
#include <deal.II/grid/grid_tools_cache_update_flags.h>
#include <deal.II/grid/tria.h>
#include <deal.II/grid/tria_accessor.h>
#include <deal.II/grid/tria_iterator.h>
 
#include <deal.II/numerics/rtree.h>
 
#include <boost/signals2.hpp>
 
#include <atomic>
#include <cmath>
#include <set>
 
 
DEAL_II_NAMESPACE_OPEN
 
namespace GridTools
{
  template <int dim, int spacedim = dim>
  class Cache : public EnableObserverPointer
  {
  public:
    Cache(const Triangulation<dim, spacedim> &tria,
          const Mapping<dim, spacedim>       &mapping);
 
    Cache(const Triangulation<dim, spacedim> &tria);
 
    ~Cache() override;
 
    void
    mark_for_update(const CacheUpdateFlags &flags = update_all);
 
 
    const std::vector<
      std::set<typename Triangulation<dim, spacedim>::active_cell_iterator>> &
    get_vertex_to_cell_map() const;
 
    const std::vector<std::vector<Tensor<1, spacedim>>> &
    get_vertex_to_cell_centers_directions() const;
 
    const std::map<unsigned int, Point<spacedim>> &
    get_used_vertices() const;
 
    const RTree<std::pair<Point<spacedim>, unsigned int>> &
    get_used_vertices_rtree() const;
 
    const RTree<
      std::pair<BoundingBox<spacedim>,
                typename Triangulation<dim, spacedim>::active_cell_iterator>> &
    get_cell_bounding_boxes_rtree() const;
 
    const RTree<
      std::pair<BoundingBox<spacedim>,
                typename Triangulation<dim, spacedim>::active_cell_iterator>> &
    get_locally_owned_cell_bounding_boxes_rtree() const;
 
 
    const std::vector<std::set<unsigned int>> &
    get_vertex_to_neighbor_subdomain() const;
 
    const std::map<unsigned int, std::set<types::subdomain_id>> &
    get_vertices_with_ghost_neighbors() const;
 
    const Triangulation<dim, spacedim> &
    get_triangulation() const;
 
    const Mapping<dim, spacedim> &
    get_mapping() const;
 
 
    const RTree<std::pair<BoundingBox<spacedim>, unsigned int>> &
    get_covering_rtree(const unsigned int level = 0) const;
 
  private:
    mutable std::atomic<std::underlying_type_t<CacheUpdateFlags>> update_flags;
 
    ObserverPointer<const Triangulation<dim, spacedim>, Cache<dim, spacedim>>
      tria;
 
    ObserverPointer<const Mapping<dim, spacedim>, Cache<dim, spacedim>> mapping;
 
 
    mutable std::vector<
      std::set<typename Triangulation<dim, spacedim>::active_cell_iterator>>
                       vertex_to_cells;
    mutable std::mutex vertex_to_cells_mutex;
 
    mutable std::vector<std::vector<Tensor<1, spacedim>>>
                       vertex_to_cell_centers;
    mutable std::mutex vertex_to_cell_centers_mutex;
 
    mutable std::map<unsigned int,
                     RTree<std::pair<BoundingBox<spacedim>, unsigned int>>>
                       covering_rtree;
    mutable std::mutex covering_rtree_mutex;
 
    mutable std::map<unsigned int, Point<spacedim>> used_vertices;
    mutable std::mutex                              used_vertices_mutex;
 
    mutable RTree<std::pair<Point<spacedim>, unsigned int>> used_vertices_rtree;
    mutable std::mutex used_vertices_rtree_mutex;
 
    mutable RTree<
      std::pair<BoundingBox<spacedim>,
                typename Triangulation<dim, spacedim>::active_cell_iterator>>
                       cell_bounding_boxes_rtree;
    mutable std::mutex cell_bounding_boxes_rtree_mutex;
 
    mutable RTree<
      std::pair<BoundingBox<spacedim>,
                typename Triangulation<dim, spacedim>::active_cell_iterator>>
                       locally_owned_cell_bounding_boxes_rtree;
    mutable std::mutex locally_owned_cell_bounding_boxes_rtree_mutex;
 
    mutable std::vector<std::set<unsigned int>> vertex_to_neighbor_subdomain;
    mutable std::mutex vertex_to_neighbor_subdomain_mutex;
 
    mutable std::map<unsigned int, std::set<::types::subdomain_id>>
                       vertices_with_ghost_neighbors;
    mutable std::mutex vertices_with_ghost_neighbors_mutex;
 
    boost::signals2::connection tria_change_signal;
 
    boost::signals2::connection tria_create_signal;
  };
 
 
 
  // Inline functions
  template <int dim, int spacedim>
  inline const Triangulation<dim, spacedim> &
  Cache<dim, spacedim>::get_triangulation() const
  {
    return *tria;
  }
 
 
 
  template <int dim, int spacedim>
  inline const Mapping<dim, spacedim> &
  Cache<dim, spacedim>::get_mapping() const
  {
    Assert(mapping, ExcNotInitialized());
    return *mapping;
  }
} // namespace GridTools
 
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif