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, 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
  44  */
  45
  46 #include <string>
  47
  48 #include <gtest/gtest.h>
  49
  50 #include "gromacs/utility/uniqueptr.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 gmx_unique_ptr<CommandLine>::type CommandLinePointer;
  63
  64 class MultiSimTest : public gmx::test::ParameterizedMdrunTestFixture
  65 {
  66     public:
  67         //! Constructor
  68         MultiSimTest();
  69
  70         /*! \brief Organize the .mdp file for this rank
  71          *
  72          * For testing multi-simulation, this .mdp file is more
  73          * complicated than it needs to be, but it does little harm,
  74          * and doing it this way allows this function to be re-used
  75          * for testing replica-exchange.
  76          *
  77          * \param controlVariable Allows parameterization to work with
  78          * T, P or (later) lambda as the control variable, by passing a
  79          * string with "mdp-param = value" such that different paths
  80          * in init_replica_exchange() are followed.
  81          */
  82         void organizeMdpFile(const char *controlVariable);
  83
  84         //! Number of MPI ranks
  85         int                size_;
  86         //! MPI rank of this process
  87         int                rank_;
  88         //! Object for building the mdrun command line
  89         CommandLinePointer mdrunCaller_;
  90         //! Name of .tpr file to be used by mdrun
  91         std::string        mdrunTprFileName_;
  92 };
  93
  94 } // namespace
  95 } // namespace
  96
  97 #endif