Update copyright statements and change license to LGPL
[alexxy/gromacs.git] / include / types / group.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, 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
39
40 #include "simple.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46         
47 typedef struct {
48   real    Th;           /* Temperature at half step        */
49   real    T;            /* Temperature at full step        */
50   tensor  ekinh;        /* Kinetic energy at half step     */
51   tensor  ekinh_old;    /* Kinetic energy at old half step */
52   tensor  ekinf;        /* Kinetic energy at full step     */
53   real    lambda;       /* Berendsen coupling lambda       */
54   double  ekinscalef_nhc;/* Scaling factor for NHC- full step */
55   double  ekinscaleh_nhc;/* Scaling factor for NHC- half step */
56   double  vscale_nhc;   /* Scaling factor for NHC- velocity */
57 } t_grp_tcstat;
58
59 typedef struct {
60   int     nat;          /* Number of atoms in this group                */
61   rvec    u;            /* Mean velocities of home particles            */
62   rvec    uold;         /* Previous mean velocities of home particles   */
63   double  mA;           /* Mass for topology A                          */
64   double  mB;           /* Mass for topology B                          */
65 } t_grp_acc;
66
67 typedef struct {
68   real    cos_accel;    /* The acceleration for the cosine profile      */
69   real    mvcos;        /* The cos momenta of home particles            */
70   real    vcos;         /* The velocity of the cosine profile           */
71 } t_cos_acc;
72
73 typedef struct {
74   gmx_bool         bNEMD;
75   int          ngtc;            /* The number of T-coupling groups      */
76   t_grp_tcstat *tcstat;         /* T-coupling data                      */
77   tensor       **ekin_work_alloc; /* Allocated locations of ekin_work   */
78   tensor       **ekin_work;     /* Work arrays for tcstat per thread    */
79   int          ngacc;           /* The number of acceleration groups    */
80   t_grp_acc    *grpstat;        /* Acceleration data                    */
81   tensor       ekin;            /* overall kinetic energy               */
82   tensor       ekinh;           /* overall 1/2 step kinetic energy      */
83   real         dekindl;         /* dEkin/dlambda at half step           */
84   real         dekindl_old;     /* dEkin/dlambda at old half step       */
85   t_cos_acc    cosacc;          /* Cosine acceleration data             */
86 } gmx_ekindata_t;
87
88 #define GID(igid,jgid,gnr) ((igid < jgid) ? (igid*gnr+jgid) : (jgid*gnr+igid))
89
90 #ifdef __cplusplus
91 }
92 #endif
93