src/programs/mdrun/tests/normalmodes.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,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
  36 /*! \internal \file
  37  * \brief
  38  * Tests for the normal modes functionality.
  39  *
  40  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #include "gmxpre.h"
  44
  45 #include <map>
  46 #include <memory>
  47 #include <string>
  48 #include <tuple>
  49 #include <vector>
  50
  51 #include <gtest/gtest.h>
  52
  53 #include "gromacs/options/filenameoption.h"
  54 #include "gromacs/topology/idef.h"
  55 #include "gromacs/topology/ifunc.h"
  56 #include "gromacs/trajectory/energyframe.h"
  57 #include "gromacs/trajectory/trajectoryframe.h"
  58 #include "gromacs/utility/basenetwork.h"
  59 #include "gromacs/utility/filestream.h"
  60 #include "gromacs/utility/stringutil.h"
  61
  62 #include "testutils/mpitest.h"
  63 #include "testutils/refdata.h"
  64 #include "testutils/simulationdatabase.h"
  65 #include "testutils/testasserts.h"
  66 #include "testutils/xvgtest.h"
  67
  68 #include "energycomparison.h"
  69 #include "energyreader.h"
  70 #include "moduletest.h"
  71
  72 namespace gmx
  73 {
  74 namespace test
  75 {
  76 namespace
  77 {
  78
  79 /*! \brief Test fixture base for normal mode analysis
  80  *
  81  * This test ensures mdrun can run a normal mode analysis, reaching
  82  * a reproducible eigenvalues following diagonalization.
  83  *
  84  * The choices for tolerance are arbitrary but sufficient. */
  85 class NormalModesTest :
  86     public MdrunTestFixture,
  87     public ::testing::WithParamInterface<std::tuple<std::string, std::string>>
  88 {
  89 };
  90
  91 TEST_P(NormalModesTest, WithinTolerances)
  92 {
  93     auto params         = GetParam();
  94     auto simulationName = std::get<0>(params);
  95     auto integrator     = std::get<1>(params);
  96     SCOPED_TRACE(formatString("Comparing normal modes for '%s'", simulationName.c_str()));
  97
  98     // TODO At some point we should also test PME-only ranks.
  99     int numRanksAvailable = getNumberOfTestMpiRanks();
 100     if (!isNumberOfPpRanksSupported(simulationName, numRanksAvailable))
 101     {
 102         fprintf(stdout,
 103                 "Test system '%s' cannot run with %d ranks.\n"
 104                 "The supported numbers are: %s\n",
 105                 simulationName.c_str(), numRanksAvailable,
 106                 reportNumbersOfPpRanksSupported(simulationName).c_str());
 107         return;
 108     }
 109     auto mdpFieldValues =
 110             prepareMdpFieldValues(simulationName.c_str(), integrator.c_str(), "no", "no");
 111     mdpFieldValues["nsteps"]      = "1";
 112     mdpFieldValues["rcoulomb"]    = "5.6";
 113     mdpFieldValues["rlist"]       = "5.6";
 114     mdpFieldValues["rvdw"]        = "5.6";
 115     mdpFieldValues["constraints"] = "none";
 116     mdpFieldValues["coulombtype"] = "Cut-off";
 117     mdpFieldValues["vdwtype"]     = "Cut-off";
 118
 119     // prepare the .tpr file
 120     {
 121         CommandLine caller;
 122         runner_.useTopG96AndNdxFromDatabase(simulationName);
 123         runner_.useStringAsMdpFile(prepareMdpFileContents(mdpFieldValues));
 124         EXPECT_EQ(0, runner_.callGrompp(caller));
 125     }
 126     // Do mdrun, preparing to check the normal modes later
 127     {
 128         CommandLine mdrunCaller;
 129         ASSERT_EQ(0, runner_.callMdrun(mdrunCaller));
 130     }
 131     // Now run gmx nmeig and check the output
 132     {
 133         ASSERT_EQ(0, runner_.callNmeig());
 134         TestReferenceData refData;
 135         auto              checker = refData.rootChecker()
 136                                .checkCompound("System", simulationName)
 137                                .checkCompound("Integrator", integrator);
 138         auto settings      = XvgMatchSettings();
 139         settings.tolerance = relativeToleranceAsFloatingPoint(1.0, 1e-05);
 140         TextInputFile input("eigenval.xvg");
 141         checkXvgFile(&input, &checker, settings);
 142     }
 143 }
 144
 145 // The time for OpenCL kernel compilation means these tests might time
 146 // out. If that proves to be a problem, these can be disabled for
 147 // OpenCL builds. However, once that compilation is cached for the
 148 // lifetime of the whole test binary process, these tests should run in
 149 // such configurations.
 150 #if GMX_DOUBLE
 151
 152 //! Containers of systems and integrators to test.
 153 //! \{
 154 std::vector<std::string> systemsToTest_g     = { "scaled-water", "villin", "spc-dimer", "one-tip5p",
 155                                              "sw-dimer" };
 156 std::vector<std::string> integratorsToTest_g = { "nm" };
 157
 158 //! \}
 159
 160 INSTANTIATE_TEST_CASE_P(NormalModesWorks,
 161                         NormalModesTest,
 162                         ::testing::Combine(::testing::ValuesIn(systemsToTest_g),
 163                                            ::testing::ValuesIn(integratorsToTest_g)));
 164 #endif
 165 } // namespace
 166 } // namespace test
 167 } // namespace gmx