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