src/programs/mdrun/tests/energycomparison.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018, 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 Implementions of related classes for tests that want to
  38  * inspect energies produced by mdrun.
  39  *
  40  * \author Mark Abraham <mark.j.abraham@gmail.com>
  41  * \ingroup module_mdrun_integration_tests
  42  */
  43 #include "gmxpre.h"
  44
  45 #include "energycomparison.h"
  46
  47 #include "gromacs/trajectory/energyframe.h"
  48
  49 #include "testutils/testasserts.h"
  50
  51 namespace gmx
  52 {
  53 namespace test
  54 {
  55
  56 void compareEnergyFrames(const EnergyFrame      &reference,
  57                          const EnergyFrame      &test,
  58                          const EnergyTolerances &tolerances)
  59 {
  60     for (auto referenceIt = reference.begin(); referenceIt != reference.end(); ++referenceIt)
  61     {
  62         auto &energyName = referenceIt->first;
  63         SCOPED_TRACE("Comparing " +  energyName + " between frames");
  64         auto  testIt = test.find(energyName);
  65         if (testIt != test.end())
  66         {
  67             auto &energyValueInReference = referenceIt->second;
  68             auto &energyValueInTest      = testIt->second;
  69             EXPECT_REAL_EQ_TOL(energyValueInReference, energyValueInTest, tolerances.at(energyName));
  70         }
  71         else
  72         {
  73             ADD_FAILURE() << "Could not find energy component from reference frame in test frame";
  74         }
  75     }
  76 }
  77
  78 } // namespace
  79 } // namespace