src/gromacs/gmxpreprocess/gen_maxwell_velocities.h

   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, 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
  38 #ifndef GMX_MAXWELL_VELOCITIES
  39 #define GMX_MAXWELL_VELOCITIES
  40
  41 #include "gromacs/legacyheaders/typedefs.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /*! \brief
  48  * Generate Maxwellian velocities.
  49  *
  50  * \param[in] tempi Temperature to generate around
  51  * \param[in] seed  Random number generator seed
  52  * \param[in] mtop  Molecular Topology
  53  * \param[out] v    Velocities
  54  */
  55 void maxwell_speed(real tempi, unsigned int seed,
  56                    gmx_mtop_t *mtop, rvec v[]);
  57
  58 /*! \brief
  59  * Remove the center of mass motion in a set of coordinates.
  60  *
  61  * \param[out] log  File for printing debug information
  62  * \param[in]  natoms Number of atoms
  63  * \param[in]  mass   Atomic masses
  64  * \param[in]  x      Coordinates
  65  * \param[out] v      Velocities
  66  */
  67 void stop_cm(FILE *log, int natoms, real mass[], rvec x[], rvec v[]);
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72
  73 #endif