Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ItemGroupImplNull Class Reference

Null group class. More...

Inheritance diagram for Arcane::ItemGroupImplNull:
Collaboration diagram for Arcane::ItemGroupImplNull:

Public Member Functions

const Stringname () const
 Returns the group name.
const StringfullName () const
virtual void convert (NodeGroup &g)
virtual void convert (EdgeGroup &g)
virtual void convert (FaceGroup &g)
virtual void convert (CellGroup &g)
Public Member Functions inherited from Arcane::ItemGroupImpl
 ItemGroupImpl ()
 Constructs a null group.
 ItemGroupImpl (IItemFamily *family, const String &name)
 Brief: Constructs a group. Constructs an empty group named name, associated with the family family.
 ItemGroupImpl (IItemFamily *family, ItemGroupImpl *parent, const String &name)
 Brief: Constructs a child group of another group. Constructs a group named name which is a child of group parent. The type of this group is the same as that of the family it belongs to.
virtual ~ItemGroupImpl ()
 Releases resources.
virtual ISharedReferencesharedReference ()
const Stringname () const
 Group name.
const StringfullName () const
 Full group name (with mesh + family).
virtual Integer nbRef () const
 Number of references on the group.
ItemGroupImplparent () const
 Parent group (0 if none).
bool null () const
 Returns true if the group is null.
bool isOwn () const
 Returns whether the group contains only elements specific to the subdomain.
void setOwn (bool v)
 Sets whether the group property is local or not.
ItemGroupImplownGroup ()
 Group of entities owned by the entities of this group.
ItemGroupImplghostGroup ()
 Items in the group not owned by the subdomain.
ItemGroupImplinterfaceGroup ()
ItemGroupImplnodeGroup ()
 Group of nodes of the elements of this group.
ItemGroupImpledgeGroup ()
 Group of edges of the elements of this group.
ItemGroupImplfaceGroup ()
 Group of faces of the elements of this group.
ItemGroupImplcellGroup ()
 Group of cells of the elements of this group.
ItemGroupImplcreateSubGroup (const String &suffix, IItemFamily *family, ItemGroupComputeFunctor *functor)
 Creates a calculated subgroup.
ItemGroupImplfindSubGroup (const String &suffix)
 Accesses a calculated subgroup.
ItemGroupImplinnerFaceGroup ()
 Brief: Group of internal faces of the elements of this group.
ItemGroupImplouterFaceGroup ()
 Brief: Group of external faces of the elements of this group.
ItemGroupImplactiveCellGroup ()
 AMR.
ItemGroupImplownActiveCellGroup ()
 Brief: Group of own active cells of this group.
ItemGroupImpllevelCellGroup (const Integer &level)
 Brief: Group of active cells of this group.
ItemGroupImplownLevelCellGroup (const Integer &level)
 Brief: Group of own active cells of this group.
ItemGroupImplactiveFaceGroup ()
 Brief: Group of domain-specific active faces.
ItemGroupImplownActiveFaceGroup ()
 Brief: Group of active external faces of the elements of this group.
ItemGroupImplinnerActiveFaceGroup ()
 Brief: Group of active internal faces of the elements of this group.
ItemGroupImplouterActiveFaceGroup ()
 Brief: Group of active external faces of the elements of this group.
bool isLocalToSubDomain () const
 AMR OFF.
void setLocalToSubDomain (bool v)
 Sets the boolean indicating if the group is local to the subdomain.
IMeshmesh () const
 Mesh to which the group belongs (0 for the null group).
eItemKind itemKind () const
 Type of the group. It is the type of its elements.
IItemFamilyitemFamily () const
 Family to which the group belongs (or 0 if none).
Integer size () const
 Number of entities in the group.
bool empty () const
 True if the group is empty.
void clear ()
 Removes the entities from the group.
ItemGroup parentGroup ()
 Parent group.
void invalidate (bool force_recompute)
 Invalidates the group.
void addItems (Int32ConstArrayView items_local_id, bool check_if_present)
 Adds entities with local IDs items_local_id.
void setItems (Int32ConstArrayView items_local_id)
 Positions the group entities at items_local_id.
void setItems (Int32ConstArrayView items_local_id, bool do_sort)
 Positions the group entities at items_local_id, optionally sorting them.
void removeItems (Int32ConstArrayView items_local_id, bool check_if_present)
 Removes the entities items_local_id from the group.
void removeAddItems (Int32ConstArrayView removed_local_id, Int32ConstArrayView added_local_id, bool check_if_present)
 Removes and adds the entities removed_local_id and added_local_id from the group.
void removeSuppressedItems ()
 Removes entities from the group whose isSuppressed() flag is true.
