src/gromacs/mdlib/nbnxn_kernels/nbnxn_kernel_cpu.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,2018,2019, 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
  36 /*! \libinternal \file
  37  *
  38  * \brief
  39  * Declares the nbnxn pair interaction kernel dispatcher.
  40  *
  41  * \author Berk Hess <hess@kth.se>
  42  */
  43
  44 #ifndef _nbnxn_kernel_cpu_h
  45 #define _nbnxn_kernel_cpu_h
  46
  47 #include "gromacs/math/vectypes.h"
  48 #include "gromacs/utility/real.h"
  49
  50 struct interaction_const_t;
  51 struct nbnxn_atomdata_t;
  52 struct nonbonded_verlet_group_t;
  53
  54 /*! \brief Dispatches the non-bonded N versus M atom cluster CPU kernels.
  55  *
  56  * OpenMP parallelization is performed within this function.
  57  * Energy reduction, but not force and shift force reduction, is performed
  58  * within this function.
  59  *
  60  * \param[in,out] nbvg          The group (local/non-local) to compute interaction for
  61  * \param[in,out] nbat          The atomdata for the interactions
  62  * \param[in]     ic            Non-bonded interaction constants
  63  * \param[in]     shiftVectors  The PBC shift vectors
  64  * \param[in]     forceFlags    Flags that tell what to compute
  65  * \param[in]     clearF        Enum that tells if to clear the force output buffer
  66  * \param[out]    fshift        Shift force output buffer
  67  * \param[out]    vCoulomb      Output buffer for Coulomb energies
  68  * \param[out]    vVdw          Output buffer for Van der Waals energies
  69  */
  70 void
  71 nbnxn_kernel_cpu(nonbonded_verlet_group_t  *nbvg,
  72                  nbnxn_atomdata_t          *nbat,
  73                  const interaction_const_t *ic,
  74                  rvec                      *shiftVectors,
  75                  int                        forceFlags,
  76                  int                        clearF,
  77                  real                      *fshift,
  78                  real                      *vCoulomb,
  79                  real                      *vVdw);
  80
  81 #endif