IItemFamilyExchanger.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IItemFamilyExchanger.h                                      (C) 2000-2025 */
/*                                                                           */
/* Exchange of family entities between sub-domains.                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IITEMFAMILYEXCHANGER_H
#define ARCANE_CORE_IITEMFAMILYEXCHANGER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/List.h"
#include "arcane/utils/TraceAccessor.h"
 
#include "arcane/core/VariableCollection.h"
 
#include "arcane/mesh/MeshGlobal.h"
 
#include <set>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ParallelExchangerOptions;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IItemFamilyExchanger
{
 public:
 
  virtual ~IItemFamilyExchanger() {}
 
 public:

  virtual void computeExchangeItems() = 0;

  virtual void setExchangeItems(ConstArrayView<std::set<Int32>> items_to_send) = 0;

  virtual bool computeExchangeInfos() = 0;

  virtual void prepareToSend() = 0;
  virtual void releaseBuffer() = 0;

  virtual void readAndAllocItems() = 0;
  virtual void readAndAllocSubMeshItems() = 0;
  virtual void readAndAllocItemRelations() = 0;

  virtual void readGroups() = 0;

  virtual void readVariables() = 0;

  virtual void removeSentItems() = 0;

  virtual void processExchange() = 0;

  virtual void finalizeExchange() = 0;

  virtual IItemFamily* itemFamily() = 0;

  virtual void setParallelExchangerOption(const ParallelExchangerOptions& options) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif