2b6920a8424fc0fe628e2a3f0f81871e44c441ff
[alexxy/gromacs.git] / src / gromacs / mdlib / nbnxn_cuda / nbnxn_cuda.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2017, 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 /*! \internal \file
36  * \brief
37  * Declares nbnxn cuda cache and texture helper functions
38  */
39 #ifndef GMX_MDLIB_NBNXN_CUDA_NBNXN_CUDA_H
40 #define GMX_MDLIB_NBNXN_CUDA_NBNXN_CUDA_H
41
42 #include "nbnxn_cuda_types.h"
43
44 //! Set up the cache configuration for the non-bonded kernels.
45 void nbnxn_cuda_set_cacheconfig(const gmx_device_info_t *devinfo);
46 /*! \brief Return the reference to the nbfp texture.
47  *
48  *  Note: it can return junk when c_disableCudaTextures==false, but we don't
49  *  assert on that condition because the data_mgmt module ends up calling this
50  *  function even if texture references are not used.
51  */
52 const struct texture<float, 1, cudaReadModeElementType> &nbnxn_cuda_get_nbfp_texref();
53 /*! \brief Return the reference to the nbfp_comb texture.
54  *
55  *  Note: it can return junk when c_disableCudaTextures==false, but we don't
56  *  assert on that condition because the data_mgmt module ends up calling this
57  *  function even if texture references are not used.
58  */
59 const struct texture<float, 1, cudaReadModeElementType> &nbnxn_cuda_get_nbfp_comb_texref();
60 /*! \brief Return the reference to the coulomb_tab texture.
61  *
62  *  Note: it can return junk when c_disableCudaTextures==false, but we don't
63  *  assert on that condition because the data_mgmt module ends up calling this
64  *  function even if texture references are not used.
65  */
66 const struct texture<float, 1, cudaReadModeElementType> &nbnxn_cuda_get_coulomb_tab_texref();
67
68 #endif