src/gromacs/nbnxm/freeenergydispatch.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 /*! \internal \file
  36  *
  37  * \brief
  38  * Declares the free-energy kernel dispatch class
  39  *
  40  * \author Berk Hess <hess@kth.se>
  41  * \ingroup module_nbnxm
  42  */
  43 #ifndef GMX_NBNXM_FREEENERGYDISPATCH_H
  44 #define GMX_NBNXM_FREEENERGYDISPATCH_H
  45
  46 #include <memory>
  47
  48 #include "gromacs/math/vectypes.h"
  49 #include "gromacs/mdtypes/enerdata.h"
  50 #include "gromacs/mdtypes/threaded_force_buffer.h"
  51 #include "gromacs/utility/arrayref.h"
  52
  53 struct gmx_enerdata_t;
  54 struct gmx_wallcycle;
  55 struct interaction_const_t;
  56 class PairlistSets;
  57 struct t_lambda;
  58 struct t_nrnb;
  59
  60 namespace gmx
  61 {
  62 template<typename>
  63 class ArrayRefWithPadding;
  64 class ForceWithShiftForces;
  65 class StepWorkload;
  66 } // namespace gmx
  67
  68 /*! \libinternal
  69  *  \brief Temporary data and methods for handling dispatching of the nbnxm free-energy kernels
  70  */
  71 class FreeEnergyDispatch
  72 {
  73 public:
  74     //! Constructor
  75     FreeEnergyDispatch(int numEnergyGroups);
  76
  77     //! Sets up the threaded force buffer and the reduction, should be called after constructing the pair lists
  78     void setupFepThreadedForceBuffer(int numAtomsForce, const PairlistSets& pairlistSets);
  79
  80     //! Dispatches the non-bonded free-energy kernels, thread parallel and reduces the output
  81     void dispatchFreeEnergyKernels(const PairlistSets&                       pairlistSets,
  82                                    const gmx::ArrayRefWithPadding<const gmx::RVec>& coords,
  83                                    gmx::ForceWithShiftForces*                forceWithShiftForces,
  84                                    bool                                      useSimd,
  85                                    int                                       ntype,
  86                                    real                                      rlist,
  87                                    const interaction_const_t&                ic,
  88                                    gmx::ArrayRef<const gmx::RVec>            shiftvec,
  89                                    gmx::ArrayRef<const real>                 nbfp,
  90                                    gmx::ArrayRef<const real>                 nbfp_grid,
  91                                    gmx::ArrayRef<const real>                 chargeA,
  92                                    gmx::ArrayRef<const real>                 chargeB,
  93                                    gmx::ArrayRef<const int>                  typeA,
  94                                    gmx::ArrayRef<const int>                  typeB,
  95                                    t_lambda*                                 fepvals,
  96                                    gmx::ArrayRef<const real>                 lambda,
  97                                    gmx_enerdata_t*                           enerd,
  98                                    const gmx::StepWorkload&                  stepWork,
  99                                    t_nrnb*                                   nrnb,
 100                                    gmx_wallcycle*                            wcycle);
 101
 102 private:
 103     //! Temporary array for storing foreign lambda group pair energies
 104     gmx_grppairener_t foreignGroupPairEnergies_;
 105
 106     //! Threaded force buffer for nonbonded FEP
 107     gmx::ThreadedForceBuffer<gmx::RVec> threadedForceBuffer_;
 108     //! Threaded buffer for nonbonded FEP foreign energies and dVdl, no forces, so numAtoms = 0
 109     gmx::ThreadedForceBuffer<gmx::RVec> threadedForeignEnergyBuffer_;
 110 };
 111
 112 #endif // GMX_NBNXN_FREEENERGYDISPATCH_H