src/gromacs/listed_forces/pairs.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2017,2018 by the GROMACS development team.
   5  * Copyright (c) 2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \libinternal \file
  37  *
  38  * \brief This file declares functions for "pair" interactions
  39  * (i.e. listed non-bonded interactions, e.g. 1-4 interactions)
  40  *
  41  * \author Mark Abraham <mark.j.abraham@gmail.com>
  42  * \inlibraryapi
  43  * \ingroup module_listed_forces
  44  */
  45 #ifndef GMX_LISTED_FORCES_PAIRS_H
  46 #define GMX_LISTED_FORCES_PAIRS_H
  47
  48 #include "gromacs/math/vec.h"
  49 #include "gromacs/topology/ifunc.h"
  50 #include "gromacs/utility/real.h"
  51
  52 struct gmx_grppairener_t;
  53 struct t_forcerec;
  54 struct t_pbc;
  55
  56 namespace gmx
  57 {
  58 class StepWorkload;
  59 template<typename>
  60 class ArrayRef;
  61 } // namespace gmx
  62
  63 /*! \brief Calculate VdW/charge listed pair interactions (usually 1-4
  64  * interactions).
  65  *
  66  * global_atom_index is only passed for printing error messages.
  67  */
  68 void do_pairs(int                           ftype,
  69               int                           nbonds,
  70               const t_iatom                 iatoms[],
  71               const t_iparams               iparams[],
  72               const rvec                    x[],
  73               rvec4                         f[],
  74               rvec                          fshift[],
  75               const struct t_pbc*           pbc,
  76               const real*                   lambda,
  77               real*                         dvdl,
  78               gmx::ArrayRef<real>           chargeA,
  79               gmx::ArrayRef<real>           chargeB,
  80               gmx::ArrayRef<bool>           atomIsPerturbed,
  81               gmx::ArrayRef<unsigned short> cENER,
  82               int                           numEnergyGroups,
  83               const t_forcerec*             fr,
  84               bool                          havePerturbedPairs,
  85               const gmx::StepWorkload&      stepWork,
  86               gmx_grppairener_t*            grppener,
  87               int*                          global_atom_index);
  88
  89 #endif