src/gromacs/ewald/pme_gpu_staging.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 /*! \libinternal \file
  37  * \brief Defines the host-side PME GPU data structures.
  38  * \todo Some renaming/refactoring, which does not impair the performance:
  39  * -- bringing the function names up to guidelines
  40  * -- PmeGpuSettings -> PmeGpuTasks
  41  * -- refining GPU notation application (#2053)
  42  * -- renaming coefficients to charges (?)
  43  *
  44  * \author Aleksei Iupinov <a.yupinov@gmail.com>
  45  * \author Mark Abraham <mark.j.abraham@gmail.com>
  46  * \ingroup module_ewald
  47  */
  48
  49 #ifndef GMX_EWALD_PME_GPU_STAGING_H
  50 #define GMX_EWALD_PME_GPU_STAGING_H
  51
  52 #include <vector>
  53
  54 #include "gromacs/gpu_utils/hostallocator.h"
  55 #include "gromacs/math/vectypes.h"
  56
  57 #ifndef NUM_STATES
  58 //! Number of FEP states.
  59 #    define NUM_STATES 2
  60 #endif
  61
  62 /*! \internal \brief
  63  * The PME GPU intermediate buffers structure, included in the main PME GPU structure by value.
  64  * Buffers are managed by the PME GPU module.
  65  */
  66 struct PmeGpuStaging
  67 {
  68     //! Host-side force buffer
  69     gmx::PaddedHostVector<gmx::RVec> h_forces;
  70
  71     /*! \brief Virial and energy intermediate host-side buffer. Size is PME_GPU_VIRIAL_AND_ENERGY_COUNT. */
  72     float* h_virialAndEnergy[NUM_STATES];
  73     /*! \brief B-spline values intermediate host-side buffer. */
  74     float* h_splineModuli[NUM_STATES];
  75
  76     /*! \brief Pointer to the host memory with B-spline values. Only used for host-side gather, or unit tests */
  77     float* h_theta;
  78     /*! \brief Pointer to the host memory with B-spline derivative values. Only used for host-side gather, or unit tests */
  79     float* h_dtheta;
  80     /*! \brief Pointer to the host memory with ivec atom gridline indices. Only used for host-side gather, or unit tests */
  81     int* h_gridlineIndices;
  82 };
  83
  84 #endif