Interface for managing an incremental connectivity. More...

#include <arcane/core/IIncrementalItemConnectivity.h>

Inheritance diagram for Arcane::IIncrementalItemConnectivity:

Collaboration diagram for Arcane::IIncrementalItemConnectivity:

Public Member Functions
virtual String	name () const =0
	Name of the connectivity.
virtual ConstArrayView< IItemFamily * >	families () const =0
	List of families (sourceFamily() + targetFamily()).
virtual IItemFamily *	targetFamily () const =0
	Target family.
virtual void	addConnectedItem (ItemLocalId source_item, ItemLocalId target_local_id)=0
	Adds the entity with localId() target_local_id to the connectivity of source_item.
virtual void	setConnectedItems (ItemLocalId source_item, Int32ConstArrayView target_local_ids)
	Allocates and positions entities connected to source_item.
virtual void	removeConnectedItem (ItemLocalId source_item, ItemLocalId target_local_id)=0
	Removes the entity with localId() target_local_id from the connectivity of source_item.
virtual void	removeConnectedItems (ItemLocalId source_item)=0
	Removes all entities connected to source_item.
virtual void	replaceConnectedItem (ItemLocalId source_item, Integer index, ItemLocalId target_local_id)=0
	Replaces the entity at index index of source_item with the entity with localId() target_local_id.
virtual void	replaceConnectedItems (ItemLocalId source_item, Int32ConstArrayView target_local_ids)=0
	Replaces the entities of source_item with the entities with localId() target_local_ids.
virtual bool	hasConnectedItem (ItemLocalId source_item, ItemLocalId target_local_id) const =0
	Tests the existence of a connectivity between source_item and the entity with localId() target_local_id.
virtual Int32	maxNbConnectedItem () const =0
	Maximum number of entities connected to a source entity.
virtual Integer	preAllocatedSize () const =0
	Number of entities pre-allocated for the connectivity of each entity.
virtual void	setPreAllocatedSize (Integer value)=0
	Sets the number of entities to pre-allocate for the connectivity of each entity.
virtual void	dumpStats (std::ostream &out) const =0
	Dumps statistics on usage and memory used to the stream out.
virtual IIncrementalItemConnectivityInternal *	_internalApi ()=0
	Internal Arcane API.
Public Member Functions inherited from Arcane::IItemConnectivityAccessor
virtual Integer	nbConnectedItem (ItemLocalId lid) const =0
	Number of entities connected to the source entity with local ID lid.
virtual Int32	connectedItemLocalId (ItemLocalId lid, Integer index) const =0
	localId() of the index-th entity connected to the source entity with local ID lid
Public Member Functions inherited from Arcane::IIncrementalItemSourceConnectivity
virtual IItemFamily *	sourceFamily () const =0
	Source family.
virtual void	notifySourceFamilyLocalIdChanged (Int32ConstArrayView new_to_old_ids)=0
	Notifies the connectivity that the source family has been compacted.
virtual void	notifySourceItemAdded (ItemLocalId item)=0
	Notifies the connectivity that an entity has been added to the source family.
virtual void	reserveMemoryForNbSourceItems (Int32 n, bool pre_alloc_connectivity)
	Reserves memory for n source entities.
virtual void	notifyReadFromDump ()=0
	Notifies the connectivity that a read has been performed from a dump.
virtual Ref< IIncrementalItemSourceConnectivity >	toSourceReference ()=0
	Returns a reference to the instance.
Public Member Functions inherited from Arcane::IIncrementalItemTargetConnectivity
virtual void	notifyTargetFamilyLocalIdChanged (Int32ConstArrayView old_to_new_ids)=0
	Notifies the connectivity that the target family has been compacted.
virtual Ref< IIncrementalItemTargetConnectivity >	toTargetReference ()=0
	Returns a reference to the instance.

Private Member Functions
	ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS ()

Additional Inherited Members
Protected Member Functions inherited from Arcane::IItemConnectivityAccessor
virtual void	_initializeStorage (ConnectivityItemVector *civ)=0
	Implements the initialization of civ for this connectivity.
virtual ItemVectorView	_connectedItems (ItemLocalId item, ConnectivityItemVector &con_items) const =0
	Fills con_items with the entities connected to item.

Detailed Description

Interface for managing an incremental connectivity.

A connectivity links two families: a source (sourceFamily()) and a target (targetFamily()).

Definition at line 115 of file IIncrementalItemConnectivity.h.

Member Function Documentation

◆ _internalApi()

virtual IIncrementalItemConnectivityInternal * Arcane::IIncrementalItemConnectivity::_internalApi ( )

pure virtual

Internal Arcane API.

Implemented in Arcane::mesh::IncrementalItemConnectivityBase, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, and Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >.

