src/gromacs/pbcutil/rmpbc.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) 2013,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_PBCUTIL_RMPBC_H
  38 #define GMX_PBCUTIL_RMPBC_H
  39
  40 #include "../math/vectypes.h"
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 struct t_atoms;
  47 struct t_idef;
  48 struct t_trxframe;
  49
  50 typedef struct gmx_rmpbc *gmx_rmpbc_t;
  51
  52 gmx_rmpbc_t gmx_rmpbc_init(struct t_idef *idef, int ePBC, int natoms);
  53
  54 void gmx_rmpbc_done(gmx_rmpbc_t gpbc);
  55
  56 void gmx_rmpbc(gmx_rmpbc_t gpbc, int natoms, matrix box, rvec x[]);
  57 /* Correct coordinates x for atoms within every molecule for the periodic
  58  * boundary conditions such that every molecule is whole.
  59  * natoms is the size x and can be smaller than the number
  60  * of atoms in idef, but should only contain complete molecules.
  61  * When ePBC=-1, the type of pbc is guessed from the box matrix.
  62  */
  63
  64 void gmx_rmpbc_copy(gmx_rmpbc_t gpbc, int natoms, matrix box, rvec x[],
  65                     rvec x_s[]);
  66 /* As gmx_rmpbc, but outputs in x_s and does not modify x. */
  67
  68 void gmx_rmpbc_trxfr(gmx_rmpbc_t gpbc, struct t_trxframe *fr);
  69 /* As gmx_rmpbc but operates on a t_trxframe data structure. */
  70
  71 void rm_gropbc(struct t_atoms *atoms, rvec x[], matrix box);
  72 /* Simple routine for use in analysis tools that just have a pdb or
  73  * similar file.
  74  */
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif