Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ParallelMngUtils.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ParallelMngUtils.h (C) 2000-2026 */
9/* */
10/* Utility functions associated with 'IParallelMng'. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_PARALLELMNGUTILS_H
13#define ARCANE_CORE_PARALLELMNGUTILS_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/UtilsTypes.h"
18
19#include "arcane/core/ArcaneTypes.h"
20#include "arcane/core/Parallel.h"
21
22/*---------------------------------------------------------------------------*/
23/*---------------------------------------------------------------------------*/
24
28namespace Arcane::ParallelMngUtils
29{
30
35extern "C++" ARCANE_CORE_EXPORT Ref<IGetVariablesValuesParallelOperation>
36createGetVariablesValuesOperationRef(IParallelMng* pm);
37
39extern "C++" ARCANE_CORE_EXPORT Ref<ITransferValuesParallelOperation>
40createTransferValuesOperationRef(IParallelMng* pm);
41
43extern "C++" ARCANE_CORE_EXPORT Ref<IParallelExchanger>
44createExchangerRef(IParallelMng* pm);
45
50extern "C++" ARCANE_CORE_EXPORT Ref<IVariableSynchronizer>
51createSynchronizerRef(IParallelMng* pm, IItemFamily* family);
52
57extern "C++" ARCANE_CORE_EXPORT Ref<IVariableSynchronizer>
58createSynchronizerRef(IParallelMng* pm, const ItemGroup& group);
59
65extern "C++" ARCANE_CORE_EXPORT Ref<IParallelTopology>
66createTopologyRef(IParallelMng* pm);
67
82extern "C++" ARCANE_CORE_EXPORT Ref<IParallelMng>
83createSubParallelMngRef(IParallelMng* pm, Int32 color, Int32 key);
84
90extern "C++" ARCANE_CORE_EXPORT Ref<ISerializeMessage>
91createSendSerializeMessageRef(IParallelMng* pm, Int32 rank);
92
98extern "C++" ARCANE_CORE_EXPORT Ref<ISerializeMessage>
99createReceiveSerializeMessageRef(IParallelMng* pm, Int32 rank);
100
114extern "C++" ARCANE_CORE_EXPORT bool
115isMachineShMemWinAvailable(IParallelMng* pm);
116
117/*---------------------------------------------------------------------------*/
118/*---------------------------------------------------------------------------*/
119
120} // End namespace Arcane::ParallelMngUtils
121
122/*---------------------------------------------------------------------------*/
123/*---------------------------------------------------------------------------*/
124
125#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Parallel.h
File containing declarations concerning the message passing model.
UtilsTypes.h
Declarations of types used in Arcane.
Arcane::IParallelMng
Interface of the parallelism manager for a subdomain.
Definition IParallelMng.h:53
Arcane::Ref
Reference to an instance.
Definition arccore/src/base/arccore/base/Ref.h:325
Arcane::ParallelMngUtils
Utility functions associated with IParallelMng.
Definition ParallelMngUtils.cc:118
Arcane::ParallelMngUtils::createSendSerializeMessageRef
Ref< ISerializeMessage > createSendSerializeMessageRef(IParallelMng *pm, Int32 rank)
Creates a non-blocking serialization message for sending to rank rank.
Arcane::ParallelMngUtils::createSubParallelMngRef
Ref< IParallelMng > createSubParallelMngRef(IParallelMng *pm, Int32 color, Int32 key)
Creates a new parallelism manager for a subset of ranks.
Definition ParallelMngUtils.cc:160
Arcane::ParallelMngUtils::createExchangerRef
Ref< IParallelExchanger > createExchangerRef(IParallelMng *pm)
Returns an interface to transfer messages between ranks.
Definition ParallelMngUtils.cc:136
Arcane::ParallelMngUtils::createGetVariablesValuesOperationRef
Ref< IGetVariablesValuesParallelOperation > createGetVariablesValuesOperationRef(IParallelMng *pm)
Returns an operation to retrieve the values of a variable on the entities of another subdomain.
Definition ParallelMngUtils.cc:124
Arcane::ParallelMngUtils::createTransferValuesOperationRef
Ref< ITransferValuesParallelOperation > createTransferValuesOperationRef(IParallelMng *pm)
Returns an operation to transfer values between ranks.
Definition ParallelMngUtils.cc:130
Arcane::ParallelMngUtils::createTopologyRef
Ref< IParallelTopology > createTopologyRef(IParallelMng *pm)
Creates an instance containing information about the rank topology of this manager.
Definition ParallelMngUtils.cc:154
Arcane::ParallelMngUtils::isMachineShMemWinAvailable
bool isMachineShMemWinAvailable(IParallelMng *pm)
Function to determine if shared memory window mode is supported and if its use is possible.
Definition ParallelMngUtils.cc:165
Arcane::ParallelMngUtils::createReceiveSerializeMessageRef
Ref< ISerializeMessage > createReceiveSerializeMessageRef(IParallelMng *pm, Int32 rank)
Creates a non-blocking serialization message for receiving from rank rank.
Arcane::ParallelMngUtils::createSynchronizerRef
Ref< IVariableSynchronizer > createSynchronizerRef(IParallelMng *pm, IItemFamily *family)
Returns an interface to synchronize variables on the group of the family family.
Definition ParallelMngUtils.cc:142
Arcane::Int32
std::int32_t Int32
Signed integer type of 32 bits.
Definition ArccoreGlobal.h:233