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