void checkValid ()
 Checks that the group is valid.
bool checkNeedUpdate ()
 Updates the group if necessary.
Int32ConstArrayView itemsLocalId () const
 List of local IDs of the entities in this group.
void beginTransaction ()
 Starts a transaction.
void endTransaction ()
 Ends a transaction.
ItemInternalList itemsInternal () const
 List of entities that the group relies on.
ItemInfoListView itemInfoListView () const
 List of entities that the group relies on.
void setIsAllItems ()
 Indicates to this group that it is the group of all entities in the family.
bool isAllItems () const
 Indicates if the group is the group of all entities.
void changeIds (Int32ConstArrayView old_to_new_ids)
 Changes the indices of the group entities.
void applyOperation (IItemOperationByBasicType *operation)
 Applies the operation operation to the group entities.
bool needSynchronization () const
 Indicates if the group structurally needs parallel synchronization.
Int64 timestamp () const
 Returns the group's timestamp. This time is incremented after every modification.
void attachObserver (const void *ref, IItemGroupObserver *obs)
 Attaches an observer.
void detachObserver (const void *ref)
 Detaches an observer.
bool hasInfoObserver () const
 Indicates if the content of this group is observed.
void setComputeFunctor (IFunctor *functor)
 Defines a group calculation function.
bool hasComputeFunctor () const
 Indicates if the group is calculated.
void destroy ()
 Destroys the group. After this call, the group becomes a null group.
SharedPtrT< GroupIndexTablelocalIdToIndex ()
 Table of local IDs to a position for all entities in the group.
IVariableSynchronizersynchronizer ()
 Group synchronizer.
bool hasSynchronizer ()
 Indicates if this group has a synchronizer.
bool checkIsSorted () const
 Checks and returns whether the group is sorted by increasing uniqueId().
bool isContigousLocalIds () const
bool isContiguousLocalIds () const
 Indicates if the group entities have contiguous localIds().
void checkLocalIdsAreContigous () const
void checkLocalIdsAreContiguous () const
 Checks if the group entities have contiguous localIds().
void shrinkMemory ()
 Limits the maximum memory used by the group.
Int64 capacity () const
 Number of allocated elements.
ItemGroupImplInternal_internalApi () const
 Internal Arcane API.
Int32ArrayunguardedItemsLocalId (const bool self_invalidate=true)
 List of local IDs of the entities in this group.
Public Member Functions inherited from Arcane::SharedReference
void addRef () override
 Increments the reference counter.
void removeRef () override
 Decrements the reference counter.
Int32 refCount () const override
 Returns the value of the reference counter.
Public Member Functions inherited from Arcane::ISharedReference
virtual ~ISharedReference ()=default
 Releases resources.

Private Attributes

String m_name

Additional Inherited Members

Static Public Member Functions inherited from Arcane::ItemGroupImpl
static ItemGroupImplcheckSharedNull ()
static void _buildSharedNull ()
 Internal.
static void _destroySharedNull ()
 Internal.

Detailed Description

Null group class.

Definition at line 46 of file ItemGroupImpl.cc.

Constructor & Destructor Documentation

◆ ItemGroupImplNull()

Arcane::ItemGroupImplNull::ItemGroupImplNull ( )
inline

Definition at line 51 of file ItemGroupImpl.cc.

Member Function Documentation

◆ convert() [1/4]

virtual void Arcane::ItemGroupImplNull::convert ( CellGroup & g)
inlinevirtual

Definition at line 66 of file ItemGroupImpl.cc.

◆ convert() [2/4]

virtual void Arcane::ItemGroupImplNull::convert ( EdgeGroup & g)
inlinevirtual

Definition at line 64 of file ItemGroupImpl.cc.

◆ convert() [3/4]

virtual void Arcane::ItemGroupImplNull::convert ( FaceGroup & g)
inlinevirtual

Definition at line 65 of file ItemGroupImpl.cc.

◆ convert() [4/4]

virtual void Arcane::ItemGroupImplNull::convert ( NodeGroup & g)
inlinevirtual

Definition at line 63 of file ItemGroupImpl.cc.

◆ fullName()

const String & Arcane::ItemGroupImplNull::fullName ( ) const
inline

Definition at line 59 of file ItemGroupImpl.cc.

◆ name()

const String & Arcane::ItemGroupImplNull::name ( ) const
inline

Returns the group name.

Definition at line 58 of file ItemGroupImpl.cc.

Member Data Documentation

◆ m_name

String Arcane::ItemGroupImplNull::m_name
private

Definition at line 70 of file ItemGroupImpl.cc.


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