Update instructions in containers.rst
[gromacs.git] / src / gromacs / gpu_utils / gputraits.cuh
blobfec113b4b4c1f4bcd1414e1ee8cfd4d4478b687f
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2018,2019,2020, 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 #ifndef GMX_GPU_UTILS_GPUTRAITS_CUH
36 #define GMX_GPU_UTILS_GPUTRAITS_CUH
38 /*! \libinternal \file
39  *  \brief Declares the CUDA type traits.
40  *
41  *  \author Aleksei Iupinov <a.yupinov@gmail.com>
42  *  \author Artem Zhmurov <zhmurov@gmail.com>
43  *
44  * \inlibraryapi
45  * \ingroup module_gpu_utils
46  */
47 #include <cuda_runtime.h>
49 //! Device texture for fast read-only data fetching
50 using DeviceTexture = cudaTextureObject_t;
52 //! \brief Single GPU call timing event - meaningless in CUDA
53 using CommandEvent = void;
55 /*! \internal \brief
56  * GPU kernels scheduling description. This is same in OpenCL/CUDA.
57  * Provides reasonable defaults, one typically only needs to set the GPU stream
58  * and non-1 work sizes.
59  */
60 struct KernelLaunchConfig
62     //! Block counts
63     size_t gridSize[3] = { 1, 1, 1 };
64     //! Per-block thread counts
65     size_t blockSize[3] = { 1, 1, 1 };
66     //! Shared memory size in bytes
67     size_t sharedMemorySize = 0;
70 //! Sets whether device code can use arrays that are embedded in structs.
71 #define c_canEmbedBuffers true
72 // TODO this should be constexpr bool
74 #endif