src/gromacs/gmxpreprocess/read-conformation.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 #ifndef GMX_GMXPREPROCESS_READ_CONFORMATION_H
  36 #define GMX_GMXPREPROCESS_READ_CONFORMATION_H
  37
  38 #include "types/simple.h"
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 struct gmx_atomprop;
  45 struct t_atoms;
  46
  47 /*! \brief Allocate and fill an array of inter-atomic half distances
  48  *
  49  * These are either scaled VDW radii taken from vdwradii.dat, or the
  50  * default value. Used directly and indirectly by solvate and
  51  * insert-molecules for deciding whether molecules clash. The return
  52  * pointer should be freed by the caller. */
  53 real *makeExclusionDistances(const struct t_atoms *a, struct gmx_atomprop *aps,
  54                              real defaultDistance, real scaleFactor);
  55
  56 /*! \brief Read a conformation from a file, allocate and fill data structures.
  57  *
  58  * Used by solvate and insert-molecules. The returned pointers *x and
  59  * *v should be freed by the caller. atoms should have its destructor
  60  * called. */
  61 char *readConformation(const char *confin, struct t_atoms *atoms, rvec **x, rvec **v,
  62                        int *ePBC, matrix box);
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif