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