src/gromacs/utility/basenetwork.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \libinternal \file
  38  * \brief
  39  * Utility functions for basic MPI and network functionality.
  40  *
  41  * \inlibraryapi
  42  * \ingroup module_utility
  43  */
  44 #ifndef GMX_UTILITY_BASENETWORK_H
  45 #define GMX_UTILITY_BASENETWORK_H
  46
  47 /*! \brief
  48  * Returns whether MPI has been initialized.
  49  *
  50  * The return value is `FALSE` if MPI_Init() has not been called, or if
  51  * \Gromacs has been compiled without MPI support.
  52  * For thread-MPI, returns `TRUE` when the threads have been started.
  53  *
  54  * Note that there is a lot of code in between MPI_Init() and the thread-MPI
  55  * thread start where the return value is different depending on compilation
  56  * options.
  57  */
  58 bool gmx_mpi_initialized();
  59
  60 /*! \brief
  61  * Returns the number of nodes.
  62  *
  63  * For thread-MPI, returns one before the threads have been started.
  64  * This allows code between the real MPI_Init() and the thread-MPI "init" to
  65  * still use this function to check for serial/parallel status and work as
  66  * expected: for thread-MPI, at that point they should behave as if the run was
  67  * serial.
  68  */
  69 int gmx_node_num();
  70
  71 /*! \brief
  72  * Returns the rank of the node.
  73  *
  74  * For thread-MPI, returns zero before the threads have been started.
  75  * This allows code between the real MPI_Init() and the thread-MPI "init" to
  76  * still use this function to check for master node work as expected:
  77  * for thread-MPI, at that point the only thread of execution should behave as
  78  * if it the master node.
  79  */
  80 int gmx_node_rank();
  81
  82 /*! \brief
  83  * Return a non-negative hash that is, hopefully, unique for each physical
  84  * node.
  85  *
  86  * This hash is useful for determining hardware locality.
  87  */
  88 int gmx_physicalnode_id_hash();
  89
  90 /*! \brief
  91  * Broadcasts given data from rank zero to all other ranks.
  92  */
  93 void gmx_broadcast_world(int size, void* buffer);
  94
  95 /** Abort the parallel run */
  96 [[noreturn]] void gmx_abort(int errorno);
  97
  98 #endif