56b323106363db5c3d28b44f05e82432ad7cb6bf
[alexxy/gromacs.git] / src / gromacs / mdtypes / mdatom.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) 2012,2013,2014,2015,2016,2017,2019, 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 /*! \brief
38  * Declares mdatom data structure.
39  *
40  * \inpublicapi
41  * \ingroup module_mdtypes
42  */
43 #ifndef GMX_MDTYPES_MDATOM_H
44 #define GMX_MDTYPES_MDATOM_H
45
46 #include "gromacs/math/vectypes.h"
47 #include "gromacs/utility/basedefinitions.h"
48 #include "gromacs/utility/real.h"
49
50 typedef struct t_mdatoms
51 {
52     //! Total mass in state A
53     real tmassA;
54     //! Total mass in state B
55     real tmassB;
56     //! Total mass
57     real tmass;
58     //! Number of atoms in arrays
59     int nr;
60     //! Number of elements in arrays
61     int nalloc;
62     //! Number of energy groups
63     int nenergrp;
64     //! Do we have multiple center of mass motion removal groups
65     gmx_bool bVCMgrps;
66     //! Do we have any virtual sites?
67     gmx_bool haveVsites;
68     //! Do we have atoms that are frozen along 1 or 2 (not 3) dimensions?
69     gmx_bool havePartiallyFrozenAtoms;
70     //! Number of perturbed atoms
71     int nPerturbed;
72     //! Number of atoms for which the mass is perturbed
73     int nMassPerturbed;
74     //! Number of atoms for which the charge is perturbed
75     int nChargePerturbed;
76     //! Number of atoms for which the type is perturbed
77     int nTypePerturbed;
78     //! Do we have orientation restraints
79     gmx_bool bOrires;
80     //! Atomic mass in A state
81     real* massA;
82     //! Atomic mass in B state
83     real* massB;
84     //! Atomic mass in present state
85     real* massT;
86     //! Inverse atomic mass per atom, 0 for vsites and shells
87     real* invmass;
88     //! Inverse atomic mass per atom and dimension, 0 for vsites, shells and frozen dimensions
89     rvec* invMassPerDim;
90     //! Atomic charge in A state
91     real* chargeA;
92     //! Atomic charge in B state
93     real* chargeB;
94     //! Dispersion constant C6 in A state
95     real* sqrt_c6A;
96     //! Dispersion constant C6 in A state
97     real* sqrt_c6B;
98     //! Van der Waals radius sigma in the A state
99     real* sigmaA;
100     //! Van der Waals radius sigma in the B state
101     real* sigmaB;
102     //! Van der Waals radius sigma^3 in the A state
103     real* sigma3A;
104     //! Van der Waals radius sigma^3 in the B state
105     real* sigma3B;
106     //! Is this atom perturbed
107     gmx_bool* bPerturbed;
108     //! Type of atom in the A state
109     int* typeA;
110     //! Type of atom in the B state
111     int* typeB;
112     //! Particle type
113     unsigned short* ptype;
114     //! Group index for temperature coupling
115     unsigned short* cTC;
116     //! Group index for energy matrix
117     unsigned short* cENER;
118     //! Group index for acceleration
119     unsigned short* cACC;
120     //! Group index for freezing
121     unsigned short* cFREEZE;
122     //! Group index for center of mass motion removal
123     unsigned short* cVCM;
124     //! Group index for user 1
125     unsigned short* cU1;
126     //! Group index for user 2
127     unsigned short* cU2;
128     //! Group index for orientation restraints
129     unsigned short* cORF;
130     //! QMMM atoms
131     gmx_bool* bQM;
132     //! Number of atoms on this processor. TODO is this still used?
133     int homenr;
134     //! The lambda value used to create the contents of the struct
135     real lambda;
136 } t_mdatoms;
137
138 #endif