multithread_info.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2000 - 2021 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_multithread_info_h
#  define dealii_multithread_info_h
//---------------------------------------------------------------------------
 
 
#  include <deal.II/base/config.h>
 
#  include <deal.II/base/exceptions.h>
#  include <deal.II/base/types.h>
 
#  include <memory>
 
#  ifdef DEAL_II_WITH_TASKFLOW
// forward declaration from <taskflow/taskflow.hpp>
namespace tf
{
  class Executor;
}
#  endif
 
 
DEAL_II_NAMESPACE_OPEN
 
class MultithreadInfo
{
public:
  MultithreadInfo() = delete;
 
  static unsigned int
  n_cores();
 
  static unsigned int
  n_threads();
 
  static std::size_t
  memory_consumption();
 
  static void
  set_thread_limit(
    const unsigned int max_threads = numbers::invalid_unsigned_int);
 
  static bool
  is_running_single_threaded();
 
  static void
  initialize_multithreading();
 
 
#  ifdef DEAL_II_WITH_TASKFLOW
  static tf::Executor &
  get_taskflow_executor();
#  endif
 
private:
  static unsigned int n_max_threads;
 
#  ifdef DEAL_II_WITH_TASKFLOW
  static std::unique_ptr<tf::Executor> executor;
#  endif
};
 
 
 
//---------------------------------------------------------------------------
DEAL_II_NAMESPACE_CLOSE
// end of #ifndef dealii_multithread_info_h
#endif
//---------------------------------------------------------------------------