MatrixDistribution.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/base/BaseTypes.h>
#include <arccore/message_passing/MessagePassingGlobal.h>
 
#include <alien/data/ISpace.h>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Alien
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class VectorDistribution;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ALIEN_EXPORT MatrixDistribution
{
 public:
  MatrixDistribution();

  MatrixDistribution(const ISpace& row_space, const ISpace& col_space,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  MatrixDistribution(const ISpace& row_space, const ISpace& col_space,
                     Integer local_row_size, IMessagePassingMng* parallel_mng);

  MatrixDistribution(const ISpace& row_space, const ISpace& col_space,
                     Integer local_row_size, Integer local_col_size, IMessagePassingMng* parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     Arccore::Integer local_row_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     Arccore::Integer local_row_size, Arccore::Integer local_col_size,
                     Arccore::MessagePassing::IMessagePassingMng* parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     Arccore::Integer local_row_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  MatrixDistribution(Arccore::Integer global_row_size, Arccore::Integer global_col_size,
                     Arccore::Integer local_row_size, Arccore::Integer local_col_size,
                     std::shared_ptr<Arccore::MessagePassing::IMessagePassingMng> parallel_mng);

  MatrixDistribution(const MatrixDistribution& dist);

  MatrixDistribution(MatrixDistribution&& dist);

  ~MatrixDistribution();

  MatrixDistribution& operator=(const MatrixDistribution& dist);

  MatrixDistribution& operator=(MatrixDistribution&& dist);

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

  bool isParallel() const;

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

  const VectorDistribution& rowDistribution() const;

  const VectorDistribution& colDistribution() const;

  const ISpace& rowSpace() const;

  const ISpace& colSpace() const;

  Arccore::Integer localRowSize() const;

  Arccore::Integer localColSize() const;

  Arccore::Integer globalRowSize() const;

  Arccore::Integer globalColSize() const;

  Arccore::Integer rowOffset() const;

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

  Arccore::Integer colOffset() const;

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

  std::shared_ptr<MatrixDistribution> clone() const;
 
 private:
  Arccore::Integer rowGlobalToLocal(Arccore::Integer i) const;

  Arccore::Integer rowGlobalToLocal(Arccore::Integer i, Arccore::Integer p) const;

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

  Arccore::Integer colGlobalToLocal(Arccore::Integer i, Arccore::Integer p) const;

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

  Arccore::Integer rowLocalToGlobal(Arccore::Integer i, Arccore::Integer p) const;

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

  Arccore::Integer colLocalToGlobal(Arccore::Integer i, Arccore::Integer p) const;

  Arccore::Integer owner(Arccore::Integer i, Arccore::Integer j) const;
 
 private:
  struct Internal;
  std::shared_ptr<Internal> m_internal;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

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