Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IItemConnectivityGhostPolicy Class Referenceabstract
Inheritance diagram for Arcane::IItemConnectivityGhostPolicy:
Collaboration diagram for Arcane::IItemConnectivityGhostPolicy:

Public Member Functions

virtual ~IItemConnectivityGhostPolicy ()
virtual Int32ConstArrayView communicatingRanks ()=0
 Ranks of sub-domains with which we communicate.
virtual Int32ConstArrayView sharedItems (const Integer rank, const String &family_name)=0
 gives the local_ids of the items of the family family_name shared for the connectivity with the rank process rank.
virtual Int32ConstArrayView sharedItemsConnectedItems (const Integer rank, const String &family_name)=0
 gives the local_ids of the items of the family family_name connected with the sharedItems(rank).
virtual void updateConnectivity (Int32ConstArrayView ghost_items, Int64ConstArrayView ghost_items_connected_items)=0
 updates the connectivity by connecting the added ghost items.

Detailed Description

Definition at line 28 of file IItemConnectivityGhostPolicy.h.

Constructor & Destructor Documentation

◆ ~IItemConnectivityGhostPolicy()

virtual Arcane::IItemConnectivityGhostPolicy::~IItemConnectivityGhostPolicy ( )
inlinevirtual

Class destructor

Definition at line 33 of file IItemConnectivityGhostPolicy.h.

Member Function Documentation

◆ communicatingRanks()

virtual Int32ConstArrayView Arcane::IItemConnectivityGhostPolicy::communicatingRanks ( )
pure virtual

Ranks of sub-domains with which we communicate.

Implemented in Arcane::GhostLayerFromConnectivityComputer.

◆ sharedItems()

virtual Int32ConstArrayView Arcane::IItemConnectivityGhostPolicy::sharedItems ( const Integer rank,
const String & family_name )
pure virtual

gives the local_ids of the items of the family family_name shared for the connectivity with the rank process rank.

The items are repeated as many times as they appear in a connectivity. If they are connected to three items, they appear three times. This array constitutes, with the sharedItemsConnectedItems array which is of the same size, a set of connected item pairs (one element of the connection in each array).

Implemented in Arcane::GhostLayerFromConnectivityComputer.

◆ sharedItemsConnectedItems()

virtual Int32ConstArrayView Arcane::IItemConnectivityGhostPolicy::sharedItemsConnectedItems ( const Integer rank,
const String & family_name )
pure virtual

gives the local_ids of the items of the family family_name connected with the sharedItems(rank).

The items are repeated as many times as they appear in a connectivity. If they are connected to three items, they appear three times. This array constitutes, with the sharedItems array which is of the same size, a set of connected item pairs (one element of the connection in each array).

Implemented in Arcane::GhostLayerFromConnectivityComputer.

◆ updateConnectivity()

virtual void Arcane::IItemConnectivityGhostPolicy::updateConnectivity ( Int32ConstArrayView ghost_items,
Int64ConstArrayView ghost_items_connected_items )
pure virtual

updates the connectivity by connecting the added ghost items.

The two arrays are of the same size, equal to the number of existing 1-to-1 connections. For each connection, the items are repeated, for example for two connections between identifiers 1-3 and 1-4 the arrays will be [ 1 1 ] and [ 3 4 ]

This format is identical to that of the two arrays shared_items and shared_items_connected_items. Warning, ghost_items_connected_items are unique identifiers (uids). They are the items to which the ghost_items were connected on their owning sub-domain. These items do not necessarily exist on the current sub-domain.

TODO: check if it is necessary to provide the families?

Implemented in Arcane::GhostLayerFromConnectivityComputer.


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