src/gromacs/fft/parallel_3dfft.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2005 David van der Spoel, Erik Lindahl, University of Groningen.
   5  * Copyright (c) 2013,2014, 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
  37 #ifndef GMX_FFT_PARALLEL_3DFFT_H
  38 #define GMX_FFT_PARALLEL_3DFFT_H
  39
  40 #include "../math/gmxcomplex.h"
  41 #include "../timing/wallcycle.h"
  42 #include "../utility/basedefinitions.h"
  43 #include "../utility/gmxmpi.h"
  44 #include "../utility/real.h"
  45
  46 #include "fft.h"
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 typedef struct gmx_parallel_3dfft *
  53     gmx_parallel_3dfft_t;
  54
  55
  56
  57 /*! \brief Initialize parallel MPI-based 3D-FFT.
  58  *
  59  *  This routine performs real-to-complex and complex-to-real parallel 3D FFTs,
  60  *  but not complex-to-complex.
  61  *
  62  *  The routine is optimized for small-to-medium size FFTs used for PME and
  63  *  PPPM algorithms, and do allocate extra workspace whenever it might improve
  64  *  performance.
  65  *
  66  *  \param pfft_setup     Pointer to parallel 3dfft setup structure, previously
  67  *                        allocated or with automatic storage.
  68  *  \param ndata          Number of grid cells in each direction
  69  *  \param real_data      Real data. Input for forward and output for backward.
  70  *  \param complex_data   Complex data.
  71  *  \param comm           MPI communicator for both parallelization axis.
  72  *                        Needs to be either initialized or MPI_NULL for
  73  *                        no parallelization in that axis.
  74  *  \param bReproducible  Try to avoid FFT timing optimizations and other stuff
  75  *                        that could make results differ for two runs with
  76  *                        identical input (reproducibility for debugging).
  77  *  \param nthreads       Run in parallel using n threads
  78  *
  79  *  \return 0 or a standard error code.
  80  */
  81 int
  82     gmx_parallel_3dfft_init   (gmx_parallel_3dfft_t *    pfft_setup,
  83                                ivec                      ndata,
  84                                real **real_data,
  85                                t_complex **complex_data,
  86                                MPI_Comm                  comm[2],
  87                                gmx_bool                  bReproducible,
  88                                int                       nthreads);
  89
  90
  91
  92
  93
  94 /*! \brief Get direct space grid index limits
  95  */
  96 int
  97 gmx_parallel_3dfft_real_limits(gmx_parallel_3dfft_t      pfft_setup,
  98                                ivec                      local_ndata,
  99                                ivec                      local_offset,
 100                                ivec                      local_size);
 101
 102
 103 /*! \brief Get reciprocal space grid index limits
 104  */
 105 int
 106 gmx_parallel_3dfft_complex_limits(gmx_parallel_3dfft_t      pfft_setup,
 107                                   ivec                      complex_order,
 108                                   ivec                      local_ndata,
 109                                   ivec                      local_offset,
 110                                   ivec                      local_size);
 111
 112
 113 int
 114 gmx_parallel_3dfft_execute(gmx_parallel_3dfft_t    pfft_setup,
 115                            enum gmx_fft_direction  dir,
 116                            int                     thread,
 117                            gmx_wallcycle_t         wcycle);
 118
 119
 120 /*! \brief Release all data in parallel fft setup
 121  *
 122  *  All temporary storage and FFT plans are released. The structure itself
 123  *  is not released, but the contents is invalid after this call.
 124  *
 125  *  \param pfft_setup Parallel 3dfft setup.
 126  *
 127  *  \return 0 or a standard error code.
 128  */
 129 int
 130 gmx_parallel_3dfft_destroy(gmx_parallel_3dfft_t    pfft_setup);
 131
 132 #ifdef __cplusplus
 133 }
 134 #endif
 135
 136 #endif