IDataSynchronizeImplementation.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IDataSynchronizeImplementation.h                            (C) 2000-2023 */
/*                                                                           */
/* Interface for the implementation of variable synchronization.             */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_IMPL_IDATASYNCHRONIZEIMPLEMENTATION_H
#define ARCANE_IMPL_IDATASYNCHRONIZEIMPLEMENTATION_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Ref.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class IDataSynchronizeBuffer;
class IParallelMng;
class DataSynchronizeInfo;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IDataSynchronizeImplementation;
class IDataSynchronizeImplementationFactory;
class AbstractDataSynchronizeImplementation;
 
using IGenericVariableSynchronizerDispatcher
ARCANE_DEPRECATED_REASON("Use 'IDataSynchronizeImplementation' instead") = IDataSynchronizeImplementation;
 
using IGenericVariableSynchronizerDispatcherFactory
ARCANE_DEPRECATED_REASON("Use 'IDataSynchronizeImplementationFactory' instead") = IDataSynchronizeImplementationFactory;
 
using AbstractGenericVariableSynchronizerDispatcher
ARCANE_DEPRECATED_REASON("Use 'AbstractDataSynchronizeImplementation' instead") = AbstractDataSynchronizeImplementation;
 
using ItemGroupSynchronizeInfo
ARCANE_DEPRECATED_REASON("Use 'DataSynchronizeInfo' instead") = DataSynchronizeInfo;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_IMPL_EXPORT IDataSynchronizeImplementation
{
 public:
 
  virtual ~IDataSynchronizeImplementation() = default;
 
 public:
 
  virtual void setDataSynchronizeInfo(DataSynchronizeInfo* sync_info) = 0;
  virtual void compute() = 0;
  virtual void beginSynchronize(IDataSynchronizeBuffer* buf) = 0;
  virtual void endSynchronize(IDataSynchronizeBuffer* buf) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_IMPL_EXPORT IDataSynchronizeImplementationFactory
{
 public:
 
  virtual ~IDataSynchronizeImplementationFactory() = default;
 
 public:
 
  virtual Ref<IDataSynchronizeImplementation> createInstance() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*
 * \brief Abstract base class for generic implementations.
 *
 * It allows retaining information about the group to be synchronized.
 */
class AbstractDataSynchronizeImplementation
: public IDataSynchronizeImplementation
{
 public:
 
  void setDataSynchronizeInfo(DataSynchronizeInfo* sync_info) final { m_sync_info = sync_info; }
 
 protected:
 
  DataSynchronizeInfo* _syncInfo() const { return m_sync_info; }
 
 private:
 
  DataSynchronizeInfo* m_sync_info = nullptr;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif