src/gromacs/nbnxm/benchmark/bench_system.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,2021, 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 <string>
  48 #include <vector>
  49
  50 #include "gromacs/math/vectypes.h"
  51 #include "gromacs/mdtypes/forcerec.h"
  52 #include "gromacs/utility/listoflists.h"
  53 #include "gromacs/utility/smalloc.h"
  54
  55 namespace gmx
  56 {
  57
  58 //! Description of the system used for benchmarking.
  59 struct BenchmarkSystem
  60 {
  61     /*! \brief Constructor
  62      *
  63      * Generates a benchmark system of size \p multiplicationFactor
  64      * times the base size by stacking cubic boxes of 1000 water molecules
  65      * with 3000 atoms total.
  66      *
  67      * \param[in] multiplicationFactor  Should be a power of 2, is checked
  68      * \param[in] outputFile            The name of the csv file to write benchmark results
  69      */
  70     BenchmarkSystem(int multiplicationFactor, const std::string& outputFile);
  71
  72     //! Number of different atom types in test system.
  73     int numAtomTypes;
  74     //! Storage for parameters for short range interactions.
  75     std::vector<real> nonbondedParameters;
  76     //! Storage for atom type parameters.
  77     std::vector<int> atomTypes;
  78     //! Storage for atom partial charges.
  79     std::vector<real> charges;
  80     //! Atom info where all atoms are marked to have Van der Waals interactions
  81     std::vector<int> atomInfoAllVdw;
  82     //! Atom info where only oxygen atoms are marked to have Van der Waals interactions
  83     std::vector<int> atomInfoOxygenVdw;
  84     //! Information about exclusions.
  85     ListOfLists<int> excls;
  86     //! Storage for atom positions.
  87     std::vector<gmx::RVec> coordinates;
  88     //! System simulation box.
  89     matrix box;
  90     //! Forcerec with only the entries used in the benchmark set
  91     t_forcerec forceRec;
  92     //! csv output file
  93     FILE* csv;
  94 };
  95
  96 } // namespace gmx
  97
  98 #endif