src/testutils/simulationdatabase.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 /*! \libinternal \file
  36  *
  37  * \brief Functionality for testing whether calls to mdrun produce the
  38  * same energy and force quantities when they should do so.
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_testutils
  42  */
  43 #ifndef GMX_TESTUTILS__SIMULATIONDATABASE_H
  44 #define GMX_TESTUTILS__SIMULATIONDATABASE_H
  45
  46 #include <map>
  47 #include <string>
  48
  49 namespace gmx
  50 {
  51
  52 namespace test
  53 {
  54
  55 /*! \brief Return whether the number of ranks is supported by
  56  * the simulation \c simulationName in the database.
  57  *
  58  * This method lets test runners understand when end-to-end tests
  59  * should be expected to work. */
  60 bool
  61 isNumberOfPpRanksSupported(const std::string &simulationName,
  62                            int                possibleNumberOfPpRanks);
  63
  64 /*! \brief Return a string describing the numbers of ranks supported
  65  * for the simulation \c simulationName in the database. */
  66 std::string
  67 reportNumbersOfPpRanksSupported(const std::string &simulationName);
  68
  69 //! Helper typedef
  70 using MdpFieldValues = std::map<std::string, std::string>;
  71
  72 /*! \brief Set up values for an .mdp file that permits a highly
  73  * reproducible simulation.
  74  *
  75  * An internal database of several kinds of simulation useful for such
  76  * comparisons is available, whose \c simulationName keys are
  77  *     - argon12
  78  *     - argon5832
  79  *     - tip3p5
  80  *     - spc2
  81  *     - spc216
  82  *     - alanine_vsite_vacuo
  83  *     - alanine_vsite_solvated
  84  *     - glycine_vacuo
  85  *     - glycine_no_constraints_vacuo
  86  *     - nonanol_vacuo
  87  *
  88  * Some of these systems are pretty minimal, because having
  89  * few atoms means few interactions, highly reproducible
  90  * forces, and allows tests to focus on the correctness of the
  91  * implementation of high-level mdrun features. The boxes are
  92  * of a reasonable size so that domain decomposition is
  93  * possible. The pressure-coupling parameters are isotropic,
  94  * and set up so that there will not be dramatic collapse of
  95  * volume over the handful of MD steps that will be run. A
  96  * single temperature-coupling group is used.
  97  *
  98  * \param[in]    simulationName   The name of the simulation, which indexes the database
  99  * \param[in]    integrator       The integrator to use
 100  * \param[in]    tcoupl           The temperature-coupling algorithm to use
 101  * \param[in]    pcoupl           The pressure-coupling algorithm to use
 102  * \return                        Mdp file values
 103  *
 104  * \throws  std::bad_alloc     if out of memory
 105  *          std::out_of_range  if \c simulationName is not in the database */
 106 MdpFieldValues
 107 prepareMdpFieldValues(const char *simulationName,
 108                       const char *integrator,
 109                       const char *tcoupl,
 110                       const char *pcoupl);
 111
 112 /*! \brief Make a string containing an .mdp file from the \c mdpFieldValues.
 113  *
 114  * \throws  std::bad_alloc     if out of memory */
 115 std::string
 116 prepareMdpFileContents(const MdpFieldValues &mdpFieldValues);
 117
 118 } // namespace test
 119 } // namespace gmx
 120
 121 #endif