api/nblib/tests/nbnxmsetup.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2021, 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 nbnxm setup utilities
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #include <cmath>
  45
  46 #include "gromacs/mdtypes/forcerec.h"
  47 #include "gromacs/mdtypes/interaction_const.h"
  48 #include "gromacs/mdtypes/simulation_workload.h"
  49 #include "gromacs/nbnxm/nbnxm.h"
  50 #include "gromacs/nbnxm/nbnxm_simd.h"
  51 #include "nblib/box.h"
  52 #include "nblib/nbnxmsetuphelpers.h"
  53
  54 #include "testutils/testasserts.h"
  55
  56 namespace nblib
  57 {
  58 namespace test
  59 {
  60 namespace
  61 {
  62
  63 TEST(NbnxmSetupTest, findNumEnergyGroups)
  64 {
  65     std::vector<int64_t> v(10);
  66     int                  arbitraryGid = 7;
  67
  68     // this sets some bit outside the range of bits used for the group ID
  69     // having all bits zero except those used for the group ID can otherwise hide bugs
  70     v[5] |= gmx::sc_atomInfo_HasCharge;
  71     v[5] = (v[5] & ~gmx::sc_atomInfo_EnergyGroupIdMask) | arbitraryGid;
  72
  73     int nEnergyGroups = arbitraryGid + 1;
  74     EXPECT_EQ(nEnergyGroups, findNumEnergyGroups(v));
  75 }
  76
  77 TEST(NbnxmSetupTest, canTranslateBenchmarkEnumAuto)
  78 {
  79     auto kernel = SimdKernels::SimdAuto;
  80     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::NotSet);
  81 }
  82
  83 TEST(NbnxmSetupTest, canTranslateBenchmarkEnumNo)
  84 {
  85     auto kernel = SimdKernels::SimdNo;
  86     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4x4_PlainC);
  87 }
  88
  89 TEST(NbnxmSetupTest, canTranslateBenchmarkEnum2XM)
  90 {
  91     auto kernel = SimdKernels::Simd2XMM;
  92     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4xN_Simd_2xNN);
  93 }
  94
  95 TEST(NbnxmSetupTest, canTranslateBenchmarkEnum4XM)
  96 {
  97     auto kernel = SimdKernels::Simd4XM;
  98     EXPECT_EQ(translateBenchmarkEnum(kernel), Nbnxm::KernelType::Cpu4xN_Simd_4xN);
  99 }
 100
 101 TEST(NbnxmSetupTest, CheckKernelSetupThrowsAuto)
 102 {
 103     EXPECT_ANY_THROW(checkKernelSetupSimd(SimdKernels::SimdAuto));
 104 }
 105
 106 TEST(NbnxmSetupTest, CheckKernelSetupThrowsCount)
 107 {
 108     EXPECT_ANY_THROW(checkKernelSetupSimd(SimdKernels::Count));
 109 }
 110
 111 TEST(NbnxmSetupTest, canCreateKernelSetupPlain)
 112 {
 113     NBKernelOptions nbKernelOptions;
 114     nbKernelOptions.nbnxmSimd = SimdKernels::SimdNo;
 115     Nbnxm::KernelSetup kernelSetup =
 116             createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr);
 117     EXPECT_EQ(kernelSetup.kernelType, Nbnxm::KernelType::Cpu4x4_PlainC);
 118     EXPECT_EQ(kernelSetup.ewaldExclusionType, Nbnxm::EwaldExclusionType::Table);
 119 }
 120
 121 TEST(NbnxmSetupTest, canCreateParticleInfoAllVdv)
 122 {
 123     size_t  numParticles = 2;
 124     int64_t mask         = 0;
 125     mask |= gmx::sc_atomInfo_HasVdw;
 126     mask |= gmx::sc_atomInfo_HasCharge;
 127     std::vector<int64_t> refParticles  = { mask, mask };
 128     std::vector<int64_t> testParticles = createParticleInfoAllVdw(numParticles);
 129     EXPECT_EQ(refParticles, testParticles);
 130 }
 131
 132 TEST(NbnxmSetupTest, ewaldCoeffWorks)
 133 {
 134     real                              ewald     = ewaldCoeff(1e-5, 1.0);
 135     gmx::test::FloatingPointTolerance tolerance = gmx::test::absoluteTolerance(1e-5);
 136     EXPECT_REAL_EQ_TOL(ewald, 3.12341, tolerance);
 137 }
 138
 139 TEST(NbnxmSetupTest, updateForcerecWorks)
 140 {
 141     t_forcerec forcerec;
 142     Box        box(3);
 143     EXPECT_NO_THROW(updateForcerec(&forcerec, box.legacyMatrix()));
 144 }
 145
 146 // The following tests check if the user is allowed to specify configurations not permitted due
 147 // to conflicting compile time setup flags
 148
 149 TEST(NbnxmSetupTest, canCheckKernelSetup)
 150 {
 151     NBKernelOptions nbKernelOptions;
 152     nbKernelOptions.nbnxmSimd = SimdKernels::SimdNo;
 153 #ifdef GMX_NBNXN_SIMD_4XN
 154     nbKernelOptions.nbnxmSimd = SimdKernels::Simd4XM;
 155 #endif
 156 #ifdef GMX_NBNXN_SIMD_2XNN
 157     nbKernelOptions.nbnxmSimd = SimdKernels::Simd2XMM;
 158 #endif
 159     EXPECT_NO_THROW(checkKernelSetupSimd(nbKernelOptions.nbnxmSimd));
 160 }
 161
 162 // check if the user is allowed to ask for SimdKernels::Simd2XMM when NBLIB is not compiled with it
 163 #ifndef GMX_NBNXN_SIMD_2XNN
 164 TEST(NbnxmSetupTest, cannotCreateKernelSetupCPU2XM)
 165 {
 166     NBKernelOptions nbKernelOptions;
 167     nbKernelOptions.nbnxmSimd             = SimdKernels::Simd2XMM;
 168     nbKernelOptions.useTabulatedEwaldCorr = true;
 169     EXPECT_ANY_THROW(createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr));
 170 }
 171 #endif
 172
 173 // check if the user is allowed to ask for SimdKernels::Simd4XM when NBLIB is not compiled with it
 174 #ifndef GMX_NBNXN_SIMD_4XN
 175 TEST(NbnxmSetupTest, cannotCreateKernelSetupCPU4XM)
 176 {
 177     NBKernelOptions nbKernelOptions;
 178     nbKernelOptions.nbnxmSimd             = SimdKernels::Simd4XM;
 179     nbKernelOptions.useTabulatedEwaldCorr = false;
 180     EXPECT_ANY_THROW(createKernelSetupCPU(nbKernelOptions.nbnxmSimd, nbKernelOptions.useTabulatedEwaldCorr));
 181 }
 182 #endif
 183
 184 TEST(NbnxmSetupTest, CanCreateNbnxmCPU)
 185 {
 186     size_t          numParticles = 1;
 187     NBKernelOptions nbKernelOptions;
 188     nbKernelOptions.nbnxmSimd             = SimdKernels::SimdNo;
 189     int               numEnergyGroups     = 1;
 190     std::vector<real> nonbondedParameters = { 1, 1 };
 191     EXPECT_NO_THROW(createNbnxmCPU(numParticles, nbKernelOptions, numEnergyGroups, nonbondedParameters));
 192 }
 193
 194 } // namespace
 195 } // namespace test
 196 } // namespace nblib