include/index.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _index_h
  37 #define _index_h
  38
  39 #include "visibility.h"
  40 #include "typedefs.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 GMX_LIBGMX_EXPORT
  47 void check_index(char *gname,int n,atom_id index[],
  48                         char *traj,int natoms);
  49 /* Checks if any index is smaller than zero or larger than natoms,
  50  * if so a fatal_error is given with the gname (if gname=NULL, "Index" is used)
  51  * and traj (if traj=NULL, "the trajectory" is used).
  52  */
  53
  54 GMX_LIBGMX_EXPORT
  55 t_blocka *init_index(const char *gfile, char ***grpname);
  56 /* Lower level routine than the next */
  57
  58 GMX_LIBGMX_EXPORT
  59 void rd_index(const char *statfile,int ngrps,int isize[],
  60               atom_id *index[],char *grpnames[]);
  61 /* Assume the group file is generated, so the
  62  * format need not be user-friendly. The format is:
  63  * nr of groups, total nr of atoms
  64  * for each group: name nr of element, elements.
  65  *
  66  * The function opens a file, reads ngrps groups, asks the
  67  * user for group numbers, and puts the resulting sizes in
  68  * isize, the atom_id s in index and the names of
  69  * the groups in grpnames.
  70  *
  71  * It is also assumed, that when ngrps groups are requested
  72  * memory has been allocated for ngrps index arrays, and that
  73  * the dimension of the isize and grpnames arrays are ngrps.
  74  */
  75
  76 void rd_index_nrs(char *statfile,int ngrps,int isize[],
  77                   atom_id *index[],char *grpnames[],int grpnr[]);
  78 /* the same but also reads the number of the selected group*/
  79
  80 GMX_LIBGMX_EXPORT
  81 void get_index(t_atoms *atoms, const char *fnm, int ngrps,
  82                int isize[], atom_id *index[],char *grpnames[]);
  83 /* Does the same as rd_index, but if the fnm pointer is NULL it
  84  * will not read from fnm, but it will make default index groups
  85  * for the atoms in *atoms.
  86  */
  87
  88 typedef struct {
  89   int      maxframe;
  90   char     **grpname;
  91   t_blocka *clust;
  92   atom_id  *inv_clust;
  93 } t_cluster_ndx;
  94
  95 GMX_LIBGMX_EXPORT
  96 t_cluster_ndx *cluster_index(FILE *fplog,const char *ndx);
  97
  98 typedef struct {
  99   int n;
 100   char **name;
 101 } t_names;
 102
 103 typedef struct gmx_residuetype *
 104 gmx_residuetype_t;
 105
 106 GMX_LIBGMX_EXPORT
 107 int
 108 gmx_residuetype_init(gmx_residuetype_t *rt);
 109
 110 GMX_LIBGMX_EXPORT
 111 int
 112 gmx_residuetype_destroy(gmx_residuetype_t rt);
 113
 114 GMX_LIBGMX_EXPORT
 115 int
 116 gmx_residuetype_get_type(gmx_residuetype_t rt,const char * resname, const char ** p_restype);
 117
 118 GMX_LIBGMX_EXPORT
 119 int
 120 gmx_residuetype_add(gmx_residuetype_t rt,const char *newresname, const char *newrestype);
 121
 122 int
 123 gmx_residuetype_get_alltypes(gmx_residuetype_t    rt,
 124                              const char ***       p_typenames,
 125                              int *                ntypes);
 126
 127 GMX_LIBGMX_EXPORT
 128 gmx_bool
 129 gmx_residuetype_is_protein(gmx_residuetype_t rt, const char *resnm);
 130
 131 GMX_LIBGMX_EXPORT
 132 gmx_bool
 133 gmx_residuetype_is_dna(gmx_residuetype_t rt, const char *resnm);
 134
 135 GMX_LIBGMX_EXPORT
 136 gmx_bool
 137 gmx_residuetype_is_rna(gmx_residuetype_t rt, const char *resnm);
 138
 139 GMX_LIBGMX_EXPORT
 140 int
 141 gmx_residuetype_get_size(gmx_residuetype_t rt);
 142
 143 GMX_LIBGMX_EXPORT
 144 int
 145 gmx_residuetype_get_index(gmx_residuetype_t rt, const char *resnm);
 146
 147 GMX_LIBGMX_EXPORT
 148 const char *
 149 gmx_residuetype_get_name(gmx_residuetype_t rt, int index);
 150
 151
 152
 153
 154
 155
 156 GMX_LIBGMX_EXPORT
 157 t_blocka *new_blocka(void);
 158 /* allocate new block */
 159
 160 GMX_LIBGMX_EXPORT
 161 void write_index(const char *outf, t_blocka *b,char **gnames);
 162 /* Writes index blocks to outf (writes an indexfile) */
 163
 164 GMX_LIBGMX_EXPORT
 165 void add_grp(t_blocka *b,char ***gnames,int nra,atom_id a[],const char *name);
 166 /* Ads group a with name name to block b and namelist gnames */
 167
 168 GMX_LIBGMX_EXPORT
 169 void analyse(t_atoms *atoms,t_blocka *gb,char ***gn,
 170                     gmx_bool bASK,gmx_bool bVerb);
 171 /* Makes index groups gb with names gn for atoms in atoms.
 172  * bASK=FALSE gives default groups.
 173  */
 174
 175 GMX_LIBGMX_EXPORT
 176 int find_group(char s[], int ngrps, char **grpname);
 177
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif  /* _index_h */