src/gromacs/utility/init.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares functions for initializing the \Gromacs library.
  38  *
  39  * Currently, only MPI initialization/finalization management is
  40  * required, and only if external MPI support is enabled.
  41  *
  42  * If MPI is already initialized, we should not call MPI_Init() or
  43  * MPI_Finalize(). This management object permits \Gromacs test code to
  44  * nest calls to functions that might normally implement a stand-alone
  45  * MPI-using tool. It also permits \Gromacs code to be called from code
  46  * that has already initialized MPI and needs that environment to work
  47  * and persist after \Gromacs code returns (e.g. \Gromacs tests,
  48  * external libraries that call \Gromacs code).
  49  *
  50  * It does so by maintaining a counter of the number of MPI
  51  * initializations, and only calling MPI_Init() or MPI_Finalize when
  52  * it is safe (ie. when the counter is at zero).
  53  *
  54  * Thread-MPI initialization and finalization for mdrun is all managed
  55  * in runner.c.
  56  *
  57  * \author Teemu Murtola <teemu.murtola@gmail.com>
  58  * \inpublicapi
  59  * \ingroup module_utility
  60  */
  61 #ifndef GMX_UTILITY_INIT_H
  62 #define GMX_UTILITY_INIT_H
  63
  64 // Forward declaration of class ProgramInfo is not sufficient for MSVC if
  65 // the return value of init() is ignored(!)
  66 #include "programinfo.h"
  67
  68 namespace gmx
  69 {
  70
  71 /*! \brief
  72  * Initializes the \Gromacs library with explicit binary name.
  73  *
  74  * \param[in] realBinaryName  Name of the binary
  75  *     (without Gromacs binary suffix or .exe on Windows).
  76  * \param[in] argc  argc value passed to main().
  77  * \param[in] argv  argv array passed to main().
  78  * \returns   Reference to initialized program information object.
  79  *
  80  * This overload is provided for cases where the program may be invoked
  81  * through a symlink, and it is necessary to know the real name of the
  82  * binary.
  83  *
  84  * Currently, this is tailored for use in command-line/standalone applications.
  85  * Some additional thought may be required to make it generally usable.
  86  *
  87  * The command line arguments are communicated so that they can be
  88  * parsed on each processor.
  89  * Arguments are the number of command line arguments, and a pointer to the
  90  * array of argument strings. Both are allowed to be NULL.
  91  *
  92  * Does not throw. Terminates the program on out-of-memory error.
  93  *
  94  * \ingroup module_utility
  95  */
  96 ProgramInfo &init(const char *realBinaryName, int *argc, char ***argv);
  97 /*! \brief
  98  * Initializes the \Gromacs library.
  99  *
 100  * \param[in] argc  argc value passed to main().
 101  * \param[in] argv  argv array passed to main().
 102  * \returns   Reference to initialized program information object.
 103  *
 104  * Does not throw. Terminates the program on out-of-memory error.
 105  *
 106  * \ingroup module_utility
 107  */
 108 ProgramInfo &init(int *argc, char ***argv);
 109 /*! \brief
 110  * Deinitializes the \Gromacs library.
 111  *
 112  * Decrements the initialization counter, and calls MPI_Finalize()
 113  * if \Gromacs is compiled with MPI support and the counter has
 114  * reached zero.  In that case, it is not possible to reinitialize
 115  * \Gromacs after calling this function.  Instead, call gmx::init() at
 116  * a higher level, and note that calls to init can be nested safely.
 117  *
 118  * \ingroup module_utility
 119  */
 120 void finalize();
 121
 122 } // namespace gmx
 123
 124 #endif