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 by the GROMACS development team.
   5  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 #ifndef GMX_MDRUN_TESTS_MULTISIMTEST_H
  37 #define GMX_MDRUN_TESTS_MULTISIMTEST_H
  38
  39 /*! \internal \file
  40  * \brief
  41  * Declares test fixture for the mdrun multi-simulation functionality
  42  *
  43  * \author Mark Abraham <mark.j.abraham@gmail.com>
  44  * \ingroup module_mdrun_integration_tests
  45  */
  46
  47 #include <memory>
  48 #include <string>
  49
  50 #include <gtest/gtest.h>
  51
  52 #include "testutils/cmdlinetest.h"
  53
  54 #include "moduletest.h"
  55
  56 namespace gmx
  57 {
  58 namespace test
  59 {
  60
  61 //! Convenience typedef
  62 typedef std::unique_ptr<CommandLine> CommandLinePointer;
  63
  64 /*! \internal
  65  * \brief Test fixture for multi-sim functionality.
  66  *
  67  * This is intended to be re-used also for tests of functionality that
  68  * are derived from multi-sim, e.g. REMD.
  69  *
  70  * \ingroup module_mdrun_integration_tests
  71  */
  72 class MultiSimTest : public ::testing::Test, public ::testing::WithParamInterface<const char*>
  73 {
  74 public:
  75     MultiSimTest();
  76
  77     /*! \brief Organize the .mdp file for this rank
  78      *
  79      * For testing multi-simulation, this .mdp file is more
  80      * complicated than it needs to be, but it does little harm,
  81      * and doing it this way allows this function to be re-used
  82      * for testing replica-exchange.
  83      *
  84      * \param runner          The simulation runner that uses the
  85      *                        mdp file that is organized.
  86      * \param controlVariable Allows parameterization to work with
  87      * T, P or (later) lambda as the control variable, by passing a
  88      * string with "mdp-param = value" such that different paths
  89      * in init_replica_exchange() are followed.
  90      * \param numSteps        Number of MD steps to perform.
  91      */
  92     void organizeMdpFile(SimulationRunner* runner, const char* controlVariable, int numSteps = 2);
  93     //! Test that a basic simulation works
  94     void runExitsNormallyTest();
  95     //! Test that mdrun -maxh and restart works
  96     void runMaxhTest();
  97     //! Number of MPI ranks
  98     int size_;
  99     //! MPI rank of this process
 100     int rank_;
 101     //! Object for building the mdrun command line
 102     CommandLinePointer mdrunCaller_;
 103     //! Manages temporary files during the test.
 104     TestFileManager fileManager_;
 105 };
 106
 107 } // namespace test
 108 } // namespace gmx
 109
 110 #endif