src/programs/mdrun/tests/simulationdatabase.h

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