Add ForceBuffers class
[alexxy/gromacs.git] / src / gromacs / mdtypes / tests / forcebuffers.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2020, 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 ForceBuffers and ForceBuffersView classes.
38  *
39  * \author berk Hess <hess@kth.se>
40  * \ingroup module_mdtypes
41  */
42 #include "gmxpre.h"
43
44 #include "gromacs/mdtypes/forcebuffers.h"
45
46 #include <array>
47
48 #include <gmock/gmock.h>
49 #include <gtest/gtest.h>
50
51 #include "testutils/testasserts.h"
52
53 namespace gmx
54 {
55
56 const std::array<RVec, 2> c_forces = { { { 0.5, 0.1, 1.2 }, { -2.1, 0.2, 0.3 } } };
57
58 TEST(ForceBuffers, ConstructsUnpinned)
59 {
60     ForceBuffers forceBuffers;
61
62     EXPECT_EQ(forceBuffers.pinningPolicy(), PinningPolicy::CannotBePinned);
63 }
64
65 TEST(ForceBuffers, ConstructsPinned)
66 {
67     ForceBuffers forceBuffers(PinningPolicy::PinnedIfSupported);
68
69     EXPECT_EQ(forceBuffers.pinningPolicy(), PinningPolicy::PinnedIfSupported);
70 }
71
72 TEST(ForceBuffers, ConstructsEmpty)
73 {
74     ForceBuffers forceBuffers;
75
76     EXPECT_EQ(forceBuffers.view().force().size(), 0);
77 }
78
79 TEST(ForceBuffers, ResizeWorks)
80 {
81     ForceBuffers forceBuffers;
82
83     forceBuffers.resize(2);
84     EXPECT_EQ(forceBuffers.view().force().size(), 2);
85 }
86
87 TEST(ForceBuffers, PaddingWorks)
88 {
89     ForceBuffers forceBuffers;
90
91     forceBuffers.resize(2);
92     auto paddedRef = forceBuffers.view().forceWithPadding();
93     EXPECT_EQ(paddedRef.unpaddedArrayRef().size(), 2);
94     EXPECT_GT(paddedRef.size(), 2);
95 }
96
97
98 TEST(ForceBuffers, CopyWorks)
99 {
100     ForceBuffers forceBuffers;
101
102     forceBuffers.resize(2);
103     auto  force = forceBuffers.view().force();
104     index i     = 0;
105     for (RVec& v : force)
106     {
107         v = c_forces[i];
108         i++;
109     }
110
111     ForceBuffers forceBuffersCopy;
112     forceBuffersCopy = forceBuffers;
113     auto forceCopy   = forceBuffersCopy.view().force();
114     EXPECT_EQ(forceBuffersCopy.view().force().size(), 2);
115     for (index i = 0; i < ssize(forceCopy); i++)
116     {
117         for (int d = 0; d < DIM; d++)
118         {
119             EXPECT_EQ(forceCopy[i][d], force[i][d]);
120         }
121     }
122 }
123
124 TEST(ForceBuffers, CopyDoesNotPin)
125 {
126     ForceBuffers forceBuffers(PinningPolicy::PinnedIfSupported);
127
128     ForceBuffers forceBuffersCopy;
129     forceBuffersCopy = forceBuffers;
130     EXPECT_EQ(forceBuffersCopy.pinningPolicy(), PinningPolicy::CannotBePinned);
131 }
132
133 } // namespace gmx