Merge branch release-4-6 into release-5-0
[alexxy/gromacs.git] / src / gromacs / gmxpreprocess / addconf.c
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 #include "addconf.h"
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 #include <stdlib.h>
44 #include <string.h>
45 #include "vec.h"
46 #include "macros.h"
47 #include "gromacs/utility/smalloc.h"
48 #include "types/commrec.h"
49 #include "force.h"
50 #include "names.h"
51 #include "nsgrid.h"
52 #include "mdatoms.h"
53 #include "nrnb.h"
54 #include "ns.h"
55 #include "mtop_util.h"
56 #include "chargegroup.h"
57
58 static real box_margin;
59
60 static real max_dist(rvec *x, real *r, int start, int end)
61 {
62     real maxd;
63     int  i, j;
64
65     maxd = 0;
66     for (i = start; i < end; i++)
67     {
68         for (j = i+1; j < end; j++)
69         {
70             maxd = max(maxd, sqrt(distance2(x[i], x[j]))+0.5*(r[i]+r[j]));
71         }
72     }
73
74     return 0.5*maxd;
75 }
76
77 static gmx_bool outside_box_minus_margin2(rvec x, matrix box)
78 {
79     return ( (x[XX] < 2*box_margin) || (x[XX] > box[XX][XX]-2*box_margin) ||
80              (x[YY] < 2*box_margin) || (x[YY] > box[YY][YY]-2*box_margin) ||
81              (x[ZZ] < 2*box_margin) || (x[ZZ] > box[ZZ][ZZ]-2*box_margin) );
82 }
83
84 static gmx_bool outside_box_plus_margin(rvec x, matrix box)
85 {
86     return ( (x[XX] < -box_margin) || (x[XX] > box[XX][XX]+box_margin) ||
87              (x[YY] < -box_margin) || (x[YY] > box[YY][YY]+box_margin) ||
88              (x[ZZ] < -box_margin) || (x[ZZ] > box[ZZ][ZZ]+box_margin) );
89 }
90
91 static int mark_res(int at, gmx_bool *mark, int natoms, t_atom *atom, int *nmark)
92 {
93     int resind;
94
95     resind = atom[at].resind;
96     while ( (at > 0) && (resind == atom[at-1].resind) )
97     {
98         at--;
99     }
100     while ( (at < natoms) && (resind == atom[at].resind) )
101     {
102         if (!mark[at])
103         {
104             mark[at] = TRUE;
105             (*nmark)++;
106         }
107         at++;
108     }
109
110     return at;
111 }
112
113 static real find_max_real(int n, real radius[])
114 {
115     int  i;
116     real rmax;
117
118     rmax = 0;
119     if (n > 0)
120     {
121         rmax = radius[0];
122         for (i = 1; (i < n); i++)
123         {
124             rmax = max(rmax, radius[i]);
125         }
126     }
127     return rmax;
128 }
129
130 static void combine_atoms(t_atoms *ap, t_atoms *as,
131                           rvec xp[], rvec *vp, rvec xs[], rvec *vs,
132                           t_atoms **a_comb, rvec **x_comb, rvec **v_comb)
133 {
134     t_atoms *ac;
135     rvec    *xc, *vc = NULL;
136     int      i, j, natot, res0;
137
138     /* Total number of atoms */
139     natot = ap->nr+as->nr;
140
141     snew(ac, 1);
142     init_t_atoms(ac, natot, FALSE);
143
144     snew(xc, natot);
145     if (vp && vs)
146     {
147         snew(vc, natot);
148     }
149
150     /* Fill the new structures */
151     for (i = j = 0; (i < ap->nr); i++, j++)
152     {
153         copy_rvec(xp[i], xc[j]);
154         if (vc)
155         {
156             copy_rvec(vp[i], vc[j]);
157         }
158         memcpy(&(ac->atom[j]), &(ap->atom[i]), sizeof(ap->atom[i]));
159         ac->atom[j].type = 0;
160     }
161     res0 = ap->nres;
162     for (i = 0; (i < as->nr); i++, j++)
163     {
164         copy_rvec(xs[i], xc[j]);
165         if (vc)
166         {
167             copy_rvec(vs[i], vc[j]);
168         }
169         memcpy(&(ac->atom[j]), &(as->atom[i]), sizeof(as->atom[i]));
170         ac->atom[j].type    = 0;
171         ac->atom[j].resind += res0;
172     }
173     ac->nr   = j;
174     ac->nres = ac->atom[j-1].resind+1;
175     /* Fill all elements to prevent uninitialized memory */
176     for (i = 0; i < ac->nr; i++)
177     {
178         ac->atom[i].m     = 1;
179         ac->atom[i].q     = 0;
180         ac->atom[i].mB    = 1;
181         ac->atom[i].qB    = 0;
182         ac->atom[i].type  = 0;
183         ac->atom[i].typeB = 0;
184         ac->atom[i].ptype = eptAtom;
185     }
186
187     /* Return values */
188     *a_comb = ac;
189     *x_comb = xc;
190     *v_comb = vc;
191 }
192
193 static t_forcerec *fr = NULL;
194
195 static void do_nsgrid(FILE *fp, gmx_bool bVerbose,
196                       matrix box, rvec x[], t_atoms *atoms, real rlong,
197                       const output_env_t oenv)
198 {
199     gmx_mtop_t     *mtop;
200     gmx_localtop_t *top;
201     t_mdatoms      *md;
202     t_block        *cgs;
203     t_inputrec     *ir;
204     t_nrnb          nrnb;
205     t_commrec      *cr;
206     int            *cg_index;
207     gmx_moltype_t  *molt;
208     gmx_ffparams_t *ffp;
209     ivec           *nFreeze;
210     int             i, m, natoms;
211     rvec            box_size;
212     real           *lambda, *dvdl;
213
214     natoms = atoms->nr;
215
216     /* Charge group index */
217     snew(cg_index, natoms);
218     for (i = 0; (i < natoms); i++)
219     {
220         cg_index[i] = i;
221     }
222
223     /* Topology needs charge groups and exclusions */
224     snew(mtop, 1);
225     init_mtop(mtop);
226     mtop->natoms = natoms;
227     /* Make one moltype that contains the whol system */
228     mtop->nmoltype = 1;
229     snew(mtop->moltype, mtop->nmoltype);
230     molt        = &mtop->moltype[0];
231     molt->name  = mtop->name;
232     molt->atoms = *atoms;
233     stupid_fill_block(&molt->cgs, mtop->natoms, FALSE);
234     stupid_fill_blocka(&molt->excls, natoms);
235     /* Make one molblock for the whole system */
236     mtop->nmolblock = 1;
237     snew(mtop->molblock, mtop->nmolblock);
238     mtop->molblock[0].type       = 0;
239     mtop->molblock[0].nmol       = 1;
240     mtop->molblock[0].natoms_mol = natoms;
241     /* Initialize a single energy group */
242     mtop->groups.grps[egcENER].nr = 1;
243     mtop->groups.ngrpnr[egcENER]  = 0;
244     mtop->groups.grpnr[egcENER]   = NULL;
245
246     ffp = &mtop->ffparams;
247
248     ffp->ntypes = 1;
249     ffp->atnr   = 1;
250     ffp->reppow = 12;
251     snew(ffp->functype, 1);
252     snew(ffp->iparams, 1);
253     ffp->iparams[0].lj.c6  = 1;
254     ffp->iparams[0].lj.c12 = 1;
255
256     /* inputrec structure */
257     snew(ir, 1);
258     ir->cutoff_scheme    = ecutsGROUP;
259     ir->coulomb_modifier = eintmodNONE;
260     ir->vdw_modifier     = eintmodNONE;
261     ir->coulombtype      = eelCUT;
262     ir->vdwtype          = evdwCUT;
263     ir->ndelta           = 2;
264     ir->ns_type          = ensGRID;
265     snew(ir->opts.egp_flags, 1);
266
267     top = gmx_mtop_generate_local_top(mtop, ir);
268
269     /* Some nasty shortcuts */
270     cgs  = &(top->cgs);
271
272     /* mdatoms structure */
273     snew(nFreeze, 2);
274     snew(md, 1);
275     md = init_mdatoms(fp, mtop, FALSE);
276     atoms2md(mtop, ir, 0, NULL, mtop->natoms, md);
277     sfree(nFreeze);
278
279     /* forcerec structure */
280     if (fr == NULL)
281     {
282         fr = mk_forcerec();
283     }
284     snew(cr, 1);
285     cr->nnodes   = 1;
286     /* cr->nthreads = 1; */
287
288     /*    ir->rlist       = ir->rcoulomb = ir->rvdw = rlong;
289        printf("Neighborsearching with a cut-off of %g\n",rlong);
290        init_forcerec(stdout,fr,ir,top,cr,md,box,FALSE,NULL,NULL,NULL,TRUE);*/
291     fr->cg0     = 0;
292     fr->hcg     = top->cgs.nr;
293     fr->nWatMol = 0;
294
295     /* Prepare for neighboursearching */
296     init_nrnb(&nrnb);
297
298     /* Init things dependent on parameters */
299     ir->rlistlong = ir->rlist = ir->rcoulomb = ir->rvdw = rlong;
300     /* create free energy data to avoid NULLs */
301     snew(ir->fepvals, 1);
302     printf("Neighborsearching with a cut-off of %g\n", rlong);
303     init_forcerec(stdout, oenv, fr, NULL, ir, mtop, cr, box,
304                   NULL, NULL, NULL, NULL, NULL, TRUE, -1);
305     if (debug)
306     {
307         pr_forcerec(debug, fr);
308     }
309
310     /* Calculate new stuff dependent on coords and box */
311     for (m = 0; (m < DIM); m++)
312     {
313         box_size[m] = box[m][m];
314     }
315     calc_shifts(box, fr->shift_vec);
316     put_charge_groups_in_box(fp, 0, cgs->nr, fr->ePBC, box, cgs, x, fr->cg_cm);
317
318     /* Do the actual neighboursearching */
319     snew(lambda, efptNR);
320     snew(dvdl, efptNR);
321     init_neighbor_list(fp, fr, md->homenr);
322     search_neighbours(fp, fr, box, top,
323                       &mtop->groups, cr, &nrnb, md, TRUE, FALSE);
324
325     if (debug)
326     {
327         dump_nblist(debug, cr, fr, 0);
328     }
329
330     if (bVerbose)
331     {
332         fprintf(stderr, "Successfully made neighbourlist\n");
333     }
334 }
335
336 static gmx_bool bXor(gmx_bool b1, gmx_bool b2)
337 {
338     return (b1 && !b2) || (b2 && !b1);
339 }
340
341 void add_conf(t_atoms *atoms, rvec **x, rvec **v, real **r, gmx_bool bSrenew,
342               int ePBC, matrix box, gmx_bool bInsert,
343               t_atoms *atoms_solvt, rvec *x_solvt, rvec *v_solvt, real *r_solvt,
344               gmx_bool bVerbose, real rshell, int max_sol, const output_env_t oenv)
345 {
346     t_nblist       *nlist;
347     t_atoms        *atoms_all;
348     real            max_vdw, *r_prot, *r_all, n2, r2, ib1, ib2;
349     int             natoms_prot, natoms_solvt;
350     int             i, j, jj, m, j0, j1, jjj, jnres, jnr, inr, iprot, is1, is2;
351     int             prev, resnr, nresadd, d, k, ncells, maxincell;
352     int             dx0, dx1, dy0, dy1, dz0, dz1;
353     int             ntest, nremove, nkeep;
354     rvec            dx, xi, xj, xpp, *x_all, *v_all;
355     gmx_bool       *remove, *keep;
356     int             bSolSol;
357
358     natoms_prot  = atoms->nr;
359     natoms_solvt = atoms_solvt->nr;
360     if (natoms_solvt <= 0)
361     {
362         fprintf(stderr, "WARNING: Nothing to add\n");
363         return;
364     }
365
366     if (ePBC == epbcSCREW)
367     {
368         gmx_fatal(FARGS, "Sorry, %s pbc is not yet supported", epbc_names[ePBC]);
369     }
370
371     if (bVerbose)
372     {
373         fprintf(stderr, "Calculating Overlap...\n");
374     }
375
376     /* Set margin around box edges to largest solvent dimension.
377      * The maximum distance between atoms in a solvent molecule should
378      * be calculated. At the moment a fudge factor of 3 is used.
379      */
380     r_prot     = *r;
381     box_margin = 3*find_max_real(natoms_solvt, r_solvt);
382     max_vdw    = max(3*find_max_real(natoms_prot, r_prot), box_margin);
383     fprintf(stderr, "box_margin = %g\n", box_margin);
384
385     snew(remove, natoms_solvt);
386
387     nremove = 0;
388     if (!bInsert)
389     {
390         for (i = 0; i < atoms_solvt->nr; i++)
391         {
392             if (outside_box_plus_margin(x_solvt[i], box) )
393             {
394                 i = mark_res(i, remove, atoms_solvt->nr, atoms_solvt->atom, &nremove);
395             }
396         }
397         fprintf(stderr, "Removed %d atoms that were outside the box\n", nremove);
398     }
399
400     /* Define grid stuff */
401     /* Largest VDW radius */
402     snew(r_all, natoms_prot+natoms_solvt);
403     for (i = j = 0; i < natoms_prot; i++, j++)
404     {
405         r_all[j] = r_prot[i];
406     }
407     for (i = 0; i < natoms_solvt; i++, j++)
408     {
409         r_all[j] = r_solvt[i];
410     }
411
412     /* Combine arrays */
413     combine_atoms(atoms, atoms_solvt, *x, v ? *v : NULL, x_solvt, v_solvt,
414                   &atoms_all, &x_all, &v_all);
415
416     /* Do neighboursearching step */
417     do_nsgrid(stdout, bVerbose, box, x_all, atoms_all, max_vdw, oenv);
418
419     /* check solvent with solute */
420     nlist = &(fr->nblists[0].nlist_sr[eNL_VDW]);
421     fprintf(stderr, "nri = %d, nrj = %d\n", nlist->nri, nlist->nrj);
422     for (bSolSol = 0; (bSolSol <= (bInsert ? 0 : 1)); bSolSol++)
423     {
424         ntest = nremove = 0;
425         fprintf(stderr, "Checking %s-Solvent overlap:",
426                 bSolSol ? "Solvent" : "Protein");
427         for (i = 0; (i < nlist->nri && nremove < natoms_solvt); i++)
428         {
429             inr = nlist->iinr[i];
430             j0  = nlist->jindex[i];
431             j1  = nlist->jindex[i+1];
432             rvec_add(x_all[inr], fr->shift_vec[nlist->shift[i]], xi);
433
434             for (j = j0; (j < j1 && nremove < natoms_solvt); j++)
435             {
436                 jnr = nlist->jjnr[j];
437                 copy_rvec(x_all[jnr], xj);
438
439                 /* Check solvent-protein and solvent-solvent */
440                 is1 = inr-natoms_prot;
441                 is2 = jnr-natoms_prot;
442
443                 /* Check if at least one of the atoms is a solvent that is not yet
444                  * listed for removal, and if both are solvent, that they are not in the
445                  * same residue.
446                  */
447                 if ((!bSolSol &&
448                      bXor((is1 >= 0), (is2 >= 0)) && /* One atom is protein */
449                      ((is1 < 0) || ((is1 >= 0) && !remove[is1])) &&
450                      ((is2 < 0) || ((is2 >= 0) && !remove[is2]))) ||
451
452                     (bSolSol  &&
453                      (is1 >= 0) && (!remove[is1]) &&                   /* is1 is solvent */
454                      (is2 >= 0) && (!remove[is2]) &&                   /* is2 is solvent */
455                      (bInsert ||                                       /* when inserting also check inside the box */
456                       (outside_box_minus_margin2(x_solvt[is1], box) && /* is1 on edge */
457                        outside_box_minus_margin2(x_solvt[is2], box))   /* is2 on edge */
458                      ) &&
459                      (atoms_solvt->atom[is1].resind !=                 /* Not the same residue */
460                       atoms_solvt->atom[is2].resind)))
461                 {
462
463                     ntest++;
464                     rvec_sub(xi, xj, dx);
465                     n2 = norm2(dx);
466                     r2 = sqr(r_all[inr]+r_all[jnr]);
467                     if (n2 < r2)
468                     {
469                         if (bInsert)
470                         {
471                             nremove = natoms_solvt;
472                             for (k = 0; k < nremove; k++)
473                             {
474                                 remove[k] = TRUE;
475                             }
476                         }
477                         /* Need only remove one of the solvents... */
478                         if (is2 >= 0)
479                         {
480                             (void) mark_res(is2, remove, natoms_solvt, atoms_solvt->atom,
481                                             &nremove);
482                         }
483                         else if (is1 >= 0)
484                         {
485                             (void) mark_res(is1, remove, natoms_solvt, atoms_solvt->atom,
486                                             &nremove);
487                         }
488                         else
489                         {
490                             fprintf(stderr, "Neither atom is solvent%d %d\n", is1, is2);
491                         }
492                     }
493                 }
494             }
495         }
496         if (!bInsert)
497         {
498             fprintf(stderr, " tested %d pairs, removed %d atoms.\n", ntest, nremove);
499         }
500     }
501     if (debug)
502     {
503         for (i = 0; i < natoms_solvt; i++)
504         {
505             fprintf(debug, "remove[%5d] = %s\n", i, bool_names[remove[i]]);
506         }
507     }
508
509     /* Search again, now with another cut-off */
510     if (rshell > 0)
511     {
512         do_nsgrid(stdout, bVerbose, box, x_all, atoms_all, rshell, oenv);
513         nlist = &(fr->nblists[0].nlist_sr[eNL_VDW]);
514         fprintf(stderr, "nri = %d, nrj = %d\n", nlist->nri, nlist->nrj);
515         nkeep = 0;
516         snew(keep, natoms_solvt);
517         for (i = 0; i < nlist->nri; i++)
518         {
519             inr = nlist->iinr[i];
520             j0  = nlist->jindex[i];
521             j1  = nlist->jindex[i+1];
522
523             for (j = j0; j < j1; j++)
524             {
525                 jnr = nlist->jjnr[j];
526
527                 /* Check solvent-protein and solvent-solvent */
528                 is1 = inr-natoms_prot;
529                 is2 = jnr-natoms_prot;
530
531                 /* Check if at least one of the atoms is a solvent that is not yet
532                  * listed for removal, and if both are solvent, that they are not in the
533                  * same residue.
534                  */
535                 if (is1 >= 0 && is2 < 0)
536                 {
537                     mark_res(is1, keep, natoms_solvt, atoms_solvt->atom, &nkeep);
538                 }
539                 else if (is1 < 0 && is2 >= 0)
540                 {
541                     mark_res(is2, keep, natoms_solvt, atoms_solvt->atom, &nkeep);
542                 }
543             }
544         }
545         fprintf(stderr, "Keeping %d solvent atoms after proximity check\n",
546                 nkeep);
547         for (i = 0; i < natoms_solvt; i++)
548         {
549             remove[i] = remove[i] || !keep[i];
550         }
551         sfree(keep);
552     }
553     /* count how many atoms and residues will be added and make space */
554     if (bInsert)
555     {
556         j     = atoms_solvt->nr;
557         jnres = atoms_solvt->nres;
558     }
559     else
560     {
561         j     = 0;
562         jnres = 0;
563         for (i = 0; ((i < atoms_solvt->nr) &&
564                      ((max_sol == 0) || (jnres < max_sol))); i++)
565         {
566             if (!remove[i])
567             {
568                 j++;
569                 if ((i == 0) ||
570                     (atoms_solvt->atom[i].resind != atoms_solvt->atom[i-1].resind))
571                 {
572                     jnres++;
573                 }
574             }
575         }
576     }
577     if (debug)
578     {
579         fprintf(debug, "Will add %d atoms in %d residues\n", j, jnres);
580     }
581     if (!bInsert)
582     {
583         /* Flag the remaing solvent atoms to be removed */
584         jjj = atoms_solvt->atom[i-1].resind;
585         for (; (i < atoms_solvt->nr); i++)
586         {
587             if (atoms_solvt->atom[i].resind > jjj)
588             {
589                 remove[i] = TRUE;
590             }
591             else
592             {
593                 j++;
594             }
595         }
596     }
597
598     if (bSrenew)
599     {
600         srenew(atoms->resinfo,  atoms->nres+jnres);
601         srenew(atoms->atomname, atoms->nr+j);
602         srenew(atoms->atom,     atoms->nr+j);
603         srenew(*x,              atoms->nr+j);
604         if (v)
605         {
606             srenew(*v,       atoms->nr+j);
607         }
608         srenew(*r,              atoms->nr+j);
609     }
610
611     /* add the selected atoms_solvt to atoms */
612     if (atoms->nr > 0)
613     {
614         resnr = atoms->resinfo[atoms->atom[atoms->nr-1].resind].nr;
615     }
616     else
617     {
618         resnr = 0;
619     }
620     prev    = -1;
621     nresadd = 0;
622     for (i = 0; i < atoms_solvt->nr; i++)
623     {
624         if (!remove[i])
625         {
626             if (prev == -1 ||
627                 atoms_solvt->atom[i].resind != atoms_solvt->atom[prev].resind)
628             {
629                 nresadd++;
630                 atoms->nres++;
631                 resnr++;
632                 atoms->resinfo[atoms->nres-1] =
633                     atoms_solvt->resinfo[atoms_solvt->atom[i].resind];
634                 atoms->resinfo[atoms->nres-1].nr = resnr;
635                 /* calculate shift of the solvent molecule using the first atom */
636                 copy_rvec(x_solvt[i], dx);
637                 put_atoms_in_box(ePBC, box, 1, &dx);
638                 rvec_dec(dx, x_solvt[i]);
639             }
640             atoms->atom[atoms->nr]     = atoms_solvt->atom[i];
641             atoms->atomname[atoms->nr] = atoms_solvt->atomname[i];
642             rvec_add(x_solvt[i], dx, (*x)[atoms->nr]);
643             if (v)
644             {
645                 copy_rvec(v_solvt[i], (*v)[atoms->nr]);
646             }
647             (*r)[atoms->nr]               = r_solvt[i];
648             atoms->atom[atoms->nr].resind = atoms->nres-1;
649             atoms->nr++;
650             prev = i;
651         }
652     }
653     if (bSrenew)
654     {
655         srenew(atoms->resinfo,  atoms->nres+nresadd);
656     }
657
658     if (bVerbose)
659     {
660         fprintf(stderr, "Added %d molecules\n", nresadd);
661     }
662
663     sfree(remove);
664     done_atom(atoms_all);
665     sfree(x_all);
666     sfree(v_all);
667 }