src/programs/mdrun/tests/multisimtest.cpp

   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, 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 multi-simulation functionality
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "multisimtest.h"
  46
  47 #include <cmath>
  48
  49 #include <algorithm>
  50 #include <string>
  51
  52 #include <gtest/gtest.h>
  53
  54 #include "gromacs/utility/basenetwork.h"
  55 #include "gromacs/utility/path.h"
  56 #include "gromacs/utility/real.h"
  57 #include "gromacs/utility/stringutil.h"
  58
  59 #include "testutils/cmdlinetest.h"
  60
  61 #include "moduletest.h"
  62 #include "terminationhelper.h"
  63
  64 namespace gmx
  65 {
  66 namespace test
  67 {
  68
  69 MultiSimTest::MultiSimTest() : size_(gmx_node_num()),
  70                                rank_(gmx_node_rank()),
  71                                mdrunCaller_(new CommandLine)
  72
  73 {
  74     const char *directoryNameFormat = "sim_%d";
  75
  76     // Modify the file manager to have a temporary directory unique to
  77     // each simulation. No need to have a mutex on this, nobody else
  78     // can access the fileManager_ yet because we only just
  79     // constructed it.
  80     std::string originalTempDirectory = fileManager_.getOutputTempDirectory();
  81     std::string newTempDirectory      = Path::join(originalTempDirectory, formatString(directoryNameFormat, rank_));
  82     Directory::create(newTempDirectory);
  83     fileManager_.setOutputTempDirectory(newTempDirectory);
  84
  85     mdrunCaller_->append("mdrun");
  86     mdrunCaller_->addOption("-multidir");
  87     for (int i = 0; i != size_; ++i)
  88     {
  89         mdrunCaller_->append(Path::join(originalTempDirectory, formatString(directoryNameFormat, i)));
  90     }
  91 }
  92
  93 void MultiSimTest::organizeMdpFile(SimulationRunner *runner,
  94                                    const char       *controlVariable,
  95                                    int               numSteps)
  96 {
  97     const real  baseTemperature = 298;
  98     const real  basePressure    = 1;
  99     std::string mdpFileContents =
 100         formatString("nsteps = %d\n"
 101                      "nstlog = 1\n"
 102                      "nstcalcenergy = 1\n"
 103                      "tcoupl = v-rescale\n"
 104                      "tc-grps = System\n"
 105                      "tau-t = 1\n"
 106                      "ref-t = %f\n"
 107                      // pressure coupling (if active)
 108                      "tau-p = 1\n"
 109                      "ref-p = %f\n"
 110                      "compressibility = 4.5e-5\n"
 111                      // velocity generation
 112                      "gen-vel = yes\n"
 113                      "gen-temp = %f\n"
 114                      // control variable specification
 115                      "%s\n",
 116                      numSteps,
 117                      baseTemperature + 0.0001*rank_,
 118                      basePressure * std::pow(1.01, rank_),
 119                      /* Set things up so that the initial KE decreases with
 120                         increasing replica number, so that the (identical)
 121                         starting PE decreases on the first step more for the
 122                         replicas with higher number, which will tend to force
 123                         replica exchange to occur. */
 124                      std::max(baseTemperature - 10 * rank_, real(0)),
 125                      controlVariable);
 126     runner->useStringAsMdpFile(mdpFileContents);
 127 }
 128
 129 void MultiSimTest::runExitsNormallyTest()
 130 {
 131     if (size_ <= 1)
 132     {
 133         /* Can't test multi-sim without multiple ranks. */
 134         return;
 135     }
 136
 137     SimulationRunner runner(&fileManager_);
 138     runner.useTopGroAndNdxFromDatabase("spc2");
 139
 140     const char *pcoupl = GetParam();
 141     organizeMdpFile(&runner, pcoupl);
 142     /* Call grompp on every rank - the standard callGrompp() only runs
 143        grompp on rank 0. */
 144     EXPECT_EQ(0, runner.callGromppOnThisRank());
 145
 146     ASSERT_EQ(0, runner.callMdrun(*mdrunCaller_));
 147 }
 148
 149 void MultiSimTest::runMaxhTest()
 150 {
 151     if (size_ <= 1)
 152     {
 153         /* Can't test replica exchange without multiple ranks. */
 154         return;
 155     }
 156
 157     SimulationRunner runner(&fileManager_);
 158     runner.useTopGroAndNdxFromDatabase("spc2");
 159
 160     TerminationHelper helper(&fileManager_, mdrunCaller_.get(), &runner);
 161     // Make sure -maxh has a chance to propagate
 162     int               numSteps = 100;
 163     organizeMdpFile(&runner, "pcoupl = no", numSteps);
 164     /* Call grompp on every rank - the standard callGrompp() only runs
 165        grompp on rank 0. */
 166     EXPECT_EQ(0, runner.callGromppOnThisRank());
 167
 168     helper.runFirstMdrun(runner.cptFileName_);
 169     helper.runSecondMdrun();
 170 }
 171
 172 }  // namespace test
 173 }  // namespace gmx