2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012,2013,2014,2015,2016 by the GROMACS development team.
5 * Copyright (c) 2017,2018,2019,2020, by the GROMACS development team, led by
6 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 * and including many others, as listed in the AUTHORS file in the
8 * top-level source directory and at http://www.gromacs.org.
10 * GROMACS is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * as published by the Free Software Foundation; either version 2.1
13 * of the License, or (at your option) any later version.
15 * GROMACS is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with GROMACS; if not, see
22 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 * If you want to redistribute modifications to GROMACS, please
26 * consider that scientific software is very special. Version
27 * control is crucial - bugs must be traceable. We will be happy to
28 * consider code for inclusion in the official distribution, but
29 * derived work must not be called official GROMACS. Details are found
30 * in the README & COPYING files - if they are missing, get the
31 * official version at http://www.gromacs.org.
33 * To help us fund GROMACS development, we humbly ask that you cite
34 * the research papers on the package. Check out http://www.gromacs.org.
36 #ifndef GMX_HARDWARE_DETECTHARDWARE_H
37 #define GMX_HARDWARE_DETECTHARDWARE_H
39 struct gmx_gpu_info_t;
45 class PhysicalNodeCommunicator;
47 /*! \brief Run detection, consistency checks, and make consistent
48 * hardware information available on all ranks.
50 * This routine constructs the global hwinfo structure and returns a pointer to
51 * it. It will run a preamble before executing cpu and hardware checks, and
52 * then run consistency checks afterwards. The results will also be made
53 * available on all nodes.
55 * May do communication on MPI_COMM_WORLD when compiled with real MPI.
57 * All processes in a physical node need to coordinate calling this
58 * routine. With thread-MPI only the first call leads to detection
59 * work, and any subsequent call receives the same handle. With real
60 * MPI, communication is needed to coordinate the results. In all
61 * cases, any thread within a process may use the returned handle. */
62 gmx_hw_info_t* gmx_detect_hardware(const gmx::MDLogger& mdlog,
63 const PhysicalNodeCommunicator& physicalNodeComm);
65 //! Return whether compatible GPUs were found.
66 bool compatibleGpusFound(const gmx_gpu_info_t& gpu_info);