tria_levels.h

// ---------------------------------------------------------------------
//
// Copyright (C) 1998 - 2018 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_tria_levels_h
#define dealii_tria_levels_h


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

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

#include <deal.II/grid/tria_object.h>
#include <deal.II/grid/tria_objects.h>

#include <boost/serialization/utility.hpp>

#include <cstdint>
#include <vector>

DEAL_II_NAMESPACE_OPEN

namespace internal
{
  namespace TriangulationImplementation
  {
    template <int dim>
    class TriaLevel
    {
    public:
      std::vector<std::uint8_t> refine_flags;

      std::vector<bool> coarsen_flags;


      std::vector<unsigned int> active_cell_indices;

      std::vector<std::pair<int, int>> neighbors;

      std::vector<types::subdomain_id> subdomain_ids;

      std::vector<types::subdomain_id> level_subdomain_ids;

      std::vector<int> parents;

      std::vector<bool> direction_flags;

      TriaObjects<TriaObject<dim>> cells;


      void
      reserve_space(const unsigned int total_cells,
                    const unsigned int dimension,
                    const unsigned int space_dimension);

      void
      monitor_memory(const unsigned int true_dimension) const;

      std::size_t
      memory_consumption() const;

      template <class Archive>
      void
      serialize(Archive &ar, const unsigned int version);

      DeclException2(ExcMemoryInexact,
                     int,
                     int,
                     << "The containers have sizes " << arg1 << " and " << arg2
                     << ", which is not as expected.");
    };

    // TODO: Replace TriaObjectsHex to avoid this specialization

    template <>
    class TriaLevel<3>
    {
    public:
      std::vector<std::uint8_t>        refine_flags;
      std::vector<bool>                coarsen_flags;
      std::vector<unsigned int>        active_cell_indices;
      std::vector<std::pair<int, int>> neighbors;
      std::vector<types::subdomain_id> subdomain_ids;
      std::vector<types::subdomain_id> level_subdomain_ids;
      std::vector<int>                 parents;

      // The following is not used
      // since we don't support
      // codim=1 meshes in 3d; only
      // needed to allow
      // compilation
      // TODO[TH]: this is no longer true and might be a bug.
      std::vector<bool> direction_flags;

      TriaObjectsHex cells;


      void
      reserve_space(const unsigned int total_cells,
                    const unsigned int dimension,
                    const unsigned int space_dimension);
      void
      monitor_memory(const unsigned int true_dimension) const;
      std::size_t
      memory_consumption() const;

      template <class Archive>
      void
      serialize(Archive &ar, const unsigned int version);

      DeclException2(ExcMemoryInexact,
                     int,
                     int,
                     << "The containers have sizes " << arg1 << " and " << arg2
                     << ", which is not as expected.");
    };



    template <int dim>
    template <class Archive>
    void
    TriaLevel<dim>::serialize(Archive &ar, const unsigned int)
    {
      ar &refine_flags &coarsen_flags;

      // do not serialize 'active_cell_indices' here. instead of storing them
      // to the stream and re-reading them again later, we just rebuild them
      // in Triangulation::load()

      ar &neighbors;
      ar &subdomain_ids;
      ar &level_subdomain_ids;
      ar &parents;
      ar &direction_flags;
      ar &cells;
    }



    template <class Archive>
    void
    TriaLevel<3>::serialize(Archive &ar, const unsigned int)
    {
      ar &refine_flags &coarsen_flags;

      // do not serialize 'active_cell_indices' here. instead of storing them
      // to the stream and re-reading them again later, we just rebuild them
      // in Triangulation::load()

      ar &neighbors;
      ar &subdomain_ids;
      ar &level_subdomain_ids;
      ar &parents;
      ar &direction_flags;
      ar &cells;
    }

  } // namespace TriangulationImplementation
} // namespace internal



DEAL_II_NAMESPACE_CLOSE

#endif