src/gromacs/trajectory/energyframe.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,2019,2020,2021, 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 "energyframe.h"
  46
  47 #include <map>
  48 #include <string>
  49
  50 #include "gromacs/utility/exceptions.h"
  51 #include "gromacs/utility/stringutil.h"
  52
  53 namespace gmx
  54 {
  55
  56 EnergyFrame::EnergyFrame(const t_enxframe& enxframe, const std::map<std::string, int>& indicesOfEnergyFields) :
  57     step_(enxframe.step), time_(enxframe.t)
  58 {
  59     for (const auto& index : indicesOfEnergyFields)
  60     {
  61         if (index.second >= enxframe.nre)
  62         {
  63             GMX_THROW(InternalError(formatString(
  64                     "Index %d for energy %s not present in energy frame with %d energies",
  65                     index.second,
  66                     index.first.c_str(),
  67                     enxframe.nre)));
  68         }
  69         values_[index.first] = enxframe.ener[index.second].e;
  70     }
  71 }
  72
  73 std::string EnergyFrame::frameName() const
  74 {
  75     return formatString("Time %f Step %" PRId64, time_, step_);
  76 }
  77
  78 const real& EnergyFrame::at(const std::string& name) const
  79 {
  80     auto valueIterator = values_.find(name);
  81     if (valueIterator == values_.end())
  82     {
  83         GMX_THROW(APIError("Cannot get energy value " + name
  84                            + " unless previously registered when constructing EnergyFrameReader"));
  85     }
  86     return valueIterator->second;
  87 }
  88
  89 EnergyFrame::MapConstIterator EnergyFrame::begin() const
  90 {
  91     return values_.begin();
  92 }
  93
  94 EnergyFrame::MapConstIterator EnergyFrame::end() const
  95 {
  96     return values_.end();
  97 }
  98
  99 EnergyFrame::MapConstIterator EnergyFrame::find(const std::string& key) const
 100 {
 101     return values_.find(key);
 102 }
 103
 104 } // namespace gmx