src/gromacs/correlationfunctions/gmx_lmcurve.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,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 /*! \libinternal
  36  * \file
  37  * \brief
  38  * Declares a driver routine for lmfit.
  39  *
  40  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  41  * \ingroup module_correlationfunctions
  42  */
  43 #ifndef GMX_CORRELATION_FUNCTIONS_GMX_LMCURVE_H
  44 #define GMX_CORRELATION_FUNCTIONS_GMX_LMCURVE_H
  45 #include "gromacs/correlationfunctions/expfit.h"
  46 /*! \brief function type for passing to fitting routine */
  47 typedef double (*t_lmcurve)(double x, const double* a);
  48 /*! \brief lmfit_exp supports fitting of different functions
  49  *
  50  * This routine calls the Levenberg-Marquardt non-linear fitting
  51  * routine for fitting a data set with errors to a target function.
  52  * Fitting routines included in gromacs in src/external/lmfit.
  53  */
  54 bool lmfit_exp(int          nfit,
  55                const double x[],
  56                const double y[],
  57                const double dy[],
  58                double       parm[],
  59                bool         bVerbose,
  60                int          eFitFn,
  61                int          nfix);
  62
  63 extern t_lmcurve lmcurves[effnNR + 1];
  64
  65 #endif