2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2016,2017, 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.
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.
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.
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.
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.
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.
37 * Implements PME force gathering tests.
39 * \author Aleksei Iupinov <a.yupinov@gmail.com>
40 * \ingroup module_ewald
47 #include <gmock/gmock.h>
49 #include "gromacs/mdrunutility/mdmodules.h"
50 #include "gromacs/mdtypes/inputrec.h"
51 #include "gromacs/utility/stringutil.h"
53 #include "testutils/refdata.h"
54 #include "testutils/testasserts.h"
56 #include "pmetestcommon.h"
65 /* Valid input instances */
67 //! A couple of valid inputs for boxes.
68 static std::vector<Matrix3x3> const c_sampleBoxes
84 //! A couple of valid inputs for grid sizes
85 static std::vector<IVec> const c_sampleGridSizes
95 static std::vector<real> const c_sampleChargesFull
97 4.95f, 3.11f, 3.97f, 1.08f, 2.09f, 1.1f, 4.13f, 3.31f, 2.8f, 5.83f, 5.09f, 6.1f, 2.86f, 0.24f, 5.76f, 5.19f, 0.72f
100 //! All the input atom gridline indices
101 static std::vector<IVec> const c_sampleGridLineIndicesFull
156 // Spline values/derivatives below are also generated randomly, so they are bogus,
157 // but that should not affect the reproducibility, which we're after
159 //! A lot of bogus input spline values - should have at list (max PME order = 5) * (DIM = 3) * (total unique atom number in all test cases = 16) values
160 static std::vector<real> const c_sampleSplineValuesFull
162 0.12f, 0.81f, 0.29f, 0.22f, 0.13f, 0.19f, 0.12f, 0.8f, 0.44f, 0.38f, 0.32f, 0.36f, 0.27f, 0.11f, 0.17f, 0.94f, 0.07f, 0.9f, 0.98f, 0.96f, 0.07f, 0.94f, 0.77f, 0.24f, 0.84f, 0.16f, 0.77f, 0.57f, 0.52f, 0.27f, 0.39f, 0.45f, 0.6f, 0.59f, 0.44f, 0.91f, 0.97f, 0.43f, 0.24f, 0.52f, 0.73f, 0.55f, 0.99f, 0.39f, 0.97f, 0.35f, 0.1f, 0.68f, 0.19f, 0.1f, 0.77f, 0.2f, 0.43f, 0.69f, 0.76f, 0.32f, 0.31f, 0.94f, 0.53f, 0.6f, 0.93f, 0.57f, 0.94f, 0.88f, 0.75f, 0.77f, 0.91f, 0.72f, 0.07f, 0.78f, 0.09f, 0.02f, 0.48f, 0.97f, 0.89f, 0.39f, 0.48f, 0.19f, 0.02f, 0.92f, 0.8f, 0.41f, 0.53f, 0.32f, 0.38f, 0.58f, 0.36f, 0.46f, 0.92f, 0.91f, 0.01f, 0.86f, 0.54f, 0.86f, 0.94f, 0.37f, 0.35f, 0.81f, 0.89f, 0.48f,
163 0.34f, 0.18f, 0.11f, 0.02f, 0.87f, 0.95f, 0.66f, 0.67f, 0.38f, 0.45f, 0.04f, 0.94f, 0.54f, 0.76f, 0.58f, 0.83f, 0.31f, 0.73f, 0.71f, 0.06f, 0.35f, 0.32f, 0.35f, 0.61f, 0.27f, 0.98f, 0.83f, 0.11f, 0.3f, 0.42f, 0.95f, 0.69f, 0.58f, 0.29f, 0.1f, 0.68f, 0.94f, 0.62f, 0.51f, 0.47f, 0.04f, 0.47f, 0.34f, 0.71f, 0.52f, 0.19f, 0.69f, 0.5f, 0.59f, 0.05f, 0.74f, 0.11f, 0.4f, 0.81f, 0.24f, 0.53f, 0.71f, 0.07f, 0.17f, 0.41f, 0.23f, 0.78f, 0.27f, 0.1f, 0.71f, 0.36f, 0.67f, 0.6f, 0.94f, 0.69f, 0.19f, 0.58f, 0.68f, 0.5f, 0.62f, 0.38f, 0.29f, 0.44f, 0.04f, 0.89f, 0.0f, 0.76f, 0.22f, 0.16f, 0.08f, 0.62f, 0.51f, 0.62f, 0.83f, 0.72f, 0.96f, 0.99f, 0.4f, 0.79f, 0.83f, 0.21f, 0.43f, 0.32f, 0.44f, 0.72f,
164 0.21f, 0.4f, 0.93f, 0.07f, 0.11f, 0.41f, 0.24f, 0.04f, 0.36f, 0.15f, 0.92f, 0.08f, 0.99f, 0.35f, 0.42f, 0.7f, 0.17f, 0.39f, 0.69f, 0.0f, 0.86f, 0.89f, 0.59f, 0.81f, 0.77f, 0.15f, 0.89f, 0.17f, 0.76f, 0.67f, 0.58f, 0.78f, 0.26f, 0.19f, 0.69f, 0.18f, 0.46f, 0.6f, 0.69f, 0.23f, 0.34f, 0.3f, 0.64f, 0.34f, 0.6f, 0.99f, 0.69f, 0.57f, 0.75f, 0.07f, 0.36f, 0.75f, 0.81f, 0.8f, 0.42f, 0.09f, 0.94f, 0.66f, 0.35f, 0.67f, 0.34f, 0.66f, 0.02f, 0.47f, 0.78f, 0.21f, 0.02f, 0.18f, 0.42f, 0.2f, 0.46f, 0.34f, 0.4f, 0.46f, 0.96f, 0.86f, 0.25f, 0.25f, 0.22f, 0.37f, 0.59f, 0.19f, 0.45f, 0.61f, 0.04f, 0.71f, 0.77f, 0.51f, 0.77f, 0.15f, 0.78f, 0.36f, 0.62f, 0.24f, 0.86f, 0.2f, 0.77f, 0.08f, 0.09f, 0.3f,
165 0.0f, 0.6f, 0.99f, 0.69f,
168 //! A lot of bogus input spline derivatives - should have at list (max PME order = 5) * (DIM = 3) * (total unique atom number in all test cases = 16) values
169 static std::vector<real> const c_sampleSplineDerivativesFull
171 0.82f, 0.88f, 0.83f, 0.11f, 0.93f, 0.32f, 0.71f, 0.37f, 0.69f, 0.88f, 0.11f, 0.38f, 0.25f, 0.5f, 0.36f, 0.81f, 0.78f, 0.31f, 0.66f, 0.32f, 0.27f, 0.35f, 0.53f, 0.83f, 0.08f, 0.08f, 0.94f, 0.71f, 0.65f, 0.24f, 0.13f, 0.01f, 0.33f, 0.65f, 0.24f, 0.53f, 0.45f, 0.84f, 0.33f, 0.97f, 0.31f, 0.7f, 0.03f, 0.31f, 0.41f, 0.76f, 0.12f, 0.3f, 0.57f, 0.65f, 0.87f, 0.99f, 0.42f, 0.97f, 0.32f, 0.39f, 0.73f, 0.23f, 0.03f, 0.67f, 0.97f, 0.57f, 0.42f, 0.38f, 0.54f, 0.17f, 0.53f, 0.54f, 0.18f, 0.8f, 0.76f, 0.13f, 0.29f, 0.83f, 0.77f, 0.56f, 0.4f, 0.87f, 0.36f, 0.18f, 0.59f, 0.04f, 0.05f, 0.61f, 0.26f, 0.91f, 0.62f, 0.16f, 0.89f, 0.23f, 0.26f, 0.59f, 0.33f, 0.2f, 0.49f, 0.41f, 0.25f, 0.4f, 0.16f, 0.83f,
172 0.44f, 0.82f, 0.21f, 0.95f, 0.14f, 0.8f, 0.37f, 0.31f, 0.41f, 0.53f, 0.15f, 0.85f, 0.78f, 0.17f, 0.92f, 0.03f, 0.13f, 0.2f, 0.03f, 0.33f, 0.87f, 0.38f, 0, 0.08f, 0.79f, 0.36f, 0.53f, 0.05f, 0.07f, 0.94f, 0.23f, 0.85f, 0.13f, 0.27f, 0.23f, 0.22f, 0.26f, 0.38f, 0.15f, 0.48f, 0.18f, 0.33f, 0.23f, 0.62f, 0.1f, 0.36f, 0.99f, 0.07f, 0.02f, 0.04f, 0.09f, 0.29f, 0.52f, 0.29f, 0.83f, 0.97f, 0.61f, 0.81f, 0.49f, 0.56f, 0.08f, 0.09f, 0.03f, 0.65f, 0.46f, 0.1f, 0.06f, 0.06f, 0.39f, 0.29f, 0.04f, 0.03f, 0.1f, 0.83f, 0.94f, 0.59f, 0.97f, 0.82f, 0.2f, 0.66f, 0.23f, 0.11f, 0.03f, 0.16f, 0.27f, 0.53f, 0.94f, 0.46f, 0.43f, 0.29f, 0.97f, 0.64f, 0.46f, 0.37f, 0.43f, 0.48f, 0.37f, 0.93f, 0.5f, 0.2f,
173 0.92f, 0.09f, 0.74f, 0.55f, 0.44f, 0.05f, 0.13f, 0.17f, 0.79f, 0.44f, 0.11f, 0.6f, 0.64f, 0.05f, 0.96f, 0.3f, 0.45f, 0.47f, 0.42f, 0.74f, 0.91f, 0.06f, 0.89f, 0.24f, 0.26f, 0.68f, 0.4f, 0.88f, 0.5f, 0.65f, 0.48f, 0.15f, 0.0f, 0.41f, 0.67f, 0.4f, 0.31f, 0.73f, 0.77f, 0.36f, 0.26f, 0.74f, 0.46f, 0.56f, 0.78f, 0.92f, 0.32f, 0.9f, 0.06f, 0.55f, 0.6f, 0.13f, 0.38f, 0.93f, 0.5f, 0.92f, 0.96f, 0.82f, 0.0f, 0.04f, 0.9f, 0.55f, 0.97f, 1.0f, 0.23f, 0.46f, 0.52f, 0.49f, 0.0f, 0.32f, 0.16f, 0.4f, 0.62f, 0.36f, 0.03f, 0.63f, 0.16f, 0.58f, 0.97f, 0.03f, 0.44f, 0.07f, 0.22f, 0.75f, 0.32f, 0.61f, 0.94f, 0.33f, 0.7f, 0.57f, 0.5f, 0.84f, 0.7f, 0.47f, 0.18f, 0.09f, 0.25f, 0.77f, 0.94f, 0.85f,
174 0.09f, 0.83f, 0.02f, 0.91f,
177 //! 2 c_sample grids - only non-zero values have to be listed
178 static std::vector<SparseRealGridValuesInput> const c_sampleGrids
180 SparseRealGridValuesInput {{
214 SparseRealGridValuesInput {{
251 //! Input forces for reduction
252 static std::vector<RVec> const c_sampleForcesFull {
287 //! PME orders to test
288 static std::vector<int> const pmeOrders {
291 //! Atom counts to test
292 static std::vector<size_t> const atomCounts {
296 /* Helper structures for test input */
298 //! A structure for all the spline data which depends in size both on the PME order and atom count
299 struct AtomAndPmeOrderSizedData
302 SplineParamsVector splineValues;
303 //! Spline derivatives
304 SplineParamsVector splineDerivatives;
307 //! A structure for all the input atom data which depends in size on atom count - including a range of spline data for different PME orders
311 GridLineIndicesVector gridLineIndices;
313 ChargesVector charges;
315 CoordinatesVector coordinates;
316 //! Spline data for different orders
317 std::map<int, AtomAndPmeOrderSizedData> splineDataByPmeOrder;
320 //! A range of the test input data sets, uniquely identified by the atom count
321 typedef std::map<size_t, AtomSizedData> InputDataByAtomCount;
323 /*! \brief Convenience typedef of the test input parameters - unit cell box, PME interpolation order, grid dimensions,
324 * grid values, overwriting/reducing the input forces, atom count.
326 * The rest of the atom-related input data - gridline indices, spline theta values, spline dtheta values, atom charges -
327 * is looked up in the inputAtomDataSets_ test fixture variable.
329 typedef std::tuple<Matrix3x3, int, IVec, SparseRealGridValuesInput, PmeGatherInputHandling, size_t> GatherInputParameters;
332 class PmeGatherTest : public ::testing::TestWithParam<GatherInputParameters>
335 //! Environment for getting the t_inputrec structure easily
336 MDModules mdModules_;
338 //! Storage of all the input atom datasets
339 static InputDataByAtomCount s_inputAtomDataSets_;
342 //! Default constructor
343 PmeGatherTest() = default;
344 //! Sets the input atom data references once
345 static void SetUpTestCase()
347 auto gridLineIndicesIt = c_sampleGridLineIndicesFull.begin();
348 auto chargesIt = c_sampleChargesFull.begin();
349 for (auto atomCount : atomCounts)
351 AtomSizedData atomData;
352 atomData.gridLineIndices = GridLineIndicesVector::fromVector(gridLineIndicesIt, gridLineIndicesIt + atomCount);
353 gridLineIndicesIt += atomCount;
354 atomData.charges = ChargesVector::fromVector(chargesIt, chargesIt + atomCount);
355 chargesIt += atomCount;
356 atomData.coordinates.resize(atomCount, RVec {1e6, 1e7, -1e8});
357 /* The coordinates are intentionally bogus in this test - only the size matters; the gridline indices are fed directly as inputs */
358 for (auto pmeOrder : pmeOrders)
360 AtomAndPmeOrderSizedData splineData;
361 const size_t dimSize = atomCount * pmeOrder;
362 for (int dimIndex = 0; dimIndex < DIM; dimIndex++)
364 splineData.splineValues[dimIndex] = SplineParamsDimVector::fromVector(c_sampleSplineValuesFull.begin() + dimIndex * dimSize,
365 c_sampleSplineValuesFull.begin() + (dimIndex + 1) * dimSize);
366 splineData.splineDerivatives[dimIndex] = SplineParamsDimVector::fromVector(c_sampleSplineDerivativesFull.begin() + dimIndex * dimSize,
367 c_sampleSplineDerivativesFull.begin() + (dimIndex + 1) * dimSize);
369 atomData.splineDataByPmeOrder[pmeOrder] = splineData;
371 s_inputAtomDataSets_[atomCount] = atomData;
377 /* Getting the input */
382 SparseRealGridValuesInput nonZeroGridValues;
383 PmeGatherInputHandling inputForceTreatment;
384 std::tie(box, pmeOrder, gridSize, nonZeroGridValues, inputForceTreatment, atomCount) = GetParam();
385 auto inputAtomData = s_inputAtomDataSets_[atomCount];
386 auto inputAtomSplineData = inputAtomData.splineDataByPmeOrder[pmeOrder];
388 /* Storing the input where it's needed, running the test */
389 t_inputrec *inputRec = mdModules_.inputrec();
390 inputRec->nkx = gridSize[XX];
391 inputRec->nky = gridSize[YY];
392 inputRec->nkz = gridSize[ZZ];
393 inputRec->pme_order = pmeOrder;
394 inputRec->coulombtype = eelPME;
396 TestReferenceData refData;
397 const std::map<CodePath, std::string> modesToTest = {{CodePath::CPU, "CPU"}};
398 for (const auto &mode : modesToTest)
400 /* Describing the test uniquely */
401 SCOPED_TRACE(formatString("Testing force gathering with %s for PME grid size %d %d %d"
402 ", order %d, %zu atoms, %s",
404 gridSize[XX], gridSize[YY], gridSize[ZZ],
407 (inputForceTreatment == PmeGatherInputHandling::ReduceWith) ? "with reduction" : "without reduction"
410 PmeSafePointer pmeSafe = pmeInitWithAtoms(inputRec, inputAtomData.coordinates, inputAtomData.charges, box);
412 /* Setting some more inputs */
413 pmeSetRealGrid(pmeSafe.get(), mode.first, nonZeroGridValues);
415 pmeSetGridLineIndices(pmeSafe.get(), mode.first, inputAtomData.gridLineIndices);
417 for (int dimIndex = 0; dimIndex < DIM; dimIndex++)
419 pmeSetSplineData(pmeSafe.get(), mode.first, inputAtomSplineData.splineValues[dimIndex], PmeSplineDataType::Values, dimIndex);
420 pmeSetSplineData(pmeSafe.get(), mode.first, inputAtomSplineData.splineDerivatives[dimIndex], PmeSplineDataType::Derivatives, dimIndex);
423 /* Explicitly copying the c_sample forces to be able to modify them */
424 auto inputForcesFull(c_sampleForcesFull);
425 GMX_RELEASE_ASSERT(inputForcesFull.size() >= atomCount, "Bad input forces size");
426 auto forces = ForcesVector::fromVector(inputForcesFull.begin(), inputForcesFull.begin() + atomCount);
428 /* Running the force gathering itself */
429 pmePerformGather(pmeSafe.get(), mode.first, inputForceTreatment, forces);
431 /* Check the output forces correctness */
432 TestReferenceChecker forceChecker(refData.rootChecker());
433 const auto ulpTolerance = 3 * pmeOrder;
434 forceChecker.setDefaultTolerance(relativeToleranceAsUlp(1.0, ulpTolerance));
435 forceChecker.checkSequence(forces.begin(), forces.end(), "Forces");
440 // An instance of static atom data
441 InputDataByAtomCount PmeGatherTest::s_inputAtomDataSets_;
443 //! Test for PME force gathering
444 TEST_P(PmeGatherTest, ReproducesOutputs)
446 EXPECT_NO_THROW(runTest());
449 //! Instantiation of the PME gathering test
450 INSTANTIATE_TEST_CASE_P(SaneInput, PmeGatherTest, ::testing::Combine(::testing::ValuesIn(c_sampleBoxes),
451 ::testing::ValuesIn(pmeOrders),
452 ::testing::ValuesIn(c_sampleGridSizes),
453 ::testing::ValuesIn(c_sampleGrids),
454 ::testing::Values(PmeGatherInputHandling::Overwrite, PmeGatherInputHandling::ReduceWith),
455 ::testing::ValuesIn(atomCounts)));