timpi_init.h

Go to the documentation of this file.

// The TIMPI Message-Passing Parallelism Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can 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.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef TIMPI_INIT_H
#define TIMPI_INIT_H
 
 
// Local includes
#include "timpi/timpi_config.h"
 
#include "timpi/semipermanent.h"
 
// C/C++ includes
 
#ifdef TIMPI_HAVE_MPI
# include "timpi/ignore_warnings.h"
# include <mpi.h>
# include "timpi/restore_warnings.h"
#endif // #ifdef TIMPI_HAVE_MPI
 
#include <memory>
 
namespace TIMPI
{
 
// Forward declarations
  class Communicator;
 
class TIMPIInit
{
public:
#ifdef TIMPI_HAVE_MPI
  TIMPIInit(int argc, const char * const * argv,
               int mpi_thread_requested=0,
               bool handle_mpi_errors=false,
               MPI_Comm COMM_WORLD_IN=MPI_COMM_WORLD);
#else
  TIMPIInit(int argc, const char * const * argv,
               int mpi_thread_requested=0,
               bool handle_mpi_errors=false);
#endif
 
  virtual ~TIMPIInit();
 
  const Communicator & comm() const { return *_comm; }
 
  Communicator & comm() { return *_comm; }
 
private:
  std::unique_ptr<Communicator> _comm;
 
  // unique_ptr so we can free it *before* we MPI_Finalize
  std::unique_ptr<SemiPermanent::Ref> _ref;
 
#ifdef TIMPI_HAVE_MPI
  bool i_initialized_mpi;
 
  MPI_Errhandler my_errhandler;
  bool err_handler_set;
#endif
};
 
 
} // namespace TIMPI
 
#endif // TIMPI_INIT_H