src/gromacs/mdlib/energydrifttracker.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 Declares and defines the EnergyDriftTracker class.
  37  *
  38  * \author Berk Hess <hess@kth.se>
  39  *
  40  * \ingroup module_mdlib
  41  */
  42 #ifndef GMX_MDLIB_ENERGYDRIFTTRACKER_H
  43 #define GMX_MDLIB_ENERGYDRIFTTRACKER_H
  44
  45 #include <string>
  46
  47 #include "gromacs/utility/real.h"
  48
  49 namespace gmx
  50 {
  51
  52 /*! \internal
  53  * \brief Class for tracking and printing the drift in the conserved energy quantity
  54  */
  55 class EnergyDriftTracker
  56 {
  57 public:
  58     /*! \brief Constructor
  59      *
  60      * \param[in] numAtoms  The total number of atoms in the system
  61      */
  62     EnergyDriftTracker(int numAtoms) : numAtoms_(numAtoms) {}
  63
  64     //! Add a point to the conserved energy tracking
  65     void addPoint(double time, double energy);
  66
  67     //! Returns the time of the last point minus the time of the first point
  68     double timeInterval() const { return lastTime_ - firstTime_; }
  69
  70     //! Returns the energy drift over the measured interval
  71     double energyDrift() const;
  72
  73     /*! \brief Returns two-line string with the time interval and drift over the interval
  74      *
  75      * \param[in] partName  A descriptive name for the period over which the tracking occured
  76      */
  77     std::string energyDriftString(const std::string& partName) const;
  78
  79 private:
  80     //! Whether we stored the first point
  81     bool storedFirst_ = false;
  82     //! The first time stored
  83     double firstTime_ = 0;
  84     //! The energy for the first time point
  85     double firstEnergy_ = 0;
  86     //! The last time stored
  87     double lastTime_ = 0;
  88     //! The energy for the last time point
  89     double lastEnergy_ = 0;
  90     //! The number of atoms in the system
  91     int numAtoms_;
  92 };
  93
  94 } // namespace gmx
  95
  96 #endif