Fix random typos
[alexxy/gromacs.git] / src / gromacs / nbnxm / gridsetdata.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 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
36 /*! \internal \file
37  *
38  * \brief
39  * Declares the GridSetData struct which holds grid data that is shared over all grids
40  *
41  * Also declares a struct for work data that is shared over grids.
42  *
43  * \author Berk Hess <hess@kth.se>
44  * \ingroup module_nbnxm
45  */
46
47 #ifndef GMX_NBNXM_GRIDSETDATA_H
48 #define GMX_NBNXM_GRIDSETDATA_H
49
50 #include <vector>
51
52 #include "gromacs/gpu_utils/hostallocator.h"
53
54 namespace Nbnxm
55 {
56
57 /*! \internal
58  * \brief Struct that holds grid data that is shared over all grids
59  *
60  * To enable a single coordinate and force array, a single cell range
61  * is needed which covers all grids.
62  */
63 struct GridSetData
64 {
65     //! The cell indices for all atoms
66     gmx::HostVector<int> cells;
67     //! The atom indices for all atoms stored in cell order
68     gmx::HostVector<int> atomIndices;
69 };
70
71 /*! \internal
72  * \brief Working arrays for constructing a grid
73  */
74 struct GridWork
75 {
76     //! Number of atoms for each grid column
77     std::vector<int> numAtomsPerColumn;
78     //! Buffer for sorting integers
79     std::vector<int> sortBuffer;
80 };
81
82 } // namespace Nbnxm
83
84 #endif