src/gromacs/mdlib/expanded_internal.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \internal \file
  36  * \brief Implements internal functionality for expanded ensemble
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \author Michael Shirts <michael.shirts@colorado.edu>
  40  * \ingroup module_mdlib
  41  */
  42 #include "gmxpre.h"
  43
  44 #include "expanded_internal.h"
  45
  46 #include <cmath>
  47
  48 #include "gromacs/mdtypes/md_enums.h"
  49 #include "gromacs/utility/exceptions.h"
  50
  51 namespace gmx
  52 {
  53 real calculateAcceptanceWeight(LambdaWeightCalculation calculationMode, real lambdaEnergyDifference)
  54 {
  55     if (calculationMode == LambdaWeightCalculation::Barker
  56         || calculationMode == LambdaWeightCalculation::Minvar)
  57     {
  58         /* Barker acceptance rule forumula is used for accumulation of probability for
  59          * both the Barker variant of the weight accumulation algorithm and the
  60          * minimum variance variant of the weight accumulation algorithm.
  61          *
  62          * Barker acceptance rule for a jump from state i -> j is defined as
  63          *     exp(-E_i)/exp(-Ei)+exp(-Ej) =   1 / (1 + exp(dE_ij))
  64          * where dE_ij is the potential energy difference between the two states
  65          * plus a constant offset that can be removed at the end for numerical stability.
  66          *     dE_ij = FE_j - FE_i + offset
  67          * Numerically, this computation can be unstable if dE gets large. (See #3304)
  68          * To avoid numerical instability, we're calculating it as
  69          *     1 / (1 + exp(dE_ij))             (if dE < 0)
  70          *     exp(-dE_ij) / (exp(-dE_ij) + 1)  (if dE > 0)
  71          */
  72         if (lambdaEnergyDifference < 0)
  73         {
  74             return 1.0 / (1.0 + std::exp(lambdaEnergyDifference));
  75         }
  76         else
  77         {
  78             return std::exp(-lambdaEnergyDifference) / (1.0 + std::exp(-lambdaEnergyDifference));
  79         }
  80     }
  81     else if (calculationMode == LambdaWeightCalculation::Metropolis)
  82     {
  83         /* Metropolis acceptance rule for a jump from state i -> j is defined as
  84          *     1            (if dE_ij < 0)
  85          *     exp(-dE_ij)  (if dE_ij >= 0)
  86          * where dE_ij is the potential energy difference between the two states
  87          * plus a free energy offset that can be subtracted off later:
  88          *     dE_ij = FE_j - FE_i + offset
  89          */
  90         if (lambdaEnergyDifference < 0)
  91         {
  92             return 1.0;
  93         }
  94         else
  95         {
  96             return std::exp(-lambdaEnergyDifference);
  97         }
  98     }
  99
 100     GMX_THROW(NotImplementedError("Unknown acceptance calculation mode"));
 101 }
 102
 103 } // namespace gmx