src/gromacs/correlationfunctions/manyautocorrelation.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, 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 /*! \libinternal
  36  * \file
  37  * \brief
  38  * Declares routine for computing many correlation functions using OpenMP
  39  *
  40  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  41  * \inlibraryapi
  42  * \ingroup module_correlationfunctions
  43  */
  44 #ifndef GMX_MANYAUTOCORRELATION_H
  45 #define GMX_MANYAUTOCORRELATION_H
  46
  47 #include "gromacs/fft/fft.h"
  48 #include "gromacs/utility/real.h"
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /*! \brief
  55  * Perform many autocorrelation calculations.
  56  *
  57  * This routine performs many autocorrelation function calculations using FFTs.
  58  * The GROMACS FFT library wrapper is employed. On return the c[] arrays contain
  59  * a symmetric function that is useful for further FFT:ing, for instance in order to
  60  * compute spectra.
  61  *
  62  * The functions uses OpenMP parallellization.
  63  *
  64  * \param[in] nfunc   Number of data functions to autocorrelate
  65  * \param[in] ndata   Number of valid data points in the data
  66  * \param[in] nfft    Length of the data arrays, this should at least be 50% larger than ndata. The c arrays will filled with zero beyond ndata before computing the correlation.
  67  * \param[inout] c    Data array of size nfunc x nfft, will also be used for output
  68  * \return fft error code, or zero if everything went fine (see fft/fft.h)
  69  */
  70 int many_auto_correl(int nfunc, int ndata, int nfft, real **c);
  71
  72 #ifdef __cplusplus
  73 }
  74 #endif
  75
  76 #endif