MachineShMemWinVariable.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MachineShMemWinVariable.h                                   (C) 2000-2026 */
/*                                                                           */
/* Classes allowing the use of the MachineShMemWinVariable object pointed    */
/*  to by the shared memory variable memory area.                            */
/*---------------------------------------------------------------------------*/
 
#ifndef ARCANE_CORE_MACHINESHMEMWINVARIABLE_H
#define ARCANE_CORE_MACHINESHMEMWINVARIABLE_H
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
#include "arcane/utils/Ref.h"
#include "arcane/utils/NumArray.h"
 
#include "arcane/core/MeshMDVariableRef.h"
 
#include "arccore/base/FixedArray.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class MachineShMemWinVariableBase;
class MachineShMemWinVariable2DBase;
class MachineShMemWinVariableMDBase;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MachineShMemWinVariableCommon
{
 
 protected:

  explicit MachineShMemWinVariableCommon(IVariable* var);
 
 public:
 
  virtual ~MachineShMemWinVariableCommon();
 
 public:

  ConstArrayView<Int32> machineRanks() const;

  void barrier() const;
 
 protected:
 
  Ref<MachineShMemWinVariableBase> m_base;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class DataType>
class MachineShMemWinVariableArrayT
: public MachineShMemWinVariableCommon
{
 
 public:

  ARCANE_CORE_EXPORT explicit MachineShMemWinVariableArrayT(VariableRefArrayT<DataType> var);
  ARCANE_CORE_EXPORT ~MachineShMemWinVariableArrayT() override;
 
 public:

  ARCANE_CORE_EXPORT Span<DataType> view(Int32 rank) const;

  ARCANE_CORE_EXPORT void updateVariable();
 
 private:
 
  VariableRefArrayT<DataType> m_vart;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType>
class MachineShMemWinMeshVariableScalarT
: public MachineShMemWinVariableCommon
{
 
 public:

  ARCANE_CORE_EXPORT explicit MachineShMemWinMeshVariableScalarT(MeshVariableScalarRefT<ItemType, DataType> var);
 
  ARCANE_CORE_EXPORT ~MachineShMemWinMeshVariableScalarT() override;
 
 public:

  ARCANE_CORE_EXPORT Span<DataType> view(Int32 rank) const;

  ARCANE_CORE_EXPORT DataType operator()(Int32 rank, Int32 notlocal_id);

  ARCANE_CORE_EXPORT void updateVariable();
 
 private:
 
  MeshVariableScalarRefT<ItemType, DataType> m_vart;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class DataType>
class MachineShMemWinVariableArray2T
{
 public:

  ARCANE_CORE_EXPORT explicit MachineShMemWinVariableArray2T(VariableRefArray2T<DataType> var);
 
  ARCANE_CORE_EXPORT ~MachineShMemWinVariableArray2T();
 
 public:

  ARCANE_CORE_EXPORT ConstArrayView<Int32> machineRanks() const;

  ARCANE_CORE_EXPORT void barrier() const;
 
 public:

  ARCANE_CORE_EXPORT Span2<DataType> view(Int32 rank) const;

  ARCANE_CORE_EXPORT void updateVariable();
 
 private:
 
  Ref<MachineShMemWinVariable2DBase> m_base;
  VariableRefArray2T<DataType> m_vart;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType>
class MachineShMemWinMeshVariableArrayT
{
 
 public:

  ARCANE_CORE_EXPORT explicit MachineShMemWinMeshVariableArrayT(MeshVariableArrayRefT<ItemType, DataType> var);
 
  ARCANE_CORE_EXPORT ~MachineShMemWinMeshVariableArrayT();
 
 public:

  ARCANE_CORE_EXPORT ConstArrayView<Int32> machineRanks() const;

  ARCANE_CORE_EXPORT void barrier() const;
 
 public:

  ARCANE_CORE_EXPORT Span2<DataType> view(Int32 rank) const;

  ARCANE_CORE_EXPORT Span<DataType> operator()(Int32 rank, Int32 notlocal_id);

  ARCANE_CORE_EXPORT void updateVariable();
 
 private:
 
  Ref<MachineShMemWinVariableMDBase> m_base;
  MeshVariableArrayRefT<ItemType, DataType> m_vart;
  Int32 m_nb_elem_dim2{};
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType, class Extents>
class MachineShMemWinMDVariableT
{
 
 protected:

  ARCANE_CORE_EXPORT explicit MachineShMemWinMDVariableT(MeshVariableArrayRefT<ItemType, DataType> var);
 
 public:
 
  ARCANE_CORE_EXPORT virtual ~MachineShMemWinMDVariableT();
 
 public:

  ARCANE_CORE_EXPORT ConstArrayView<Int32> machineRanks() const;

  ARCANE_CORE_EXPORT void barrier() const;
 
 public:

  ARCANE_CORE_EXPORT MDSpan<DataType, typename MDDimType<Extents::rank() + 1>::DimType> view(Int32 rank) const;

  ARCANE_CORE_EXPORT MDSpan<DataType, Extents> operator()(Int32 rank, Int32 notlocal_id);

  ARCANE_CORE_EXPORT void updateVariable();
 
 private:
 
  Ref<MachineShMemWinVariableMDBase> m_base;
  MeshVariableArrayRefT<ItemType, DataType> m_vart;
  Int32 m_nb_elem_dim2{};
  std::array<Int32, Extents::rank()> m_shape_dim2{};
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType, class Extents>
class MachineShMemWinMeshMDVariableT
: public MachineShMemWinMDVariableT<ItemType, DataType, Extents>
{
 
 public:

  explicit MachineShMemWinMeshMDVariableT(MeshMDVariableRefT<ItemType, DataType, Extents> var)
  : MachineShMemWinMDVariableT<ItemType, DataType, Extents>(var.underlyingVariable())
  {}
 
  ~MachineShMemWinMeshMDVariableT() override = default;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType, class Extents>
class MachineShMemWinMeshVectorMDVariableT
: public MachineShMemWinMDVariableT<ItemType, DataType, typename Extents::template AddedFirstExtentsType<DynExtent>>
{
  using AddedFirstExtentsType = Extents::template AddedFirstExtentsType<DynExtent>;
 
 public:

  template <Int32 Size>
  explicit MachineShMemWinMeshVectorMDVariableT(MeshVectorMDVariableRefT<ItemType, DataType, Size, Extents> var)
  : MachineShMemWinMDVariableT<ItemType, DataType, AddedFirstExtentsType>(var.underlyingVariable())
  {}
 
  ~MachineShMemWinMeshVectorMDVariableT() override = default;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class ItemType, class DataType, class Extents>
class MachineShMemWinMeshMatrixMDVariableT
: public MachineShMemWinMDVariableT<ItemType, DataType, typename Extents::template AddedFirstLastExtentsType<DynExtent, DynExtent>>
{
  using AddedFirstLastExtentsType = Extents::template AddedFirstLastExtentsType<DynExtent, DynExtent>;
 
 public:

  template <Int32 Row, Int32 Column>
  explicit MachineShMemWinMeshMatrixMDVariableT(MeshMatrixMDVariableRefT<ItemType, DataType, Row, Column, Extents> var)
  : MachineShMemWinMDVariableT<ItemType, DataType, AddedFirstLastExtentsType>(var.underlyingVariable())
  {}
 
  ~MachineShMemWinMeshMatrixMDVariableT() override = default;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif