src/programs/mdrun/tests/energycomparison.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 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 EnergyTermsToCompare EnergyComparison::defaultEnergyTermsToCompare()
  68 {
  69     return {
  70         { interaction_function[F_EPOT].longname, relativeToleranceAsUlp(10.0, 50) },
  71         { interaction_function[F_EKIN].longname, relativeToleranceAsUlp(10.0, 50) },
  72         // The pressure is very strongly affected by summation errors,
  73         // so we need a large tolerance.
  74         // The value of 15000 is calibrated for running a small water box for 16 steps.
  75         // For a single frame for a water box a value of 150 could work.
  76         { interaction_function[F_PRES].longname, relativeToleranceAsUlp(10.0, 15000) },
  77     };
  78 };
  79
  80 EnergyComparison::EnergyComparison(const EnergyTermsToCompare& energyTermsToCompare,
  81                                    MaxNumFrames                maxNumFrames) :
  82     energyTermsToCompare_(energyTermsToCompare),
  83     maxNumFrames_(maxNumFrames)
  84 {
  85 }
  86
  87 std::vector<std::string> EnergyComparison::getEnergyNames() const
  88 {
  89     std::vector<std::string> keys;
  90     keys.reserve(energyTermsToCompare_.size());
  91     for (const auto& it : energyTermsToCompare_)
  92     {
  93         keys.push_back(it.first);
  94     }
  95     return keys;
  96 }
  97
  98 void EnergyComparison::operator()(const EnergyFrame& reference, const EnergyFrame& test) const
  99 {
 100     if (numComparedFrames_ >= maxNumFrames_)
 101     {
 102         // Nothing should be compared
 103         return;
 104     }
 105
 106     SCOPED_TRACE("Comparing energy reference frame " + reference.frameName() + " and test frame "
 107                  + test.frameName());
 108     for (auto referenceIt = reference.begin(); referenceIt != reference.end(); ++referenceIt)
 109     {
 110         auto& energyName = referenceIt->first;
 111         SCOPED_TRACE("Comparing " + energyName + " between frames");
 112         auto testIt = test.find(energyName);
 113         if (testIt != test.end())
 114         {
 115             auto& energyValueInReference = referenceIt->second;
 116             auto& energyValueInTest      = testIt->second;
 117             EXPECT_REAL_EQ_TOL(energyValueInReference, energyValueInTest,
 118                                energyTermsToCompare_.at(energyName));
 119         }
 120         else
 121         {
 122             ADD_FAILURE() << "Could not find energy component from reference frame in test frame";
 123         }
 124     }
 125     numComparedFrames_++;
 126 }
 127
 128 void checkEnergiesAgainstReferenceData(const std::string&          energyFilename,
 129                                        const EnergyTermsToCompare& energyTermsToCompare,
 130                                        TestReferenceChecker*       checker,
 131                                        MaxNumFrames                maxNumEnergyFrames)
 132 {
 133     const bool thisRankChecks = (gmx_node_rank() == 0);
 134
 135     if (thisRankChecks)
 136     {
 137         EnergyComparison energyComparison(energyTermsToCompare, maxNumEnergyFrames);
 138         auto energyReader = openEnergyFileToReadTerms(energyFilename, energyComparison.getEnergyNames());
 139
 140         std::unordered_map<std::string, TestReferenceChecker> checkers;
 141         for (const auto& energyTermToCompare : energyTermsToCompare)
 142         {
 143             const auto& energyName      = energyTermToCompare.first;
 144             checkers[energyName]        = checker->checkCompound("Energy", energyName.c_str());
 145             const auto& energyTolerance = energyTermToCompare.second;
 146             checkers[energyName].setDefaultTolerance(energyTolerance);
 147         }
 148
 149         // We can't assume that frame names based purely on frame
 150         // contents are unique. For example, CG can write multiple
 151         // frames with the same step number. But we need a unique
 152         // identifier so we match the intended reference data, so we
 153         // keep track of the number of the frame read from the file.
 154         unsigned int frameNumber = 0;
 155         while (frameNumber < maxNumEnergyFrames && energyReader->readNextFrame())
 156         {
 157             const EnergyFrame& frame = energyReader->frame();
 158             const std::string  frameName =
 159                     frame.frameName() + " in frame " + toString(static_cast<int64_t>(frameNumber));
 160
 161             SCOPED_TRACE("Comparing frame " + frameName);
 162             for (const auto& energyTermToCompare : energyTermsToCompare)
 163             {
 164                 const std::string& energyName  = energyTermToCompare.first;
 165                 const real         energyValue = frame.at(energyName);
 166
 167                 SCOPED_TRACE("Comparing energy " + energyName);
 168                 checkers[energyName].checkReal(energyValue, frameName.c_str());
 169             }
 170             ++frameNumber;
 171         }
 172         if (frameNumber == maxNumEnergyFrames && energyReader->readNextFrame())
 173         {
 174             // There would have been at least one more frame!
 175             checker->disableUnusedEntriesCheck();
 176         }
 177     }
 178     else
 179     {
 180         EXPECT_NONFATAL_FAILURE(checker->checkUnusedEntries(), ""); // skip checks on other ranks
 181     }
 182 }
 183
 184 void checkEnergiesAgainstReferenceData(const std::string&          energyFilename,
 185                                        const EnergyTermsToCompare& energyTermsToCompare,
 186                                        TestReferenceChecker*       checker)
 187 {
 188     checkEnergiesAgainstReferenceData(energyFilename, energyTermsToCompare, checker,
 189                                       MaxNumFrames::compareAllFrames());
 190 }
 191
 192 } // namespace test
 193 } // namespace gmx