1 /*
2 * This file is part of the GROMACS molecular simulation package.
3 *
4 * Copyright (c) 2016,2018,2019, 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 /*! \internal \file
36 * \brief
37 * Tests for the mdrun signalling functionality
38 *
39 * \author Mark Abraham <mark.j.abraham@gmail.com>
40 * \ingroup module_mdlib
41 */
42 #include "gmxpre.h"
43
44 #include "gromacs/mdlib/simulationsignal.h"
45
46 #include <gtest/gtest.h>
47
48 #include "gromacs/utility/arrayref.h"
49
50 namespace gmx
51 {
52
53 namespace test
54 {
55
56 //! Check that a null signaller can be called without problems
TEST(NullSignalTest,NullSignallerWorks)57 TEST(NullSignalTest, NullSignallerWorks)
58 {
59 SimulationSignaller signaller(nullptr, nullptr, nullptr, false, false);
60 EXPECT_EQ(0, signaller.getCommunicationBuffer().size());
61 signaller.finalizeSignals();
62 }
63
64 //! Test fixture for mdrun signalling
65 class SignalTest : public ::testing::Test
66 {
67 public:
SignalTest()68 SignalTest() : signals_{}
69 {
70 signals_[0].sig = 1;
71 signals_[1].sig = -1;
72 }
73 //! Default object to hold signals
74 SimulationSignals signals_;
75 };
76
TEST_F(SignalTest,NoSignalPropagatesIfNoSignallingTakesPlace)77 TEST_F(SignalTest, NoSignalPropagatesIfNoSignallingTakesPlace)
78 {
79 SimulationSignaller signaller(&signals_, nullptr, nullptr, false, false);
80 EXPECT_EQ(0, signaller.getCommunicationBuffer().size());
81 signaller.finalizeSignals();
82 EXPECT_EQ(1, signals_[0].sig);
83 EXPECT_EQ(-1, signals_[1].sig);
84 EXPECT_EQ(0, signals_[2].sig);
85 EXPECT_EQ(0, signals_[0].set);
86 EXPECT_EQ(0, signals_[1].set);
87 EXPECT_EQ(0, signals_[2].set);
88 }
89
TEST_F(SignalTest,LocalIntraSimSignalPropagatesWhenIntraSimSignalTakesPlace)90 TEST_F(SignalTest, LocalIntraSimSignalPropagatesWhenIntraSimSignalTakesPlace)
91 {
92 SimulationSignaller signaller(&signals_, nullptr, nullptr, false, true);
93 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
94 signaller.finalizeSignals();
95 EXPECT_EQ(0, signals_[0].sig);
96 EXPECT_EQ(0, signals_[1].sig);
97 EXPECT_EQ(0, signals_[2].sig);
98 EXPECT_EQ(1, signals_[0].set);
99 EXPECT_EQ(-1, signals_[1].set);
100 EXPECT_EQ(0, signals_[2].set);
101 }
102
TEST_F(SignalTest,LocalIntraSimSignalPropagatesWhenInterSimTakesPlace)103 TEST_F(SignalTest, LocalIntraSimSignalPropagatesWhenInterSimTakesPlace)
104 {
105 SimulationSignaller signaller(&signals_, nullptr, nullptr, true, false);
106 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
107 // Can't call finalizeSignals without a full commrec
108 signaller.setSignals();
109 EXPECT_EQ(0, signals_[0].sig);
110 EXPECT_EQ(0, signals_[1].sig);
111 EXPECT_EQ(0, signals_[2].sig);
112 EXPECT_EQ(1, signals_[0].set);
113 EXPECT_EQ(-1, signals_[1].set);
114 EXPECT_EQ(0, signals_[2].set);
115 }
116
TEST_F(SignalTest,LocalIntraSimSignalPropagatesWhenBothTakePlace)117 TEST_F(SignalTest, LocalIntraSimSignalPropagatesWhenBothTakePlace)
118 {
119 SimulationSignaller signaller(&signals_, nullptr, nullptr, true, true);
120 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
121 // Can't call finalizeSignals without a full commrec
122 signaller.setSignals();
123 EXPECT_EQ(0, signals_[0].sig);
124 EXPECT_EQ(0, signals_[1].sig);
125 EXPECT_EQ(0, signals_[2].sig);
126 EXPECT_EQ(1, signals_[0].set);
127 EXPECT_EQ(-1, signals_[1].set);
128 EXPECT_EQ(0, signals_[2].set);
129 }
130
TEST_F(SignalTest,NonLocalSignalDoesntPropagateWhenIntraSimSignalTakesPlace)131 TEST_F(SignalTest, NonLocalSignalDoesntPropagateWhenIntraSimSignalTakesPlace)
132 {
133 signals_[0].isLocal = false;
134 SimulationSignaller signaller(&signals_, nullptr, nullptr, false, true);
135 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
136 signaller.finalizeSignals();
137 EXPECT_EQ(1, signals_[0].sig);
138 EXPECT_EQ(0, signals_[1].sig);
139 EXPECT_EQ(0, signals_[2].sig);
140 EXPECT_EQ(0, signals_[0].set);
141 EXPECT_EQ(-1, signals_[1].set);
142 EXPECT_EQ(0, signals_[2].set);
143 }
144
TEST_F(SignalTest,NonLocalSignalPropagatesWhenInterSimSignalTakesPlace)145 TEST_F(SignalTest, NonLocalSignalPropagatesWhenInterSimSignalTakesPlace)
146 {
147 signals_[0].isLocal = false;
148 SimulationSignaller signaller(&signals_, nullptr, nullptr, true, false);
149 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
150 // Can't call finalizeSignals without a full commrec
151 signaller.setSignals();
152 EXPECT_EQ(0, signals_[0].sig);
153 EXPECT_EQ(0, signals_[1].sig);
154 EXPECT_EQ(0, signals_[2].sig);
155 EXPECT_EQ(1, signals_[0].set);
156 EXPECT_EQ(-1, signals_[1].set);
157 EXPECT_EQ(0, signals_[2].set);
158 }
159
TEST_F(SignalTest,NonLocalSignalPropagatesWhenBothTakePlace)160 TEST_F(SignalTest, NonLocalSignalPropagatesWhenBothTakePlace)
161 {
162 signals_[0].isLocal = false;
163 SimulationSignaller signaller(&signals_, nullptr, nullptr, true, true);
164 EXPECT_NE(0, signaller.getCommunicationBuffer().size());
165 // Can't call finalizeSignals without a full commrec
166 signaller.setSignals();
167 EXPECT_EQ(0, signals_[0].sig);
168 EXPECT_EQ(0, signals_[1].sig);
169 EXPECT_EQ(0, signals_[2].sig);
170 EXPECT_EQ(1, signals_[0].set);
171 EXPECT_EQ(-1, signals_[1].set);
172 EXPECT_EQ(0, signals_[2].set);
173 }
174
175 } // namespace test
176 } // namespace gmx
177