Arcane  4.2.3.0
User documentation
Loading...
Searching...
No Matches
IParallelDispatch.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/* IParallelDispatch.h (C) 2000-2026 */
9/* */
10/* Parallel message handling for a value type. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_IPARALLELDISPATCH_H
13#define ARCANE_CORE_IPARALLELDISPATCH_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/ArcaneTypes.h"
18#include "arcane/core/Parallel.h"
19#include "arccore/message_passing/ITypeDispatcher.h"
20
21/*---------------------------------------------------------------------------*/
22/*---------------------------------------------------------------------------*/
23
24namespace Arcane
25{
26
27/*---------------------------------------------------------------------------*/
28/*---------------------------------------------------------------------------*/
29/*!
30 * \internal
31 * \brief Parallel message handling for the type \a Type.
32 */
33template <class Type>
34class IParallelDispatchT
35{
36 public:
37
38 using Request = Parallel::Request;
39 using eReduceType = Parallel::eReduceType;
40 using PointToPointMessageInfo = Parallel::PointToPointMessageInfo;
41
42 public:
43
44 virtual ~IParallelDispatchT() = default;
45
46 public:
47
48 virtual void finalize() = 0;
49
50 public:
51
52 virtual void broadcast(ArrayView<Type> send_buf, Int32 rank) = 0;
53 virtual void allGather(ConstArrayView<Type> send_buf, ArrayView<Type> recv_buf) = 0;
54 virtual void allGatherVariable(ConstArrayView<Type> send_buf, Array<Type>& recv_buf) = 0;
55 virtual void gather(ConstArrayView<Type> send_buf, ArrayView<Type> recv_buf, Int32 rank) = 0;
56 virtual void gatherVariable(ConstArrayView<Type> send_buf, Array<Type>& recv_buf, Int32 rank) = 0;
57 virtual void scatterVariable(ConstArrayView<Type> send_buf, ArrayView<Type> recv_buf, Int32 root) = 0;
58 virtual void allToAll(ConstArrayView<Type> send_buf, ArrayView<Type> recv_buf, Integer count) = 0;
59 virtual void allToAllVariable(ConstArrayView<Type> send_buf, Int32ConstArrayView send_count,
60 Int32ConstArrayView send_index, ArrayView<Type> recv_buf,
61 Int32ConstArrayView recv_count, Int32ConstArrayView recv_index) = 0;
62 virtual Type allReduce(eReduceType op, Type send_buf) = 0;
63 virtual void allReduce(eReduceType op, ArrayView<Type> send_and_receive_buf) = 0;
64 virtual void allReduce(eReduceType op, ConstArrayView<Type> send_buf, ArrayView<Type> receive_buf) = 0;
65
66 public:
67
68 virtual Request send(ConstArrayView<Type> send_buffer, Int32 rank, bool is_blocked) = 0;
69 virtual Request send(Span<const Type> recv_buffer, const PointToPointMessageInfo& message) = 0;
70 virtual Request recv(ArrayView<Type> recv_buffer, Int32 rank, bool is_blocked) = 0;
71 virtual Request receive(Span<Type> recv_buffer, const PointToPointMessageInfo& message) = 0;
72 virtual void send(ConstArrayView<Type> send_buffer, Int32 rank) = 0;
73 virtual void recv(ArrayView<Type> recv_buffer, Int32 rank) = 0;
74 virtual void sendRecv(ConstArrayView<Type> send_buffer, ArrayView<Type> recv_buffer, Int32 proc) = 0;
75 virtual Type scan(eReduceType op, Type send_buf) = 0;
76 virtual void scan(eReduceType op, ArrayView<Type> send_buf) = 0;
77 virtual void computeMinMaxSum(Type val, Type& min_val, Type& max_val, Type& sum_val,
78 Int32& min_rank,
79 Int32& max_rank) = 0;
80 virtual void computeMinMaxSum(ConstArrayView<Type> values,
81 ArrayView<Type> min_values,
82 ArrayView<Type> max_values,
83 ArrayView<Type> sum_values,
84 ArrayView<Int32> min_ranks,
85 ArrayView<Int32> max_ranks) = 0;
86
87 public:
88
89 virtual ITypeDispatcher<Type>* toArccoreDispatcher() = 0;
90};
91
92/*---------------------------------------------------------------------------*/
93/*---------------------------------------------------------------------------*/
94
95} // namespace Arcane
96
97/*---------------------------------------------------------------------------*/
98/*---------------------------------------------------------------------------*/
99
100#endif
ArcaneTypes.h
Declarations of Arcane's general types.
Parallel.h
File containing declarations concerning the message passing model.
Arcane::ArrayView
Modifiable view of an array of type T.
Definition arccore/src/base/arccore/base/ArrayView.h:96
Arcane::Array
Base class for 1D data vectors.
Definition arccore/src/common/arccore/common/Array.h:44
Arcane::ConstArrayView
Constant view of an array of type T.
Definition arccore/src/base/arccore/base/ArrayView.h:550
Arcane::MessagePassing::PointToPointMessageInfo
Information for sending/receiving a point-to-point message.
Definition PointToPointMessageInfo.h:56
Arcane::Span
View of an array of elements of type T.
Definition Span.h:633
Arcane::MessagePassing::eReduceType
eReduceType
Supported reduction types.
Definition MessagePassingGlobal.h:111
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition AbstractCaseDocumentVisitor.cc:21
Arcane::Integer
Int32 Integer
Type representing an integer.
Definition ArccoreGlobal.h:293
Arcane::Int32ConstArrayView
ConstArrayView< Int32 > Int32ConstArrayView
C equivalent of a 1D array of 32-bit integers.
Definition UtilsTypes.h:476
Arcane::Int32
std::int32_t Int32
Signed integer type of 32 bits.
Definition ArccoreGlobal.h:233