api/nblib/forcecalculator.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 /*! \inpublicapi \file
  36  * \brief
  37  * Implements nblib ForceCalculator
  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_FORCECALCULATOR_H
  45 #define NBLIB_FORCECALCULATOR_H
  46
  47 #include "nblib/interactions.h"
  48 #include "nblib/kerneloptions.h"
  49 #include "nblib/simulationstate.h"
  50
  51 namespace gmx
  52 {
  53 template<typename T>
  54 class ArrayRef;
  55 } // namespace gmx
  56
  57 namespace nblib
  58 {
  59 class NbvSetupUtil;
  60 class GmxForceCalculator;
  61
  62 /*! \brief Setups up and computes forces using gromacs backend.
  63  *
  64  * The ForceCalculator uses the data in the SimulationState and NBKernelOptions to opaquely
  65  * construct all gromacs data structures needed to perform nonbonded force calculations. It is
  66  * costly to create this object since much of the SimulationState and NBKernelOptions has to be
  67  * passed to the gromacs backend. However, once constructed, compute can be called repeatedly only
  68  * paying the cost of the actual nonbonded force calculation. Repeated calls to compute on the same
  69  * coordinates will always return the same forces (within precision), so the user must update the
  70  * positions using the forces generated here to advance a simulation. If the coordinates move
  71  * sufficiently far from their positions at construction time, the efficiency of the calculation
  72  * will suffer. To alleviate this, the user can call updatePairList.
  73  *
  74  */
  75 class ForceCalculator final
  76 {
  77 public:
  78     ForceCalculator(const SimulationState& system, const NBKernelOptions& options);
  79
  80     ~ForceCalculator();
  81
  82     /*! \brief Dispatch the nonbonded force kernels and reduce the forces
  83      *
  84      * This function zeroes out all values in the passed in forces buffer, so it can be regarded as
  85      * an output only param.
  86      *
  87      * \param[in] coordinates to be used for the force calculation
  88      * \param[out] forces buffer to store the output forces
  89      */
  90     void compute(gmx::ArrayRef<const Vec3> coordinates, gmx::ArrayRef<Vec3> forces);
  91
  92     /*! \brief Puts particles on a grid based on bounds specified by the box
  93      *
  94      * As compute is called repeatedly, the particles drift apart and the force computation becomes
  95      * progressively less efficient. Calling this function recomputes the particle-particle pair
  96      * lists so that computation can proceed efficiently. Should be called around every 100 steps.
  97      *
  98      * \param particleInfoAllVdW The types of the particles to be placed on grids
  99      * \param coordinates The coordinates to be placed on grids
 100      * \param[in] box The system simulation box
 101      */
 102     void updatePairList(gmx::ArrayRef<const int64_t> particleInfoAllVdW,
 103                         gmx::ArrayRef<Vec3>          coordinates,
 104                         const Box&                   box);
 105
 106 private:
 107     //! GROMACS force calculator to compute forces
 108     std::unique_ptr<GmxForceCalculator> gmxForceCalculator_;
 109 };
 110
 111 } // namespace nblib
 112
 113 #endif // NBLIB_FORCECALCULATOR_H