src/programs/mdrun/tests/simulatorcomparison.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  * \brief
  37  * Helper classes for tests that compare the results of equivalent
  38  * simulation runs. Currently used for the rerun and the simulator
  39  * tests
  40  *
  41  * \author Mark Abraham <mark.j.abraham@gmail.com>
  42  * \author Pascal Merz <pascal.merz@me.com>
  43  * \ingroup module_mdrun_integration_tests
  44  */
  45
  46 #ifndef GMX_PROGRAMS_MDRUN_TESTS_SIMULATORCOMPARISON_H
  47 #define GMX_PROGRAMS_MDRUN_TESTS_SIMULATORCOMPARISON_H
  48
  49 #include <string>
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55 /*!
  56  * \brief Run and compare a simulator run with and without an environment variable
  57  *
  58  * Run grompp, and repeat mdrun with and without the environment variable set.
  59  * Compare energies (via EnergyComparator) and trajectories.
  60  */
  61 template<typename... Args>
  62 void executeSimulatorComparisonTest(const std::string& environmentVariable, Args&&... args);
  63
  64 /*!
  65  * \brief Run and compare a simulator run to its rerun
  66  *
  67  * Run grompp, run mdrun and rerun the resulting trajectory.
  68  * Compare energies (via EnergyComparator) and trajectories.
  69  */
  70 template<typename... Args>
  71 void executeRerunTest(Args&&... args);
  72
  73 } // namespace test
  74 } // namespace gmx
  75
  76 // Including this here avoid having to put everything in the header file,
  77 // or to explicitly declare the templates (which would render the parameter
  78 // pack useless)
  79 #include "simulatorcomparison.cpp"
  80
  81 #endif // GMX_PROGRAMS_MDRUN_TESTS_SIMULATORCOMPARISON_H