Apply clang-format to source tree
[alexxy/gromacs.git] / src / gromacs / nbnxm / benchmark / bench_system.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 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 /*!\file
37  * \brief
38  * This file declares functions for setting up a benchmark system
39  *
40  * \author Berk Hess <hess@kth.se>
41  * \ingroup module_nbnxm
42  */
43
44 #ifndef GMX_NBNXN_BENCH_SYSTEM_H
45 #define GMX_NBNXN_BENCH_SYSTEM_H
46
47 #include <vector>
48
49 #include "gromacs/math/vectypes.h"
50 #include "gromacs/mdtypes/forcerec.h"
51 #include "gromacs/topology/block.h"
52 #include "gromacs/utility/smalloc.h"
53
54 namespace gmx
55 {
56
57 //! Description of the system used for benchmarking.
58 struct BenchmarkSystem
59 {
60     /*! \brief Constructor
61      *
62      * Generates a benchmark system of size \p multiplicationFactor
63      * times the base size by stacking cubic boxes of 1000 water molecules
64      * with 3000 atoms total.
65      *
66      * \param[in] multiplicationFactor  Should be a power of 2, is checked
67      */
68     BenchmarkSystem(int multiplicationFactor);
69
70     //! Number of different atom types in test system.
71     int numAtomTypes;
72     //! Storage for parameters for short range interactions.
73     std::vector<real> nonbondedParameters;
74     //! Storage for atom type parameters.
75     std::vector<int> atomTypes;
76     //! Storage for atom partial charges.
77     std::vector<real> charges;
78     //! Atom info where all atoms are marked to have Van der Waals interactions
79     std::vector<int> atomInfoAllVdw;
80     //! Atom info where only oxygen atoms are marked to have Van der Waals interactions
81     std::vector<int> atomInfoOxygenVdw;
82     //! Information about exclusions.
83     t_blocka excls;
84     //! Storage for atom positions.
85     std::vector<gmx::RVec> coordinates;
86     //! System simulation box.
87     matrix box;
88     //! Forcerec with only the entries used in the benchmark set
89     t_forcerec forceRec;
90 };
91
92 } // namespace gmx
93
94 #endif