src/gromacs/awh/pointstate.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2015,2016,2017,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
  38  * Implements the one method of the PointState class called only for one point per step.
  39  *
  40  * \author Viveca Lindahl
  41  * \author Berk Hess <hess@kth.se>
  42  * \ingroup module_awh
  43  */
  44
  45 #include "gmxpre.h"
  46
  47 #include "pointstate.h"
  48
  49 namespace gmx
  50 {
  51
  52 namespace
  53 {
  54
  55 /*! \brief Returns the exponent c where exp(c) = exp(a) + exp(b).
  56  *
  57  * \param[in] a  First exponent.
  58  * \param[in] b  Second exponent.
  59  * \returns c.
  60  */
  61 double expSum(double a, double b)
  62 {
  63     return (a > b ? a : b) + std::log1p(std::exp(-std::fabs(a - b)));
  64 }
  65
  66 } // namespace
  67
  68 void PointState::samplePmf(double convolvedBias)
  69 {
  70     if (inTargetRegion())
  71     {
  72         logPmfSum_ = expSum(logPmfSum_, -convolvedBias);
  73         numVisitsIteration_ += 1;
  74     }
  75 }
  76
  77 void PointState::updatePmfUnvisited(double bias)
  78 {
  79     if (inTargetRegion())
  80     {
  81         logPmfSum_ = expSum(logPmfSum_, -bias);
  82     }
  83 }
  84
  85 } // namespace gmx