api/nblib/gmxcalculatorcpu.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  * \brief
  37  * Implements a force calculator based on GROMACS data structures.
  38  *
  39  * Intended for internal use inside the ForceCalculator.
  40  *
  41  * \author Victor Holanda <victor.holanda@cscs.ch>
  42  * \author Joe Jordan <ejjordan@kth.se>
  43  * \author Prashanth Kanduri <kanduri@cscs.ch>
  44  * \author Sebastian Keller <keller@cscs.ch>
  45  */
  46
  47 #ifndef NBLIB_GMXCALCULATORCPU_H
  48 #define NBLIB_GMXCALCULATORCPU_H
  49
  50 #include <memory>
  51 #include <vector>
  52
  53 #include "nblib/box.h"
  54 #include "nblib/vector.h"
  55
  56 namespace gmx
  57 {
  58 template<typename T>
  59 class ArrayRef;
  60 } // namespace gmx
  61
  62 namespace nblib
  63 {
  64 struct NBKernelOptions;
  65 class Topology;
  66 struct TprReader;
  67
  68 class GmxNBForceCalculatorCpu final
  69 {
  70 public:
  71     GmxNBForceCalculatorCpu(gmx::ArrayRef<int>     particleTypeIdOfAllParticles,
  72                             gmx::ArrayRef<real>    nonBondedParams,
  73                             gmx::ArrayRef<real>    charges,
  74                             gmx::ArrayRef<int64_t> particleInteractionFlags,
  75                             gmx::ArrayRef<int>     exclusionRanges,
  76                             gmx::ArrayRef<int>     exclusionElements,
  77                             const NBKernelOptions& options);
  78
  79     ~GmxNBForceCalculatorCpu();
  80
  81     //! calculates a new pair list based on new coordinates (for every NS step)
  82     void updatePairlist(gmx::ArrayRef<gmx::RVec> coordinates, const Box& box);
  83
  84     //! Compute forces and return
  85     void compute(gmx::ArrayRef<const gmx::RVec> coordinateInput,
  86                  const Box&                     box,
  87                  gmx::ArrayRef<gmx::RVec>       forceOutput);
  88
  89     //! Compute forces and virial tensor
  90     void compute(gmx::ArrayRef<const gmx::RVec> coordinateInput,
  91                  const Box&                     box,
  92                  gmx::ArrayRef<gmx::RVec>       forceOutput,
  93                  gmx::ArrayRef<real>            virialOutput);
  94
  95     //! Compute forces, virial tensor and potential energies
  96     void compute(gmx::ArrayRef<const gmx::RVec> coordinateInput,
  97                  const Box&                     box,
  98                  gmx::ArrayRef<gmx::RVec>       forceOutput,
  99                  gmx::ArrayRef<real>            virialOutput,
 100                  gmx::ArrayRef<real>            energyOutput);
 101
 102 private:
 103     //! Private implementation
 104     class CpuImpl;
 105     std::unique_ptr<CpuImpl> impl_;
 106 };
 107
 108 std::unique_ptr<GmxNBForceCalculatorCpu> setupGmxForceCalculatorCpu(const Topology&        topology,
 109                                                                     const NBKernelOptions& options);
 110
 111 //! Sets up and returns a GmxForceCalculatorCpu based on a TPR file as input
 112 std::unique_ptr<GmxNBForceCalculatorCpu> setupGmxForceCalculatorCpu(TprReader& tprReader,
 113                                                                     const NBKernelOptions& options);
 114
 115 } // namespace nblib
 116
 117 #endif // NBLIB_GMXCALCULATORCPU_H