include/atomprop.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 _atomprop_h
  37 #define _atomprop_h
  38 #include "visibility.h"
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 #include "index.h"
  44
  45 /* Abstract type for the atom property database */
  46 typedef struct gmx_atomprop *gmx_atomprop_t;
  47
  48 enum { epropMass, epropVDW, epropDGsol, epropElectroneg, epropElement,
  49        epropNR };
  50
  51 GMX_LIBGMX_EXPORT
  52 gmx_atomprop_t gmx_atomprop_init(void);
  53 /* Initializes and returns the atom properties struct */
  54
  55 GMX_LIBGMX_EXPORT
  56 void gmx_atomprop_destroy(gmx_atomprop_t aps);
  57 /* Get rid of memory after use */
  58
  59 char *gmx_atomprop_element(gmx_atomprop_t aps,int atomnumber);
  60
  61 int gmx_atomprop_atomnumber(gmx_atomprop_t aps,const char *element);
  62
  63 GMX_LIBGMX_EXPORT
  64 gmx_bool gmx_atomprop_query(gmx_atomprop_t aps,
  65                         int eprop,const char *resnm,const char *atomnm,
  66                         real *value);
  67 /* Extract a value from the database. Returns TRUE on succes,
  68  * FALSE otherwise. In the latter case, value is a deafult value.
  69  * The first time this function is called for this property
  70  * the database will be read.
  71  */
  72
  73 #ifdef __cplusplus
  74 }
  75 #endif
  76
  77
  78 #endif