src/gromacs/ewald/pme_coordinate_receiver_gpu_impl.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2019,2020,2021, 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 PME-PP GPU comm 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_ewald
  45  */
  46 #include "gmxpre.h"
  47
  48 #include "config.h"
  49
  50 #include "gromacs/ewald/pme_coordinate_receiver_gpu.h"
  51 #include "gromacs/utility/arrayref.h"
  52 #include "gromacs/utility/gmxassert.h"
  53
  54 #if !GMX_GPU_CUDA
  55
  56 namespace gmx
  57 {
  58
  59 /*!\brief \internal Impl class stub. */
  60 class PmeCoordinateReceiverGpu::Impl
  61 {
  62 };
  63
  64 /*!\brief Constructor stub. */
  65 PmeCoordinateReceiverGpu::PmeCoordinateReceiverGpu(MPI_Comm /* comm */,
  66                                                    const DeviceContext& /* deviceContext */,
  67                                                    gmx::ArrayRef<PpRanks> /* ppRanks */) :
  68     impl_(nullptr)
  69 {
  70     GMX_ASSERT(!impl_,
  71                "A CPU stub for PME-PP GPU communication was called instead of the correct "
  72                "implementation.");
  73 }
  74
  75 PmeCoordinateReceiverGpu::~PmeCoordinateReceiverGpu() = default;
  76
  77 /*!\brief init PME-PP GPU communication stub */
  78 void PmeCoordinateReceiverGpu::reinitCoordinateReceiver(DeviceBuffer<RVec> /* d_x */)
  79 {
  80     GMX_ASSERT(!impl_,
  81                "A CPU stub for PME-PP GPU communication initialization was called instead of the "
  82                "correct implementation.");
  83 }
  84
  85 void PmeCoordinateReceiverGpu::receiveCoordinatesSynchronizerFromPpCudaDirect(int /* ppRank */)
  86 {
  87     GMX_ASSERT(!impl_,
  88                "A CPU stub for PME-PP GPU communication was called instead of the correct "
  89                "implementation.");
  90 }
  91
  92 void PmeCoordinateReceiverGpu::launchReceiveCoordinatesFromPpCudaMpi(DeviceBuffer<RVec> /* recvbuf */,
  93                                                                      int /* numAtoms */,
  94                                                                      int /* numBytes */,
  95                                                                      int /* ppRank */)
  96 {
  97     GMX_ASSERT(!impl_,
  98                "A CPU stub for PME-PP GPU communication was called instead of the correct "
  99                "implementation.");
 100 }
 101
 102 int PmeCoordinateReceiverGpu::synchronizeOnCoordinatesFromPpRank(int /* pipelineStage */,
 103                                                                  const DeviceStream& /* deviceStream */)
 104 {
 105     GMX_ASSERT(!impl_,
 106                "A CPU stub for PME-PP GPU communication was called instead of the correct "
 107                "implementation.");
 108     return 0;
 109 }
 110
 111 void PmeCoordinateReceiverGpu::synchronizeOnCoordinatesFromAllPpRanks(const DeviceStream& /* deviceStream */)
 112 {
 113     GMX_ASSERT(!impl_,
 114                "A CPU stub for PME-PP GPU communication was called instead of the correct "
 115                "implementation.");
 116 }
 117
 118 DeviceStream* PmeCoordinateReceiverGpu::ppCommStream(int /* senderIndex */)
 119 {
 120     GMX_ASSERT(!impl_,
 121                "A CPU stub for PME-PP GPU communication was called instead of the correct "
 122                "implementation.");
 123     return nullptr;
 124 }
 125
 126 std::tuple<int, int> PmeCoordinateReceiverGpu::ppCommAtomRange(int /* senderIndex */)
 127 {
 128     GMX_ASSERT(!impl_,
 129                "A CPU stub for PME-PP GPU communication was called instead of the correct "
 130                "implementation.");
 131     return std::make_tuple(0, 0);
 132 }
 133
 134 int PmeCoordinateReceiverGpu::ppCommNumSenderRanks()
 135 {
 136     GMX_ASSERT(!impl_,
 137                "A CPU stub for PME-PP GPU communication was called instead of the correct "
 138                "implementation.");
 139     return 0;
 140 }
 141
 142
 143 } // namespace gmx
 144
 145 #endif // !GMX_GPU_CUDA