StandaloneMpiMessagePassingMng.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* StandaloneMpiMessagePassingMng.h                            (C) 2000-2026 */
/*                                                                           */
/* Version autonome de MpiMessagePassingMng.                                 */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_MESSAGEPASSINGMPI_STANDALONEMPIMESSAGEPASSINGMNG_H
#define ARCCORE_MESSAGEPASSINGMPI_STANDALONEMPIMESSAGEPASSINGMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/message_passing_mpi/MessagePassingMpiGlobal.h"
#include "arccore/message_passing/IMessagePassingMng.h"
 
#include "arccore/base/Ref.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing::Mpi
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \brief Version autonome de IMessagePassingMng associée à un communicateur MPI
 *
 * La création se fait via la méthode statique createRef() ou la méthode
 * obsolète create().
 *
 * À partir du IMessagePassingMng retourné, il est possible de récupérer
 * le MPI_Comm associé en utilisant les fonctions d'aide
 * fillMpiCommunicatorIfValid() ou toMpiCommunicator().
 */
class ARCCORE_MESSAGEPASSINGMPI_EXPORT StandaloneMpiMessagePassingMng
{
 public:
 
  /*!
   * \brief Créé un gestionnaire associé au communicateur \a comm.
   *
   * \deprecated Utiliser createRef() à la place car cette méthode gère
   * automatiquement la mémoire.
   */
  ARCCORE_DEPRECATED_REASON("Y2026: Use createRef() instead")
  static IMessagePassingMng* create(MPI_Comm comm, bool clean_comm = false);
 
  /*!
   * \brief Créé un gestionnaire associé au communicateur \a comm.
   *
   * Si \a clean_comm est vrai, on appelle MPI_Comm_free() sur \a comm
   * lors de la destruction de l'instance.
   */
  static Ref<IMessagePassingMng> createRef(MPI_Comm comm, bool clean_comm = false);
 
  /*!
   * \brief Créé un gestionnaire associé au communicateur MPI_WORLD_COMM.
   */
  static Ref<IMessagePassingMng> createWorldRef();
 
  /*!
   * \brief Initialise MPI et créé un gestionnaire associé au communicateur
   * MPI_WORLD_COMM.
   *
   * L'initialisation se fait en appelant `MPI_Init_thread()` avec le niveau
   * de thread \a wanted_thread_level (une des valeurs `MPI_THREAD_SINGLE`,
   * `MPI_THREAD_FUNNELED`, `MPI_THREAD_SERIALIZED`, `MPI_THREAD_MULTIPLE`)
   * et les arguments \a argc et \a argv.
   *
   * MPI_Finalize() sera appelé lorsque l'instance sort du domaine de validité.
   */
  static Ref<IMessagePassingMng> createAndInitializeMPI(int* argc, char** argv[], int wanted_thread_level);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::MessagePassing::Mpi
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif