IMeshMaterialSynchronizeBuffer.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMeshMaterialSynchronizeBuffer.h                            (C) 2000-2023 */
/*                                                                           */
/* Interface des buffers pour la synchronisation de variables matériaux.     */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_MATERIALS_IMESHMATERIALSYNCHRONIZEBUFFER_H
#define ARCANE_MATERIALS_IMESHMATERIALSYNCHRONIZEBUFFER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArrayView.h"
#include "arcane/utils/Ref.h"
 
#include "arcane/materials/MaterialsGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::Materials
{
/*
 * TODO: Cette interface pourrait être utilisée en dehors des matériaux.
 *       Regarder comment la rendre générique.
 */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \internal
 * \brief Interface des buffers pour la synchronisation de variables matériaux.
 *
 * Pour utiliser les instances de cette interface, il faut procéder comme suit:
 * 1. Positionner le nombre de rangs via setNbRank().
 * 2. Pour chaque buffer, appeler setSendBufferSize() et setReceiveBufferSize()
 *    pour indiquer le nombre d'éléments de chaque buffer.
 * 3. Appeler allocate() pour allouer les buffers.
 * 4. Récupérer les vues sur les buffers via sendBuffer() ou receiveBuffer().
 */
class ARCANE_MATERIALS_EXPORT IMeshMaterialSynchronizeBuffer
{
 public:
 
  virtual ~IMeshMaterialSynchronizeBuffer() {}
 
 public:
 
  //! Nombre de rangs
  virtual Int32 nbRank() const = 0;
 
  //! Positionne le nombre de rangs. Cela invalide les buffers d'envoi et de réception
  virtual void setNbRank(Int32 nb_rank) = 0;
 
  //! Buffer d'envoi pour le \a i-ème buffer
  virtual Span<Byte> sendBuffer(Int32 i) = 0;
 
  //! Positionne le nombre d'éléments pour le \a i-ème buffer d'envoi
  virtual void setSendBufferSize(Int32 i, Int32 new_size) = 0;
 
  //! Buffer d'envoi pour le \a i-\ème buffer
  virtual Span<Byte> receiveBuffer(Int32 i) = 0;
 
  //! Positionne le nombre d'éléments pour le \a i-ème buffer de réception
  virtual void setReceiveBufferSize(Int32 i, Int32 new_size) = 0;
 
  //! Alloue la mémoire pour les buffers
  virtual void allocate() = 0;
 
  //! Taille totale allouée pour les buffers
  virtual Int64 totalSize() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace impl
{
extern "C++" ARCANE_MATERIALS_EXPORT Ref<IMeshMaterialSynchronizeBuffer>
makeMultiBufferMeshMaterialSynchronizeBufferRef();
extern "C++" ARCANE_MATERIALS_EXPORT Ref<IMeshMaterialSynchronizeBuffer>
makeMultiBufferMeshMaterialSynchronizeBufferRef(eMemoryRessource mem);
extern "C++" ARCANE_MATERIALS_EXPORT Ref<IMeshMaterialSynchronizeBuffer>
makeOneBufferMeshMaterialSynchronizeBufferRef(eMemoryRessource mem);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::Materials
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif