ItemFlags.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ItemFlags.h                                                 (C) 2000-2026 */
/*                                                                           */
/* Flags containing the characteristics of an entity.                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITEMFLAGS_H
#define ARCANE_CORE_ITEMFLAGS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArcaneGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ItemFlags
{
 public:
 
  using FlagType = Int32;
 
 public:
 
  // The 'readable' display of the flags is implemented in ItemPrinter.
  // It must be updated if values here are modified or added.
 
  enum : FlagType
  {
    II_Boundary = 1 << 1, 
    II_HasFrontCell = 1 << 2, 
    II_HasBackCell = 1 << 3, 
    II_FrontCellIsFirst = 1 << 4, 
    II_BackCellIsFirst = 1 << 5, 
    II_Own = 1 << 6, 
    II_Added = 1 << 7, 
    II_Suppressed = 1 << 8, 
    II_Shared = 1 << 9, 
    II_SubDomainBoundary = 1 << 10, 
    //II_JustRemoved = 1 << 11, //!< The entity has just been removed
    II_JustAdded = 1 << 12, 
    II_NeedRemove = 1 << 13, 
    II_SlaveFace = 1 << 14, 
    II_MasterFace = 1 << 15, 
    II_Detached = 1 << 16, 
    /*
     * \brief The entity uses edges instead of faces.
     *
     * This is only used for 2D cells of non-manifold meshes. If set, it means that
     * 1D entities are of type Edge and not of type Face.
     */
    II_HasEdgeFor1DItems = 1 << 17,
 
    II_Coarsen = 1 << 18, 
    II_DoNothing = 1 << 19, 
    II_Refine = 1 << 20, 
    II_JustRefined = 1 << 21, 
    II_JustCoarsened = 1 << 22, 
    II_Inactive = 1 << 23, 
    II_CoarsenInactive = 1 << 24, 

    II_Overlap = 1 << 25,

    II_InPatch = 1 << 26,
 
    II_UserMark1 = 1 << 30, 
    II_UserMark2 = 1 << 31 
  };
 
  static const int II_InterfaceFlags = II_Boundary + II_HasFrontCell + II_HasBackCell +
  II_FrontCellIsFirst + II_BackCellIsFirst;
 
  static constexpr bool isOwn(FlagType f) { return (f & II_Own) != 0; }
  static constexpr bool isShared(FlagType f) { return (f & II_Shared) != 0; }
  static constexpr bool isBoundary(FlagType f) { return (f & II_Boundary) != 0; }
  static constexpr bool isSubDomainBoundary(FlagType f) { return (f & II_Boundary) != 0; }
  static constexpr bool hasBackCell(FlagType f) { return (f & II_HasBackCell) != 0; }
  static constexpr bool isSubDomainBoundaryOutside(FlagType f)
  {
    return isSubDomainBoundary(f) && hasBackCell(f);
  }

  static constexpr Int32 backCellIndex(FlagType f)
  {
    if (f & II_HasBackCell)
      return (f & II_BackCellIsFirst) ? 0 : 1;
    return -1;
  }

  static constexpr Int32 frontCellIndex(FlagType f)
  {
    if (f & II_HasFrontCell)
      return (f & II_FrontCellIsFirst) ? 0 : 1;
    return -1;
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif