src/programs/mdrun/tests/multisimtest.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014,2015,2016,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 #ifndef GMX_MDRUN_TESTS_MULTISIMTEST_H
  36 #define GMX_MDRUN_TESTS_MULTISIMTEST_H
  37
  38 /*! \internal \file
  39  * \brief
  40  * Declares test fixture for the mdrun multi-simulation functionality
  41  *
  42  * \author Mark Abraham <mark.j.abraham@gmail.com>
  43  * \ingroup module_mdrun_integration_tests
  44  */
  45
  46 #include <memory>
  47 #include <string>
  48
  49 #include <gtest/gtest.h>
  50
  51 #include "testutils/cmdlinetest.h"
  52
  53 #include "moduletest.h"
  54
  55 namespace gmx
  56 {
  57 namespace test
  58 {
  59
  60 //! Convenience typedef
  61 typedef std::unique_ptr<CommandLine> CommandLinePointer;
  62
  63 /*! \internal
  64  * \brief Test fixture for multi-sim functionality.
  65  *
  66  * This is intended to be re-used also for tests of functionality that
  67  * are derived from multi-sim, e.g. REMD.
  68  *
  69  * \ingroup module_mdrun_integration_tests
  70  */
  71 class MultiSimTest : public ::testing::Test, public ::testing::WithParamInterface<const char*>
  72 {
  73 public:
  74     MultiSimTest();
  75
  76     /*! \brief Organize the .mdp file for this rank
  77      *
  78      * For testing multi-simulation, this .mdp file is more
  79      * complicated than it needs to be, but it does little harm,
  80      * and doing it this way allows this function to be re-used
  81      * for testing replica-exchange.
  82      *
  83      * \param runner          The simulation runner that uses the
  84      *                        mdp file that is organized.
  85      * \param controlVariable Allows parameterization to work with
  86      * T, P or (later) lambda as the control variable, by passing a
  87      * string with "mdp-param = value" such that different paths
  88      * in init_replica_exchange() are followed.
  89      * \param numSteps        Number of MD steps to perform.
  90      */
  91     void organizeMdpFile(SimulationRunner* runner, const char* controlVariable, int numSteps = 2);
  92     //! Test that a basic simulation works
  93     void runExitsNormallyTest();
  94     //! Test that mdrun -maxh and restart works
  95     void runMaxhTest();
  96     //! Number of MPI ranks
  97     int size_;
  98     //! MPI rank of this process
  99     int rank_;
 100     //! Object for building the mdrun command line
 101     CommandLinePointer mdrunCaller_;
 102     //! Manages temporary files during the test.
 103     TestFileManager fileManager_;
 104 };
 105
 106 } // namespace test
 107 } // namespace gmx
 108
 109 #endif