src/gromacs/nbnxm/prunekerneldispatch.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,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 pair-list pruning kernel wrapper function.
  40  *
  41  * The wrapper function internally performs the OpenMP parallelization
  42  * and calls the selected kernel flavor (different SIMD types / C reference).
  43  *
  44  * \inlibraryapi
  45  *
  46  * \author Berk Hess <hess@kth.se>
  47  */
  48
  49 #include "gromacs/math/vectypes.h"
  50 #include "gromacs/utility/real.h"
  51
  52 struct nbnxn_atomdata_t;
  53 struct nonbonded_verlet_group_t;
  54
  55 /*! \brief Prune all pair-lists in the set with distance \p rlistInner
  56  *
  57  * For all pair-lists in the set takes the outer list and prunes out
  58  * pairs beyond \p rlistInner and writes the result to a list that is
  59  * to be consumed by the non-bonded kernel.
  60  */
  61 void nbnxn_kernel_cpu_prune(nonbonded_verlet_group_t  *nbvg,
  62                             const nbnxn_atomdata_t    *nbat,
  63                             const rvec                *shift_vec,
  64                             real                       rlistInner);