api/nblib/tests/integrator.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2020,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  * This implements molecule setup tests
  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  * \author Artem Zhmurov <zhmurov@gmail.com>
  44  */
  45 #include "nblib/integrator.h"
  46 #include "gromacs/pbcutil/pbc.h"
  47 #include "gromacs/utility/arrayref.h"
  48 #include "nblib/molecules.h"
  49 #include "nblib/particletype.h"
  50 #include "nblib/simulationstate.h"
  51 #include "nblib/topology.h"
  52
  53 #include "testutils/testasserts.h"
  54
  55 namespace nblib
  56 {
  57 namespace test
  58 {
  59 namespace
  60 {
  61
  62 TEST(NBlibTest, IntegratorWorks)
  63 {
  64     int  numAtoms = 1;
  65     int  numSteps = 100;
  66     real dt       = 0.001;
  67
  68     ParticleType particleType(ParticleTypeName("H"), Mass(1.0));
  69     Molecule     molecule(MoleculeName("SomeMolecule"));
  70     molecule.addParticle(ParticleName("SomeAtom"), particleType);
  71
  72     ParticleTypesInteractions interactions;
  73     interactions.add(particleType.name(), C6{ 0 }, C12{ 0 });
  74
  75     TopologyBuilder topologyBuilder;
  76     topologyBuilder.addMolecule(molecule, numAtoms);
  77     topologyBuilder.addParticleTypesInteractions(interactions);
  78     Topology topology = topologyBuilder.buildTopology();
  79
  80     std::vector<Vec3> x(numAtoms, { 0.0, 0.0, 0.0 });
  81     std::vector<Vec3> v(numAtoms, { 0.0, 0.0, 0.0 });
  82     std::vector<Vec3> f(numAtoms, { 1.0, 2.0, 0.0 });
  83
  84     Box box(100);
  85
  86     std::vector<Vec3> x0(x);
  87     std::vector<Vec3> v0(v);
  88
  89     SimulationState simulationState(x, v, f, box, topology);
  90     put_atoms_in_box(PbcType::Xyz, box.legacyMatrix(), x0);
  91
  92     LeapFrog integrator(simulationState.topology(), simulationState.box());
  93
  94     gmx::test::FloatingPointTolerance tolerance = gmx::test::absoluteTolerance(numSteps * 0.000005);
  95     for (int step = 0; step < numSteps; step++)
  96     {
  97         real totalTime = step * dt;
  98
  99         Vec3 xAnalytical;
 100         Vec3 vAnalytical;
 101
 102         for (int i = 0; i < numAtoms; i++)
 103         {
 104             for (int d = 0; d < dimSize; d++)
 105             {
 106                 // Analytical solution for constant-force particle movement
 107                 int  typeIndex = simulationState.topology().getParticleTypeIdOfAllParticles()[i];
 108                 real im = 1.0 / simulationState.topology().getParticleTypes()[typeIndex].mass();
 109                 xAnalytical[d] =
 110                         x0[i][d] + v0[i][d] * totalTime + 0.5 * f[i][d] * totalTime * totalTime * im;
 111                 vAnalytical[d] = v0[i][d] + f[i][d] * totalTime * im;
 112
 113                 EXPECT_REAL_EQ_TOL(xAnalytical[d], simulationState.coordinates()[i][d], tolerance)
 114                         << formatString(
 115                                    "Coordinate {} of atom {} is different from analytical solution "
 116                                    "at step {}.",
 117                                    d,
 118                                    i,
 119                                    step);
 120
 121                 EXPECT_REAL_EQ_TOL(vAnalytical[d], simulationState.velocities()[i][d], tolerance)
 122                         << formatString(
 123                                    "Velocity component {} of atom {} is different from analytical "
 124                                    "solution at step {}.",
 125                                    d,
 126                                    i,
 127                                    step);
 128             }
 129             integrator.integrate(dt,
 130                                  simulationState.coordinates(),
 131                                  simulationState.velocities(),
 132                                  simulationState.forces());
 133         }
 134     }
 135 }
 136
 137 } // namespace
 138 } // namespace test
 139 } // namespace nblib