Reference to a group of a given kind. More...

#include <arcane/core/ItemGroup.h>

Inheritance diagram for Arcane::ItemGroupT< T >:

Collaboration diagram for Arcane::ItemGroupT< T >:

Public Types
typedef ItemGroupT< T >	ThatClass
	Type of this class.
typedef ItemTraitsT< T >	TraitsType
	Type of the class containing the entity characteristics.
typedef TraitsType::ItemType	ItemType
typedef const ItemType *	const_iterator
typedef ItemType *	iterator
typedef ItemType	value_type
typedef const ItemType &	const_reference
Public Types inherited from Arcane::ItemGroup
typedef ItemEnumerator	const_iter
	Iteration range type (to be removed).

Public Member Functions
	ItemGroupT (ItemGroupImpl *from)
	ItemGroupT (const ItemGroup &from)
	ItemGroupT (const ItemGroupT< T > &from)
const ItemGroupT< T > &	operator= (const ItemGroupT< T > &from)
const ItemGroupT< T > &	operator= (const ItemGroup &from)
ThatClass	own () const
ItemEnumeratorT< T >	enumerator () const
Public Member Functions inherited from Arcane::ItemGroup
	ItemGroup ()
	Constructs a null group.
	ItemGroup (ItemGroupImpl *prv)
	Constructs a group from the internal representation prv.
	ItemGroup (const ItemGroup &from)
	Constructs a reference to the group from.
ItemGroup &	operator= (const ItemGroup &from)=default
	Assigns a reference to the group from to this instance.
bool	null () const
	true means the group is the null group
const String &	name () const
	Group name.
const String &	fullName () const
	Group name.
Integer	size () const
	Number of elements in the group.
bool	empty () const
	Tests if the group is empty.
eItemKind	itemKind () const
	Group kind. This is the kind of its elements.
ItemGroupImpl *	internal () const
	Returns the group implementation.
IItemFamily *	itemFamily () const
	Entity family to which this group belongs (0 for the null group).
IMesh *	mesh () const
	Mesh to which this group belongs (0 for the null group).
ItemGroup	own () const
	Group equivalent to this one but containing only the local elements of the subdomain.
ItemGroup	ghost () const
bool	isOwn () const
	Returns whether the group contains only elements belonging to the subdomain.
void	setOwn (bool v)
	Sets whether the group property is local or not.
ItemGroup	interface () const
NodeGroup	nodeGroup () const
	Group of nodes of the elements of this group.
EdgeGroup	edgeGroup () const
	Group of edges of the elements of this group.
FaceGroup	faceGroup () const
	Group of faces of the elements of this group.
CellGroup	cellGroup () const
	Group of cells of the elements of this group.
FaceGroup	innerFaceGroup () const
	Group of internal faces of the elements of this group.
FaceGroup	outerFaceGroup () const
	Group of external faces of the elements of this group.
CellGroup	activeCellGroup () const
	AMR.
CellGroup	ownActiveCellGroup () const
	Group of own active cells of the elements of this group.
CellGroup	levelCellGroup (const Integer &level) const
	Group of level l cells of the elements of this group.
CellGroup	ownLevelCellGroup (const Integer &level) const
	Group of own level l cells of the elements of this group.
FaceGroup	activeFaceGroup () const
	Group of active faces.
FaceGroup	ownActiveFaceGroup () const
	Group of active faces belonging to the domain of the elements of this group.
FaceGroup	innerActiveFaceGroup () const
	Group of internal faces of the elements of this group.
FaceGroup	outerActiveFaceGroup () const
	Group of active external faces of the elements of this group.
ItemGroup	createSubGroup (const String &suffix, IItemFamily family, ItemGroupComputeFunctor functor) const
	Creates a computed subgroup.
ItemGroup	findSubGroup (const String &suffix) const
	Access to a subgroup.
bool	isLocalToSubDomain () const
	True if the group is local to the subdomain.
void	setLocalToSubDomain (bool v)
	Sets the boolean indicating if the group is local to the subdomain.
void	invalidate (bool force_recompute=false)
	Invalidates the group.
void	addItems (Int32ConstArrayView items_local_id, bool check_if_present=true)
	Adds entities.
void	removeItems (Int32ConstArrayView items_local_id, bool check_if_present=true)
	Removes entities.
void	setItems (Int32ConstArrayView items_local_id)
	Sets the entities of the group.
void	setItems (Int32ConstArrayView items_local_id, bool do_sort)
	Sets the entities of the group.
void	checkValid ()
	Internal check of group validity.
void	clear ()
	Clears the entities of the group.
void	applyOperation (IItemOperationByBasicType *operation) const
	Applies the operation operation to the entities of the group.
ItemVectorView	view () const
	View of the group entities.
bool	isAllItems () const
	Indicates if the group is that of all entities.
Int64	timestamp () const
void	incrementTimestamp () const
	Increments the last modification time of the group.
