Added documentation about proper use of pdb2gmx -ter.
[gromacs/rigid-bodies.git] / include / princ.h
blobfde98024470d5ba70aecfd7ee855cedcad407bbe
1 /*
2 *
3 * This source code is part of
4 *
5 * G R O M A C S
6 *
7 * GROningen MAchine for Chemical Simulations
8 *
9 * VERSION 3.2.0
10 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
11 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
12 * Copyright (c) 2001-2004, The GROMACS development team,
13 * check out http://www.gromacs.org for more information.
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License
17 * as published by the Free Software Foundation; either version 2
18 * of the License, or (at your option) any later version.
20 * If you want to redistribute modifications, please consider that
21 * scientific software is very special. Version control is crucial -
22 * bugs must be traceable. We will be happy to consider code for
23 * inclusion in the official distribution, but derived work must not
24 * be called official GROMACS. Details are found in the README & COPYING
25 * files - if they are missing, get the official version at www.gromacs.org.
27 * To help us fund GROMACS development, we humbly ask that you cite
28 * the papers on the package - you can find them in the top README file.
30 * For more info, check our website at http://www.gromacs.org
32 * And Hey:
33 * Gromacs Runs On Most of All Computer Systems
36 #ifndef _princ_h
37 #define _princ_h
39 #include "typedefs.h"
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
45 void rotate_atoms(int gnx,atom_id index[],rvec x[],matrix trans);
46 /* Rotate all atoms in index using matrix trans */
48 void principal_comp(int n,atom_id index[],t_atom atom[],rvec x[],
49 matrix trans,rvec d);
50 /* Calculate the principal components of atoms in index. Atoms are
51 * mass weighted. It is assumed that the center of mass is in the origin!
54 void orient_princ(t_atoms *atoms, int isize, atom_id *index,
55 int natoms, rvec x[], rvec *v, rvec d);
56 /* rotates molecule to align principal axes with coordinate axes */
58 real calc_xcm(rvec x[],int gnx,atom_id *index,t_atom *atom,rvec xcm,
59 gmx_bool bQ);
60 /* Calculate the center of mass of the atoms in index. if bQ then the atoms
61 * will be charge weighted rather than mass weighted.
62 * Returns the total mass/charge.
65 real sub_xcm(rvec x[],int gnx,atom_id *index,t_atom atom[],rvec xcm,
66 gmx_bool bQ);
67 /* Calc. the center of mass and subtract it from all coordinates.
68 * Returns the original center of mass in xcm
69 * Returns the total mass
72 void add_xcm(rvec x[],int gnx,atom_id *index,rvec xcm);
73 /* Increment all atoms in index with xcm */
75 #ifdef __cplusplus
77 #endif
79 #endif