Arcane  4.2.3.0
Developer documentation
Loading...
Searching...
No Matches
MessagePassingMpiEnum.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/* MessagePassingMpiEnum.h (C) 2000-2026 */
9/* */
10/* Enumeration of different MPI operations. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCCORE_MESSAGEPASSINGMPI_MESSAGEPASSINGMPIENUM_H
13#define ARCCORE_MESSAGEPASSINGMPI_MESSAGEPASSINGMPIENUM_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arccore/message_passing_mpi/MessagePassingMpiGlobal.h"
18
19#include "arccore/collections/CollectionsGlobal.h"
20
22#include "arccore/base/String.h"
23
24/*---------------------------------------------------------------------------*/
25/*---------------------------------------------------------------------------*/
26
27namespace Arcane::MessagePassing::Mpi
28{
29
30/*---------------------------------------------------------------------------*/
31/*---------------------------------------------------------------------------*/
32
37enum class ARCCORE_MESSAGEPASSINGMPI_EXPORT eMpiName
38{
39 Bcast = 0,
40 Gather = 1,
41 Gatherv = 2,
42 Allgather = 3,
43 Allgatherv = 4,
44 Scatterv = 5,
45 Alltoall = 6,
46 Alltoallv = 7,
47 Barrier = 8,
48 Reduce = 9,
49 Allreduce = 10,
50 Scan = 11,
51 Sendrecv = 12,
52 Isend = 13,
53 Send = 14,
54 Irecv = 15,
55 Recv = 16,
56 Test = 17,
57 Probe = 18,
58 Get_count = 19,
59 Wait = 20,
60 Waitall = 21,
61 Testsome = 22,
62 Waitsome = 23,
63 ScanExclusive = 24,
64 NameOffset = 25 // Attention a bien laisser ce champ en dernier (avec sa valeur a jour) si on rajoute des enums !
65};
66
67/*---------------------------------------------------------------------------*/
68/*---------------------------------------------------------------------------*/
69
75class ARCCORE_MESSAGEPASSINGMPI_EXPORT MpiInfo
76{
77 public:
78
79 // Ctor: we build everything on the fly rather than storing a huge string table
80 explicit MpiInfo(eMpiName mpi_operation);
81 ~MpiInfo() = default;
82
84 const String& name() const;
85
87 const String& description() const;
88
89 private:
90
91 String m_name;
92 String m_description;
93};
94
95/*---------------------------------------------------------------------------*/
96/*---------------------------------------------------------------------------*/
97
98} // namespace Arcane::MessagePassing::Mpi
99
100/*---------------------------------------------------------------------------*/
101/*---------------------------------------------------------------------------*/
102
103namespace Arccore::MessagePassing::Mpi
104{
105using Arcane::MessagePassing::Mpi::eMpiName;
107} // namespace Arccore::MessagePassing::Mpi
108
109/*---------------------------------------------------------------------------*/
110/*---------------------------------------------------------------------------*/
111
112#endif
Declarations of types for the 'base' component of Arccore.
Informative structure linked to the enumerations for MPI operations. Provides the name associated wit...
const String & description() const
Accessor for the description associated with the enum.
const String & name() const
Accessor for the name associated with the enum.