src/gromacs/mdlib/energydrifttracker.cpp

   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 Implements functions from the EnergyDriftTracker class.
  37  *
  38  * \author Berk Hess <hess@kth.se>
  39  *
  40  * \ingroup module_mdlib
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "energydrifttracker.h"
  45
  46 #include <cmath>
  47
  48 #include <string>
  49
  50 #include "gromacs/utility/gmxassert.h"
  51 #include "gromacs/utility/real.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 namespace gmx
  55 {
  56
  57 void EnergyDriftTracker::addPoint(double time, double energy)
  58 {
  59     GMX_ASSERT(std::isfinite(energy), "Non-finite energy encountered!");
  60
  61     if (!storedFirst_)
  62     {
  63         firstTime_   = time;
  64         firstEnergy_ = energy;
  65         storedFirst_ = true;
  66     }
  67     lastTime_   = time;
  68     lastEnergy_ = energy;
  69 }
  70
  71 double EnergyDriftTracker::energyDrift() const
  72 {
  73     if (timeInterval() > 0)
  74     {
  75         return (lastEnergy_ - firstEnergy_) / (timeInterval() * numAtoms_);
  76     }
  77     else
  78     {
  79         return 0;
  80     }
  81 }
  82
  83 std::string EnergyDriftTracker::energyDriftString(const std::string& partName) const
  84 {
  85     std::string mesg;
  86
  87     if (timeInterval() > 0)
  88     {
  89         mesg = formatString("Energy conservation over %s of length %g ns, time %g to %g ns\n",
  90                             partName.c_str(),
  91                             timeInterval(),
  92                             firstTime_,
  93                             lastTime_);
  94         mesg += formatString("  Conserved energy drift: %.2e kJ/mol/ps per atom\n", energyDrift());
  95     }
  96     else
  97     {
  98         mesg = formatString(
  99                 "Time interval for measuring conserved energy has length 0, time %g to %g\n",
 100                 firstTime_,
 101                 lastTime_);
 102     }
 103
 104     return mesg;
 105 }
 106
 107 } // namespace gmx