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