788725170fec74bc3610fc7917e977129483ede3
[alexxy/gromacs.git] / src / gromacs / gpu_utils / tests / gputest.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2017,2018,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 /*! \internal \file
36  * \brief
37  * Declares test fixture testing GPU utility components.
38  *
39  * \author Mark Abraham <mark.j.abraham@gmail.com>
40  */
41 #ifndef GMX_GPU_UTILS_TESTS_GPUTEST_H
42 #define GMX_GPU_UTILS_TESTS_GPUTEST_H
43
44 #include "gmxpre.h"
45
46 #include <gtest/gtest.h>
47
48 struct gmx_gpu_info_t;
49
50 namespace gmx
51 {
52 namespace test
53 {
54
55 class GpuTest : public ::testing::Test
56 {
57 public:
58     //! Information about GPUs that are present.
59     gmx_gpu_info_t* gpuInfo_;
60
61     GpuTest();
62     ~GpuTest() override;
63     //! Getter for convenience in testing
64     bool haveValidGpus() const;
65 };
66
67 } // namespace test
68 } // namespace gmx
69
70 #endif