src/gromacs/mdlib/nbnxn_gpu_common_utils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2017, 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_mdlib
  40  */
  41
  42 #ifndef GMX_MDLIB_NBNXN_GPU_COMMON_UTILS_H
  43 #define GMX_MDLIB_NBNXN_GPU_COMMON_UTILS_H
  44
  45 #include "config.h"
  46
  47 #if GMX_GPU == GMX_GPU_CUDA
  48 #include "nbnxn_cuda/nbnxn_cuda_types.h"
  49 #endif
  50
  51 #if GMX_GPU == GMX_GPU_OPENCL
  52 #include "nbnxn_ocl/nbnxn_ocl_types.h"
  53 #endif
  54
  55 /*! \brief An early return condition for empty NB GPU workloads
  56  *
  57  * This is currently used for non-local kernels/transfers only.
  58  * Skipping the local kernel is more complicated, since the
  59  * local part of the force array also depends on the non-local kernel.
  60  * The skip of the local kernel is taken care of separately.
  61  */
  62 static inline bool canSkipWork(const gmx_nbnxn_gpu_t *nb, int iloc)
  63 {
  64     assert(nb && nb->plist[iloc]);
  65     return (iloc == eintNonlocal) && (nb->plist[iloc]->nsci == 0);
  66 }
  67
  68 #endif