IParticleExchanger.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IParticleExchanger.h                                        (C) 2000-2025 */
/*                                                                           */
/* Interface of a particle exchanger.                                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IPARTICLEEXCHANGER_H
#define ARCANE_CORE_IPARTICLEEXCHANGER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/ItemTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IParticleExchanger
{
 public:
 
  virtual ~IParticleExchanger() = default; 
 
 public:
 
  virtual void build() = 0;

  virtual void initialize(IItemFamily* item_family) = 0;
 
 public:

  virtual void beginNewExchange(Integer nb_particle) = 0;

  virtual ARCANE_DEPRECATED bool exchangeItems(Integer nb_particle_finish_exchange,
                                               Int32ConstArrayView local_ids,
                                               Int32ConstArrayView sub_domains_to_send,
                                               ItemGroup item_group,
                                               IFunctor* wait_functor) = 0;

  virtual bool exchangeItems(Integer nb_particle_finish_exchange,
                             Int32ConstArrayView local_ids,
                             Int32ConstArrayView ranks_to_send,
                             Int32Array* new_particle_local_ids,
                             IFunctor* wait_functor) = 0;

  virtual void sendItems(Integer nb_particle_finish_exchange,
                         Int32ConstArrayView local_ids,
                         Int32ConstArrayView sub_domains_to_send) = 0;

  virtual bool waitMessages(Integer nb_pending_particle,
                            Int32Array* new_particle_local_ids,
                            IFunctor* functor) = 0;

  virtual void addNewParticles(Integer nb_particle) = 0;

  virtual IItemFamily* itemFamily() = 0;

  virtual void setVerboseLevel(Integer level) = 0;

  virtual Integer verboseLevel() const = 0;

  virtual IAsyncParticleExchanger* asyncParticleExchanger() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif