src/gromacs/legacyheaders/index.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) 2010,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
  38 #ifndef _index_h
  39 #define _index_h
  40
  41 #include <stdio.h>
  42
  43 #include "types/simple.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 struct t_atoms;
  50 struct t_blocka;
  51
  52 void check_index(char *gname, int n, atom_id index[],
  53                  char *traj, int natoms);
  54 /* Checks if any index is smaller than zero or larger than natoms,
  55  * if so a fatal_error is given with the gname (if gname=NULL, "Index" is used)
  56  * and traj (if traj=NULL, "the trajectory" is used).
  57  */
  58
  59 struct t_blocka *init_index(const char *gfile, char ***grpname);
  60 /* Lower level routine than the next */
  61
  62 void rd_index(const char *statfile, int ngrps, int isize[],
  63               atom_id *index[], char *grpnames[]);
  64 /* Assume the group file is generated, so the
  65  * format need not be user-friendly. The format is:
  66  * nr of groups, total nr of atoms
  67  * for each group: name nr of element, elements.
  68  *
  69  * The function opens a file, reads ngrps groups, asks the
  70  * user for group numbers, and puts the resulting sizes in
  71  * isize, the atom_id s in index and the names of
  72  * the groups in grpnames.
  73  *
  74  * It is also assumed, that when ngrps groups are requested
  75  * memory has been allocated for ngrps index arrays, and that
  76  * the dimension of the isize and grpnames arrays are ngrps.
  77  */
  78
  79 void rd_index_nrs(char *statfile, int ngrps, int isize[],
  80                   atom_id *index[], char *grpnames[], int grpnr[]);
  81 /* the same but also reads the number of the selected group*/
  82
  83 void get_index(struct t_atoms *atoms, const char *fnm, int ngrps,
  84                int isize[], atom_id *index[], char *grpnames[]);
  85 /* Does the same as rd_index, but if the fnm pointer is NULL it
  86  * will not read from fnm, but it will make default index groups
  87  * for the atoms in *atoms.
  88  */
  89
  90 typedef struct {
  91     int               maxframe;
  92     char            **grpname;
  93     struct t_blocka  *clust;
  94     atom_id          *inv_clust;
  95 } t_cluster_ndx;
  96
  97 t_cluster_ndx *cluster_index(FILE *fplog, const char *ndx);
  98
  99 typedef struct {
 100     int    n;
 101     char **name;
 102 } t_names;
 103
 104 typedef struct gmx_residuetype *
 105     gmx_residuetype_t;
 106
 107 int
 108 gmx_residuetype_init(gmx_residuetype_t *rt);
 109
 110 int
 111 gmx_residuetype_destroy(gmx_residuetype_t rt);
 112
 113 int
 114 gmx_residuetype_get_type(gmx_residuetype_t rt, const char * resname, const char ** p_restype);
 115
 116 int
 117 gmx_residuetype_add(gmx_residuetype_t rt, const char *newresname, const char *newrestype);
 118
 119 int
 120 gmx_residuetype_get_alltypes(gmx_residuetype_t    rt,
 121                              const char ***       p_typenames,
 122                              int *                ntypes);
 123
 124 gmx_bool
 125 gmx_residuetype_is_protein(gmx_residuetype_t rt, const char *resnm);
 126
 127 gmx_bool
 128 gmx_residuetype_is_dna(gmx_residuetype_t rt, const char *resnm);
 129
 130 gmx_bool
 131 gmx_residuetype_is_rna(gmx_residuetype_t rt, const char *resnm);
 132
 133 int
 134 gmx_residuetype_get_size(gmx_residuetype_t rt);
 135
 136 int
 137 gmx_residuetype_get_index(gmx_residuetype_t rt, const char *resnm);
 138
 139 const char *
 140 gmx_residuetype_get_name(gmx_residuetype_t rt, int index);
 141
 142
 143
 144
 145
 146
 147 void write_index(const char *outf, struct t_blocka *b, char **gnames, gmx_bool bDuplicate, int natoms);
 148 /* Writes index blocks to outf (writes an indexfile) */
 149
 150 void add_grp(struct t_blocka *b, char ***gnames, int nra, atom_id a[], const char *name);
 151 /* Ads group a with name name to block b and namelist gnames */
 152
 153 void analyse(struct t_atoms *atoms, struct t_blocka *gb, char ***gn,
 154              gmx_bool bASK, gmx_bool bVerb);
 155 /* Makes index groups gb with names gn for atoms in atoms.
 156  * bASK=FALSE gives default groups.
 157  */
 158
 159 int find_group(char s[], int ngrps, char **grpname);
 160
 161
 162 #ifdef __cplusplus
 163 }
 164 #endif
 165
 166 #endif  /* _index_h */