src/gromacs/gmxpreprocess/gpp_atomtype.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,2014,2015,2018,2019, 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 GMX_GMXPREPROCESS_GPP_ATOMTYPE_H
  39 #define GMX_GMXPREPROCESS_GPP_ATOMTYPE_H
  40
  41 #include <cstdio>
  42
  43 #include "gromacs/utility/arrayref.h"
  44 #include "gromacs/utility/real.h"
  45
  46 struct gmx_mtop_t;
  47 struct gpp_atomtype;
  48 struct t_atom;
  49 struct t_atomtypes;
  50 struct t_param;
  51 struct InteractionTypeParameters;
  52 struct t_symtab;
  53
  54 int get_atomtype_type(const char *str, gpp_atomtype *at);
  55 /* Return atomtype corresponding to case-insensitive str
  56    or NOTSET if not found */
  57
  58 int get_atomtype_ntypes(gpp_atomtype *at);
  59 /* Return number of atomtypes */
  60
  61 char *get_atomtype_name(int nt, gpp_atomtype *at);
  62 /* Return name corresponding to atomtype nt, or NULL if not found */
  63
  64 real get_atomtype_massA(int nt, gpp_atomtype *at);
  65 real get_atomtype_massB(int nt, gpp_atomtype *at);
  66 real get_atomtype_qA(int nt, gpp_atomtype *at);
  67 real get_atomtype_qB(int nt, gpp_atomtype *at);
  68 int get_atomtype_ptype(int nt, gpp_atomtype *at);
  69 int get_atomtype_batype(int nt, const gpp_atomtype* at);
  70 int get_atomtype_atomnumber(int nt, gpp_atomtype *at);
  71
  72 /* Return the above variable for atomtype nt, or NOTSET if not found */
  73
  74 real get_atomtype_nbparam(int nt, int param, gpp_atomtype *at);
  75 /* Similar to the previous but returns the paramth parameter or NOTSET */
  76
  77 gpp_atomtype *init_atomtype();
  78 /* Return a new atomtype structure */
  79
  80 void done_atomtype(gpp_atomtype *at);
  81 /* Free the memory in the structure */
  82
  83 int set_atomtype(int nt, gpp_atomtype *at, t_symtab *tab,
  84                  t_atom *a, const char *name, t_param *nb,
  85                  int bondatomtype, int atomnumber);
  86 /* Set the values of an existing atom type nt. Returns nt on success or
  87    NOTSET on error. */
  88
  89 int add_atomtype(gpp_atomtype *at, t_symtab *tab,
  90                  t_atom *a, const char *name, t_param *nb,
  91                  int bondatomtype, int atomnumber);
  92 /* Add a complete new atom type to an existing atomtype structure. Returns
  93    the number of the atom type. */
  94
  95 void print_at (FILE * out, gpp_atomtype *at);
  96 /* Print an atomtype record to a text file */
  97
  98 void renum_atype(gmx::ArrayRef<InteractionTypeParameters> plist, gmx_mtop_t *mtop,
  99                  int *wall_atomtype,
 100                  gpp_atomtype *at, bool bVerbose);
 101
 102 void copy_atomtype_atomtypes(gpp_atomtype *atype, t_atomtypes *atypes);
 103 /* Copy from one structure to another */
 104
 105 #endif