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 */
/*                                                                           */
/* Drapeaux contenant les caractéristiques d'une entité.                     */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ITEMFLAGS_H
#define ARCANE_CORE_ITEMFLAGS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArcaneGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Flags pour les caractéristiques des entités.
 *
 * Ces flags permettent de conserver des informations sur les entités (Item).
 * Ils sont réservés à %Arcane et ne doivent pas être utilisés en dehors
 * d'Arcane. La seule exception concerne les valeurs ItemFlags::II_UserMark1
 * et ItemFlags::II_UserMark2. Ils peuvent être associés aux entités via
 * les méthodes MutableItemBase::addFlags(), MutableItemBase::removeFlags() ou
 * ItemBase::hasFlags().
 */
class ARCANE_CORE_EXPORT ItemFlags
{
 public:
 
  using FlagType = Int32;
 
 public:
 
  // L'affichage 'lisible' des flags est implémenté dans ItemPrinter.
  // Il doit être mis à jour si des valeurs ici sont modifiées ou ajoutées.
 
  enum : FlagType
  {
    II_Boundary = 1 << 1, //!< L'entité est sur la frontière
    II_HasFrontCell = 1 << 2, //!< L'entité a une maille devant
    II_HasBackCell = 1 << 3, //!< L'entité a une maille derrière
    II_FrontCellIsFirst = 1 << 4, //!< La première maille de l'entité est la maille devant
    II_BackCellIsFirst = 1 << 5, //!< La première maille de l'entité est la maille derrière
    II_Own = 1 << 6, //!< L'entité est une entité propre au sous-domaine
    II_Added = 1 << 7, //!< L'entité vient d'être ajoutée
    II_Suppressed = 1 << 8, //!< L'entité vient d'être supprimée
    II_Shared = 1 << 9, //!< L'entité est partagée par un autre sous-domaine
    II_SubDomainBoundary = 1 << 10, //!< L'entité est à la frontière de deux sous-domaines
    //II_JustRemoved = 1 << 11, //!< L'entité vient d'être supprimé
    II_JustAdded = 1 << 12, //!< L'entité vient d'être ajoutée
    II_NeedRemove = 1 << 13, //!< L'entité doit être supprimé
    II_SlaveFace = 1 << 14, //!< L'entité est une face esclave d'une interface
    II_MasterFace = 1 << 15, //!< L'entité est une face maître d'une interface
    II_Detached = 1 << 16, //!< L'entité est détachée du maillage
    /*
     * \brief L'entité utilise des arêtes au lieu des faces.
     *
     * Cela n'est utilisé que pour les mailles 2D des maillages
     * non manifold. Si positionné, cela veut dire que les entités
     * de dimension 1 sont de type Edge et pas de type Face.
     */
    II_HasEdgeFor1DItems = 1 << 17,
 
    II_Coarsen = 1 << 18, //!<  L'entité est marquée pour dé-raffinement
    II_DoNothing = 1 << 19, //!<  L'entité est bloquée
    II_Refine = 1 << 20, //!<  L'entité est marquée pour raffinement
    II_JustRefined = 1 << 21, //!<  L'entité vient d'être raffinée
    II_JustCoarsened = 1 << 22, //!<  L'entité vient d'être dé-raffiné
    II_Inactive = 1 << 23, //!<  L'entité est inactive //COARSEN_INACTIVE,
    II_CoarsenInactive = 1 << 24, //!< L'entité est inactive et a des enfants tagués pour dé-raffinement
 
    /*!
     * \brief [AMR Patch] L'entité est marquée comme étant de recouvrement par
     * au moins un patch AMR.
     */
    II_Overlap = 1 << 25,
 
    /*!
     * \brief [AMR Patch] L'entité est marqué comme étant dans un patch AMR.
     */
    II_InPatch = 1 << 26,
 
    II_UserMark1 = 1 << 30, //!< Marque utilisateur
    II_UserMark2 = 1 << 31 //!< Marque utilisateur
  };
 
  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);
  }
  /*!
   * \brief Index dans la face la maille derrière.
   *
   * \retval -1 si pas de maillage derrière.
   * \retval 0 ou 1 pour l'index de la maille derrière.
   *
   * Si l'index est positif, il est possible de récupérer
   * la maille derrière via Face::cell(ItemFlags::backCellIndex(f)).
   */
  static constexpr Int32 backCellIndex(FlagType f)
  {
    if (f & II_HasBackCell)
      return (f & II_BackCellIsFirst) ? 0 : 1;
    return -1;
  }
  /*!
   * \brief Index dans la face la maille devant.
   *
   * \retval -1 si pas de maillage devant.
   * \retval 0 ou 1 pour l'index de la maille devant.
   *
   * Si l'index est positif, il est possible de récupérer
   * la maille devant via Face::cell(ItemFlags::frontCellIndex(f)).
   */
  static constexpr Int32 frontCellIndex(FlagType f)
  {
    if (f & II_HasFrontCell)
      return (f & II_FrontCellIsFirst) ? 0 : 1;
    return -1;
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif