src/programs/mdrun/tests/replicaexchange.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2013,2014, 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
  36 /*! \internal \file
  37  * \brief
  38  * Tests for the mdrun replica exchange functionality
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_mdrun
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "config.h"
  46
  47 #include <math.h>
  48
  49 #include <algorithm>
  50
  51 #include <gtest/gtest.h>
  52
  53 #include "gromacs/utility/basenetwork.h"
  54 #include "gromacs/utility/path.h"
  55 #include "gromacs/utility/real.h"
  56 #include "gromacs/utility/stringutil.h"
  57 #include "programs/mdrun/mdrun_main.h"
  58
  59 #include "testutils/cmdlinetest.h"
  60
  61 #include "moduletest.h"
  62
  63 namespace
  64 {
  65
  66 /*! \brief
  67  * Test fixture for replica exchange
  68  */
  69 class ReplicaExchangeTest : public gmx::test::ParameterizedMdrunTestFixture
  70 {
  71     public:
  72         //! Constructor
  73         ReplicaExchangeTest() : size(gmx_node_num()),
  74                                 rank(gmx_node_rank())
  75         {
  76             mdrunCaller.append("mdrun_mpi");
  77         }
  78
  79         /*! \brief Organize the -multidir directories for the test.
  80          *
  81          * These are created inside the temporary directory for the
  82          * test case, and added to the eventual mdrun command
  83          * line. The temporary directory for the call to grompp by
  84          * this rank is set to the appropriate -multidir directory, so
  85          * the grompp output files go to the right place. */
  86         void organizeMultidir()
  87         {
  88             mdrunCaller.append("-multidir");
  89
  90             std::string futureTestTempDirectory;
  91             for (int i = 0; i != size; ++i)
  92             {
  93                 std::string replicaTempDirectory =
  94                     gmx::formatString("%s/multidir_%d",
  95                                       fileManager_.getOutputTempDirectory(), i);
  96                 mdrunCaller.append(replicaTempDirectory);
  97
  98                 if (rank == i)
  99                 {
 100                     gmx::Directory::create(replicaTempDirectory);
 101                     futureTestTempDirectory = std::string(replicaTempDirectory);
 102                 }
 103             }
 104             fileManager_.setOutputTempDirectory(futureTestTempDirectory);
 105
 106             /* Prepare grompp output filenames inside the new
 107                temporary directory */
 108             mdpInputFileName  = fileManager_.getTemporaryFilePath("input.mdp");
 109             mdpOutputFileName = fileManager_.getTemporaryFilePath("output.mdp");
 110             tprFileName       = fileManager_.getTemporaryFilePath(".tpr");
 111
 112             mdrunCaller.addOption("-deffnm", fileManager_.getTestSpecificFileNameRoot());
 113         }
 114
 115         /*! \brief Organize the .mdp file for this rank
 116          *
 117          * \param controlVariable Allows parameterization to work with
 118          * T, P or (later) lamda as the control variable, by passing a
 119          * string with "mdp-param = value" such that different paths
 120          * in init_replica_exchange() are followed.
 121          */
 122         void organizeMdpFile(const char *controlVariable)
 123         {
 124             const real  baseTemperature = 298;
 125             const real  basePressure    = 1;
 126             std::string mdpFileContents =
 127                 gmx::formatString
 128                     ("nsteps = 2\n"
 129                     "nstlog = 1\n"
 130                     "nstcalcenergy = 1\n"
 131                     "tcoupl = v-rescale\n"
 132                     "tc-grps = System\n"
 133                     "tau-t = 1\n"
 134                     "ref-t = %f\n"
 135                     // pressure coupling (if active)
 136                     "tau-p = 1\n"
 137                     "ref-p = %f\n"
 138                     "compressibility = 4.5e-5\n"
 139                     // velocity generation
 140                     "gen-vel = yes\n"
 141                     "gen-temp = %f\n"
 142                     // control variable specification
 143                     "%s\n",
 144                     baseTemperature + 0.0001*rank,
 145                     basePressure * pow(1.01, rank),
 146                     /* Set things up so that the initial KE decreases
 147                        with increasing replica number, so that the
 148                        (identical) starting PE decreases on the first
 149                        step more for the replicas with higher number,
 150                        which will tend to force replica exchange to
 151                        occur. */
 152                     std::max(baseTemperature - 10 * rank, real(0)),
 153                     controlVariable);
 154             useStringAsMdpFile(mdpFileContents);
 155         }
 156
 157         //! MPI process set size
 158         int                    size;
 159         //! MPI rank of this process
 160         int                    rank;
 161         //! Object for building the mdrun command line
 162         gmx::test::CommandLine mdrunCaller;
 163 };
 164
 165 /* This test ensures mdrun can run NVT REMD under the supported
 166  * conditions.
 167  *
 168  * TODO Preferably, we could test that mdrun correctly refuses to run
 169  * replica exchange unless under real MPI with more than one rank
 170  * available. However, those cases trigger an error that is currently
 171  * fatal to mdrun and also to the test binary. So, in the meantime we
 172  * must not test those cases. This is done via disabling the test, so
 173  * that there is a reminder that it is disabled. There's no elegant
 174  * way to conditionally disable a test. */
 175 TEST_P(ReplicaExchangeTest, ExitsNormally)
 176 {
 177     if (size <= 1)
 178     {
 179         /* Can't test replica exchange without multiple ranks. */
 180         return;
 181     }
 182
 183     organizeMultidir();
 184     const char *pcoupl = GetParam();
 185     organizeMdpFile(pcoupl);
 186     useTopGroAndNdxFromDatabase("spc2");
 187     /* Call grompp on every rank - the standard callGrompp() only runs
 188        grompp on rank 0. */
 189     EXPECT_EQ(0, callGromppOnThisRank());
 190
 191     mdrunCaller.addOption("-replex", 1);
 192     ASSERT_EQ(0, gmx_mdrun(mdrunCaller.argc(), mdrunCaller.argv()));
 193 }
 194
 195 #ifdef GMX_LIB_MPI
 196 INSTANTIATE_TEST_CASE_P(WithDifferentControlVariables, ReplicaExchangeTest,
 197                             ::testing::Values("pcoupl = no", "pcoupl = Berendsen"));
 198 #else
 199 INSTANTIATE_TEST_CASE_P(DISABLED_WithDifferentControlVariables, ReplicaExchangeTest,
 200                             ::testing::Values("pcoupl = no", "pcoupl = Berendsen"));
 201 #endif
 202
 203 } // namespace