include/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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _rmpbc_h
  40 #define _rmpbc_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 typedef struct gmx_rmpbc *gmx_rmpbc_t;
  49
  50 GMX_LIBGMX_EXPORT
  51 gmx_rmpbc_t gmx_rmpbc_init(t_idef *idef, int ePBC, int natoms,
  52                            matrix box);
  53
  54 GMX_LIBGMX_EXPORT
  55 void gmx_rmpbc_done(gmx_rmpbc_t gpbc);
  56
  57 GMX_LIBGMX_EXPORT
  58 void gmx_rmpbc(gmx_rmpbc_t gpbc, int natoms, matrix box, rvec x[]);
  59 /* Correct coordinates x for atoms within every molecule for the periodic
  60  * boundary conditions such that every molecule is whole.
  61  * natoms is the size x and can be smaller than the number
  62  * of atoms in idef, but should only contain complete molecules.
  63  * When ePBC=-1, the type of pbc is guessed from the box matrix.
  64  */
  65
  66 GMX_LIBGMX_EXPORT
  67 void gmx_rmpbc_copy(gmx_rmpbc_t gpbc, int natoms, matrix box, rvec x[],
  68                     rvec x_s[]);
  69 /* As gmx_rmpbc, but outputs in x_s and does not modify x. */
  70
  71 GMX_LIBGMX_EXPORT
  72 void gmx_rmpbc_trxfr(gmx_rmpbc_t gpbc, t_trxframe *fr);
  73 /* As gmx_rmpbc but operates on a t_trxframe data structure. */
  74
  75 /*void rm_pbc(t_idef *idef,int ePBC,int natoms,
  76    matrix box,rvec x[],rvec x_s[]);*/
  77 /* Convenience function that still holds a static variable. */
  78
  79 GMX_LIBGMX_EXPORT
  80 void rm_gropbc(t_atoms *atoms, rvec x[], matrix box);
  81 /* Simple routine for use in analysis tools that just have a pdb or
  82  * similar file.
  83  */
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif  /* _rmpbc_h */