api/nblib/systemdescription.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib simulation box
  38  *
  39  * \author Victor Holanda <victor.holanda@cscs.ch>
  40  * \author Joe Jordan <ejjordan@kth.se>
  41  * \author Prashanth Kanduri <kanduri@cscs.ch>
  42  * \author Sebastian Keller <keller@cscs.ch>
  43  */
  44 #ifndef NBLIB_SYSTEMDESCRIPTION_H
  45 #define NBLIB_SYSTEMDESCRIPTION_H
  46
  47 #include "gromacs/ewald/ewald_utils.h"
  48 #include "gromacs/gmxlib/nrnb.h"
  49 #include "gromacs/gpu_utils/device_stream_manager.h"
  50 #include "gromacs/mdlib/rf_util.h"
  51 #include "gromacs/mdtypes/enerdata.h"
  52 #include "gromacs/mdtypes/forcerec.h"
  53 #include "gromacs/mdtypes/interaction_const.h"
  54 #include "gromacs/mdtypes/simulation_workload.h"
  55 #include "gromacs/nbnxm/gpu_data_mgmt.h"
  56 #include "gromacs/nbnxm/nbnxm_gpu.h"
  57 #include "gromacs/nbnxm/atomdata.h"
  58 #include "gromacs/nbnxm/nbnxm.h"
  59 #include "gromacs/nbnxm/pairlistset.h"
  60 #include "gromacs/nbnxm/pairlistsets.h"
  61 #include "gromacs/nbnxm/pairsearch.h"
  62 #include "gromacs/timing/wallcycle.h"
  63 #include "gromacs/utility/listoflists.h"
  64 #include "gromacs/utility/range.h"
  65
  66 namespace nblib
  67 {
  68
  69 //! \brief client-side provided system description data
  70 struct SystemDescription
  71 {
  72     SystemDescription() = default;
  73
  74     SystemDescription(gmx::ArrayRef<int>     particleTypeIdOfAllParticles,
  75                       gmx::ArrayRef<real>    nonBondedParams,
  76                       gmx::ArrayRef<real>    charges,
  77                       gmx::ArrayRef<int64_t> particleInteractionFlags)
  78     {
  79         std::array inputSizes{ particleTypeIdOfAllParticles.size(),
  80                                charges.size(),
  81                                particleInteractionFlags.size() };
  82         if (static_cast<unsigned long>(std::count(begin(inputSizes), end(inputSizes), inputSizes[0]))
  83             != inputSizes.size())
  84         {
  85             throw InputException("input array size inconsistent");
  86         }
  87
  88         int numParticleTypes = int(std::round(std::sqrt(nonBondedParams.size() / 2)));
  89         if (2 * numParticleTypes * numParticleTypes != int(nonBondedParams.size()))
  90         {
  91             throw InputException("Wrong size of nonBondedParams");
  92         }
  93
  94         numParticles_     = particleTypeIdOfAllParticles.size();
  95         numParticleTypes_ = numParticleTypes;
  96
  97         particleTypeIdOfAllParticles_ = std::vector<int>(particleTypeIdOfAllParticles.begin(),
  98                                                          particleTypeIdOfAllParticles.end());
  99
 100         nonBondedParams_ = std::vector<real>(nonBondedParams.begin(), nonBondedParams.end());
 101         charges_         = std::vector<real>(charges.begin(), charges.end());
 102         particleInfo_ =
 103                 std::vector<int64_t>(particleInteractionFlags.begin(), particleInteractionFlags.end());
 104     }
 105
 106     //! number of particles
 107     size_t numParticles_{ 0 };
 108
 109     //! number of particle types
 110     size_t numParticleTypes_{ 0 };
 111
 112     //! particle type id of all particles
 113     std::vector<int> particleTypeIdOfAllParticles_;
 114
 115     //! Storage for parameters for short range interactions.
 116     std::vector<real> nonBondedParams_;
 117
 118     //! electrostatic charges
 119     std::vector<real> charges_;
 120
 121     //! flag for each particle to set LJ and Q interactions
 122     std::vector<int64_t> particleInfo_;
 123
 124     //! Legacy matrix for box
 125     Box box_{ 0 };
 126 };
 127
 128
 129 } // namespace nblib
 130 #endif // NBLIB_SYSTEMDESCRIPTION_H