src/gromacs/gpu_utils/typecasts.cuh

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 /*! \libinternal \file
  36  *  \brief Declare functions to be used to cast CPU types to compatible GPU types.
  37  *
  38  *  \author Artem Zhmurov <zhmurov@gmail.com>
  39  *
  40  *  \inlibraryapi
  41  */
  42 #ifndef GMX_GPU_UTILS_TYPECASTS_CUH
  43 #define GMX_GPU_UTILS_TYPECASTS_CUH
  44
  45 #include "gmxpre.h"
  46
  47 #include "gromacs/math/vectypes.h"
  48
  49 /*! \brief Cast RVec buffer to float3 buffer.
  50  *
  51  * \param[in] in The RVec buffer to cast.
  52  *
  53  * \returns Buffer, casted to float3*.
  54  */
  55 static inline __host__ __device__ float3* asFloat3(gmx::RVec* in)
  56 {
  57     static_assert(sizeof(in[0]) == sizeof(float3),
  58                   "Size of the host-side data-type is different from the size of the device-side "
  59                   "counterpart.");
  60     return reinterpret_cast<float3*>(in);
  61 }
  62
  63 /*! \brief Cast pointer RVec buffer to a pointer to float3 buffer.
  64  *
  65  * \param[in] in The Pointer to RVec buffer to cast.
  66  *
  67  * \returns Buffer pointer, casted to float3*.
  68  */
  69 static inline __host__ __device__ float3** asFloat3Pointer(gmx::RVec** in)
  70 {
  71     static_assert(sizeof((*in)[0]) == sizeof(float3),
  72                   "Size of the host-side data-type is different from the size of the device-side "
  73                   "counterpart.");
  74     return reinterpret_cast<float3**>(in);
  75 }
  76 static inline __host__ __device__ const float3* const* asFloat3Pointer(const gmx::RVec* const* in)
  77 {
  78     static_assert(sizeof((*in)[0]) == sizeof(float3),
  79                   "Size of the host-side data-type is different from the size of the device-side "
  80                   "counterpart.");
  81     return reinterpret_cast<const float3* const*>(in);
  82 }
  83
  84 #endif // GMX_GPU_UTILS_TYPECASTS_CUH