◆ addConnectedItem()

virtual void Arcane::IIncrementalItemConnectivity::addConnectedItem	(	ItemLocalId	source_item,
		ItemLocalId	target_local_id )

pure virtual

Adds the entity with localId() target_local_id to the connectivity of source_item.

Implemented in Arcane::mesh::FaceToCellIncrementalItemConnectivity, Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

References setConnectedItems().

Referenced by setConnectedItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dumpStats()

virtual void Arcane::IIncrementalItemConnectivity::dumpStats ( std::ostream & out ) const

pure virtual

Dumps statistics on usage and memory used to the stream out.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

◆ families()

virtual ConstArrayView< IItemFamily * > Arcane::IIncrementalItemConnectivity::families ( ) const

pure virtual

List of families (sourceFamily() + targetFamily()).

Implemented in Arcane::mesh::AbstractIncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, and Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >.

◆ hasConnectedItem()

virtual bool Arcane::IIncrementalItemConnectivity::hasConnectedItem	(	ItemLocalId	source_item,
		ItemLocalId	target_local_id ) const

pure virtual

Tests the existence of a connectivity between source_item and the entity with localId() target_local_id.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

◆ maxNbConnectedItem()

virtual Int32 Arcane::IIncrementalItemConnectivity::maxNbConnectedItem ( ) const

pure virtual

Maximum number of entities connected to a source entity.

This value may be greater than the current maximum number of connected entities if removeConnectedItem() and removeConnectedItems() have been called.

Implemented in Arcane::mesh::IncrementalItemConnectivityBase, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, and Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >.

◆ name()

virtual String Arcane::IIncrementalItemConnectivity::name ( ) const

pure virtual

Name of the connectivity.

Implemented in Arcane::mesh::AbstractIncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, and Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >.

Referenced by Arcane::ItemConnectivityMng::isUpToDateWithSourceFamily(), Arcane::ItemConnectivityMng::isUpToDateWithTargetFamily(), and Arcane::ItemConnectivityMng::setUpToDate().

Here is the caller graph for this function:

◆ preAllocatedSize()

virtual Integer Arcane::IIncrementalItemConnectivity::preAllocatedSize ( ) const

pure virtual

Number of entities pre-allocated for the connectivity of each entity.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

Referenced by Arcane::mesh::IncrementalItemConnectivityBase::reserveMemoryForNbSourceItems().

Here is the caller graph for this function:

◆ removeConnectedItem()

virtual void Arcane::IIncrementalItemConnectivity::removeConnectedItem	(	ItemLocalId	source_item,
		ItemLocalId	target_local_id )

pure virtual

Removes the entity with localId() target_local_id from the connectivity of source_item.

Implemented in Arcane::mesh::FaceToCellIncrementalItemConnectivity, Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

Referenced by Arcane::mesh::ItemFamily::removeNeedRemoveMarkedItems().

Here is the caller graph for this function:

◆ removeConnectedItems()

virtual void Arcane::IIncrementalItemConnectivity::removeConnectedItems ( ItemLocalId source_item )

pure virtual

Removes all entities connected to source_item.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

Referenced by setConnectedItems().

Here is the caller graph for this function:

◆ replaceConnectedItem()

virtual void Arcane::IIncrementalItemConnectivity::replaceConnectedItem	(	ItemLocalId	source_item,
		Integer	index,
		ItemLocalId	target_local_id )

pure virtual

Replaces the entity at index index of source_item with the entity with localId() target_local_id.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

◆ replaceConnectedItems()

virtual void Arcane::IIncrementalItemConnectivity::replaceConnectedItems	(	ItemLocalId	source_item,
		Int32ConstArrayView	target_local_ids )

pure virtual

Replaces the entities of source_item with the entities with localId() target_local_ids.

Implemented in Arcane::mesh::IncrementalItemConnectivity, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, LegacyType, CustomType >, Arcane::mesh::NewWithLegacyConnectivity< SourceFamily, TargetFamily, typename LegacyConnectivityTraitsT< TargetFamily >::type >, and Arcane::mesh::OneItemIncrementalItemConnectivity.

◆ setConnectedItems()

void Arcane::IIncrementalItemConnectivity::setConnectedItems	(	ItemLocalId	source_item,
		Int32ConstArrayView	target_local_ids )

virtual

Allocates and positions entities connected to source_item.

If there were already entities connected to source_item, they are removed. target_local_ids contains the list of local IDs of entities to add. This method is equivalent to calling the following code but allows for memory management optimizations:

IIncrementalItemConnectivity* c = ...;
c->removeConnectedItems(source_item);
for( Int32 x : target_local_ids )
  c->addConnectedItem(source_item,ItemLocalId{x});