src/gromacs/nbnxm/gpu_common_utils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017,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  * \brief Implements common util routines for different NBNXN GPU implementations
  37  *
  38  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  39  * \ingroup module_nbnxm
  40  */
  41
  42 #ifndef GMX_NBNXM_GPU_COMMON_UTILS_H
  43 #define GMX_NBNXM_GPU_COMMON_UTILS_H
  44
  45 #include "gromacs/listed_forces/gpubonded.h"
  46 #include "gromacs/mdtypes/locality.h"
  47 #include "gromacs/nbnxm/gpu_types_common.h"
  48 #include "gromacs/utility/exceptions.h"
  49 #include "gromacs/utility/range.h"
  50
  51 namespace Nbnxm
  52 {
  53
  54 /*! \brief An early return condition for empty NB GPU workloads
  55  *
  56  * This is currently used for non-local kernels/transfers only.
  57  * Skipping the local kernel is more complicated, since the
  58  * local part of the force array also depends on the non-local kernel.
  59  * The skip of the local kernel is taken care of separately.
  60  */
  61 static inline bool canSkipNonbondedWork(const NbnxmGpu& nb, InteractionLocality iloc)
  62 {
  63     assert(nb.plist[iloc]);
  64     return (iloc == InteractionLocality::NonLocal && nb.plist[iloc]->nsci == 0);
  65 }
  66
  67 /*! \brief Calculate atom range and return start index and length.
  68  *
  69  * \param[in] atomData Atom descriptor data structure
  70  * \param[in] atomLocality Atom locality specifier
  71  * \returns Range of indexes for selected locality.
  72  */
  73 static inline gmx::Range<int> getGpuAtomRange(const NBAtomDataGpu* atomData, const AtomLocality atomLocality)
  74 {
  75     assert(atomData);
  76
  77     /* calculate the atom data index range based on locality */
  78     if (atomLocality == AtomLocality::Local)
  79     {
  80         return gmx::Range<int>(0, atomData->numAtomsLocal);
  81     }
  82     else if (atomLocality == AtomLocality::NonLocal)
  83     {
  84         return gmx::Range<int>(atomData->numAtomsLocal, atomData->numAtoms);
  85     }
  86     else
  87     {
  88         GMX_THROW(gmx::InconsistentInputError(
  89                 "Only Local and NonLocal atom locities can be used to get atom ranges in NBNXM."));
  90     }
  91 }
  92
  93 } // namespace Nbnxm
  94
  95 #endif