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.
39 #include "gromacs/pbcutil/mshift.h"
45 #include "gromacs/legacyheaders/types/ifunc.h"
47 #include "gromacs/math/vec.h"
48 #include "gromacs/pbcutil/pbc.h"
49 #include "gromacs/utility/fatalerror.h"
50 #include "gromacs/utility/smalloc.h"
52 /************************************************************
54 * S H I F T U T I L I T I E S
56 ************************************************************/
59 /************************************************************
61 * G R A P H G E N E R A T I O N C O D E
63 ************************************************************/
65 static void add_gbond(t_graph *g, atom_id a0, atom_id a1)
71 inda0 = a0 - g->at_start;
72 inda1 = a1 - g->at_start;
74 /* Search for a direct edge between a0 and a1.
75 * All egdes are bidirectional, so we only need to search one way.
77 for (i = 0; (i < g->nedge[inda0] && !bFound); i++)
79 bFound = (g->edge[inda0][i] == a1);
84 g->edge[inda0][g->nedge[inda0]++] = a1;
85 g->edge[inda1][g->nedge[inda1]++] = a0;
89 static void mk_igraph(t_graph *g, int ftype, t_ilist *il,
90 int at_start, int at_end,
103 np = interaction_function[ftype].nratoms;
105 if (ia[1] >= at_start && ia[1] < at_end)
107 if (ia[np] >= at_end)
110 "Molecule in topology has atom numbers below and "
111 "above natoms (%d).\n"
112 "You are probably trying to use a trajectory which does "
113 "not match the first %d atoms of the run input file.\n"
114 "You can make a matching run input file with gmx convert-tpr.",
117 if (ftype == F_SETTLE)
119 /* Bond all the atoms in the settle */
120 add_gbond(g, ia[1], ia[2]);
121 add_gbond(g, ia[1], ia[3]);
123 else if (part == NULL)
125 /* Simply add this bond */
126 for (j = 1; j < np; j++)
128 add_gbond(g, ia[j], ia[j+1]);
133 /* Add this bond when it connects two unlinked parts of the graph */
134 for (j = 1; j < np; j++)
136 if (part[ia[j]] != part[ia[j+1]])
138 add_gbond(g, ia[j], ia[j+1]);
148 GMX_ATTRIBUTE_NORETURN static void g_error(int line, const char *file)
150 gmx_fatal(FARGS, "Tring to print non existant graph (file %s, line %d)",
153 #define GCHECK(g) if (g == NULL) g_error(__LINE__, __FILE__)
155 void p_graph(FILE *log, const char *title, t_graph *g)
158 const char *cc[egcolNR] = { "W", "G", "B" };
161 fprintf(log, "graph: %s\n", title);
162 fprintf(log, "nnodes: %d\n", g->nnodes);
163 fprintf(log, "nbound: %d\n", g->nbound);
164 fprintf(log, "start: %d\n", g->at_start);
165 fprintf(log, "end: %d\n", g->at_end);
166 fprintf(log, " atom shiftx shifty shiftz C nedg e1 e2 etc.\n");
167 for (i = 0; (i < g->nnodes); i++)
171 fprintf(log, "%5d%7d%7d%7d %1s%5d", g->at_start+i+1,
172 g->ishift[g->at_start+i][XX],
173 g->ishift[g->at_start+i][YY],
174 g->ishift[g->at_start+i][ZZ],
175 (g->negc > 0) ? cc[g->egc[i]] : " ",
177 for (j = 0; (j < g->nedge[i]); j++)
179 fprintf(log, " %5u", g->edge[i][j]+1);
187 static void calc_1se(t_graph *g, int ftype, t_ilist *il,
188 int nbond[], int at_start, int at_end)
190 int k, nratoms, end, j;
196 for (j = 0; (j < end); j += nratoms+1, ia += nratoms+1)
198 nratoms = interaction_function[ftype].nratoms;
200 if (ftype == F_SETTLE)
203 if (iaa >= at_start && iaa < at_end)
208 g->at_start = std::min(g->at_start, iaa);
209 g->at_end = std::max(g->at_end, iaa+2+1);
214 for (k = 1; (k <= nratoms); k++)
217 if (iaa >= at_start && iaa < at_end)
219 g->at_start = std::min(g->at_start, iaa);
220 g->at_end = std::max(g->at_end, iaa+1);
221 /* When making the graph we (might) link all atoms in an interaction
222 * sequentially. Therefore the end atoms add 1 to the count,
223 * the middle atoms 2.
225 if (k == 1 || k == nratoms)
239 static int calc_start_end(FILE *fplog, t_graph *g, t_ilist il[],
240 int at_start, int at_end,
245 g->at_start = at_end;
248 /* First add all the real bonds: they should determine the molecular
251 for (i = 0; (i < F_NRE); i++)
253 if (interaction_function[i].flags & IF_CHEMBOND)
255 calc_1se(g, i, &il[i], nbond, at_start, at_end);
258 /* Then add all the other interactions in fixed lists, but first
259 * check to see what's there already.
261 for (i = 0; (i < F_NRE); i++)
263 if (!(interaction_function[i].flags & IF_CHEMBOND))
265 calc_1se(g, i, &il[i], nbond, at_start, at_end);
271 for (i = g->at_start; (i < g->at_end); i++)
274 nnb = std::max(nnb, nbond[i]);
278 fprintf(fplog, "Max number of connections per atom is %d\n", nnb);
279 fprintf(fplog, "Total number of connections is %d\n", nbtot);
286 static void compact_graph(FILE *fplog, t_graph *g)
288 int i, j, n, max_nedge;
292 for (i = 0; i < g->nnodes; i++)
294 for (j = 0; j < g->nedge[i]; j++)
296 g->edge[0][n++] = g->edge[i][j];
298 max_nedge = std::max(max_nedge, g->nedge[i]);
300 srenew(g->edge[0], n);
301 /* set pointers after srenew because edge[0] might move */
302 for (i = 1; i < g->nnodes; i++)
304 g->edge[i] = g->edge[i-1] + g->nedge[i-1];
309 fprintf(fplog, "Max number of graph edges per atom is %d\n",
311 fprintf(fplog, "Total number of graph edges is %d\n", n);
315 static gmx_bool determine_graph_parts(t_graph *g, int *part)
319 atom_id at_i, *at_i2;
322 /* Initialize the part array with all entries different */
323 for (at_i = g->at_start; at_i < g->at_end; at_i++)
328 /* Loop over the graph until the part array is fixed */
333 for (i = 0; (i < g->nnodes); i++)
335 at_i = g->at_start + i;
337 for (e = 0; e < g->nedge[i]; e++)
339 /* Set part for both nodes to the minimum */
340 if (part[at_i2[e]] > part[at_i])
342 part[at_i2[e]] = part[at_i];
345 else if (part[at_i2[e]] < part[at_i])
347 part[at_i] = part[at_i2[e]];
351 if (part[at_i] != part[g->at_start])
358 fprintf(debug, "graph part[] nchanged=%d, bMultiPart=%d\n",
359 nchanged, bMultiPart);
362 while (nchanged > 0);
367 void mk_graph_ilist(FILE *fplog,
368 t_ilist *ilist, int at_start, int at_end,
369 gmx_bool bShakeOnly, gmx_bool bSettle,
376 /* The naming is somewhat confusing, but we need g->at0 and g->at1
377 * for shifthing coordinates to a new array (not in place) when
378 * some atoms are not connected by the graph, which runs from
379 * g->at_start (>= g->at0) to g->at_end (<= g->at1).
385 nbtot = calc_start_end(fplog, g, ilist, at_start, at_end, nbond);
387 if (g->at_start >= g->at_end)
389 g->at_start = at_start;
396 g->nnodes = g->at_end - g->at_start;
397 snew(g->nedge, g->nnodes);
398 snew(g->edge, g->nnodes);
399 /* Allocate a single array and set pointers into it */
400 snew(g->edge[0], nbtot);
401 for (i = 1; (i < g->nnodes); i++)
403 g->edge[i] = g->edge[i-1] + nbond[g->at_start+i-1];
408 /* First add all the real bonds: they should determine the molecular
411 for (i = 0; (i < F_NRE); i++)
413 if (interaction_function[i].flags & IF_CHEMBOND)
415 mk_igraph(g, i, &(ilist[i]), at_start, at_end, NULL);
419 /* Determine of which separated parts the IF_CHEMBOND graph consists.
420 * Store the parts in the nbond array.
422 bMultiPart = determine_graph_parts(g, nbond);
426 /* Then add all the other interactions in fixed lists,
427 * but only when they connect parts of the graph
428 * that are not connected through IF_CHEMBOND interactions.
430 for (i = 0; (i < F_NRE); i++)
432 if (!(interaction_function[i].flags & IF_CHEMBOND))
434 mk_igraph(g, i, &(ilist[i]), at_start, at_end, nbond);
439 /* Removed all the unused space from the edge array */
440 compact_graph(fplog, g);
444 /* This is a special thing used in splitter.c to generate shake-blocks */
445 mk_igraph(g, F_CONSTR, &(ilist[F_CONSTR]), at_start, at_end, NULL);
448 mk_igraph(g, F_SETTLE, &(ilist[F_SETTLE]), at_start, at_end, NULL);
452 for (i = 0; (i < g->nnodes); i++)
466 snew(g->ishift, g->at1);
470 p_graph(debug, "graph", g);
474 t_graph *mk_graph(FILE *fplog,
475 t_idef *idef, int at_start, int at_end,
476 gmx_bool bShakeOnly, gmx_bool bSettle)
482 mk_graph_ilist(fplog, idef->il, at_start, at_end, bShakeOnly, bSettle, g);
487 void done_graph(t_graph *g)
500 /************************************************************
502 * S H I F T C A L C U L A T I O N C O D E
504 ************************************************************/
506 static void mk_1shift_tric(int npbcdim, matrix box, rvec hbox,
507 rvec xi, rvec xj, int *mi, int *mj)
509 /* Calculate periodicity for triclinic box... */
513 rvec_sub(xi, xj, dx);
516 for (m = npbcdim-1; (m >= 0); m--)
518 /* If dx < hbox, then xj will be reduced by box, so that
519 * xi - xj will be bigger
521 if (dx[m] < -hbox[m])
524 for (d = m-1; d >= 0; d--)
529 else if (dx[m] >= hbox[m])
532 for (d = m-1; d >= 0; d--)
544 static void mk_1shift(int npbcdim, rvec hbox, rvec xi, rvec xj, int *mi, int *mj)
546 /* Calculate periodicity for rectangular box... */
550 rvec_sub(xi, xj, dx);
553 for (m = 0; (m < npbcdim); m++)
555 /* If dx < hbox, then xj will be reduced by box, so that
556 * xi - xj will be bigger
558 if (dx[m] < -hbox[m])
562 else if (dx[m] >= hbox[m])
573 static void mk_1shift_screw(matrix box, rvec hbox,
574 rvec xi, rvec xj, int *mi, int *mj)
576 /* Calculate periodicity for rectangular box... */
580 if ((mi[XX] > 0 && mi[XX] % 2 == 1) ||
581 (mi[XX] < 0 && -mi[XX] % 2 == 1))
590 rvec_sub(xi, xj, dx);
592 if (dx[XX] < -hbox[XX])
596 else if (dx[XX] >= hbox[XX])
604 if (mj[XX] != mi[XX])
607 dx[YY] = xi[YY] - (box[YY][YY] + box[ZZ][YY] - xj[YY]);
608 dx[ZZ] = xi[ZZ] - (box[ZZ][ZZ] - xj[ZZ]);
610 for (m = 1; (m < DIM); m++)
612 /* The signs are taken such that we can first shift x and rotate
613 * and then shift y and z.
615 if (dx[m] < -hbox[m])
617 mj[m] = mi[m] - signi;
619 else if (dx[m] >= hbox[m])
621 mj[m] = mi[m] + signi;
630 static int mk_grey(egCol egc[], t_graph *g, int *AtomI,
631 int npbcdim, matrix box, rvec x[], int *nerror)
633 int m, j, ng, ai, aj, g0;
639 for (m = 0; (m < DIM); m++)
641 hbox[m] = box[m][m]*0.5;
643 bTriclinic = TRICLINIC(box);
649 /* Loop over all the bonds */
650 for (j = 0; (j < g->nedge[ai-g0]); j++)
652 aj = g->edge[ai-g0][j];
653 /* If there is a white one, make it grey and set pbc */
656 mk_1shift_screw(box, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
660 mk_1shift_tric(npbcdim, box, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
664 mk_1shift(npbcdim, hbox, x[ai], x[aj], g->ishift[ai], is_aj);
667 if (egc[aj-g0] == egcolWhite)
669 if (aj - g0 < *AtomI)
673 egc[aj-g0] = egcolGrey;
675 copy_ivec(is_aj, g->ishift[aj]);
679 else if ((is_aj[XX] != g->ishift[aj][XX]) ||
680 (is_aj[YY] != g->ishift[aj][YY]) ||
681 (is_aj[ZZ] != g->ishift[aj][ZZ]))
685 set_pbc(&pbc, -1, box);
686 pbc_dx(&pbc, x[ai], x[aj], dx);
687 fprintf(debug, "mk_grey: shifts for atom %d due to atom %d\n"
688 "are (%d,%d,%d), should be (%d,%d,%d)\n"
690 aj+1, ai+1, is_aj[XX], is_aj[YY], is_aj[ZZ],
691 g->ishift[aj][XX], g->ishift[aj][YY], g->ishift[aj][ZZ],
692 dx[XX], dx[YY], dx[ZZ]);
700 static int first_colour(int fC, egCol Col, t_graph *g, egCol egc[])
701 /* Return the first node with colour Col starting at fC.
702 * return -1 if none found.
707 for (i = fC; (i < g->nnodes); i++)
709 if ((g->nedge[i] > 0) && (egc[i] == Col))
718 void mk_mshift(FILE *log, t_graph *g, int ePBC, matrix box, rvec x[])
720 static int nerror_tot = 0;
723 int nW, nG, nB; /* Number of Grey, Black, White */
724 int fW, fG; /* First of each category */
727 g->bScrewPBC = (ePBC == epbcSCREW);
739 /* This puts everything in the central box, that is does not move it
740 * at all. If we return without doing this for a system without bonds
741 * (i.e. only settles) all water molecules are moved to the opposite octant
743 for (i = g->at0; (i < g->at1); i++)
745 g->ishift[i][XX] = g->ishift[i][YY] = g->ishift[i][ZZ] = 0;
754 if (nnodes > g->negc)
757 srenew(g->egc, g->negc);
759 memset(g->egc, 0, (size_t)(nnodes*sizeof(g->egc[0])));
767 /* We even have a loop invariant:
768 * nW+nG+nB == g->nbound
771 fprintf(log, "Starting W loop\n");
775 /* Find the first white, this will allways be a larger
776 * number than before, because no nodes are made white
779 if ((fW = first_colour(fW, egcolWhite, g, g->egc)) == -1)
781 gmx_fatal(FARGS, "No WHITE nodes found while nW=%d\n", nW);
784 /* Make the first white node grey */
785 g->egc[fW] = egcolGrey;
789 /* Initial value for the first grey */
792 fprintf(log, "Starting G loop (nW=%d, nG=%d, nB=%d, total %d)\n",
793 nW, nG, nB, nW+nG+nB);
797 if ((fG = first_colour(fG, egcolGrey, g, g->egc)) == -1)
799 gmx_fatal(FARGS, "No GREY nodes found while nG=%d\n", nG);
802 /* Make the first grey node black */
803 g->egc[fG] = egcolBlack;
807 /* Make all the neighbours of this black node grey
808 * and set their periodicity
810 ng = mk_grey(g->egc, g, &fG, npbcdim, box, x, &nerror);
811 /* ng is the number of white nodes made grey */
819 if (nerror_tot <= 100)
821 fprintf(stderr, "There were %d inconsistent shifts. Check your topology\n",
825 fprintf(log, "There were %d inconsistent shifts. Check your topology\n",
829 if (nerror_tot == 100)
831 fprintf(stderr, "Will stop reporting inconsistent shifts\n");
834 fprintf(log, "Will stop reporting inconsistent shifts\n");
840 /************************************************************
842 * A C T U A L S H I F T C O D E
844 ************************************************************/
846 void shift_x(t_graph *g, matrix box, rvec x[], rvec x_s[])
857 for (j = g->at0; j < g0; j++)
859 copy_rvec(x[j], x_s[j]);
864 for (j = g0; (j < g1); j++)
870 if ((tx > 0 && tx % 2 == 1) ||
871 (tx < 0 && -tx %2 == 1))
873 x_s[j][XX] = x[j][XX] + tx*box[XX][XX];
874 x_s[j][YY] = box[YY][YY] + box[ZZ][YY] - x[j][YY];
875 x_s[j][ZZ] = box[ZZ][ZZ] - x[j][ZZ];
879 x_s[j][XX] = x[j][XX];
881 x_s[j][YY] = x[j][YY] + ty*box[YY][YY] + tz*box[ZZ][YY];
882 x_s[j][ZZ] = x[j][ZZ] + tz*box[ZZ][ZZ];
885 else if (TRICLINIC(box))
887 for (j = g0; (j < g1); j++)
893 x_s[j][XX] = x[j][XX]+tx*box[XX][XX]+ty*box[YY][XX]+tz*box[ZZ][XX];
894 x_s[j][YY] = x[j][YY]+ty*box[YY][YY]+tz*box[ZZ][YY];
895 x_s[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
900 for (j = g0; (j < g1); j++)
906 x_s[j][XX] = x[j][XX]+tx*box[XX][XX];
907 x_s[j][YY] = x[j][YY]+ty*box[YY][YY];
908 x_s[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
912 for (j = g1; j < g->at1; j++)
914 copy_rvec(x[j], x_s[j]);
918 void shift_self(t_graph *g, matrix box, rvec x[])
926 gmx_incons("screw pbc not implemented for shift_self");
934 fprintf(stderr, "Shifting atoms %d to %d\n", g0, g0+gn);
938 for (j = g0; (j < g1); j++)
944 x[j][XX] = x[j][XX]+tx*box[XX][XX]+ty*box[YY][XX]+tz*box[ZZ][XX];
945 x[j][YY] = x[j][YY]+ty*box[YY][YY]+tz*box[ZZ][YY];
946 x[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
951 for (j = g0; (j < g1); j++)
957 x[j][XX] = x[j][XX]+tx*box[XX][XX];
958 x[j][YY] = x[j][YY]+ty*box[YY][YY];
959 x[j][ZZ] = x[j][ZZ]+tz*box[ZZ][ZZ];
964 void unshift_x(t_graph *g, matrix box, rvec x[], rvec x_s[])
972 gmx_incons("screw pbc not implemented (yet) for unshift_x");
979 for (j = g->at0; j < g0; j++)
981 copy_rvec(x_s[j], x[j]);
986 for (j = g0; (j < g1); j++)
992 x[j][XX] = x_s[j][XX]-tx*box[XX][XX]-ty*box[YY][XX]-tz*box[ZZ][XX];
993 x[j][YY] = x_s[j][YY]-ty*box[YY][YY]-tz*box[ZZ][YY];
994 x[j][ZZ] = x_s[j][ZZ]-tz*box[ZZ][ZZ];
999 for (j = g0; (j < g1); j++)
1005 x[j][XX] = x_s[j][XX]-tx*box[XX][XX];
1006 x[j][YY] = x_s[j][YY]-ty*box[YY][YY];
1007 x[j][ZZ] = x_s[j][ZZ]-tz*box[ZZ][ZZ];
1011 for (j = g1; j < g->at1; j++)
1013 copy_rvec(x_s[j], x[j]);
1017 void unshift_self(t_graph *g, matrix box, rvec x[])
1025 gmx_incons("screw pbc not implemented for unshift_self");
1034 for (j = g0; (j < g1); j++)
1040 x[j][XX] = x[j][XX]-tx*box[XX][XX]-ty*box[YY][XX]-tz*box[ZZ][XX];
1041 x[j][YY] = x[j][YY]-ty*box[YY][YY]-tz*box[ZZ][YY];
1042 x[j][ZZ] = x[j][ZZ]-tz*box[ZZ][ZZ];
1047 for (j = g0; (j < g1); j++)
1053 x[j][XX] = x[j][XX]-tx*box[XX][XX];
1054 x[j][YY] = x[j][YY]-ty*box[YY][YY];
1055 x[j][ZZ] = x[j][ZZ]-tz*box[ZZ][ZZ];