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