e00d4e3d606f96385ddc1b88a46f1fa2f588765e
[alexxy/gromacs.git] / src / gromacs / domdec / gpuhaloexchange_impl.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 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  *
37  * \brief May be used to implement Domdec CUDA interfaces for non-GPU builds.
38  *
39  * Currently, reports and exits if any of the interfaces are called.
40  * Needed to satisfy compiler on systems, where CUDA is not available.
41  *
42  * \author Alan Gray <alang@nvidia.com>
43  *
44  * \ingroup module_domdec
45  */
46 #include "gmxpre.h"
47
48 #include "config.h"
49
50 #include <utility>
51
52 #include "gromacs/domdec/gpuhaloexchange.h"
53 #include "gromacs/utility/gmxassert.h"
54
55 #if !GMX_GPU_CUDA
56
57 namespace gmx
58 {
59
60 /*!\brief Impl class stub. */
61 class GpuHaloExchange::Impl
62 {
63 };
64
65 /*!\brief Constructor stub. */
66 GpuHaloExchange::GpuHaloExchange(gmx_domdec_t* /* dd */,
67                                  int /* dimIndex */,
68                                  MPI_Comm /* mpi_comm_mysim */,
69                                  const DeviceContext& /* deviceContext */,
70                                  const DeviceStream& /*streamLocal */,
71                                  const DeviceStream& /*streamNonLocal */,
72                                  int /*pulse */,
73                                  gmx_wallcycle* /*wcycle*/) :
74     impl_(nullptr)
75 {
76     GMX_ASSERT(false,
77                "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
78 }
79
80 GpuHaloExchange::~GpuHaloExchange() = default;
81
82 GpuHaloExchange::GpuHaloExchange(GpuHaloExchange&&) noexcept = default;
83
84 GpuHaloExchange& GpuHaloExchange::operator=(GpuHaloExchange&& other) noexcept
85 {
86     std::swap(impl_, other.impl_);
87     return *this;
88 }
89
90 /*!\brief init halo exhange stub. */
91 void GpuHaloExchange::reinitHalo(DeviceBuffer<RVec> /* d_coordinatesBuffer */,
92                                  DeviceBuffer<RVec> /* d_forcesBuffer */)
93 {
94     GMX_ASSERT(!impl_,
95                "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
96 }
97
98 /*!\brief apply X halo exchange stub. */
99 void GpuHaloExchange::communicateHaloCoordinates(const matrix /* box */,
100                                                  GpuEventSynchronizer* /*coordinatesOnDeviceEvent*/)
101 {
102     GMX_ASSERT(!impl_,
103                "A CPU stub for GPU Halo Exchange exchange was called insted of the correct "
104                "implementation.");
105 }
106
107 /*!\brief apply F halo exchange stub. */
108 void GpuHaloExchange::communicateHaloForces(bool gmx_unused accumulateForces)
109 {
110     GMX_ASSERT(!impl_,
111                "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
112 }
113
114 /*!\brief get forces ready on device event stub. */
115 GpuEventSynchronizer* GpuHaloExchange::getForcesReadyOnDeviceEvent()
116 {
117     GMX_ASSERT(!impl_,
118                "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
119     return nullptr;
120 }
121
122 } // namespace gmx
123
124 #endif // !GMX_GPU_CUDA