src/programs/mdrun/tests/energycomparison.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019, 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 <gtest/gtest.h>
  48 #include <gtest/gtest-spi.h>
  49
  50 #include "gromacs/topology/ifunc.h"
  51 #include "gromacs/trajectory/energyframe.h"
  52 #include "gromacs/utility/basenetwork.h"
  53 #include "gromacs/utility/strconvert.h"
  54 #include "gromacs/utility/stringutil.h"
  55
  56 #include "testutils/refdata.h"
  57 #include "testutils/testasserts.h"
  58
  59 #include "energyreader.h"
  60 #include "moduletest.h"
  61
  62 namespace gmx
  63 {
  64 namespace test
  65 {
  66
  67 const EnergyTermsToCompare EnergyComparison::s_defaultEnergyTermsToCompare = {
  68     { interaction_function[F_EPOT].longname, relativeToleranceAsUlp(10.0, 50) },
  69     { interaction_function[F_EKIN].longname, relativeToleranceAsUlp(10.0, 50) },
  70     // The pressure is very strongly affected by summation errors,
  71     // so we need a large tolerance.
  72     // The value of 15000 is calibrated for running a small water box for 16 steps.
  73     // For a single frame for a water box a value of 150 could work.
  74     { interaction_function[F_PRES].longname, relativeToleranceAsUlp(10.0, 15000) },
  75 };
  76
  77 EnergyComparison::EnergyComparison(const EnergyTermsToCompare& energyTermsToCompare) :
  78     energyTermsToCompare_(energyTermsToCompare)
  79 {
  80 }
  81
  82 std::vector<std::string> EnergyComparison::getEnergyNames() const
  83 {
  84     std::vector<std::string> keys;
  85     keys.reserve(energyTermsToCompare_.size());
  86     for (const auto& it : energyTermsToCompare_)
  87     {
  88         keys.push_back(it.first);
  89     }
  90     return keys;
  91 }
  92
  93 void EnergyComparison::operator()(const EnergyFrame& reference, const EnergyFrame& test) const
  94 {
  95     SCOPED_TRACE("Comparing energy reference frame " + reference.frameName() + " and test frame "
  96                  + test.frameName());
  97     for (auto referenceIt = reference.begin(); referenceIt != reference.end(); ++referenceIt)
  98     {
  99         auto& energyName = referenceIt->first;
 100         SCOPED_TRACE("Comparing " + energyName + " between frames");
 101         auto testIt = test.find(energyName);
 102         if (testIt != test.end())
 103         {
 104             auto& energyValueInReference = referenceIt->second;
 105             auto& energyValueInTest      = testIt->second;
 106             EXPECT_REAL_EQ_TOL(energyValueInReference, energyValueInTest,
 107                                energyTermsToCompare_.at(energyName));
 108         }
 109         else
 110         {
 111             ADD_FAILURE() << "Could not find energy component from reference frame in test frame";
 112         }
 113     }
 114 }
 115
 116 void checkEnergiesAgainstReferenceData(const std::string&          energyFilename,
 117                                        const EnergyTermsToCompare& energyTermsToCompare,
 118                                        TestReferenceChecker*       checker)
 119 {
 120     const bool thisRankChecks = (gmx_node_rank() == 0);
 121
 122     if (thisRankChecks)
 123     {
 124         EnergyComparison energyComparison(energyTermsToCompare);
 125         auto energyReader = openEnergyFileToReadTerms(energyFilename, energyComparison.getEnergyNames());
 126
 127         std::unordered_map<std::string, TestReferenceChecker> checkers;
 128         for (const auto& energyTermToCompare : energyTermsToCompare)
 129         {
 130             const auto& energyName      = energyTermToCompare.first;
 131             checkers[energyName]        = checker->checkCompound("Energy", energyName.c_str());
 132             const auto& energyTolerance = energyTermToCompare.second;
 133             checkers[energyName].setDefaultTolerance(energyTolerance);
 134         }
 135
 136         // We can't assume that frame names based purely on frame
 137         // contents are unique. For example, CG can write multiple
 138         // frames with the same step number. But we need a unique
 139         // identifier so we match the intended reference data, so we
 140         // keep track of the number of the frame read from the file.
 141         int frameNumber = 0;
 142         while (energyReader->readNextFrame())
 143         {
 144             const EnergyFrame& frame     = energyReader->frame();
 145             const std::string  frameName = frame.frameName() + " in frame " + toString(frameNumber);
 146
 147             for (const auto& energyTermToCompare : energyTermsToCompare)
 148             {
 149                 const std::string& energyName  = energyTermToCompare.first;
 150                 const real         energyValue = frame.at(energyName);
 151
 152                 SCOPED_TRACE("Comparing " + energyName + " in " + frameName);
 153                 checkers[energyName].checkReal(energyValue, frameName.c_str());
 154             }
 155             ++frameNumber;
 156         }
 157     }
 158     else
 159     {
 160         EXPECT_NONFATAL_FAILURE(checker->checkUnusedEntries(), ""); // skip checks on other ranks
 161     }
 162 }
 163
 164 } // namespace test
 165 } // namespace gmx