VectorDistribution.h

Go to the documentation of this file.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2025 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------

 
#pragma once
 
#include <arccore/message_passing/MessagePassingGlobal.h>
#include "alien/data/ISpace.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ALIEN_EXPORT VectorDistribution
{
 public:
  VectorDistribution();

  VectorDistribution(
  const ISpace& space, Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  VectorDistribution(const ISpace& space,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  VectorDistribution(Arccore::Integer global_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  // FIXME: not implemented !
  VectorDistribution(Arccore::Integer global_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  VectorDistribution(const ISpace& space, Arccore::Integer local_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  VectorDistribution(const ISpace& space, Arccore::Integer local_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  VectorDistribution(Arccore::Integer global_size, Arccore::Integer local_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  VectorDistribution(Arccore::Integer global_size, Arccore::Integer local_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  VectorDistribution(const VectorDistribution& dist);

  VectorDistribution(VectorDistribution&& dist);

  ~VectorDistribution();

  VectorDistribution& operator=(const VectorDistribution& dist);

  VectorDistribution& operator=(VectorDistribution&& dist);

  bool operator==(const VectorDistribution& dist) const;

  bool isParallel() const;

  std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> sharedParallelMng() const;

  Arccore::MessagePassing::IMessagePassingMng* parallelMng() const;

  const ISpace& space() const;

  Arccore::Integer localSize() const;

  Arccore::Integer globalSize() const;

  Arccore::Integer offset() const;

  Arccore::Integer offset(Arccore::Integer p) const;

 
  Arccore::ConstArrayView<Integer> offsets() const;

  Arccore::Integer owner(Arccore::Integer i) const;

  std::shared_ptr<VectorDistribution> clone() const;

  Arccore::Integer globalToLocal(Arccore::Integer i) const;
 
 private:
  Arccore::Integer globalToLocal(Arccore::Integer i, Arccore::Integer p) const;

  Arccore::Integer localToGlobal(Arccore::Integer i) const;

  Arccore::Integer localToGlobal(Arccore::Integer i, Arccore::Integer p) const;
 
  // due to 'private' of VectorDistribution methods
  // will be removed
  friend class MatrixDistribution;
 
 private:
  struct Internal;
  std::shared_ptr<Internal> m_internal;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

extern ALIEN_EXPORT std::ostream& operator<<(
std::ostream& nout, const VectorDistribution& dist);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Alien
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/