include/mshift.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, 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 _mshift_h
  40 #define _mshift_h
  41 #include "visibility.h"
  42 #include "typedefs.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 GMX_LIBGMX_EXPORT
  49 t_graph *mk_graph(FILE *fplog,
  50                          t_idef *idef,int at_start,int at_end,
  51                          gmx_bool bShakeOnly,gmx_bool bSettle);
  52 /* Build a graph from an idef description. The graph can be used
  53  * to generate mol-shift indices.
  54  * at_start and at_end should coincide will molecule boundaries,
  55  * for the whole system this is simply 0 and natoms.
  56  * If bShakeOnly, only the connections in the shake list are used.
  57  * If bSettle && bShakeOnly the settles are used too.
  58  */
  59
  60 GMX_LIBGMX_EXPORT
  61 void mk_graph_ilist(FILE *fplog,
  62                            t_ilist *ilist,int at_start,int at_end,
  63                            gmx_bool bShakeOnly,gmx_bool bSettle,
  64                            t_graph *g);
  65 /* As mk_graph, but takes t_ilist iso t_idef and does not allocate g */
  66
  67
  68 GMX_LIBGMX_EXPORT
  69 void done_graph(t_graph *g);
  70 /* Free the memory in g */
  71
  72 GMX_LIBGMX_EXPORT
  73 void p_graph(FILE *log,const char *title,t_graph *g);
  74 /* Print a graph to log */
  75
  76 GMX_LIBGMX_EXPORT
  77 void mk_mshift(FILE *log,t_graph *g,int ePBC,matrix box,rvec x[]);
  78 /* Calculate the mshift codes, based on the connection graph in g. */
  79
  80 GMX_LIBGMX_EXPORT
  81 void shift_x(t_graph *g,matrix box,rvec x[],rvec x_s[]);
  82 /* Add the shift vector to x, and store in x_s (may be same array as x) */
  83
  84 GMX_LIBGMX_EXPORT
  85 void shift_self(t_graph *g,matrix box,rvec x[]);
  86 /* Id. but in place */
  87
  88 GMX_LIBGMX_EXPORT
  89 void unshift_x(t_graph *g,matrix box,rvec x[],rvec x_s[]);
  90 /* Subtract the shift vector from x_s, and store in x (may be same array) */
  91
  92 GMX_LIBGMX_EXPORT
  93 void unshift_self(t_graph *g,matrix box,rvec x[]);
  94 /* Id, but in place */
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100 #endif  /* _mshift_h */