src/gromacs/nbnxm/nbnxm_gpu_data_mgmt.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014,2015,2017 by the GROMACS development team.
   5  * Copyright (c) 2018,2019,2020,2021, by the GROMACS development team, led by
   6  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7  * and including many others, as listed in the AUTHORS file in the
   8  * top-level source directory and at http://www.gromacs.org.
   9  *
  10  * GROMACS is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public License
  12  * as published by the Free Software Foundation; either version 2.1
  13  * of the License, or (at your option) any later version.
  14  *
  15  * GROMACS is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with GROMACS; if not, see
  22  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24  *
  25  * If you want to redistribute modifications to GROMACS, please
  26  * consider that scientific software is very special. Version
  27  * control is crucial - bugs must be traceable. We will be happy to
  28  * consider code for inclusion in the official distribution, but
  29  * derived work must not be called official GROMACS. Details are found
  30  * in the README & COPYING files - if they are missing, get the
  31  * official version at http://www.gromacs.org.
  32  *
  33  * To help us fund GROMACS development, we humbly ask that you cite
  34  * the research papers on the package. Check out http://www.gromacs.org.
  35  */
  36 /*! \libinternal \file
  37  *  \brief Declare common functions for NBNXM GPU data management.
  38  *
  39  *  \author Artem Zhmurov <zhmurov@gmail.com>
  40  *
  41  *  \ingroup module_nbnxm
  42  */
  43
  44 #ifndef GMX_NBNXM_NBNXM_GPU_DATA_MGMT_H
  45 #define GMX_NBNXM_NBNXM_GPU_DATA_MGMT_H
  46
  47 class DeviceContext;
  48 struct interaction_const_t;
  49 struct NBParamGpu;
  50 struct PairlistParams;
  51
  52 namespace gmx
  53 {
  54 enum class InteractionLocality;
  55 }
  56
  57 namespace Nbnxm
  58 {
  59
  60 struct gpu_plist;
  61
  62 /*! \brief Tabulates the Ewald Coulomb force and initializes the size/scale and the table GPU array.
  63  *
  64  * If called with an already allocated table, it just re-uploads the
  65  * table.
  66  */
  67 void init_ewald_coulomb_force_table(const EwaldCorrectionTables& tables,
  68                                     NBParamGpu*                  nbp,
  69                                     const DeviceContext&         deviceContext);
  70
  71 /*! \brief Selects the Ewald kernel type, analytical or tabulated, single or twin cut-off. */
  72 enum ElecType nbnxn_gpu_pick_ewald_kernel_type(const interaction_const_t gmx_unused& ic,
  73                                                const DeviceInformation&              deviceInfo);
  74
  75 /*! \brief Copies all parameters related to the cut-off from ic to nbp
  76  */
  77 void set_cutoff_parameters(NBParamGpu* nbp, const interaction_const_t& ic, const PairlistParams& listParams);
  78
  79 /*! \brief Initializes the pair list data structure.
  80  */
  81 void init_plist(gpu_plist* pl);
  82
  83 /*! \brief Initializes the timings data structure. */
  84 void init_timings(gmx_wallclock_gpu_nbnxn_t* t);
  85
  86 void gpu_init_platform_specific(NbnxmGpu* nb);
  87
  88 } // namespace Nbnxm
  89
  90 #endif // GMX_NBNXM_NBNXM_GPU_DATA_MGMT_H