src/gromacs/mdlib/freeenergyparameters.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  *
  37  * \brief Handling of free energy parameters
  38  *
  39  * \author Christian Blau <blau@kth.se>
  40  * \ingroup module_mdlib
  41  */
  42
  43 #ifndef GMX_MDLIB_FREEENERGYPARAMETERS_H
  44 #define GMX_MDLIB_FREEENERGYPARAMETERS_H
  45
  46 #include <array>
  47
  48 #include "gromacs/mdtypes/md_enums.h"
  49 #include "gromacs/utility/real.h"
  50
  51 struct t_lambda;
  52
  53 namespace gmx
  54 {
  55
  56 /*! \brief Evaluate the current lambdas
  57  *
  58  * \param[in] step the current simulation step
  59  * \param[in] fepvals describing the lambda setup
  60  * \param[in] currentLambdaState the lambda state to use to set the lambdas, -1 if not set
  61  * \returns the current lambda-value array
  62  */
  63 std::array<real, efptNR> currentLambdas(int64_t step, const t_lambda& fepvals, int currentLambdaState);
  64
  65 } // namespace gmx
  66
  67 #endif