init_finalize.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2023 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
 
#ifndef dealii_init_finalize_h
#define dealii_init_finalize_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/mpi_stub.h>
#include <deal.II/base/numbers.h>
 
#include <boost/signals2.hpp>
 
#include <set>
 
DEAL_II_NAMESPACE_OPEN
 
enum class InitializeLibrary
{
  None = 0,
  MPI = 1,
  Kokkos = 2,
  SLEPc = 4,
  PETSc = 8,
  Zoltan = 16,
  P4EST = 32
};
 
 
 
inline InitializeLibrary
operator|(const InitializeLibrary f1, const InitializeLibrary f2)
{
  return static_cast<InitializeLibrary>(static_cast<unsigned int>(f1) |
                                        static_cast<unsigned int>(f2));
}
 
 
 
inline InitializeLibrary
operator&(const InitializeLibrary f1, const InitializeLibrary f2)
{
  return static_cast<InitializeLibrary>(static_cast<unsigned int>(f1) &
                                        static_cast<unsigned int>(f2));
}
 
 
 
class InitFinalize
{
public:
  InitFinalize(
    int                     &argc,
    char                  **&argv,
    const InitializeLibrary &libraries,
    const unsigned int       max_num_threads = numbers::invalid_unsigned_int);
 
  ~InitFinalize();
 
  void
  finalize();
 
  static void
  register_request(MPI_Request &request);
 
  static void
  unregister_request(MPI_Request &request);
 
  struct Signals
  {
    boost::signals2::signal<void()> at_mpi_init;
 
    boost::signals2::signal<void()> at_mpi_finalize;
  };
 
  static Signals signals;
 
private:
  InitializeLibrary libraries;
 
  static std::set<MPI_Request *> requests;
 
  bool is_finalized = false;
 
#ifdef DEAL_II_WITH_PETSC
  bool finalize_petscslepc;
#endif
};
 
DEAL_II_NAMESPACE_CLOSE
 
#endif