Improve workload data structures' docs
[gromacs.git] / src / gromacs / ewald / pme_gpu_program.cpp
blob67e6a4e1c901e584b6a4b1886b01358df8057497
1 /*
2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 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.
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.
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.
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.
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.
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.
36 /*! \internal \file
37 * \brief
38 * Implements PmeGpuProgram, which wrap arounds PmeGpuProgramImpl
39 * to store permanent PME GPU context-derived data,
40 * such as (compiled) kernel handles.
42 * \author Aleksei Iupinov <a.yupinov@gmail.com>
43 * \ingroup module_ewald
46 #include "gmxpre.h"
48 #include "pme_gpu_program.h"
50 #include <memory>
52 #include "pme_gpu_program_impl.h"
54 PmeGpuProgram::PmeGpuProgram(const gmx_device_info_t *deviceInfo) :
55 impl_(std::make_unique<PmeGpuProgramImpl>(deviceInfo))
59 PmeGpuProgram::~PmeGpuProgram() = default;
61 PmeGpuProgramStorage buildPmeGpuProgram(const gmx_device_info_t *deviceInfo)
63 if (!deviceInfo)
65 // This workaround is only needed for CodePath::CPU dummy in testhardwarecontexts.cpp
66 return nullptr;
68 return std::make_unique<PmeGpuProgram>(deviceInfo);