2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
37 #include "gromacs/pbcutil/mshift.h"
49 #include "gromacs/math/vec.h"
50 #include "gromacs/utility/fatalerror.h"
51 #include "gromacs/utility/smalloc.h"
53 /************************************************************
55 * S H I F T U T I L I T I E S
57 ************************************************************/
60 /************************************************************
62 * G R A P H G E N E R A T I O N C O D E
64 ************************************************************/
66 static void add_gbond(t_graph *g, atom_id a0, atom_id a1)
72 inda0 = a0 - g->at_start;
73 inda1 = a1 - g->at_start;
75 /* Search for a direct edge between a0 and a1.
76 * All egdes are bidirectional, so we only need to search one way.
78 for (i = 0; (i < g->nedge[inda0] && !bFound); i++)
80 bFound = (g->edge[inda0][i] == a1);
85 g->edge[inda0][g->nedge[inda0]++] = a1;
86 g->edge[inda1][g->nedge[inda1]++] = a0;
90 static void mk_igraph(t_graph *g, int ftype, t_ilist *il,
91 int at_start, int at_end,
104 np = interaction_function[ftype].nratoms;
106 if (ia[1] >= at_start && ia[1] < at_end)
108 if (ia[np] >= at_end)
111 "Molecule in topology has atom numbers below and "
112 "above natoms (%d).\n"
113 "You are probably trying to use a trajectory which does "
114 "not match the first %d atoms of the run input file.\n"
115 "You can make a matching run input file with gmx convert-tpr.",
118 if (ftype == F_SETTLE)
120 /* Bond all the atoms in the settle */
121 add_gbond(g, ia[1], ia[2]);
122 add_gbond(g, ia[1], ia[3]);
124 else if (part == NULL)
126 /* Simply add this bond */
127 for (j = 1; j < np; j++)
129 add_gbond(g, ia[j], ia[j+1]);
134 /* Add this bond when it connects two unlinked parts of the graph */
135 for (j = 1; j < np; j++)
137 if (part[ia[j]] != part[ia[j+1]])
139 add_gbond(g, ia[j], ia[j+1]);
149 GMX_ATTRIBUTE_NORETURN static void g_error(int line, const char *file)
151 gmx_fatal(FARGS, "Tring to print non existant graph (file %s, line %d)",
154 #define GCHECK(g) if (g == NULL) g_error(__LINE__, __FILE__)
156 void p_graph(FILE *log, const char *title, t_graph *g)
159 const char *cc[egcolNR] = { "W", "G", "B" };
162 fprintf(log, "graph: %s\n", title);
163 fprintf(log, "nnodes: %d\n", g->nnodes);
164 fprintf(log, "nbound: %d\n", g->nbound);
165 fprintf(log, "start: %d\n", g->at_start);
166 fprintf(log, "end: %d\n", g->at_end);
167 fprintf(log, " atom shiftx shifty shiftz C nedg e1 e2 etc.\n");
168 for (i = 0; (i < g->nnodes); i++)
172 fprintf(log, "%5d%7d%7d%7d %1s%5d", g->at_start+i+1,
173 g->ishift[g->at_start+i][XX],
174 g->ishift[g->at_start+i][YY],
175 g->ishift[g->at_start+i][ZZ],
176 (g->negc > 0) ? cc[g->egc[i]] : " ",
178 for (j = 0; (j < g->nedge[i]); j++)
180 fprintf(log, " %5u", g->edge[i][j]+1);
188 static void calc_1se(t_graph *g, int ftype, t_ilist *il,
189 int nbond[], int at_start, int at_end)
191 int k, nratoms, end, j;
197 for (j = 0; (j < end); j += nratoms+1, ia += nratoms+1)
199 nratoms = interaction_function[ftype].nratoms;
201 if (ftype == F_SETTLE)
204 if (iaa >= at_start && iaa < at_end)
209 g->at_start = std::min(g->at_start, iaa);
210 g->at_end = std::max(g->at_end, iaa+2+1);
215 for (k = 1; (k <= nratoms); k++)
218 if (iaa >= at_start && iaa < at_end)
220 g->at_start = std::min(g->at_start, iaa);
221 g->at_end = std::max(g->at_end, iaa+1);
222 /* When making the graph we (might) link all atoms in an interaction
223 * sequentially. Therefore the end atoms add 1 to the count,
224 * the middle atoms 2.
226 if (k == 1 || k == nratoms)
240 static int calc_start_end(FILE *fplog, t_graph *g, t_ilist il[],
241 int at_start, int at_end,
246 g->at_start = at_end;
249 /* First add all the real bonds: they should determine the molecular
252 for (i = 0; (i < F_NRE); i++)
254 if (interaction_function[i].flags & IF_CHEMBOND)
256 calc_1se(g, i, &il[i], nbond, at_start, at_end);
259 /* Then add all the other interactions in fixed lists, but first
260 * check to see what's there already.
262 for (i = 0; (i < F_NRE); i++)
264 if (!(interaction_function[i].flags & IF_CHEMBOND))
266 calc_1se(g, i, &il[i], nbond, at_start, at_end);
272 for (i = g->at_start; (i < g->at_end); i++)
275 nnb = std::max(nnb, nbond[i]);
279 fprintf(fplog, "Max number of connections per atom is %d\n", nnb);
280 fprintf(fplog, "Total number of connections is %d\n", nbtot);
287 static void compact_graph(FILE *fplog, t_graph *g)
289 int i, j, n, max_nedge;
293 for (i = 0; i < g->nnodes; i++)
295 for (j = 0; j < g->nedge[i]; j++)
297 g->edge[0][n++] = g->edge[i][j];
299 max_nedge = std::max(max_nedge, g->nedge[i]);
301 srenew(g->edge[0], n);
302 /* set pointers after srenew because edge[0] might move */
303 for (i = 1; i < g->nnodes; i++)
305 g->edge[i] = g->edge[i-1] + g->nedge[i-1];
310 fprintf(fplog, "Max number of graph edges per atom is %d\n",
312 fprintf(fplog, "Total number of graph edges is %d\n", n);
316 static gmx_bool determine_graph_parts(t_graph *g, int *part)
320 atom_id at_i, *at_i2;
323 /* Initialize the part array with all entries different */
324 for (at_i = g->at_start; at_i < g->at_end; at_i++)
329 /* Loop over the graph until the part array is fixed */
334 for (i = 0; (i < g->nnodes); i++)
336 at_i = g->at_start + i;
338 for (e = 0; e < g->nedge[i]; e++)
340 /* Set part for both nodes to the minimum */
341 if (part[at_i2[e]] > part[at_i])
343 part[at_i2[e]] = part[at_i];
346 else if (part[at_i2[e]] < part[at_i])
348 part[at_i] = part[at_i2[e]];
352 if (part[at_i] != part[g->at_start])
359 fprintf(debug, "graph part[] nchanged=%d, bMultiPart=%d\n",
360 nchanged, bMultiPart);
363 while (nchanged > 0);
368 void mk_graph_ilist(FILE *fplog,
369 t_ilist *ilist, int at_start, int at_end,
370 gmx_bool bShakeOnly, gmx_bool bSettle,
377 /* The naming is somewhat confusing, but we need g->at0 and g->at1
378 * for shifthing coordinates to a new array (not in place) when
379 * some atoms are not connected by the graph, which runs from
380 * g->at_start (>= g->at0) to g->at_end (<= g->at1).
386 nbtot = calc_start_end(fplog, g, ilist, at_start, at_end, nbond);
388 if (g->at_start >= g->at_end)
390 g->at_start = at_start;
397 g->nnodes = g->at_end - g->at_start;
398 snew(g->nedge, g->nnodes);
399 snew(g->edge, g->nnodes);
400 /* Allocate a single array and set pointers into it */
401 snew(g->edge[0], nbtot);
402 for (i = 1; (i < g->nnodes); i++)
404 g->edge[i] = g->edge[i-1] + nbond[g->at_start+i-1];
409 /* First add all the real bonds: they should determine the molecular
412 for (i = 0; (i < F_NRE); i++)
414 if (interaction_function[i].flags & IF_CHEMBOND)
416 mk_igraph(g, i, &(ilist[i]), at_start, at_end, NULL);
420 /* Determine of which separated parts the IF_CHEMBOND graph consists.
421 * Store the parts in the nbond array.
423 bMultiPart = determine_graph_parts(g, nbond);
427 /* Then add all the other interactions in fixed lists,
428 * but only when they connect parts of the graph
429 * that are not connected through IF_CHEMBOND interactions.
431 for (i = 0; (i < F_NRE); i++)
433 if (!(interaction_function[i].flags & IF_CHEMBOND))
435 mk_igraph(g, i, &(ilist[i]), at_start, at_end, nbond);
440 /* Removed all the unused space from the edge array */
441 compact_graph(fplog, g);
445 /* This is a special thing used in splitter.c to generate shake-blocks */
446 mk_igraph(g, F_CONSTR, &(ilist[F_CONSTR]), at_start, at_end, NULL);
449 mk_igraph(g, F_SETTLE, &(ilist[F_SETTLE]), at_start, at_end, NULL);
453 for (i = 0; (i < g->nnodes); i++)
467 snew(g->ishift, g->at1);
471 p_graph(debug, "graph", g);
475 t_graph *mk_graph(FILE *fplog,
476 t_idef *idef, int at_start, int at_end,
477 gmx_bool bShakeOnly, gmx_bool bSettle)
483 mk_graph_ilist(fplog, idef->il, at_start, at_end, bShakeOnly, bSettle, g);
488 void done_graph(t_graph *g)
501 /************************************************************
503 * S H I F T C A L C U L A T I O N C O D E
505 ************************************************************/
507 static void mk_1shift_tric(int npbcdim, matrix box, rvec hbox,
508 rvec xi, rvec xj, int *mi, int *mj)
510 /* Calculate periodicity for triclinic box... */
514 rvec_sub(xi, xj, dx);
517 for (m = npbcdim-1; (m >= 0); m--)
519 /* If dx < hbox, then xj will be reduced by box, so that
520 * xi - xj will be bigger
522 if (dx[m] < -hbox[m])
525 for (d = m-1; d >= 0; d--)
530 else if (dx[m] >= hbox[m])
533 for (d = m-1; d >= 0; d--)
545 static void mk_1shift(int npbcdim, rvec hbox, rvec xi, rvec xj, int *mi, int *mj)
547 /* Calculate periodicity for rectangular box... */
551 rvec_sub(xi, xj, dx);
554 for (m = 0; (m < npbcdim); m++)
556 /* If dx < hbox, then xj will be reduced by box, so that
557 * xi - xj will be bigger
559 if (dx[m] < -hbox[m])
563 else if (dx[m] >= hbox[m])
574 static void mk_1shift_screw(matrix box, rvec hbox,
575 rvec xi, rvec xj, int *mi, int *mj)
577 /* Calculate periodicity for rectangular box... */
581 if ((mi[XX] > 0 && mi[XX] % 2 == 1) ||
582 (mi[XX] < 0 && -mi[XX] % 2 == 1))
591 rvec_sub(xi, xj, dx);
593 if (dx[XX] < -hbox[XX])
597 else if (dx[XX] >= hbox[XX])
605 if (mj[XX] != mi[XX])
608 dx[YY] = xi[YY] - (box[YY][YY] + box[ZZ][YY] - xj[YY]);
609 dx[ZZ] = xi[ZZ] - (box[ZZ][ZZ] - xj[ZZ]);
611 for (m = 1; (m < DIM); m++)
613 /* The signs are taken such that we can first shift x and rotate
614 * and then shift y and z.
616 if (dx[m] < -hbox[m])
618 mj[m] = mi[m] - signi;
620 else if (dx[m] >= hbox[m])
622 mj[m] = mi[m] + signi;
631 static int mk_grey(egCol egc[], t_graph *g, int *AtomI,
632 int npbcdim, matrix box, rvec x[], int *nerror)
634 int m, j, ng, ai, aj, g0;
640 for (m = 0; (m < DIM); m++)
642 hbox[m] = box[m][m]*0.5;
644 bTriclinic = TRICLINIC(box);
650 /* Loop over all the bonds */
651 for (j = 0; (j < g->nedge[ai-g0]); j++)
653 aj = g->edge[ai-g0][j];
654 /* If there is a white one, make it grey and set pbc */
657 mk_1shift_screw(box, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
661 mk_1shift_tric(npbcdim, box, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
665 mk_1shift(npbcdim, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
668 if (egc[aj-g0] == egcolWhite)
670 if (aj - g0 < *AtomI)
674 egc[aj-g0] = egcolGrey;
676 copy_ivec(is_aj, g->ishift[aj]);
680 else if ((is_aj[XX] != g->ishift[aj][XX]) ||
681 (is_aj[YY] != g->ishift[aj][YY]) ||
682 (is_aj[ZZ] != g->ishift[aj][ZZ]))
686 set_pbc(&pbc, -1, box);
687 pbc_dx(&pbc, x[ai], x[aj], dx);
688 fprintf(debug, "mk_grey: shifts for atom %d due to atom %d\n"
689 "are (%d,%d,%d), should be (%d,%d,%d)\n"
691 aj+1, ai+1, is_aj[XX], is_aj[YY], is_aj[ZZ],
692 g->ishift[aj][XX], g->ishift[aj][YY], g->ishift[aj][ZZ],
693 dx[XX], dx[YY], dx[ZZ]);
701 static int first_colour(int fC, egCol Col, t_graph *g, egCol egc[])
702 /* Return the first node with colour Col starting at fC.
703 * return -1 if none found.
708 for (i = fC; (i < g->nnodes); i++)
710 if ((g->nedge[i] > 0) && (egc[i] == Col))
719 void mk_mshift(FILE *log, t_graph *g, int ePBC, matrix box, rvec x[])
721 static int nerror_tot = 0;
724 int nW, nG, nB; /* Number of Grey, Black, White */
725 int fW, fG; /* First of each category */
728 g->bScrewPBC = (ePBC == epbcSCREW);
740 /* This puts everything in the central box, that is does not move it
741 * at all. If we return without doing this for a system without bonds
742 * (i.e. only settles) all water molecules are moved to the opposite octant
744 for (i = g->at0; (i < g->at1); i++)
746 g->ishift[i][XX] = g->ishift[i][YY] = g->ishift[i][ZZ] = 0;
755 if (nnodes > g->negc)
758 srenew(g->egc, g->negc);
760 memset(g->egc, 0, (size_t)(nnodes*sizeof(g->egc[0])));
768 /* We even have a loop invariant:
769 * nW+nG+nB == g->nbound
772 fprintf(log, "Starting W loop\n");
776 /* Find the first white, this will allways be a larger
777 * number than before, because no nodes are made white
780 if ((fW = first_colour(fW, egcolWhite, g, g->egc)) == -1)
782 gmx_fatal(FARGS, "No WHITE nodes found while nW=%d\n", nW);
785 /* Make the first white node grey */
786 g->egc[fW] = egcolGrey;
790 /* Initial value for the first grey */
793 fprintf(log, "Starting G loop (nW=%d, nG=%d, nB=%d, total %d)\n",
794 nW, nG, nB, nW+nG+nB);
798 if ((fG = first_colour(fG, egcolGrey, g, g->egc)) == -1)
800 gmx_fatal(FARGS, "No GREY nodes found while nG=%d\n", nG);
803 /* Make the first grey node black */
804 g->egc[fG] = egcolBlack;
808 /* Make all the neighbours of this black node grey
809 * and set their periodicity
811 ng = mk_grey(g->egc, g, &fG, npbcdim, box, x, &nerror);
812 /* ng is the number of white nodes made grey */
820 if (nerror_tot <= 100)
822 fprintf(stderr, "There were %d inconsistent shifts. Check your topology\n",
826 fprintf(log, "There were %d inconsistent shifts. Check your topology\n",
830 if (nerror_tot == 100)
832 fprintf(stderr, "Will stop reporting inconsistent shifts\n");
835 fprintf(log, "Will stop reporting inconsistent shifts\n");
841 /************************************************************
843 * A C T U A L S H I F T C O D E
845 ************************************************************/
847 void shift_x(t_graph *g, matrix box, rvec x[], rvec x_s[])
858 for (j = g->at0; j < g0; j++)
860 copy_rvec(x[j], x_s[j]);
865 for (j = g0; (j < g1); j++)
871 if ((tx > 0 && tx % 2 == 1) ||
872 (tx < 0 && -tx %2 == 1))
874 x_s[j][XX] = x[j][XX] + tx*box[XX][XX];
875 x_s[j][YY] = box[YY][YY] + box[ZZ][YY] - x[j][YY];
876 x_s[j][ZZ] = box[ZZ][ZZ] - x[j][ZZ];
880 x_s[j][XX] = x[j][XX];
882 x_s[j][YY] = x[j][YY] + ty*box[YY][YY] + tz*box[ZZ][YY];
883 x_s[j][ZZ] = x[j][ZZ] + tz*box[ZZ][ZZ];
886 else if (TRICLINIC(box))
888 for (j = g0; (j < g1); j++)
894 x_s[j][XX] = x[j][XX]+tx*box[XX][XX]+ty*box[YY][XX]+tz*box[ZZ][XX];
895 x_s[j][YY] = x[j][YY]+ty*box[YY][YY]+tz*box[ZZ][YY];
896 x_s[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
901 for (j = g0; (j < g1); j++)
907 x_s[j][XX] = x[j][XX]+tx*box[XX][XX];
908 x_s[j][YY] = x[j][YY]+ty*box[YY][YY];
909 x_s[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
913 for (j = g1; j < g->at1; j++)
915 copy_rvec(x[j], x_s[j]);
919 void shift_self(t_graph *g, matrix box, rvec x[])
927 gmx_incons("screw pbc not implemented for shift_self");
935 fprintf(stderr, "Shifting atoms %d to %d\n", g0, g0+gn);
939 for (j = g0; (j < g1); j++)
945 x[j][XX] = x[j][XX]+tx*box[XX][XX]+ty*box[YY][XX]+tz*box[ZZ][XX];
946 x[j][YY] = x[j][YY]+ty*box[YY][YY]+tz*box[ZZ][YY];
947 x[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
952 for (j = g0; (j < g1); j++)
958 x[j][XX] = x[j][XX]+tx*box[XX][XX];
959 x[j][YY] = x[j][YY]+ty*box[YY][YY];
960 x[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
965 void unshift_x(t_graph *g, matrix box, rvec x[], rvec x_s[])
973 gmx_incons("screw pbc not implemented (yet) for unshift_x");
980 for (j = g->at0; j < g0; j++)
982 copy_rvec(x_s[j], x[j]);
987 for (j = g0; (j < g1); j++)
993 x[j][XX] = x_s[j][XX]-tx*box[XX][XX]-ty*box[YY][XX]-tz*box[ZZ][XX];
994 x[j][YY] = x_s[j][YY]-ty*box[YY][YY]-tz*box[ZZ][YY];
995 x[j][ZZ] = x_s[j][ZZ]-tz*box[ZZ][ZZ];
1000 for (j = g0; (j < g1); j++)
1006 x[j][XX] = x_s[j][XX]-tx*box[XX][XX];
1007 x[j][YY] = x_s[j][YY]-ty*box[YY][YY];
1008 x[j][ZZ] = x_s[j][ZZ]-tz*box[ZZ][ZZ];
1012 for (j = g1; j < g->at1; j++)
1014 copy_rvec(x_s[j], x[j]);
1018 void unshift_self(t_graph *g, matrix box, rvec x[])
1026 gmx_incons("screw pbc not implemented for unshift_self");
1035 for (j = g0; (j < g1); j++)
1041 x[j][XX] = x[j][XX]-tx*box[XX][XX]-ty*box[YY][XX]-tz*box[ZZ][XX];
1042 x[j][YY] = x[j][YY]-ty*box[YY][YY]-tz*box[ZZ][YY];
1043 x[j][ZZ] = x[j][ZZ]-tz*box[ZZ][ZZ];
1048 for (j = g0; (j < g1); j++)
1054 x[j][XX] = x[j][XX]-tx*box[XX][XX];
1055 x[j][YY] = x[j][YY]-ty*box[YY][YY];
1056 x[j][ZZ] = x[j][ZZ]-tz*box[ZZ][ZZ];