IVariableSynchronizer.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IVariableSynchronizer.h                                     (C) 2000-2024 */
/*                                                                           */
/* Interface of a variable synchronization service.                          */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IVARIABLESYNCHRONIZER_H
#define ARCANE_CORE_IVARIABLESYNCHRONIZER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

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

  virtual IParallelMng* parallelMng() = 0;

  virtual const ItemGroup& itemGroup() = 0;

  virtual void compute() = 0;

  virtual void changeLocalIds(Int32ConstArrayView old_to_new_ids) = 0;

  virtual void synchronize(IVariable* var) = 0;
 
  // TODO: make pure virtual (December 2024)
  virtual void synchronize(IVariable* var, Int32ConstArrayView local_ids);

  virtual void synchronize(VariableCollection vars) = 0;
 
  // TODO: make pure virtual (December 2024)
  virtual void synchronize(VariableCollection vars, Int32ConstArrayView local_ids);

  virtual Int32ConstArrayView communicatingRanks() = 0;

  virtual Int32ConstArrayView sharedItems(Int32 index) = 0;

  virtual Int32ConstArrayView ghostItems(Int32 index) = 0;

  virtual void synchronizeData(IData* data) = 0;

  virtual EventObservable<const VariableSynchronizerEventArgs&>& onSynchronized() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif