Remove single-dimension limitation from GPU halo exchange
[gromacs.git] / src / gromacs / domdec / gpuhaloexchange_impl.cpp
blob64221f0257deece465f0dc2f831f14e9c8b696e7
1 /*
2 * This file is part of the GROMACS molecular simulation package.
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.
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.
35 /*! \internal \file
37 * \brief May be used to implement Domdec CUDA interfaces for non-GPU builds.
39 * Currently, reports and exits if any of the interfaces are called.
40 * Needed to satisfy compiler on systems, where CUDA is not available.
42 * \author Alan Gray <alang@nvidia.com>
44 * \ingroup module_domdec
46 #include "gmxpre.h"
48 #include "config.h"
50 #include "gromacs/domdec/gpuhaloexchange.h"
51 #include "gromacs/utility/gmxassert.h"
53 #if !GMX_GPU_CUDA
55 namespace gmx
58 /*!\brief Impl class stub. */
59 class GpuHaloExchange::Impl
63 /*!\brief Constructor stub. */
64 GpuHaloExchange::GpuHaloExchange(gmx_domdec_t* /* dd */,
65 int /* dimIndex */,
66 MPI_Comm /* mpi_comm_mysim */,
67 const DeviceContext& /* deviceContext */,
68 const DeviceStream& /*streamLocal */,
69 const DeviceStream& /*streamNonLocal */,
70 int /*pulse */,
71 gmx_wallcycle* /*wcycle*/) :
72 impl_(nullptr)
74 GMX_ASSERT(false,
75 "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
78 GpuHaloExchange::~GpuHaloExchange() = default;
80 /*!\brief init halo exhange stub. */
81 void GpuHaloExchange::reinitHalo(DeviceBuffer<RVec> /* d_coordinatesBuffer */,
82 DeviceBuffer<RVec> /* d_forcesBuffer */)
84 GMX_ASSERT(!impl_,
85 "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
88 /*!\brief apply X halo exchange stub. */
89 void GpuHaloExchange::communicateHaloCoordinates(const matrix /* box */,
90 GpuEventSynchronizer* /*coordinatesOnDeviceEvent*/)
92 GMX_ASSERT(!impl_,
93 "A CPU stub for GPU Halo Exchange exchange was called insted of the correct "
94 "implementation.");
97 /*!\brief apply F halo exchange stub. */
98 void GpuHaloExchange::communicateHaloForces(bool gmx_unused accumulateForces)
100 GMX_ASSERT(!impl_,
101 "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
104 /*!\brief get forces ready on device event stub. */
105 GpuEventSynchronizer* GpuHaloExchange::getForcesReadyOnDeviceEvent()
107 GMX_ASSERT(!impl_,
108 "A CPU stub for GPU Halo Exchange was called insted of the correct implementation.");
109 return nullptr;
112 } // namespace gmx
114 #endif // !GMX_GPU_CUDA