src/gromacs/listed_forces/gpubonded_impl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2018,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 /*! \internal \file
  36  *
  37  * \brief Implements GPU bonded lists for non-GPU builds
  38  *
  39  * \author Mark Abraham <mark.j.abraham@gmail.com>
  40  *
  41  * \ingroup module_listed_forces
  42  */
  43
  44 #include "gmxpre.h"
  45
  46 #include "config.h"
  47
  48 #include <algorithm>
  49 #include <string>
  50
  51 #include "gromacs/listed_forces/gpubonded.h"
  52 #include "gromacs/mdtypes/inputrec.h"
  53 #include "gromacs/topology/topology.h"
  54 #include "gromacs/utility/stringutil.h"
  55
  56 namespace gmx
  57 {
  58
  59 //! Returns whether there are any interactions in ilists suitable for a GPU.
  60 static bool someInteractionsCanRunOnGpu(const InteractionLists& ilists)
  61 {
  62     // Perturbation is not implemented in the GPU bonded
  63     // kernels. If all the interactions were actually
  64     // perturbed, then that will be detected later on each
  65     // domain, and work will never run on the GPU. This is
  66     // very unlikely to occur, and has little run-time cost,
  67     // so we don't complicate the code by catering for it
  68     // here.
  69     return std::any_of(fTypesOnGpu.begin(), fTypesOnGpu.end(), [ilists](int fType) {
  70         return !ilists[fType].iatoms.empty();
  71     });
  72 }
  73
  74 //! Returns whether there are any bonded interactions in the global topology suitable for a GPU.
  75 static bool bondedInteractionsCanRunOnGpu(const gmx_mtop_t& mtop)
  76 {
  77     // Check the regular molecule types
  78     for (const auto& moltype : mtop.moltype)
  79     {
  80         if (someInteractionsCanRunOnGpu(moltype.ilist))
  81         {
  82             return true;
  83         }
  84     }
  85     // Check the inter-molecular interactions.
  86     if (mtop.intermolecular_ilist)
  87     {
  88         if (someInteractionsCanRunOnGpu(*mtop.intermolecular_ilist))
  89         {
  90             return true;
  91         }
  92     }
  93     return false;
  94 }
  95
  96 /*! \brief Help build a descriptive message in \c error if there are
  97  * \c errorReasons why bondeds on a GPU are not supported.
  98  *
  99  * \returns Whether the lack of errorReasons indicate there is support. */
 100 static bool addMessageIfNotSupported(ArrayRef<const std::string> errorReasons, std::string* error)
 101 {
 102     bool isSupported = errorReasons.empty();
 103     if (!isSupported && error)
 104     {
 105         *error = "Bonded interactions cannot run on GPUs: ";
 106         *error += joinStrings(errorReasons, "; ") + ".";
 107     }
 108     return isSupported;
 109 }
 110
 111 bool buildSupportsGpuBondeds(std::string* error)
 112 {
 113     std::vector<std::string> errorReasons;
 114
 115     if (GMX_DOUBLE)
 116     {
 117         errorReasons.emplace_back("not supported with double precision");
 118     }
 119     if (GMX_GPU_OPENCL)
 120     {
 121         errorReasons.emplace_back("not supported with OpenCL build of GROMACS");
 122     }
 123     if (GMX_GPU_SYCL)
 124     {
 125         errorReasons.emplace_back("not supported with SYCL build of GROMACS");
 126     }
 127     else if (!GMX_GPU)
 128     {
 129         errorReasons.emplace_back("not supported with CPU-only build of GROMACS");
 130     }
 131     return addMessageIfNotSupported(errorReasons, error);
 132 }
 133
 134 bool inputSupportsGpuBondeds(const t_inputrec& ir, const gmx_mtop_t& mtop, std::string* error)
 135 {
 136     std::vector<std::string> errorReasons;
 137
 138     if (!bondedInteractionsCanRunOnGpu(mtop))
 139     {
 140         errorReasons.emplace_back("No supported bonded interactions are present");
 141     }
 142     if (!EI_DYNAMICS(ir.eI))
 143     {
 144         errorReasons.emplace_back(
 145                 "Cannot compute bonded interactions on a GPU, because GPU implementation requires "
 146                 "a dynamical integrator (md, sd, etc).");
 147     }
 148     if (EI_MIMIC(ir.eI))
 149     {
 150         errorReasons.emplace_back("MiMiC");
 151     }
 152     if (ir.useMts)
 153     {
 154         errorReasons.emplace_back("Cannot run with multiple time stepping");
 155     }
 156     if (ir.opts.ngener > 1)
 157     {
 158         errorReasons.emplace_back("Cannot run with multiple energy groups");
 159     }
 160     return addMessageIfNotSupported(errorReasons, error);
 161 }
 162
 163 #if !GMX_GPU_CUDA
 164
 165 class GpuBonded::Impl
 166 {
 167 };
 168
 169 GpuBonded::GpuBonded(const gmx_ffparams_t& /* ffparams */,
 170                      const float /* electrostaticsScaleFactor */,
 171                      const DeviceContext& /* deviceContext */,
 172                      const DeviceStream& /* deviceStream */,
 173                      gmx_wallcycle* /* wcycle */) :
 174     impl_(nullptr)
 175 {
 176 }
 177
 178 GpuBonded::~GpuBonded() = default;
 179
 180 void GpuBonded::updateInteractionListsAndDeviceBuffers(ArrayRef<const int> /* nbnxnAtomOrder */,
 181                                                        const InteractionDefinitions& /* idef */,
 182                                                        void* /* xqDevice */,
 183                                                        DeviceBuffer<RVec> /* forceDevice */,
 184                                                        DeviceBuffer<RVec> /* fshiftDevice */)
 185 {
 186 }
 187
 188 void GpuBonded::setPbc(PbcType /* pbcType */, const matrix /* box */, bool /* canMoleculeSpanPbc */)
 189 {
 190 }
 191
 192 bool GpuBonded::haveInteractions() const
 193 {
 194     return !impl_;
 195 }
 196
 197 void GpuBonded::launchKernel(const gmx::StepWorkload& /* stepWork */) {}
 198
 199 void GpuBonded::setPbcAndlaunchKernel(PbcType /* pbcType */,
 200                                       const matrix /* box */,
 201                                       bool /* canMoleculeSpanPbc */,
 202                                       const gmx::StepWorkload& /* stepWork */)
 203 {
 204 }
 205
 206 void GpuBonded::launchEnergyTransfer() {}
 207
 208 void GpuBonded::waitAccumulateEnergyTerms(gmx_enerdata_t* /* enerd */) {}
 209
 210 void GpuBonded::clearEnergies() {}
 211
 212 #endif // !GMX_GPU_CUDA
 213
 214 } // namespace gmx