Arcane  4.2.3.0
User documentation
Loading...
Searching...
No Matches
Arcane::MessagePassing::MessagePassingMng Class Reference

Implementation of interface IMessagePassingMng. More...

#include <arccore/message_passing/MessagePassingMng.h>

Public Member Functions

 MessagePassingMng (Int32 comm_rank, Int32 comm_size, IDispatchers *d)
Int32 commRank () const override
 Rank of this instance in the communicator.
Int32 commSize () const override
 Number of instances in the communicator.
IDispatchers * dispatchers () override
ITimeMetricCollector * timeMetricCollector () const override
 Interface for collecting execution times (can be null).
Communicator communicator () const override
 MPI communicator associated with this instance.
void setTimeMetricCollector (ITimeMetricCollector *c)
void setCommunicator (Communicator c)
Public Member Functions inherited from Arcane::ReferenceCounterImpl
void addReference ()
void removeReference ()
void _internalAddReference ()
bool _internalRemoveReference ()

Detailed Description

Implementation of interface IMessagePassingMng.

This class in internal to Arccore. Uses should use the interface IMessagePassingMng.

Definition at line 36 of file MessagePassingMng.h.

Constructor & Destructor Documentation

◆ MessagePassingMng()

Arcane::MessagePassing::MessagePassingMng::MessagePassingMng ( Int32 comm_rank,
Int32 comm_size,
IDispatchers * d )

Definition at line 25 of file MessagePassingMng.cc.

◆ ~MessagePassingMng()

Arcane::MessagePassing::MessagePassingMng::~MessagePassingMng ( )
override

Definition at line 36 of file MessagePassingMng.cc.

Member Function Documentation

◆ commRank()

Int32 Arcane::MessagePassing::MessagePassingMng::commRank ( ) const
inlineoverridevirtual

Rank of this instance in the communicator.

Implements Arcane::MessagePassing::IMessagePassingMng.

Definition at line 49 of file MessagePassingMng.h.

◆ commSize()

Int32 Arcane::MessagePassing::MessagePassingMng::commSize ( ) const
inlineoverridevirtual

Number of instances in the communicator.

Implements Arcane::MessagePassing::IMessagePassingMng.

Definition at line 50 of file MessagePassingMng.h.

◆ communicator()

Communicator Arcane::MessagePassing::MessagePassingMng::communicator ( ) const
overridevirtual

MPI communicator associated with this instance.

The communicator is only valid if the instance is associated with an MPI implementation. You can convert a communicator to a MPI communicator using helper methods toMpiCommunicator() and fillMpiCommunicatorIfValid() or like that:

IMessagePassingMng* mpm = ...;
Communicator comm = mpm->communicator();
if (comm.isValid())
MPI_Comm mpi_comm = static_cast<MPI_Comm>(comm).
Communicator for message exchange.
bool isValid() const
Indicates if the communicator is valid.
Interface of the message passing manager.
virtual Communicator communicator() const
MPI communicator associated with this instance.

Reimplemented from Arcane::MessagePassing::IMessagePassingMng.

Definition at line 53 of file MessagePassingMng.cc.

◆ dispatchers()

IDispatchers * Arcane::MessagePassing::MessagePassingMng::dispatchers ( )
overridevirtual

Implements Arcane::MessagePassing::IMessagePassingMng.

Definition at line 47 of file MessagePassingMng.cc.

◆ setCommunicator()

void Arcane::MessagePassing::MessagePassingMng::setCommunicator ( Communicator c)

Definition at line 59 of file MessagePassingMng.cc.

◆ setTimeMetricCollector()

void Arcane::MessagePassing::MessagePassingMng::setTimeMetricCollector ( ITimeMetricCollector * c)

Definition at line 71 of file MessagePassingMng.cc.

◆ timeMetricCollector()

ITimeMetricCollector * Arcane::MessagePassing::MessagePassingMng::timeMetricCollector ( ) const
overridevirtual

Interface for collecting execution times (can be null).

Implements Arcane::MessagePassing::IMessagePassingMng.

Definition at line 65 of file MessagePassingMng.cc.


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