src/programs/mdrun/tests/simulatorcomparison.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  * \brief
  37  * Helper functions for tests that compare the results of equivalent
  38  * simulation runs. Currently used for the rerun and the simulator
  39  * tests
  40  *
  41  * \author Mark Abraham <mark.j.abraham@gmail.com>
  42  * \author Pascal Merz <pascal.merz@me.com>
  43  * \ingroup module_mdrun_integration_tests
  44  */
  45 #include "gmxpre.h"
  46
  47 #include "simulatorcomparison.h"
  48
  49 #include "gromacs/trajectory/energyframe.h"
  50
  51 #include "energyreader.h"
  52 #include "mdruncomparison.h"
  53 #include "moduletest.h"
  54 #include "trajectoryreader.h"
  55
  56 namespace gmx
  57 {
  58 namespace test
  59 {
  60
  61 void runGrompp(SimulationRunner* runner, const std::vector<SimulationOptionTuple>& options)
  62 {
  63     CommandLine caller;
  64     caller.append("grompp");
  65
  66     for (const std::tuple<std::string, std::string>& option : options)
  67     {
  68         caller.addOption(std::get<0>(option).c_str(), std::get<1>(option));
  69     }
  70
  71     EXPECT_EQ(0, runner->callGrompp(caller));
  72 }
  73
  74 void runMdrun(SimulationRunner* runner, const std::vector<SimulationOptionTuple>& options)
  75 {
  76     CommandLine caller;
  77     caller.append("mdrun");
  78
  79     for (const std::tuple<std::string, std::string>& option : options)
  80     {
  81         caller.addOption(std::get<0>(option).c_str(), std::get<1>(option));
  82     }
  83
  84     EXPECT_EQ(0, runner->callMdrun(caller));
  85 }
  86
  87 void compareEnergies(const std::string&          edr1Name,
  88                      const std::string&          edr2Name,
  89                      const EnergyTermsToCompare& energyTermsToCompare,
  90                      const MaxNumFrames          maxNumFrames)
  91 {
  92     // Build the functor that will compare energy frames on the chosen
  93     // energy terms.
  94     EnergyComparison energyComparison(energyTermsToCompare, maxNumFrames);
  95
  96     // Build the manager that will present matching pairs of frames to compare.
  97     //
  98     // TODO Here is an unnecessary copy of keys (ie. the energy term
  99     // names), for convenience. In the future, use a range.
 100     auto                                namesOfEnergiesToMatch = energyComparison.getEnergyNames();
 101     FramePairManager<EnergyFrameReader> energyManager(
 102             openEnergyFileToReadTerms(edr1Name, namesOfEnergiesToMatch),
 103             openEnergyFileToReadTerms(edr2Name, namesOfEnergiesToMatch));
 104     // Compare the energy frames.
 105     energyManager.compareAllFramePairs<EnergyFrame>(energyComparison);
 106 }
 107
 108 void compareTrajectories(const std::string&          trajectory1Name,
 109                          const std::string&          trajectory2Name,
 110                          const TrajectoryComparison& trajectoryComparison)
 111 {
 112     // Build the manager that will present matching pairs of frames to compare
 113     FramePairManager<TrajectoryFrameReader> trajectoryManager(
 114             std::make_unique<TrajectoryFrameReader>(trajectory1Name),
 115             std::make_unique<TrajectoryFrameReader>(trajectory2Name));
 116     // Compare the trajectory frames.
 117     trajectoryManager.compareAllFramePairs<TrajectoryFrame>(trajectoryComparison);
 118 }
 119
 120 } // namespace test
 121 } // namespace gmx