p3m_gpu_cuda.cu

Go to the documentation of this file.

/*
 * Copyright (C) 2010-2022 The ESPResSo project
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ESPResSo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
/**
 * @file
 *
 * P3M electrostatics on GPU.
 *
 * The corresponding header file is @ref p3m_gpu_cuda.cuh.
 */
 
#include "config/config.hpp"
 
#ifdef ELECTROSTATICS
 
#define P3M_GPU_FLOAT
// #define P3M_GPU_REAL_DOUBLE
 
#ifdef P3M_GPU_FLOAT
#define REAL_TYPE float
#define FFT_TYPE_COMPLEX cufftComplex
#define FFT_FORW_FFT cufftExecR2C
#define FFT_BACK_FFT cufftExecC2R
#define FFT_PLAN_FORW_FLAG CUFFT_R2C
#define FFT_PLAN_BACK_FLAG CUFFT_C2R
#endif
 
#ifdef P3M_GPU_REAL_DOUBLE
#define REAL_TYPE double
#define FFT_TYPE_COMPLEX cufftDoubleComplex
#define FFT_FORW_FFT cufftExecD2Z
#define FFT_BACK_FFT cufftExecZ2D
#define FFT_PLAN_FORW_FLAG CUFFT_D2Z
#define FFT_PLAN_BACK_FLAG CUFFT_Z2D
#endif
 
#include "electrostatics/p3m_gpu_cuda.cuh"
 
#include "cuda/utils.cuh"
#include "p3m/math.hpp"
#include "system/System.hpp"
 
#include <utils/math/bspline.hpp>
#include <utils/math/int_pow.hpp>
#include <utils/math/sqr.hpp>
 
#include <cuda.h>
#include <cufft.h>
 
#include <algorithm>
#include <cassert>
#include <cstddef>
#include <limits>
#include <numbers>
#include <stdexcept>
 
#if defined(OMPI_MPI_H) || defined(_MPI_H)
#error CU-file includes mpi.h! This should not happen!
#endif
 
using Utils::int_pow;
using Utils::sqr;
 
struct P3MGpuData {
  /** Charge mesh */
  FFT_TYPE_COMPLEX *charge_mesh;
  /** Force meshes */
  FFT_TYPE_COMPLEX *force_mesh_x;
  FFT_TYPE_COMPLEX *force_mesh_y;
  FFT_TYPE_COMPLEX *force_mesh_z;
  /** Influence Function */
  REAL_TYPE *G_hat;
  /** Charge assignment order */
  int cao;
  /** Total number of mesh points (including padding) */
  int mesh_size;
  /** Ewald parameter */
  REAL_TYPE alpha;
  /** Number of particles */
  unsigned int n_part; // oddity: size_t causes UB with GCC 11.4 in Debug mode
  /** Box size */
  REAL_TYPE box[3];
  /** Mesh dimensions */
  int mesh[3];
  /** Padded size */
  int mesh_z_padded;
  /** Inverse mesh spacing */
  REAL_TYPE hi[3];
  /** Position shift */
  REAL_TYPE pos_shift;
};
 
struct P3MGpuFftPlan {
  /** Forward FFT plan */
  cufftHandle forw_plan;
  /** Backward FFT plan */
  cufftHandle back_plan;
};
 
struct P3MGpuParams {
  P3MGpuData p3m_gpu_data;
  P3MGpuFftPlan p3m_fft;
  bool is_initialized;
 
  ~P3MGpuParams() { free_device_memory(); }
 
  void free_device_memory() {
    auto const free_device_pointer = [](auto *&ptr) {
      if (ptr != nullptr) {
        cuda_safe_mem(cudaFree(reinterpret_cast<void *>(ptr)));
        ptr = nullptr;
      }
    };
    free_device_pointer(p3m_gpu_data.charge_mesh);
    free_device_pointer(p3m_gpu_data.force_mesh_x);
    free_device_pointer(p3m_gpu_data.force_mesh_y);
    free_device_pointer(p3m_gpu_data.force_mesh_z);
    free_device_pointer(p3m_gpu_data.G_hat);
    cufftDestroy(p3m_fft.forw_plan);
    cufftDestroy(p3m_fft.back_plan);
    is_initialized = false;
  }
};
 
