src/gromacs/pbcutil/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,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_MSHIFT_H
  38 #define GMX_PBCUTIL_MSHIFT_H
  39
  40 #include <stdio.h>
  41
  42 #include "gromacs/legacyheaders/types/simple.h"
  43 #include "gromacs/math/vectypes.h"
  44 #include "gromacs/utility/basedefinitions.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 struct t_idef;
  51 struct t_ilist;
  52
  53 typedef enum {
  54     egcolWhite, egcolGrey, egcolBlack, egcolNR
  55 } egCol;
  56
  57 typedef struct t_graph {
  58     int          at0;       /* The first atom the graph was constructed for */
  59     int          at1;       /* The last atom the graph was constructed for  */
  60     int          nnodes;    /* The number of nodes, nnodes=at_end-at_start  */
  61     int          nbound;    /* The number of nodes with edges               */
  62     int          at_start;  /* The first connected atom in this graph       */
  63     int          at_end;    /* The last+1 connected atom in this graph      */
  64     int         *nedge;     /* For each node the number of edges            */
  65     atom_id    **edge;      /* For each node, the actual edges (bidirect.)  */
  66     gmx_bool     bScrewPBC; /* Screw boundary conditions                    */
  67     ivec        *ishift;    /* Shift for each particle                      */
  68     int          negc;
  69     egCol       *egc;       /* color of each node */
  70 } t_graph;
  71
  72 #define SHIFT_IVEC(g, i) ((g)->ishift[i])
  73
  74 t_graph *mk_graph(FILE *fplog,
  75                   struct t_idef *idef, int at_start, int at_end,
  76                   gmx_bool bShakeOnly, gmx_bool bSettle);
  77 /* Build a graph from an idef description. The graph can be used
  78  * to generate mol-shift indices.
  79  * at_start and at_end should coincide will molecule boundaries,
  80  * for the whole system this is simply 0 and natoms.
  81  * If bShakeOnly, only the connections in the shake list are used.
  82  * If bSettle && bShakeOnly the settles are used too.
  83  */
  84
  85 void mk_graph_ilist(FILE *fplog,
  86                     struct t_ilist *ilist, int at_start, int at_end,
  87                     gmx_bool bShakeOnly, gmx_bool bSettle,
  88                     t_graph *g);
  89 /* As mk_graph, but takes t_ilist iso t_idef and does not allocate g */
  90
  91
  92 void done_graph(t_graph *g);
  93 /* Free the memory in g */
  94
  95 void p_graph(FILE *log, const char *title, t_graph *g);
  96 /* Print a graph to log */
  97
  98 void mk_mshift(FILE *log, t_graph *g, int ePBC, matrix box, rvec x[]);
  99 /* Calculate the mshift codes, based on the connection graph in g. */
 100
 101 void shift_x(t_graph *g, matrix box, rvec x[], rvec x_s[]);
 102 /* Add the shift vector to x, and store in x_s (may be same array as x) */
 103
 104 void shift_self(t_graph *g, matrix box, rvec x[]);
 105 /* Id. but in place */
 106
 107 void unshift_x(t_graph *g, matrix box, rvec x[], rvec x_s[]);
 108 /* Subtract the shift vector from x_s, and store in x (may be same array) */
 109
 110 void unshift_self(t_graph *g, matrix box, rvec x[]);
 111 /* Id, but in place */
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif