src/gromacs/ewald/long_range_correction.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-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017 by the GROMACS development team.
   7  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \libinternal \file
  39  *
  40  * \brief This file contains function declarations necessary for
  41  * computing energies and forces for the PME long-ranged part (Coulomb
  42  * and LJ).
  43  *
  44  * \author Erik Lindahl <erik@kth.se>
  45  * \author Berk Hess <hess@kth.se>
  46  * \author Mark Abraham <mark.j.abraham@gmail.com>
  47  * \inlibraryapi
  48  * \ingroup module_ewald
  49  */
  50
  51 #ifndef GMX_EWALD_LONG_RANGE_CORRECTION_H
  52 #define GMX_EWALD_LONG_RANGE_CORRECTION_H
  53
  54 #include "gromacs/math/vectypes.h"
  55 #include "gromacs/utility/real.h"
  56
  57 struct t_commrec;
  58 struct t_forcerec;
  59 struct t_inputrec;
  60 enum class EwaldGeometry : int;
  61
  62 namespace gmx
  63 {
  64 template<typename>
  65 class ArrayRef;
  66 }
  67
  68 /*! \brief Calculate long-range Ewald correction terms.
  69  *
  70  * Calculate correction for electrostatic surface dipole terms.
  71  */
  72 void ewald_LRcorrection(int                            numAtomsLocal,
  73                         const t_commrec*               commrec,
  74                         int                            numThreads,
  75                         int                            thread,
  76                         real                           epsilonR,
  77                         gmx::ArrayRef<const double>    qsum,
  78                         EwaldGeometry                  ewaldGeometry,
  79                         real                           epsilonSurface,
  80                         bool                           havePbcXY2Walls,
  81                         real                           wallEwaldZfac,
  82                         gmx::ArrayRef<const real>      chargeA,
  83                         gmx::ArrayRef<const real>      chargeB,
  84                         bool                           bHaveChargePerturbed,
  85                         gmx::ArrayRef<const gmx::RVec> coords,
  86                         const matrix                   box,
  87                         gmx::ArrayRef<const gmx::RVec> mu_tot,
  88                         gmx::ArrayRef<gmx::RVec>       forces,
  89                         real*                          Vcorr_q,
  90                         real                           lambda_q,
  91                         real*                          dvdlambda_q);
  92
  93 #endif