include/gbutil.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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 #include "visibility.h"
  39 #include "typedefs.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 GMX_LIBGMX_EXPORT
  46 void rotate_conf(int natom, rvec *x, rvec *v, real alfa, real beta, real gamma);
  47 /*rotate() rotates a configuration alfa degrees around the x_axis and beta degrees around the y_axis, *v can be NULL */
  48
  49 void orient(int natom, rvec *x, rvec *v, rvec angle, matrix box);
  50 /*orient() rotates a configuration until the largest atom-atom distance is
  51  * placed along the z-axis and the second largest distance is placed along
  52  * the y-axis. Finally the third longest distance is placed along the x-axis
  53  */
  54
  55 GMX_LIBGMX_EXPORT
  56 void genconf(t_atoms *atoms, rvec *x, rvec *v, real *r, matrix box, ivec n_box);
  57 /*genconf() generates a new configuration by adding boxes*/
  58 GMX_LIBGMX_EXPORT
  59 void gen_box(int NTB, int natoms, rvec *x, matrix box, rvec box_space,
  60              gmx_bool bCenter);
  61 /* gen_box() generates a box around a configuration, box_space is optional
  62  * extra space around it. If NTB = 1 then a truncated octahedon will be
  63  * generated (don't!) if bCenter then coordinates will be centered in the
  64  * genereated box
  65  */
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif