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