cell_id_translator.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) 2021 - 2026 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_cell_id_translator_h
#define dealii_cell_id_translator_h
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/template_constraints.h>
#include <deal.II/base/utilities.h>
 
#include <deal.II/grid/cell_id.h>
#include <deal.II/grid/tria_accessor.h>
 
#include <cstdint>
#include <limits>
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declarations
#ifndef DOXYGEN
template <int dim, int spacedim>
DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
class Triangulation;
#endif
 
namespace internal
{
  template <int dim>
  class CellIDTranslator
  {
  public:
    template <int spacedim>
    CellIDTranslator(const Triangulation<dim, spacedim> &tria);

    types::global_cell_index
    size() const;

    template <typename Accessor>
    types::global_cell_index
    translate(const TriaIterator<Accessor> &cell) const;

    template <typename Accessor>
    types::global_cell_index
    translate_level(const TriaIterator<Accessor> &cell) const;

    template <typename Accessor>
    types::global_cell_index
    translate(const TriaIterator<Accessor>  &cell,
              const types::global_cell_index i) const;

    CellId
    to_cell_id(const types::global_cell_index id) const;
 
  private:
    types::global_cell_index
    to_level_cell_index(const CellId &cell_id) const;

    const bool has_pyramids;

    const unsigned int max_children_per_cell;

    const types::global_cell_index n_coarse_cells;

    const types::global_cell_index n_global_levels;

    std::vector<types::global_cell_index> tree_sizes;
  };
 
 
 
  template <int dim>
  types::global_cell_index
  CellIDTranslator<dim>::size() const
  {
    return n_coarse_cells *
           (Utilities::pow<types::global_cell_index>(max_children_per_cell,
                                                     n_global_levels) -
            1);
  }
 
 
 
  template <int dim>
  template <typename Accessor>
  types::global_cell_index
  CellIDTranslator<dim>::translate(const TriaIterator<Accessor> &cell) const
  {
    static_assert(dim == Accessor::dimension &&
                    dim == Accessor::structure_dimension,
                  "The information can only be queried for cells.");
 
    return translate_level(cell) + tree_sizes[cell->level()];
  }
 
 
 
  template <int dim>
  template <typename Accessor>
  types::global_cell_index
  CellIDTranslator<dim>::translate_level(
    const TriaIterator<Accessor> &cell) const
  {
    static_assert(dim == Accessor::dimension &&
                    dim == Accessor::structure_dimension,
                  "The information can only be queried for cells.");
 
    return to_level_cell_index(
      CellAccessor<Accessor::dimension, Accessor::space_dimension>(*cell).id());
  }
 
 
 
  template <int dim>
  template <typename Accessor>
  types::global_cell_index
  CellIDTranslator<dim>::translate(const TriaIterator<Accessor>  &cell,
                                   const types::global_cell_index i) const
  {
    static_assert(dim == Accessor::dimension &&
                    dim == Accessor::structure_dimension,
                  "The information can only be queried for cells.");
 
    return (translate(cell) - tree_sizes[cell->level()]) *
             max_children_per_cell +
           i + tree_sizes[cell->level() + 1];
  }
} // namespace internal
 
DEAL_II_NAMESPACE_CLOSE
 
#endif