ParallelLoopOptions.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ParallelLoopOptions.h                                       (C) 2000-2024 */
/*                                                                           */
/* Options de configuration pour les boucles parallèles en multi-thread.     */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_UTILS_PARALLELLOOPOPTIONS_H
#define ARCANE_UTILS_PARALLELLOOPOPTIONS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/UtilsTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_UTILS_EXPORT ParallelLoopOptions
{
 private:

  enum SetFlags
  {
    SF_MaxThread = 1,
    SF_GrainSize = 2,
    SF_Partitioner = 4
  };
 
 public:

  enum class Partitioner
  {
    Auto = 0,
    Static = 1,
    Deterministic = 2
  };
 
 public:
 
  ParallelLoopOptions()
  : m_grain_size(0)
  , m_max_thread(-1)
  , m_partitioner(Partitioner::Auto)
  , m_flags(0)
  {}
 
 public:

  Int32 maxThread() const { return m_max_thread; }
  void setMaxThread(Integer v)
  {
    m_max_thread = v;
    m_flags |= SF_MaxThread;
  }

  bool hasMaxThread() const { return m_flags & SF_MaxThread; }

  Integer grainSize() const { return m_grain_size; }
  void setGrainSize(Integer v)
  {
    m_grain_size = v;
    m_flags |= SF_GrainSize;
  }

  bool hasGrainSize() const { return m_flags & SF_GrainSize; }

  Partitioner partitioner() const { return m_partitioner; }
  void setPartitioner(Partitioner v)
  {
    m_partitioner = v;
    m_flags |= SF_Partitioner;
  }

  bool hasPartitioner() const { return m_flags & SF_Partitioner; }
 
 public:

  void mergeUnsetValues(const ParallelLoopOptions& po)
  {
    if (!hasMaxThread())
      setMaxThread(po.maxThread());
    if (!hasGrainSize())
      setGrainSize(po.grainSize());
    if (!hasPartitioner())
      setPartitioner(po.partitioner());
  }
 
 private:

  Int32 m_grain_size = 0;
  Int32 m_max_thread = -1;
  Partitioner m_partitioner = Partitioner::Auto;
 
  unsigned int m_flags = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif