IMultiReduce.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMultiReduce.h                                              (C) 2000-2016 */
/*                                                                           */
/* Management of multiple reductions.                                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_PARALLEL_IMULTIREDUCE_H
#define ARCANE_PARALLEL_IMULTIREDUCE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/Array.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ReduceSumOfRealHelper
{
 public:
 
  ReduceSumOfRealHelper(bool is_strict)
  : m_reduced_value(0.0)
  , m_is_strict(is_strict)
  {
    if (!m_is_strict)
      m_values.add(0.0);
  }
 
 public:

  void add(Real v)
  {
    if (m_is_strict)
      m_values.add(v);
    else
      m_values[0] += v;
  }

  void clear()
  {
    m_values.clear();
  }

  RealConstArrayView values() const { return m_values; }

  Real reducedValue() const { return m_reduced_value; }

  void setReducedValue(Real v) { m_reduced_value = v; }
 
 private:
 
  SharedArray<Real> m_values;
  Real m_reduced_value;
  bool m_is_strict;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IMultiReduce
{
 public:
 
  virtual ~IMultiReduce() {} 
 
 public:
 
  static IMultiReduce* create(IParallelMng* pm);
 
 public:

  virtual void execute() = 0;

  virtual bool isStrict() const = 0;

  virtual void setStrict(bool is_strict) = 0;
 
 public:

  virtual ReduceSumOfRealHelper* getSumOfReal(const String& name) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif