IParallelExchanger.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2022 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IParallelExchanger.h                                        (C) 2000-2022 */
/*                                                                           */
/* Echange d'informations entre processeurs.                                 */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_IPARALLELEXCHANGER_H
#define ARCANE_IPARALLELEXCHANGER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/ArcaneTypes.h"
#include "arcane/Parallel.h"
#include "arcane/ParallelExchangerOptions.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IParallelMng;
class IItemFamily;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT IParallelExchanger
{
 public:
 
  enum eExchangeMode
  {
    EM_Independant = ParallelExchangerOptions::EM_Independant,
    EM_Collective = ParallelExchangerOptions::EM_Collective,
    EM_Auto = ParallelExchangerOptions::EM_Auto
  };
 
 public:
 
  virtual ~IParallelExchanger() = default;
 
 public:
 
  virtual bool initializeCommunicationsMessages() =0;
 
  virtual void initializeCommunicationsMessages(Int32ConstArrayView recv_ranks) =0;
 
  virtual void processExchange() =0;
 
  virtual void processExchange(const ParallelExchangerOptions& options) =0;
 
 public:
 
  virtual IParallelMng* parallelMng() const =0;
 
  virtual Integer nbSender() const =0;
  virtual Int32ConstArrayView senderRanks() const =0;
  virtual void addSender(Int32 rank) =0;
  virtual ISerializeMessage* messageToSend(Integer i) =0;
 
  virtual Integer nbReceiver() const =0;
  virtual Int32ConstArrayView receiverRanks() =0;
  virtual ISerializeMessage* messageToReceive(Integer i) =0;
 
  [[deprecated("Y2021: Use ParallelExchangerOptions::setExchangeMode()")]]
  virtual void setExchangeMode(eExchangeMode mode) =0;
  [[deprecated("Y2021: Use ParallelExchangerOptions::exchangeMode()")]]
  virtual eExchangeMode exchangeMode() const =0;
 
  virtual void setVerbosityLevel(Int32 v) =0;
  virtual Int32 verbosityLevel() const =0;
 
  virtual void setName(const String& name) =0;
  virtual String name() const =0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif