src/gromacs/gmxlib/nonbonded/nb_free_energy.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2008, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2018,2019,2020,2021, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37
  38 #ifndef _nb_free_energy_h_
  39 #define _nb_free_energy_h_
  40
  41 #include "gromacs/math/vectypes.h"
  42 #include "gromacs/utility/basedefinitions.h"
  43
  44 struct t_forcerec;
  45 struct t_mdatoms;
  46 struct t_nrnb;
  47 struct t_nblist;
  48 namespace gmx
  49 {
  50 class ForceWithShiftForces;
  51 template<typename>
  52 class ArrayRef;
  53 } // namespace gmx
  54
  55 void gmx_nb_free_energy_kernel(const t_nblist* gmx_restrict nlist,
  56                                rvec* gmx_restrict         xx,
  57                                gmx::ForceWithShiftForces* forceWithShiftForces,
  58                                const t_forcerec* gmx_restrict fr,
  59                                const t_mdatoms* gmx_restrict mdatoms,
  60                                int                           flags,
  61                                gmx::ArrayRef<const real>     lambda,
  62                                gmx::ArrayRef<real>           dvdl,
  63                                gmx::ArrayRef<real>           energygrp_elec,
  64                                gmx::ArrayRef<real>           energygrp_vdw,
  65                                t_nrnb* gmx_restrict nrnb);
  66
  67 #endif