src/gromacs/topology/topology.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) 2011,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 #ifndef GMX_TOPOLOGY_TOPOLOGY_H
  38 #define GMX_TOPOLOGY_TOPOLOGY_H
  39
  40 #include "gromacs/math/vectypes.h"
  41 #include "gromacs/topology/atoms.h"
  42 #include "gromacs/topology/block.h"
  43 #include "gromacs/topology/idef.h"
  44 #include "gromacs/topology/symtab.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 enum {
  51     egcTC,    egcENER,   egcACC, egcFREEZE,
  52     egcUser1, egcUser2,  egcVCM, egcCompressedX,
  53     egcORFIT, egcQMMM,
  54     egcNR
  55 };
  56
  57 typedef struct gmx_moltype_t
  58 {
  59     char          **name;       /* Name of the molecule type            */
  60     t_atoms         atoms;      /* The atoms                            */
  61     t_ilist         ilist[F_NRE];
  62     t_block         cgs;        /* The charge groups                    */
  63     t_blocka        excls;      /* The exclusions                       */
  64 } gmx_moltype_t;
  65
  66 typedef struct gmx_molblock_t
  67 {
  68     int            type;        /* The molcule type index in mtop.moltype */
  69     int            nmol;        /* The number of molecules in this block  */
  70     int            natoms_mol;  /* The number of atoms in one molecule    */
  71     int            nposres_xA;  /* The number of posres coords for top A  */
  72     rvec          *posres_xA;   /* The posres coords for top A            */
  73     int            nposres_xB;  /* The number of posres coords for top B  */
  74     rvec          *posres_xB;   /* The posres coords for top B            */
  75 } gmx_molblock_t;
  76
  77 typedef struct gmx_groups_t
  78 {
  79     t_grps            grps[egcNR];  /* Groups of things                     */
  80     int               ngrpname;     /* Number of groupnames                 */
  81     char           ***grpname;      /* Names of the groups                  */
  82     int               ngrpnr[egcNR];
  83     unsigned char    *grpnr[egcNR]; /* Group numbers or NULL                */
  84 } gmx_groups_t;
  85
  86 /* This macro gives the group number of group type egc for atom i.
  87  * This macro is useful, since the grpnr pointers are NULL
  88  * for group types that have all entries 0.
  89  */
  90 #define ggrpnr(groups, egc, i) ((groups)->grpnr[egc] ? (groups)->grpnr[egc][i] : 0)
  91
  92 /* The global, complete system topology struct, based on molecule types.
  93    This structure should contain no data that is O(natoms) in memory. */
  94 typedef struct gmx_mtop_t
  95 {
  96     char           **name;      /* Name of the topology                 */
  97     gmx_ffparams_t   ffparams;
  98     int              nmoltype;
  99     gmx_moltype_t   *moltype;
 100     int              nmolblock;
 101     gmx_molblock_t  *molblock;
 102     int              natoms;
 103     int              maxres_renum; /* Parameter for residue numbering      */
 104     int              maxresnr;     /* The maximum residue number in moltype */
 105     t_atomtypes      atomtypes;    /* Atomtype properties                  */
 106     t_block          mols;         /* The molecules                        */
 107     gmx_groups_t     groups;
 108     t_symtab         symtab;       /* The symbol table                     */
 109 } gmx_mtop_t;
 110
 111 /* The mdrun node-local topology struct, completely written out */
 112 typedef struct gmx_localtop_t
 113 {
 114     t_idef        idef;         /* The interaction function definition  */
 115     t_atomtypes   atomtypes;    /* Atomtype properties                  */
 116     t_block       cgs;          /* The charge groups                    */
 117     t_blocka      excls;        /* The exclusions                       */
 118 } gmx_localtop_t;
 119
 120 /* The old topology struct, completely written out, used in analysis tools */
 121 typedef struct t_topology
 122 {
 123     char          **name;       /* Name of the topology                 */
 124     t_idef          idef;       /* The interaction function definition  */
 125     t_atoms         atoms;      /* The atoms                            */
 126     t_atomtypes     atomtypes;  /* Atomtype properties                  */
 127     t_block         cgs;        /* The charge groups                    */
 128     t_block         mols;       /* The molecules                        */
 129     t_blocka        excls;      /* The exclusions                       */
 130     t_symtab        symtab;     /* The symbol table                     */
 131 } t_topology;
 132
 133 void init_mtop(gmx_mtop_t *mtop);
 134 void init_top(t_topology *top);
 135 void done_moltype(gmx_moltype_t *molt);
 136 void done_molblock(gmx_molblock_t *molb);
 137 void done_mtop(gmx_mtop_t *mtop, gmx_bool bDoneSymtab);
 138 void done_top(t_topology *top);
 139
 140 t_atoms *mtop2atoms(gmx_mtop_t *mtop);
 141 /* generate a t_atoms struct for the system from gmx_mtop_t */
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147 #endif