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