Merge branch release-2020 into merge-2020-into-2021
[alexxy/gromacs.git] / src / gromacs / gpu_utils / gpu_utils.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2014,2015,2017,2018,2019,2020, 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 Function definitions for non-GPU builds
37  *
38  *  \author Mark Abraham <mark.j.abraham@gmail.com>
39  */
40 #include "gmxpre.h"
41
42 #include "gpu_utils.h"
43
44 #include "config.h"
45
46 #include <cassert>
47
48 #include "gromacs/utility/arrayref.h"
49 #include "gromacs/utility/smalloc.h"
50 #include "gromacs/utility/stringutil.h"
51
52 #ifdef _MSC_VER
53 #    pragma warning(disable : 6237)
54 #endif
55
56 /*! \brief Help build a descriptive message in \c error if there are
57  * \c errorReasons why nonbondeds on a GPU are not supported.
58  *
59  * \returns Whether the lack of errorReasons indicate there is support. */
60 static bool addMessageIfNotSupported(gmx::ArrayRef<const std::string> errorReasons, std::string* error)
61 {
62     bool isSupported = errorReasons.empty();
63     if (!isSupported && error)
64     {
65         *error = "Nonbonded interactions cannot run on GPUs: ";
66         *error += joinStrings(errorReasons, "; ") + ".";
67     }
68     return isSupported;
69 }
70
71 bool buildSupportsNonbondedOnGpu(std::string* error)
72 {
73     std::vector<std::string> errorReasons;
74     if (GMX_DOUBLE)
75     {
76         errorReasons.emplace_back("double precision");
77     }
78     if (!GMX_GPU)
79     {
80         errorReasons.emplace_back("non-GPU build of GROMACS");
81     }
82     if (GMX_GPU_SYCL)
83     {
84         errorReasons.emplace_back("SYCL build of GROMACS");
85     }
86     return addMessageIfNotSupported(errorReasons, error);
87 }