IDataSynchronizeBuffer.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IDataSynchronizeBuffer.h                                    (C) 2000-2023 */
/*                                                                           */
/* Interface of a generic buffer for data synchronization.                   */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_IMPL_IDATASYNCHRONIZEBUFFER_H
#define ARCANE_IMPL_IDATASYNCHRONIZEBUFFER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArrayView.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_IMPL_EXPORT IDataSynchronizeBuffer
{
 public:
 
  virtual ~IDataSynchronizeBuffer() = default;
 
 public:

  virtual Int32 nbRank() const = 0;

  virtual Int32 targetRank(Int32 index) const = 0;

  virtual bool hasGlobalBuffer() const = 0;

  virtual MutableMemoryView globalSendBuffer() = 0;

  virtual MutableMemoryView globalReceiveBuffer() = 0;

  virtual MutableMemoryView sendBuffer(Int32 index) = 0;

  virtual MutableMemoryView receiveBuffer(Int32 index) = 0;

  virtual Int64 sendDisplacement(Int32 index) const = 0;

  virtual Int64 receiveDisplacement(Int32 index) const = 0;

  virtual void copyReceiveAsync(Int32 index) = 0;

  virtual void copyAllReceive();

  virtual void copySendAsync(Int32 index) = 0;

  virtual void copyAllSend();

  virtual Int64 totalSendSize() const = 0;

  virtual Int64 totalReceiveSize() const = 0;

  virtual void barrier() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif