src/gromacs/mdrunutility/freeenergy.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  * \brief Defines helper functions for mdrun pertaining to free energy calculations.
  37  *
  38  * \author Pascal Merz <pascal.merz@me.com>
  39  * \ingroup module_mdrunutility
  40  * \inlibraryapi
  41  */
  42
  43 #include "gmxpre.h"
  44
  45 #include "freeenergy.h"
  46
  47 #include <numeric>
  48
  49 #include "gromacs/mdrun/replicaexchange.h"
  50 #include "gromacs/mdtypes/awh_params.h"
  51 #include "gromacs/mdtypes/inputrec.h"
  52
  53 namespace gmx
  54 {
  55
  56 int computeFepPeriod(const t_inputrec& inputrec, const ReplicaExchangeParameters& replExParams)
  57 {
  58     if (inputrec.efep == FreeEnergyPerturbationType::No)
  59     {
  60         return 0;
  61     }
  62
  63     // Set free energy calculation period as the greatest common
  64     // denominator of nstdhdl, nstexpanded, replica exchange interval,
  65     // and AWH nstSampleCoord.
  66     int nstfep = inputrec.fepvals->nstdhdl;
  67     if (inputrec.bExpanded)
  68     {
  69         nstfep = std::gcd(inputrec.expandedvals->nstexpanded, nstfep);
  70     }
  71     if (replExParams.exchangeInterval > 0)
  72     {
  73         nstfep = std::gcd(replExParams.exchangeInterval, nstfep);
  74     }
  75     if (inputrec.bDoAwh)
  76     {
  77         nstfep = std::gcd(inputrec.awhParams->nstSampleCoord(), nstfep);
  78     }
  79     return nstfep;
  80 }
  81
  82 } // namespace gmx