src/gromacs/gpu_utils/gpu_testutils.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019, 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 /*! \libinternal \file
  36  *  \brief Declare functions for detection of GPU devices, specific for tests.
  37  *
  38  *  \todo This should eventually go to src/testutils
  39  *
  40  *  \author Artem Zhmurov <zhmurov@gmail.com>
  41  *
  42  *  \inlibraryapi
  43  */
  44
  45 #ifndef GMX_GPU_UTILS_GPU_TESTUTILS_H
  46 #define GMX_GPU_UTILS_GPU_TESTUTILS_H
  47
  48 /*! \brief Checks if there is a compatible GPU to run the computations on
  49  *
  50  * There are several reasons why code can not rune on the GPU:
  51  * 1. The GPU can not be detected, because there is none in the system.
  52  * 2. GPU detection is disabled by GMX_DISABLE_GPU_DETECTION environmental variable.
  53  * 3. GPUs are detected, but none of them is compatible.
  54  * This function checks all these conditions and returns true only if there at least
  55  * one GPU that can be used for computations.
  56  *
  57  * \returns True, if there a GPU that can be used for computations
  58  */
  59 bool canComputeOnGpu();
  60
  61 #endif // GMX_GPU_UTILS_GPU_TESTUTILS_H