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,2018,2019, 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 "gromacs/utility/basedefinitions.h"
  40 #include "gromacs/utility/real.h"
  41
  42 struct gmx_pme_t;
  43
  44 /*! \brief
  45  * We allow coordinates to be out the unit-cell by up to 2 box lengths,
  46  * which might be needed along dimension x for a very skewed unit-cell.
  47  */
  48 constexpr int c_pmeMaxUnitcellShift = 2;
  49
  50 /*! \brief
  51  * This affects the size of the lookup table of the modulo operation result,
  52  * when working with PME local grid indices of the particles.
  53  */
  54 constexpr int c_pmeNeighborUnitcellCount = 2 * c_pmeMaxUnitcellShift + 1;
  55
  56 struct pmegrid_t;
  57 struct pmegrids_t;
  58
  59 void gmx_sum_qgrid_dd(gmx_pme_t* pme, real* grid, int direction);
  60
  61 int copy_pmegrid_to_fftgrid(const gmx_pme_t* pme, const real* pmegrid, real* fftgrid, int grid_index);
  62
  63 int copy_fftgrid_to_pmegrid(gmx_pme_t* pme, const real* fftgrid, real* pmegrid, int grid_index, int nthread, int thread);
  64
  65 void wrap_periodic_pmegrid(const gmx_pme_t* pme, real* pmegrid);
  66
  67 void unwrap_periodic_pmegrid(gmx_pme_t* pme, real* pmegrid);
  68
  69 void pmegrid_init(pmegrid_t* grid,
  70                   int        cx,
  71                   int        cy,
  72                   int        cz,
  73                   int        x0,
  74                   int        y0,
  75                   int        z0,
  76                   int        x1,
  77                   int        y1,
  78                   int        z1,
  79                   gmx_bool   set_alignment,
  80                   int        pme_order,
  81                   real*      ptr);
  82
  83 void pmegrids_init(pmegrids_t* grids,
  84                    int         nx,
  85                    int         ny,
  86                    int         nz,
  87                    int         nz_base,
  88                    int         pme_order,
  89                    gmx_bool    bUseThreads,
  90                    int         nthread,
  91                    int         overlap_x,
  92                    int         overlap_y);
  93
  94 void pmegrids_destroy(pmegrids_t* grids);
  95
  96 void make_gridindex_to_localindex(int n, int local_start, int local_range, int** global_to_local, real** fraction_shift);
  97
  98 void set_grid_alignment(int* pmegrid_nz, int pme_order);
  99
 100 void reuse_pmegrids(const pmegrids_t* oldgrid, pmegrids_t* newgrid);
 101
 102 #endif