Update mdrun Doxygen
[alexxy/gromacs.git] / src / programs / mdrun / tests / replicaexchange.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 replica-exchange 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 "config.h"
46
47 #include <gtest/gtest.h>
48
49 #include "multisimtest.h"
50
51 namespace gmx
52 {
53 namespace test
54 {
55
56 //! Convenience typedef
57 typedef MultiSimTest ReplicaExchangeTest;
58
59 /* This test ensures mdrun can run NVT REMD under the supported
60  * conditions. It runs one replica per MPI rank.
61  *
62  * See also comments about MultiSimTest */
63 TEST_P(ReplicaExchangeTest, ExitsNormally)
64 {
65     if (size_ <= 1)
66     {
67         /* Can't test replica exchange without multiple ranks. */
68         return;
69     }
70
71     const char *pcoupl = GetParam();
72     organizeMdpFile(pcoupl);
73     /* Call grompp on every rank - the standard callGrompp() only runs
74        grompp on rank 0. */
75     EXPECT_EQ(0, runner_.callGromppOnThisRank());
76
77     // mdrun names the files without the rank suffix
78     runner_.tprFileName_ = mdrunTprFileName_;
79     mdrunCaller_->addOption("-replex", 1);
80     ASSERT_EQ(0, runner_.callMdrun(*mdrunCaller_));
81 }
82
83 /* Note, not all preprocessor implementations nest macro expansions
84    the same way / at all, if we would try to duplicate less code. */
85 #ifdef GMX_LIB_MPI
86 INSTANTIATE_TEST_CASE_P(WithDifferentControlVariables, ReplicaExchangeTest,
87                             ::testing::Values("pcoupl = no", "pcoupl = Berendsen"));
88 #else
89 INSTANTIATE_TEST_CASE_P(DISABLED_WithDifferentControlVariables, ReplicaExchangeTest,
90                             ::testing::Values("pcoupl = no", "pcoupl = Berendsen"));
91 #endif
92
93 } // namespace
94 } // namespace