src/gromacs/correlationfunctions/polynomials.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 /*! \internal \file
  38  * \brief
  39  * Implements help function to compute Legendre polynomials
  40  *
  41  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  42  * \author Anders G&auml;rden&auml;s <anders.gardenas@gmail.com>
  43  * \ingroup module_correlationfunctions
  44  */
  45 #include "gmxpre.h"
  46
  47 #include "polynomials.h"
  48
  49 #include "gromacs/utility/fatalerror.h"
  50
  51 real LegendreP(real x, unsigned int m)
  52
  53 {
  54     real polynomial = 0, x2, x3;
  55
  56     switch (m)
  57     {
  58         case 0:
  59             polynomial = 1.0;
  60             break;
  61         case 1:
  62             polynomial = x;
  63             break;
  64         case 2:
  65             x2         = x*x;
  66             polynomial = 1.5*x2 - 0.5;
  67             break;
  68         case 3:
  69             x2         = x*x;
  70             polynomial = (5*x2*x - 3*x )* 0.5;
  71             break;
  72         case 4:
  73             x2         = x*x;
  74             polynomial = (35*x2*x2 - 30*x2 + 3)/8;
  75             break;
  76         case 5:
  77             x2         = x*x;
  78             x3         = x2*x;
  79             polynomial = (63*x3*x2 - 70*x3 + 15*x)/8;
  80             break;
  81         default:
  82             gmx_fatal(FARGS, "Legendre polynomials of order %u are not supported", m);
  83     }
  84     return (polynomial);
  85 }