include/mshift.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _mshift_h
  37 #define _mshift_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43 #include "typedefs.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 extern t_graph *mk_graph(FILE *fplog,
  50                          t_idef *idef,int at_start,int at_end,
  51                          bool bShakeOnly,bool bSettle);
  52 /* Build a graph from an idef description. The graph can be used
  53  * to generate mol-shift indices.
  54  * If bShakeOnly, only the connections in the shake list are used.
  55  * If bSettle && bShakeOnly the settles are used too.
  56  */
  57
  58 extern void mk_graph_ilist(FILE *fplog,
  59                            t_ilist *ilist,int at_start,int at_end,
  60                            bool bShakeOnly,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 extern void done_graph(t_graph *g);
  66 /* Free the memory in g */
  67
  68 extern void p_graph(FILE *log,const char *title,t_graph *g);
  69 /* Print a graph to log */
  70
  71 extern 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 extern 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 extern void shift_self(t_graph *g,matrix box,rvec x[]);
  78 /* Id. but in place */
  79
  80 extern 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 extern 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 */