static auto p3m_calc_blocks(unsigned int cao, std::size_t n_part) {
  auto const cao3 = Utils::int_pow<3>(cao);
  auto parts_per_block = 1u;
  while ((parts_per_block + 1u) * cao3 <= 1024u) {
    ++parts_per_block;
  }
  assert((n_part / parts_per_block) <= std::numeric_limits<unsigned>::max());
  auto n = static_cast<unsigned int>(n_part / parts_per_block);
  auto n_blocks = ((n_part % parts_per_block) == 0u) ? std::max(1u, n) : n + 1u;
  assert(n_blocks <= std::numeric_limits<unsigned>::max());
  return std::make_pair(parts_per_block, static_cast<unsigned>(n_blocks));
}
 
dim3 p3m_make_grid(unsigned int n_blocks) {
  dim3 grid(n_blocks, 1u, 1u);
  while (grid.x > 65536u) {
    grid.y++;
    if ((n_blocks % grid.y) == 0u)
      grid.x = std::max(1u, n_blocks / grid.y);
    else
      grid.x = n_blocks / grid.y + 1u;
  }
  return grid;
}
 
template <int cao>
__device__ void static Aliasing_sums_ik(const P3MGpuData p, int NX, int NY,
                                        int NZ, REAL_TYPE *Zaehler,
                                        REAL_TYPE *Nenner) {
  REAL_TYPE S1, S2, S3;
  REAL_TYPE zwi;
  int MX, MY, MZ;
  REAL_TYPE NMX, NMY, NMZ;
  REAL_TYPE NM2;
  REAL_TYPE TE;
  REAL_TYPE Leni[3];
  REAL_TYPE Meshi[3];
  for (int i = 0; i < 3; ++i) {
    Leni[i] = 1.0f / p.box[i];
    Meshi[i] = 1.0f / static_cast<REAL_TYPE>(p.mesh[i]);
  }
 
  Zaehler[0] = Zaehler[1] = Zaehler[2] = *Nenner = 0.0;
 
  for (MX = -P3M_BRILLOUIN; MX <= P3M_BRILLOUIN; MX++) {
    NMX = static_cast<REAL_TYPE>(((NX > p.mesh[0] / 2) ? NX - p.mesh[0] : NX) +
                                 p.mesh[0] * MX);
    S1 = int_pow<2 * cao>(math::sinc(Meshi[0] * NMX));
    for (MY = -P3M_BRILLOUIN; MY <= P3M_BRILLOUIN; MY++) {
      NMY = static_cast<REAL_TYPE>(
          ((NY > p.mesh[1] / 2) ? NY - p.mesh[1] : NY) + p.mesh[1] * MY);
      S2 = S1 * int_pow<2 * cao>(math::sinc(Meshi[1] * NMY));
      for (MZ = -P3M_BRILLOUIN; MZ <= P3M_BRILLOUIN; MZ++) {
        NMZ = static_cast<REAL_TYPE>(
            ((NZ > p.mesh[2] / 2) ? NZ - p.mesh[2] : NZ) + p.mesh[2] * MZ);
        S3 = S2 * int_pow<2 * cao>(math::sinc(Meshi[2] * NMZ));
 
        NM2 = sqr(NMX * Leni[0]) + sqr(NMY * Leni[1]) + sqr(NMZ * Leni[2]);
        *Nenner += S3;
 
        TE = exp(-sqr(std::numbers::pi_v<REAL_TYPE> / (p.alpha)) * NM2);
        zwi = S3 * TE / NM2;
        Zaehler[0] += NMX * zwi * Leni[0];
        Zaehler[1] += NMY * zwi * Leni[1];
        Zaehler[2] += NMZ * zwi * Leni[2];
      }
    }
  }
}
 
/* Calculate influence function */
template <int cao>
__global__ void calculate_influence_function_device(const P3MGpuData p) {
 
  const auto NX = static_cast<int>(blockDim.x * blockIdx.x + threadIdx.x);
  const auto NY = static_cast<int>(blockDim.y * blockIdx.y + threadIdx.y);
  const auto NZ = static_cast<int>(blockDim.z * blockIdx.z + threadIdx.z);
  REAL_TYPE Dnx, Dny, Dnz;
  REAL_TYPE Zaehler[3] = {0.0, 0.0, 0.0}, Nenner = 0.0;
  REAL_TYPE zwi;
  auto index = 0;
  REAL_TYPE Leni[3];
  for (int i = 0; i < 3; ++i) {
    Leni[i] = REAL_TYPE{1} / p.box[i];
  }
 
  if ((NX >= p.mesh[0]) || (NY >= p.mesh[1]) || (NZ >= (p.mesh[2] / 2 + 1)))
    return;
 
  index = NX * p.mesh[1] * (p.mesh[2] / 2 + 1) + NY * (p.mesh[2] / 2 + 1) + NZ;
 
  if (((NX == 0) && (NY == 0) && (NZ == 0)) ||
      ((NX % (p.mesh[0] / 2) == 0) && (NY % (p.mesh[1] / 2) == 0) &&
       (NZ % (p.mesh[2] / 2) == 0))) {
    p.G_hat[index] = 0;
  } else {
    Aliasing_sums_ik<cao>(p, NX, NY, NZ, Zaehler, &Nenner);
 
    Dnx = static_cast<REAL_TYPE>((NX > p.mesh[0] / 2) ? NX - p.mesh[0] : NX);
    Dny = static_cast<REAL_TYPE>((NY > p.mesh[1] / 2) ? NY - p.mesh[1] : NY);
    Dnz = static_cast<REAL_TYPE>((NZ > p.mesh[2] / 2) ? NZ - p.mesh[2] : NZ);
 
    zwi = Dnx * Zaehler[0] * Leni[0] + Dny * Zaehler[1] * Leni[1] +
          Dnz * Zaehler[2] * Leni[2];
    zwi /= ((sqr(Dnx * Leni[0]) + sqr(Dny * Leni[1]) + sqr(Dnz * Leni[2])) *
            sqr(Nenner));
    p.G_hat[index] = REAL_TYPE{2} * zwi / std::numbers::pi_v<REAL_TYPE>;
  }
}
 
namespace {
__device__ inline auto linear_index_r(P3MGpuData const &p, int i, int j,
                                      int k) {
  return static_cast<unsigned int>(p.mesh[1] * p.mesh_z_padded * i +
                                   p.mesh_z_padded * j + k);
}
 
__device__ inline auto linear_index_k(P3MGpuData const &p, int i, int j,
                                      int k) {
  return static_cast<unsigned int>(p.mesh[1] * (p.mesh[2] / 2 + 1) * i +
                                   (p.mesh[2] / 2 + 1) * j + k);
}
} // namespace
 
__global__ void apply_diff_op(const P3MGpuData p) {
  auto const linear_index = linear_index_k(p, static_cast<int>(blockIdx.x),
                                           static_cast<int>(blockIdx.y),
                                           static_cast<int>(threadIdx.x));
 
  auto const bidx = static_cast<int>(blockIdx.x);
  auto const bidy = static_cast<int>(blockIdx.y);
  auto const nx = (bidx > p.mesh[0] / 2) ? bidx - p.mesh[0] : bidx;
  auto const ny = (bidy > p.mesh[1] / 2) ? bidy - p.mesh[1] : bidy;
  auto const nz = static_cast<int>(threadIdx.x);
 
  const FFT_TYPE_COMPLEX meshw = p.charge_mesh[linear_index];
  FFT_TYPE_COMPLEX buf;
  buf.x = REAL_TYPE(-2) * std::numbers::pi_v<REAL_TYPE> * meshw.y;
  buf.y = REAL_TYPE(+2) * std::numbers::pi_v<REAL_TYPE> * meshw.x;
 
  p.force_mesh_x[linear_index].x =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(nx) * buf.x / p.box[0];
  p.force_mesh_x[linear_index].y =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(nx) * buf.y / p.box[0];
 
  p.force_mesh_y[linear_index].x =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(ny) * buf.x / p.box[1];
  p.force_mesh_y[linear_index].y =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(ny) * buf.y / p.box[1];
 
  p.force_mesh_z[linear_index].x =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(nz) * buf.x / p.box[2];
  p.force_mesh_z[linear_index].y =
      static_cast<decltype(FFT_TYPE_COMPLEX::x)>(nz) * buf.y / p.box[2];
}
 
__device__ inline int wrap_index(const int ind, const int mesh) {
  if (ind < 0)
    return ind + mesh;
  if (ind >= mesh)
    return ind - mesh;
  return ind;
}
 
__global__ void apply_influence_function(const P3MGpuData p) {
  auto const linear_index = linear_index_k(p, static_cast<int>(blockIdx.x),
                                           static_cast<int>(blockIdx.y),
                                           static_cast<int>(threadIdx.x));
 
  p.charge_mesh[linear_index].x *= p.G_hat[linear_index];
  p.charge_mesh[linear_index].y *= p.G_hat[linear_index];
}
 
template <int cao, bool shared>
__global__ void assign_charge_kernel(P3MGpuData const params,
                                     float const *const __restrict__ part_pos,
                                     float const *const __restrict__ part_q,
                                     unsigned int const parts_per_block) {
  auto const part_in_block = threadIdx.x / static_cast<unsigned int>(cao);
  auto const cao_id_x =
      threadIdx.x - part_in_block * static_cast<unsigned int>(cao);
  /* id of the particle */
  auto const id =
      parts_per_block * (blockIdx.x * gridDim.y + blockIdx.y) + part_in_block;
  if (id >= params.n_part)
    return;
  /* position relative to the closest gird point */
  REAL_TYPE m_pos[3];
  /* index of the nearest mesh point */
  int nmp_x, nmp_y, nmp_z;
 
  auto *charge_mesh = (REAL_TYPE *)params.charge_mesh;
 
  m_pos[0] = part_pos[3 * id + 0] * params.hi[0] - params.pos_shift;
  m_pos[1] = part_pos[3 * id + 1] * params.hi[1] - params.pos_shift;
  m_pos[2] = part_pos[3 * id + 2] * params.hi[2] - params.pos_shift;
 
  nmp_x = static_cast<int>(floorf(m_pos[0] + 0.5f));
  nmp_y = static_cast<int>(floorf(m_pos[1] + 0.5f));
  nmp_z = static_cast<int>(floorf(m_pos[2] + 0.5f));
 
  m_pos[0] -= static_cast<REAL_TYPE>(nmp_x);
  m_pos[1] -= static_cast<REAL_TYPE>(nmp_y);
  m_pos[2] -= static_cast<REAL_TYPE>(nmp_z);
 
  nmp_x = wrap_index(nmp_x + static_cast<int>(cao_id_x), params.mesh[0]);
  nmp_y = wrap_index(nmp_y + static_cast<int>(threadIdx.y), params.mesh[1]);
  nmp_z = wrap_index(nmp_z + static_cast<int>(threadIdx.z), params.mesh[2]);
 
  auto const index = linear_index_r(params, nmp_x, nmp_y, nmp_z);
 
  extern __shared__ float weights[];
 
  if (shared) {
    auto const offset = static_cast<unsigned int>(cao) * part_in_block;
    if ((threadIdx.y < 3u) && (threadIdx.z == 0u)) {
      weights[3u * offset + 3u * cao_id_x + threadIdx.y] =
          Utils::bspline<cao>(static_cast<int>(cao_id_x), m_pos[threadIdx.y]);
    }
 
    __syncthreads();
 
    auto const c = weights[3u * offset + 3u * cao_id_x] *
                   weights[3u * offset + 3u * threadIdx.y + 1u] *
                   weights[3u * offset + 3u * threadIdx.z + 2u] * part_q[id];
    atomicAdd(&(charge_mesh[index]), REAL_TYPE(c));
 
  } else {
    auto const c =
        Utils::bspline<cao>(static_cast<int>(cao_id_x), m_pos[0]) * part_q[id] *
        Utils::bspline<cao>(static_cast<int>(threadIdx.y), m_pos[1]) *
        Utils::bspline<cao>(static_cast<int>(threadIdx.z), m_pos[2]);
    atomicAdd(&(charge_mesh[index]), REAL_TYPE(c));
  }
}
 
