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