Merge release-5-0 into release-5-1
[alexxy/gromacs.git] / 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, 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  * \todo Test mdrun -multidir also
41  *
42  * \author Mark Abraham <mark.j.abraham@gmail.com>
43  * \ingroup module_mdrun
44  */
45 #include "gmxpre.h"
46
47 #include "multisimtest.h"
48
49 #include <cmath>
50
51 #include <algorithm>
52 #include <string>
53
54 #include <gtest/gtest.h>
55
56 #include "gromacs/utility/basenetwork.h"
57 #include "gromacs/utility/real.h"
58 #include "gromacs/utility/stringutil.h"
59
60 #include "testutils/cmdlinetest.h"
61
62 #include "moduletest.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     runner_.mdpInputFileName_  = fileManager_.getTemporaryFilePath(formatString("input%d.mdp", rank_));
74     runner_.mdpOutputFileName_ = fileManager_.getTemporaryFilePath(formatString("output%d.mdp", rank_));
75
76     /* grompp needs to name the .tpr file so that when mdrun appends
77        the MPI rank, it will find the right file. If we just used
78        "%d.tpr" then \c TestFileManager prefixes that with an
79        underscore. Then, there is no way for mdrun to be told the
80        right name, because if you add the underscore manually, you get
81        a second one from \c TestFileManager. However, it's easy to
82        just start the suffix with "topol" in both cases. */
83     runner_.tprFileName_ = fileManager_.getTemporaryFilePath(formatString("topol%d.tpr", rank_));
84     mdrunTprFileName_    = fileManager_.getTemporaryFilePath("topol.tpr");
85
86     runner_.useTopGroAndNdxFromDatabase("spc2");
87
88     mdrunCaller_->append("mdrun_mpi");
89     mdrunCaller_->addOption("-multi", size_);
90 }
91
92 void MultiSimTest::organizeMdpFile(const char *controlVariable)
93 {
94     const real  baseTemperature = 298;
95     const real  basePressure    = 1;
96     std::string mdpFileContents =
97         formatString("nsteps = 2\n"
98                      "nstlog = 1\n"
99                      "nstcalcenergy = 1\n"
100                      "tcoupl = v-rescale\n"
101                      "tc-grps = System\n"
102                      "tau-t = 1\n"
103                      "ref-t = %f\n"
104                      // pressure coupling (if active)
105                      "tau-p = 1\n"
106                      "ref-p = %f\n"
107                      "compressibility = 4.5e-5\n"
108                      // velocity generation
109                      "gen-vel = yes\n"
110                      "gen-temp = %f\n"
111                      // control variable specification
112                      "%s\n",
113                      baseTemperature + 0.0001*rank_,
114                      basePressure * std::pow(1.01, rank_),
115                      /* Set things up so that the initial KE decreases with
116                         increasing replica number, so that the (identical)
117                         starting PE decreases on the first step more for the
118                         replicas with higher number, which will tend to force
119                         replica exchange to occur. */
120                      std::max(baseTemperature - 10 * rank_, real(0)),
121                      controlVariable);
122     runner_.useStringAsMdpFile(mdpFileContents);
123 }
124
125 } // namespace
126 } // namespace