src/gromacs/ewald/pme-grid.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2016,2017, 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 /* TODO find out what this file should be called */
  36 #ifndef GMX_EWALD_PME_GRID_H
  37 #define GMX_EWALD_PME_GRID_H
  38
  39 #include "config.h"
  40
  41 #include "gromacs/utility/basedefinitions.h"
  42 #include "gromacs/utility/real.h"
  43
  44 struct gmx_pme_t;
  45
  46 /*! \brief
  47  * We allow coordinates to be out the unit-cell by up to 2 box lengths,
  48  * which might be needed along dimension x for a very skewed unit-cell.
  49  */
  50 constexpr int c_pmeMaxUnitcellShift = 2;
  51
  52 /*! \brief
  53  * This affects the size of the lookup table of the modulo operation result,
  54  * when working with PME local grid indices of the particles.
  55  */
  56 constexpr int c_pmeNeighborUnitcellCount = 2*c_pmeMaxUnitcellShift + 1;
  57
  58 struct pmegrid_t;
  59 struct pmegrids_t;
  60
  61 #if GMX_MPI
  62 void
  63 gmx_sum_qgrid_dd(gmx_pme_t *pme, real *grid, int direction);
  64 #endif
  65
  66 int
  67 copy_pmegrid_to_fftgrid(const gmx_pme_t *pme, real *pmegrid, real *fftgrid, int grid_index);
  68
  69 int
  70 copy_fftgrid_to_pmegrid(gmx_pme_t *pme, const real *fftgrid, real *pmegrid, int grid_index,
  71                         int nthread, int thread);
  72
  73 void
  74 wrap_periodic_pmegrid(const gmx_pme_t *pme, real *pmegrid);
  75
  76 void
  77 unwrap_periodic_pmegrid(gmx_pme_t *pme, real *pmegrid);
  78
  79 void
  80 pmegrid_init(pmegrid_t *grid,
  81              int cx, int cy, int cz,
  82              int x0, int y0, int z0,
  83              int x1, int y1, int z1,
  84              gmx_bool set_alignment,
  85              int pme_order,
  86              real *ptr);
  87
  88 void
  89 pmegrids_init(pmegrids_t *grids,
  90               int nx, int ny, int nz, int nz_base,
  91               int pme_order,
  92               gmx_bool bUseThreads,
  93               int nthread,
  94               int overlap_x,
  95               int overlap_y);
  96
  97 void
  98 pmegrids_destroy(pmegrids_t *grids);
  99
 100 void
 101 make_gridindex_to_localindex(int n, int local_start, int local_range,
 102                              int **global_to_local,
 103                              real **fraction_shift);
 104
 105 void
 106 set_grid_alignment(int *pmegrid_nz, int pme_order);
 107
 108 void
 109 reuse_pmegrids(const pmegrids_t *oldgrid, pmegrids_t *newgrid);
 110
 111 /* This function is called from gmx_pme_do() only from debugging code
 112    that is commented out. */
 113 void
 114 dump_local_fftgrid(gmx_pme_t *pme, const real *fftgrid);
 115
 116 #endif