Arcane::ItemFlags Class Reference

Flags for entity characteristics. More...

#include <arcane/core/ItemFlags.h>

Inheritance diagram for Arcane::ItemFlags:

Collaboration diagram for Arcane::ItemFlags:

Public Types
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_JustAdded = 1 << 12 , II_NeedRemove = 1 << 13 ,   II_SlaveFace = 1 << 14 , II_MasterFace = 1 << 15 , II_Detached = 1 << 16 , 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 }
using	FlagType = Int32

Static Public Member Functions
static constexpr bool	isOwn (FlagType f)
static constexpr bool	isShared (FlagType f)
static constexpr bool	isBoundary (FlagType f)
static constexpr bool	isSubDomainBoundary (FlagType f)
static constexpr bool	hasBackCell (FlagType f)
static constexpr bool	isSubDomainBoundaryOutside (FlagType f)
static constexpr Int32	backCellIndex (FlagType f)
	Index in the face for the back cell.
static constexpr Int32	frontCellIndex (FlagType f)
	Index in the face for the front cell.

Static Public Attributes
static const int	II_InterfaceFlags

Detailed Description

Flags for entity characteristics.

These flags allow storing information about entities (Item). They are reserved for Arcane and must not be used outside of Arcane. The only exception concerns the values ItemFlags::II_UserMark1 and ItemFlags::II_UserMark2. They can be associated with entities via the methods MutableItemBase::addFlags(), MutableItemBase::removeFlags() or ItemBase::hasFlags().

Definition at line 38 of file ItemFlags.h.

Member Typedef Documentation

FlagType

using Arcane::ItemFlags::FlagType = Int32

Definition at line 42 of file ItemFlags.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : FlagType

Enumerator
II_Boundary	The entity is on the boundary.
II_HasFrontCell	The entity has a front cell.
II_HasBackCell	The entity has a back cell.
II_FrontCellIsFirst	The first cell of the entity is the front cell.
II_BackCellIsFirst	The first cell of the entity is the back cell.
II_Own	The entity is a domain-specific entity.
II_Added	The entity has just been added.
II_Suppressed	The entity has just been suppressed.
II_Shared	The entity is shared by another subdomain.
II_SubDomainBoundary	The entity is at the boundary of two subdomains.
II_JustAdded	The entity has just been added.
II_NeedRemove	The entity must be removed.
II_SlaveFace	The entity is a slave face of an interface.
II_MasterFace	The entity is a master face of an interface.
II_Detached	The entity is detached from the mesh.
II_Coarsen	The entity is marked for coarsening.
II_DoNothing	The entity is blocked.
II_Refine	The entity is marked for refinement.
II_JustRefined	The entity has just been refined.
II_JustCoarsened	The entity has just been coarsened.
II_Inactive	The entity is inactive //COARSEN_INACTIVE,.
II_CoarsenInactive	The entity is inactive and has children tagged for coarsening.
II_Overlap	[AMR Patch] The entity is marked as overlapping with at least one AMR patch.
II_InPatch	[AMR Patch] The entity is marked as being in an AMR patch.
II_UserMark1	User mark.
II_UserMark2	User mark.

Definition at line 49 of file ItemFlags.h.

Member Function Documentation

backCellIndex()

constexpr Int32 Arcane::ItemFlags::backCellIndex ( FlagType f )

inlinestaticconstexpr

Index in the face for the back cell.

Return values

-1	if there is no cell behind.
0	or 1 for the index of the back cell.

If the index is positive, it is possible to retrieve the back cell via Face::cell(ItemFlags::backCellIndex(f)).

Definition at line 120 of file ItemFlags.h.

References II_BackCellIsFirst, and II_HasBackCell.

frontCellIndex()

constexpr Int32 Arcane::ItemFlags::frontCellIndex ( FlagType f )

inlinestaticconstexpr

Index in the face for the front cell.

Return values

-1	if there is no cell in front.
0	or 1 for the index of the front cell.

If the index is positive, it is possible to retrieve the front cell via Face::cell(ItemFlags::frontCellIndex(f)).

Definition at line 136 of file ItemFlags.h.

References II_FrontCellIsFirst, and II_HasFrontCell.

hasBackCell()

constexpr bool Arcane::ItemFlags::hasBackCell ( FlagType f )

inlinestaticconstexpr

Definition at line 105 of file ItemFlags.h.

isBoundary()

constexpr bool Arcane::ItemFlags::isBoundary ( FlagType f )

inlinestaticconstexpr

Definition at line 103 of file ItemFlags.h.

isOwn()

constexpr bool Arcane::ItemFlags::isOwn ( FlagType f )

inlinestaticconstexpr

Definition at line 101 of file ItemFlags.h.

isShared()

constexpr bool Arcane::ItemFlags::isShared ( FlagType f )

inlinestaticconstexpr

Definition at line 102 of file ItemFlags.h.

isSubDomainBoundary()

constexpr bool Arcane::ItemFlags::isSubDomainBoundary ( FlagType f )

inlinestaticconstexpr

Definition at line 104 of file ItemFlags.h.

isSubDomainBoundaryOutside()

constexpr bool Arcane::ItemFlags::isSubDomainBoundaryOutside ( FlagType f )

inlinestaticconstexpr

Definition at line 106 of file ItemFlags.h.

Member Data Documentation

II_InterfaceFlags

const int Arcane::ItemFlags::II_InterfaceFlags

static

Initial value:

                                   = II_Boundary + II_HasFrontCell + II_HasBackCell +
II_FrontCellIsFirst + II_BackCellIsFirst

Definition at line 98 of file ItemFlags.h.

---

The documentation for this class was generated from the following file:

• ItemFlags.h