SharedPtrT< GroupIndexTable >	localIdToIndex () const
	Table of local ids to a position for all entities in the group.
IVariableSynchronizer *	synchronizer () const
	Group synchronizer.
bool	isAutoComputed () const
	True if it is an automatically computed group.
bool	hasSynchronizer () const
	Indicates if the group has an active synchronizer.
bool	checkIsSorted () const
	Checks and returns whether the group is sorted by increasing uniqueId().
ItemVectorView	_paddedView () const
	View of the group entities with padding for vectorization.
ItemVectorView	_unpaddedView () const
	View of the group entities without padding for vectorization.
ItemGroupImplInternal *	_internalApi () const
	Internal Arcane API.
ItemEnumerator	enumerator () const
	Enumerator over the group entities.

Protected Member Functions
void	_assign (const ItemGroup &from)
Protected Member Functions inherited from Arcane::ItemGroup
ItemVectorView	_view (bool do_padding) const

Additional Inherited Members
Static Protected Member Functions inherited from Arcane::ItemGroup
static ItemGroupImpl *	_check (ItemGroupImpl *impl, eItemKind ik)
	Returns the group impl if it is of kind kt, the null group otherwise.
Protected Attributes inherited from Arcane::ItemGroup
AutoRefT< ItemGroupImpl >	m_impl
	Internal representation of the group.

Detailed Description

template<typename T>
class Arcane::ItemGroupT< T >

Reference to a group of a given kind.

Definition at line 418 of file ItemGroup.h.

Member Typedef Documentation

◆ const_iterator

template<typename T>

typedef const ItemType* Arcane::ItemGroupT< T >::const_iterator

Definition at line 430 of file ItemGroup.h.

◆ const_reference

template<typename T>

typedef const ItemType& Arcane::ItemGroupT< T >::const_reference

Definition at line 433 of file ItemGroup.h.

◆ ItemType

template<typename T>

typedef TraitsType::ItemType Arcane::ItemGroupT< T >::ItemType

Definition at line 428 of file ItemGroup.h.

◆ iterator

template<typename T>

typedef ItemType* Arcane::ItemGroupT< T >::iterator

Definition at line 431 of file ItemGroup.h.

◆ ThatClass

template<typename T>

typedef ItemGroupT<T> Arcane::ItemGroupT< T >::ThatClass

Type of this class.

Definition at line 424 of file ItemGroup.h.

◆ TraitsType

template<typename T>

typedef ItemTraitsT<T> Arcane::ItemGroupT< T >::TraitsType

Type of the class containing the entity characteristics.

Definition at line 426 of file ItemGroup.h.

◆ value_type

template<typename T>

typedef ItemType Arcane::ItemGroupT< T >::value_type

Definition at line 432 of file ItemGroup.h.

Constructor & Destructor Documentation

◆ ItemGroupT() [1/3]

template<typename T>

Arcane::ItemGroupT< T >::ItemGroupT ( ItemGroupImpl * from )

inlineexplicit

Definition at line 438 of file ItemGroup.h.

◆ ItemGroupT() [2/3]

template<typename T>

Arcane::ItemGroupT< T >::ItemGroupT ( const ItemGroup & from )

inline

Definition at line 441 of file ItemGroup.h.

◆ ItemGroupT() [3/3]

template<typename T>

Arcane::ItemGroupT< T >::ItemGroupT ( const ItemGroupT< T > & from )

inline

Definition at line 444 of file ItemGroup.h.

Member Function Documentation

◆ _assign()

template<typename T>

void Arcane::ItemGroupT< T >::_assign ( const ItemGroup & from )

inlineprotected

Definition at line 472 of file ItemGroup.h.

◆ enumerator()

template<typename T>

ItemEnumeratorT< T > Arcane::ItemGroupT< T >::enumerator ( ) const

inline

Definition at line 465 of file ItemGroup.h.

◆ operator=() [1/2]

template<typename T>

const ItemGroupT< T > & Arcane::ItemGroupT< T >::operator= ( const ItemGroup & from )

inline

Definition at line 452 of file ItemGroup.h.

◆ operator=() [2/2]

template<typename T>

const ItemGroupT< T > & Arcane::ItemGroupT< T >::operator= ( const ItemGroupT< T > & from )

inline

Definition at line 447 of file ItemGroup.h.

◆ own()

template<typename T>

ThatClass Arcane::ItemGroupT< T >::own ( ) const

inline

Definition at line 460 of file ItemGroup.h.

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

ItemGroup.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reference

◆ ItemType

◆ iterator

◆ ThatClass

◆ TraitsType

◆ value_type

Constructor & Destructor Documentation

◆ ItemGroupT() [1/3]

◆ ItemGroupT() [2/3]

◆ ItemGroupT() [3/3]

Member Function Documentation

◆ _assign()

◆ enumerator()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ own()