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