tria_objects_orientations.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2023 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_tria_objects_orientations_h
#define dealii_tria_objects_orientations_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/memory_consumption.h>
#include <deal.II/base/utilities.h>
 
#include <deal.II/grid/reference_cell.h>
 
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace internal
{
  namespace TriangulationImplementation
  {
    class TriaObjectsOrientations
    {
    public:
      TriaObjectsOrientations();
 
      TriaObjectsOrientations(const unsigned int n_objects);
 
      unsigned int
      n_objects() const;
 
      void
      reinit(const unsigned int n_objects);
 
      void
      resize(const unsigned int n_objects);
 
      std::size_t
      memory_consumption() const;
 
      unsigned char
      get_combined_orientation(const unsigned int object) const;
 
      bool
      get_orientation(const unsigned int object) const;
 
      bool
      get_rotation(const unsigned int object) const;
 
      bool
      get_flip(const unsigned int object) const;
 
      void
      set_combined_orientation(const unsigned int  object,
                               const unsigned char value);
 
      template <class Archive>
      void
      serialize(Archive &ar, const unsigned int version);
 
    private:
      unsigned int n_stored_objects;
 
      std::vector<unsigned char> flags;
    };
 
    //----------------------------------------------------------------------//
 
    inline TriaObjectsOrientations::TriaObjectsOrientations()
    {
      reinit(0);
    }
 
 
 
    inline TriaObjectsOrientations::TriaObjectsOrientations(
      const unsigned int n_objects)
    {
      reinit(n_objects);
    }
 
 
 
    inline void
    TriaObjectsOrientations::reinit(const unsigned int n_objects)
    {
      n_stored_objects = n_objects;
      // Assign to the default orientation
      flags.assign(n_objects,
                   ReferenceCell::default_combined_face_orientation());
    }
 
 
 
    inline void
    TriaObjectsOrientations::resize(const unsigned int n_objects)
    {
      flags.resize(n_objects,
                   ReferenceCell::default_combined_face_orientation());
      n_stored_objects = n_objects;
    }
 
 
 
    inline std::size_t
    TriaObjectsOrientations::memory_consumption() const
    {
      return MemoryConsumption::memory_consumption(n_stored_objects) +
             MemoryConsumption::memory_consumption(flags);
    }
 
 
 
    inline unsigned int
    TriaObjectsOrientations::n_objects() const
    {
      return n_stored_objects;
    }
 
 
 
    inline unsigned char
    TriaObjectsOrientations::get_combined_orientation(
      const unsigned int object) const
    {
      AssertIndexRange(object, n_stored_objects);
      return flags[object];
    }
 
 
 
    inline bool
    TriaObjectsOrientations::get_orientation(const unsigned int object) const
    {
      AssertIndexRange(object, n_stored_objects);
      return Utilities::get_bit(flags[object], 0);
    }
 
 
 
    inline bool
    TriaObjectsOrientations::get_rotation(const unsigned int object) const
    {
      AssertIndexRange(object, n_stored_objects);
      return Utilities::get_bit(flags[object], 1);
    }
 
 
 
    inline bool
    TriaObjectsOrientations::get_flip(const unsigned int object) const
    {
      AssertIndexRange(object, n_stored_objects);
      return Utilities::get_bit(flags[object], 2);
    }
 
 
 
    inline void
    TriaObjectsOrientations::set_combined_orientation(const unsigned int object,
                                                      const unsigned char value)
    {
      AssertIndexRange(object, n_stored_objects);
      flags[object] = value;
    }
 
 
 
    template <class Archive>
    void
    TriaObjectsOrientations::serialize(Archive &ar, const unsigned int)
    {
      ar &n_stored_objects &flags;
    }
  } // namespace TriangulationImplementation
} // namespace internal
 
DEAL_II_NAMESPACE_CLOSE
 
#endif