void assign_charges(P3MGpuData const &params,
                    float const *const __restrict__ part_pos,
                    float const *const __restrict__ part_q) {
  auto const cao = static_cast<unsigned int>(params.cao);
  auto const [parts_per_block, n_blocks] = p3m_calc_blocks(cao, params.n_part);
  dim3 block(parts_per_block * cao, cao, cao);
  dim3 grid = p3m_make_grid(n_blocks);
 
  auto const data_length = std::size_t(3u) *
                           static_cast<std::size_t>(parts_per_block) *
                           static_cast<std::size_t>(cao) * sizeof(REAL_TYPE);
  switch (params.cao) {
  case 1:
    (assign_charge_kernel<1, false>)<<<grid, block, std::size_t(0u), nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 2:
    (assign_charge_kernel<2, false>)<<<grid, block, std::size_t(0u), nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 3:
    (assign_charge_kernel<3, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 4:
    (assign_charge_kernel<4, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 5:
    (assign_charge_kernel<5, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 6:
    (assign_charge_kernel<6, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  case 7:
    (assign_charge_kernel<7, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, parts_per_block);
    break;
  default:
    break;
  }
  cuda_check_errors_exit(block, grid, "assign_charge", __FILE__, __LINE__);
}
 
template <int cao, bool shared>
__global__ void assign_forces_kernel(P3MGpuData const params,
                                     float const *const __restrict__ part_pos,
                                     float const *const __restrict__ part_q,
                                     float *const __restrict__ part_f,
                                     REAL_TYPE prefactor,
                                     unsigned int const parts_per_block) {
  auto const part_in_block = threadIdx.x / static_cast<unsigned int>(cao);
  auto const cao_id_x =
      threadIdx.x - part_in_block * static_cast<unsigned int>(cao);
  /* id of the particle */
  auto const id =
      parts_per_block * (blockIdx.x * gridDim.y + blockIdx.y) + part_in_block;
  if (id >= static_cast<unsigned>(params.n_part))
    return;
  /* position relative to the closest grid point */
  REAL_TYPE m_pos[3];
  /* index of the nearest mesh point */
  int nmp_x, nmp_y, nmp_z;
 
  m_pos[0] = part_pos[3u * id + 0u] * params.hi[0] - params.pos_shift;
  m_pos[1] = part_pos[3u * id + 1u] * params.hi[1] - params.pos_shift;
  m_pos[2] = part_pos[3u * id + 2u] * params.hi[2] - params.pos_shift;
 
  nmp_x = static_cast<int>(floorf(m_pos[0] + REAL_TYPE{0.5}));
  nmp_y = static_cast<int>(floorf(m_pos[1] + REAL_TYPE{0.5}));
  nmp_z = static_cast<int>(floorf(m_pos[2] + REAL_TYPE{0.5}));
 
  m_pos[0] -= static_cast<REAL_TYPE>(nmp_x);
  m_pos[1] -= static_cast<REAL_TYPE>(nmp_y);
  m_pos[2] -= static_cast<REAL_TYPE>(nmp_z);
 
  nmp_x = wrap_index(nmp_x + static_cast<int>(cao_id_x), params.mesh[0]);
  nmp_y = wrap_index(nmp_y + static_cast<int>(threadIdx.y), params.mesh[1]);
  nmp_z = wrap_index(nmp_z + static_cast<int>(threadIdx.z), params.mesh[2]);
 
  auto const index = linear_index_r(params, nmp_x, nmp_y, nmp_z);
 
  extern __shared__ float weights[];
 
  REAL_TYPE c = -prefactor * part_q[id];
  if (shared) {
    auto const offset = static_cast<unsigned int>(cao) * part_in_block;
    if ((threadIdx.y < 3u) && (threadIdx.z == 0u)) {
      weights[3u * offset + 3u * cao_id_x + threadIdx.y] =
          Utils::bspline<cao>(static_cast<int>(cao_id_x), m_pos[threadIdx.y]);
    }
 
    __syncthreads();
 
    c *= REAL_TYPE(weights[3u * offset + 3u * cao_id_x] *
                   weights[3u * offset + 3u * threadIdx.y + 1u] *
                   weights[3u * offset + 3u * threadIdx.z + 2u]);
  } else {
    c *=
        REAL_TYPE(Utils::bspline<cao>(static_cast<int>(cao_id_x), m_pos[0]) *
                  Utils::bspline<cao>(static_cast<int>(threadIdx.y), m_pos[1]) *
                  Utils::bspline<cao>(static_cast<int>(threadIdx.z), m_pos[2]));
  }
 
  const REAL_TYPE *force_mesh_x = (REAL_TYPE *)params.force_mesh_x;
  const REAL_TYPE *force_mesh_y = (REAL_TYPE *)params.force_mesh_y;
  const REAL_TYPE *force_mesh_z = (REAL_TYPE *)params.force_mesh_z;
 
  atomicAdd(&(part_f[3u * id + 0u]), float(c * force_mesh_x[index]));
  atomicAdd(&(part_f[3u * id + 1u]), float(c * force_mesh_y[index]));
  atomicAdd(&(part_f[3u * id + 2u]), float(c * force_mesh_z[index]));
}
 
void assign_forces(P3MGpuData const &params,
                   float const *const __restrict__ part_pos,
                   float const *const __restrict__ part_q,
                   float *const __restrict__ part_f,
                   REAL_TYPE const prefactor) {
  auto const cao = static_cast<unsigned int>(params.cao);
  auto const [parts_per_block, n_blocks] = p3m_calc_blocks(cao, params.n_part);
  dim3 block(parts_per_block * cao, cao, cao);
  dim3 grid = p3m_make_grid(n_blocks);
 
  /* Switch for assignment templates, the shared version only is faster for cao
   * > 2 */
  auto const data_length = std::size_t(3u) *
                           static_cast<std::size_t>(parts_per_block) *
                           static_cast<std::size_t>(cao) * sizeof(float);
  switch (params.cao) {
  case 1:
    (assign_forces_kernel<1, false>)<<<grid, block, std::size_t(0u), nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 2:
    (assign_forces_kernel<2, false>)<<<grid, block, std::size_t(0u), nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 3:
    (assign_forces_kernel<3, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 4:
    (assign_forces_kernel<4, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 5:
    (assign_forces_kernel<5, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 6:
    (assign_forces_kernel<6, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  case 7:
    (assign_forces_kernel<7, true>)<<<grid, block, data_length, nullptr>>>(
        params, part_pos, part_q, part_f, prefactor, parts_per_block);
    break;
  default:
    break;
  }
  cuda_check_errors_exit(block, grid, "assign_forces", __FILE__, __LINE__);
}
 
/**
 * @brief Initialize the internal data structure of the P3M GPU.
 * Mainly allocation on the device and influence function calculation.
 * Be advised: this needs `mesh^3*5*sizeof(REAL_TYPE)` of device memory.
 * We use real to complex FFTs, so the size of the reciprocal mesh
 * is (cuFFT convention) `Nx * Ny * ( Nz /2 + 1 )`.
 */
void p3m_gpu_init(std::shared_ptr<P3MGpuParams> &data, int cao,
                  Utils::Vector3i const &mesh, double alpha,
                  Utils::Vector3d const &box_l, std::size_t n_part) {
  if (mesh == Utils::Vector3i::broadcast(-1))
    throw std::runtime_error("P3M: invalid mesh size");
 
  if (not data) {
    data = std::make_shared<P3MGpuParams>();
  }
 
  auto &p3m_gpu_data = data->p3m_gpu_data;
  bool do_reinit = false, mesh_changed = false;
  assert(n_part <= std::numeric_limits<unsigned int>::max());
  p3m_gpu_data.n_part = static_cast<unsigned>(n_part);
 
  if (not data->is_initialized or p3m_gpu_data.alpha != alpha) {
    p3m_gpu_data.alpha = static_cast<REAL_TYPE>(alpha);
    do_reinit = true;
  }
 
  if (not data->is_initialized or p3m_gpu_data.cao != cao) {
    p3m_gpu_data.cao = cao;
    // NOLINTNEXTLINE(bugprone-integer-division)
    p3m_gpu_data.pos_shift = static_cast<REAL_TYPE>((p3m_gpu_data.cao - 1) / 2);
    do_reinit = true;
  }
 
  if (not data->is_initialized or mesh != Utils::Vector3i(p3m_gpu_data.mesh)) {
    std::copy(mesh.begin(), mesh.end(), p3m_gpu_data.mesh);
    mesh_changed = true;
    do_reinit = true;
  }
 
  if (auto constexpr eps =
          static_cast<double>(std::numeric_limits<float>::epsilon());
      not data->is_initialized or
      (box_l - Utils::Vector3d(p3m_gpu_data.box)).norm() >= eps) {
    std::copy(box_l.begin(), box_l.end(), p3m_gpu_data.box);
    do_reinit = true;
  }
 
  p3m_gpu_data.mesh_z_padded = (mesh[2] / 2 + 1) * 2;
  p3m_gpu_data.mesh_size = mesh[0] * mesh[1] * p3m_gpu_data.mesh_z_padded;
 
  for (auto i = 0u; i < 3u; ++i) {
    p3m_gpu_data.hi[i] =
        static_cast<REAL_TYPE>(p3m_gpu_data.mesh[i]) / p3m_gpu_data.box[i];
  }
 
  if (data->is_initialized and mesh_changed) {
    data->free_device_memory();
    data->is_initialized = false;
  }
 
  if (not data->is_initialized and p3m_gpu_data.mesh_size > 0) {
    /* Size of the complex mesh Nx * Ny * ( Nz / 2 + 1 ) */
    auto const cmesh_size =
        static_cast<std::size_t>(p3m_gpu_data.mesh[0]) *
        static_cast<std::size_t>(p3m_gpu_data.mesh[1]) *
        static_cast<std::size_t>(p3m_gpu_data.mesh[2] / 2 + 1);
    auto const mesh_len = cmesh_size * sizeof(FFT_TYPE_COMPLEX);
    cuda_safe_mem(cudaMalloc((void **)&(p3m_gpu_data.charge_mesh), mesh_len));
    cuda_safe_mem(cudaMalloc((void **)&(p3m_gpu_data.force_mesh_x), mesh_len));
    cuda_safe_mem(cudaMalloc((void **)&(p3m_gpu_data.force_mesh_y), mesh_len));
    cuda_safe_mem(cudaMalloc((void **)&(p3m_gpu_data.force_mesh_z), mesh_len));
    cuda_safe_mem(cudaMalloc((void **)&(p3m_gpu_data.G_hat),
                             cmesh_size * sizeof(REAL_TYPE)));
 
    if (cufftPlan3d(&(data->p3m_fft.forw_plan), mesh[0], mesh[1], mesh[2],
                    FFT_PLAN_FORW_FLAG) != CUFFT_SUCCESS or
        cufftPlan3d(&(data->p3m_fft.back_plan), mesh[0], mesh[1], mesh[2],
                    FFT_PLAN_BACK_FLAG) != CUFFT_SUCCESS) {
      throw std::runtime_error("Unable to create fft plan");
    }
  }
 
  if ((do_reinit or not data->is_initialized) and p3m_gpu_data.mesh_size > 0) {
    dim3 grid(1, 1, 1);
    dim3 block(1, 1, 1);
    block.x = static_cast<unsigned>(512 / mesh[0] + 1);
    block.y = static_cast<unsigned>(mesh[1]);
    block.z = 1;
    grid.x = static_cast<unsigned>(mesh[0]) / block.x + 1;
    grid.z = static_cast<unsigned>(mesh[2]) / 2 + 1;
 
    switch (p3m_gpu_data.cao) {
    case 1:
      KERNELCALL(calculate_influence_function_device<1>, grid, block,
                 p3m_gpu_data);
      break;
    case 2:
      KERNELCALL(calculate_influence_function_device<2>, grid, block,
                 p3m_gpu_data);
      break;
    case 3:
      KERNELCALL(calculate_influence_function_device<3>, grid, block,
                 p3m_gpu_data);
      break;
    case 4:
      KERNELCALL(calculate_influence_function_device<4>, grid, block,
                 p3m_gpu_data);
      break;
    case 5:
      KERNELCALL(calculate_influence_function_device<5>, grid, block,
                 p3m_gpu_data);
      break;
    case 6:
      KERNELCALL(calculate_influence_function_device<6>, grid, block,
                 p3m_gpu_data);
      break;
    case 7:
      KERNELCALL(calculate_influence_function_device<7>, grid, block,
                 p3m_gpu_data);
      break;
    }
  }
  if (p3m_gpu_data.mesh_size > 0)
    data->is_initialized = true;
}
 
/**
 *  \brief The long-range part of the P3M algorithm.
 */
void p3m_gpu_add_farfield_force(P3MGpuParams &data, GpuParticleData &gpu,
                                double prefactor, std::size_t n_part) {
  auto &p3m_gpu_data = data.p3m_gpu_data;
  p3m_gpu_data.n_part = static_cast<unsigned>(n_part);
 
  if (n_part == 0u)
    return;
 
  auto const positions_device = gpu.get_particle_positions_device();
  auto const charges_device = gpu.get_particle_charges_device();
  auto const forces_device = gpu.get_particle_forces_device();
 
  dim3 gridConv(static_cast<unsigned>(p3m_gpu_data.mesh[0]),
                static_cast<unsigned>(p3m_gpu_data.mesh[1]), 1u);
  dim3 threadsConv(static_cast<unsigned>(p3m_gpu_data.mesh[2] / 2 + 1), 1u, 1u);
 
  auto const volume =
      Utils::product(Utils::Vector3<REAL_TYPE>(p3m_gpu_data.box));
  auto const pref = static_cast<REAL_TYPE>(prefactor) / (volume * REAL_TYPE{2});
 
  cuda_safe_mem(cudaMemset(p3m_gpu_data.charge_mesh, 0,
                           static_cast<std::size_t>(p3m_gpu_data.mesh_size) *
                               sizeof(REAL_TYPE)));
 
  /* Interpolate the charges to the mesh */
  assign_charges(p3m_gpu_data, positions_device, charges_device);
 
  /* Do forward FFT of the charge mesh */
  if (FFT_FORW_FFT(data.p3m_fft.forw_plan,
                   (REAL_TYPE *)p3m_gpu_data.charge_mesh,
                   p3m_gpu_data.charge_mesh) != CUFFT_SUCCESS) {
    throw std::runtime_error("CUFFT error: Forward FFT failed");
  }
 
  /* Do convolution */
  KERNELCALL(apply_influence_function, gridConv, threadsConv, p3m_gpu_data);
 
  /* Take derivative */
  KERNELCALL(apply_diff_op, gridConv, threadsConv, p3m_gpu_data);
 
  /* Transform the components of the electric field back */
  FFT_BACK_FFT(data.p3m_fft.back_plan, p3m_gpu_data.force_mesh_x,
               (REAL_TYPE *)p3m_gpu_data.force_mesh_x);
  FFT_BACK_FFT(data.p3m_fft.back_plan, p3m_gpu_data.force_mesh_y,
               (REAL_TYPE *)p3m_gpu_data.force_mesh_y);
  FFT_BACK_FFT(data.p3m_fft.back_plan, p3m_gpu_data.force_mesh_z,
               (REAL_TYPE *)p3m_gpu_data.force_mesh_z);
 
  /* Assign the forces from the mesh back to the particles */
  assign_forces(p3m_gpu_data, positions_device, charges_device, forces_device,
                pref);
}
 
#endif // ELECTROSTATICS