src/testutils/mpi-printer.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  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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 /*! \internal \file
  36  * \brief
  37  * Declares gmx::test::initMPIOutput().
  38  *
  39  * \ingroup module_testutils
  40  */
  41 #ifndef GMX_TESTUTILS_MPI_PRINTER_H
  42 #define GMX_TESTUTILS_MPI_PRINTER_H
  43
  44 namespace gmx
  45 {
  46 namespace test
  47 {
  48
  49 //! \cond internal
  50 /*! \brief
  51  * Customizes test output and test failure handling for MPI runs.
  52  *
  53  * Only one rank should report the test result. Errors detected on a
  54  * subset of ranks need to be reported individually, and as an overall
  55  * failure.
  56  *
  57  * On non-MPI builds, does nothing.
  58  *
  59  * \ingroup module_testutils
  60  */
  61 void initMPIOutput();
  62 //! \endcond
  63
  64 } // namespace test
  65 } // namespace gmx
  66
  67 #endif