Merge release-4-6 into master
[alexxy/gromacs.git] / src / gromacs / gmxpreprocess / convparm.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 /* This file is completely threadsafe - keep it that way! */
38 #ifdef HAVE_CONFIG_H
39 #include <config.h>
40 #endif
41
42 #include <math.h>
43 #include "sysstuff.h"
44 #include "physics.h"
45 #include "vec.h"
46 #include "smalloc.h"
47 #include "typedefs.h"
48 #include "gmx_fatal.h"
49 #include "topio.h"
50 #include "toputil.h"
51 #include "convparm.h"
52 #include "names.h"
53 #include "gpp_atomtype.h"
54 #include "gromacs/math/utilities.h"
55
56 static int round_check(real r, int limit, int ftype, const char *name)
57 {
58     int i;
59
60     if (r >= 0)
61     {
62         i = (int)(r + 0.5);
63     }
64     else
65     {
66         i = (int)(r - 0.5);
67     }
68
69     if (r-i > 0.01 || r-i < -0.01)
70     {
71         gmx_fatal(FARGS, "A non-integer value (%f) was supplied for '%s' in %s",
72                   r, name, interaction_function[ftype].longname);
73     }
74
75     if (i < limit)
76     {
77         gmx_fatal(FARGS, "Value of '%s' in %s is %d, which is smaller than the minimum of %d",
78                   name, interaction_function[ftype].longname, i, limit);
79     }
80
81     return i;
82 }
83
84 static void set_ljparams(int comb, double reppow, real v, real w,
85                          real *c6, real *c12)
86 {
87     if (comb == eCOMB_ARITHMETIC || comb == eCOMB_GEOM_SIG_EPS)
88     {
89         if (v >= 0)
90         {
91             *c6  = 4*w*pow(v, 6.0);
92             *c12 = 4*w*pow(v, reppow);
93         }
94         else
95         {
96             /* Interpret negative sigma as c6=0 and c12 with -sigma */
97             *c6  = 0;
98             *c12 = 4*w*pow(-v, reppow);
99         }
100     }
101     else
102     {
103         *c6  = v;
104         *c12 = w;
105     }
106 }
107
108 /* A return value of 0 means parameters were assigned successfully,
109  * returning -1 means this is an all-zero interaction that should not be added.
110  */
111 static int
112 assign_param(t_functype ftype, t_iparams *newparam,
113              real old[MAXFORCEPARAM], int comb, double reppow)
114 {
115     int      i, j;
116     real     tmp;
117     gmx_bool all_param_zero = TRUE;
118
119     /* Set to zero */
120     for (j = 0; (j < MAXFORCEPARAM); j++)
121     {
122         newparam->generic.buf[j] = 0.0;
123         /* If all parameters are zero we might not add some interaction types (selected below).
124          * We cannot apply this to ALL interactions, since many have valid reasons for having
125          * zero parameters (e.g. an index to a Cmap interaction, or LJ parameters), but
126          * we use it for angles and torsions that are typically generated automatically.
127          */
128         all_param_zero = (all_param_zero == TRUE) && fabs(old[j]) < GMX_REAL_MIN;
129     }
130
131     if (all_param_zero == TRUE)
132     {
133         if (IS_ANGLE(ftype) || IS_RESTRAINT_TYPE(ftype) || ftype == F_IDIHS ||
134             ftype == F_PDIHS || ftype == F_PIDIHS || ftype == F_RBDIHS || ftype == F_FOURDIHS)
135         {
136             return -1;
137         }
138     }
139
140     switch (ftype)
141     {
142         case F_G96ANGLES:
143             /* Post processing of input data: store cosine iso angle itself */
144             newparam->harmonic.rA  = cos(old[0]*DEG2RAD);
145             newparam->harmonic.krA = old[1];
146             newparam->harmonic.rB  = cos(old[2]*DEG2RAD);
147             newparam->harmonic.krB = old[3];
148             break;
149         case F_G96BONDS:
150             /* Post processing of input data: store square of length itself */
151             newparam->harmonic.rA  = sqr(old[0]);
152             newparam->harmonic.krA = old[1];
153             newparam->harmonic.rB  = sqr(old[2]);
154             newparam->harmonic.krB = old[3];
155             break;
156         case F_FENEBONDS:
157             newparam->fene.bm = old[0];
158             newparam->fene.kb = old[1];
159             break;
160         case F_RESTRBONDS:
161             newparam->restraint.lowA = old[0];
162             newparam->restraint.up1A = old[1];
163             newparam->restraint.up2A = old[2];
164             newparam->restraint.kA   = old[3];
165             newparam->restraint.lowB = old[4];
166             newparam->restraint.up1B = old[5];
167             newparam->restraint.up2B = old[6];
168             newparam->restraint.kB   = old[7];
169             break;
170         case F_TABBONDS:
171         case F_TABBONDSNC:
172         case F_TABANGLES:
173         case F_TABDIHS:
174             newparam->tab.table = round_check(old[0], 0, ftype, "table index");
175             newparam->tab.kA    = old[1];
176             newparam->tab.kB    = old[3];
177             break;
178         case F_CROSS_BOND_BONDS:
179             newparam->cross_bb.r1e = old[0];
180             newparam->cross_bb.r2e = old[1];
181             newparam->cross_bb.krr = old[2];
182             break;
183         case F_CROSS_BOND_ANGLES:
184             newparam->cross_ba.r1e = old[0];
185             newparam->cross_ba.r2e = old[1];
186             newparam->cross_ba.r3e = old[2];
187             newparam->cross_ba.krt = old[3];
188             break;
189         case F_UREY_BRADLEY:
190             newparam->u_b.thetaA  = old[0];
191             newparam->u_b.kthetaA = old[1];
192             newparam->u_b.r13A    = old[2];
193             newparam->u_b.kUBA    = old[3];
194             newparam->u_b.thetaB  = old[4];
195             newparam->u_b.kthetaB = old[5];
196             newparam->u_b.r13B    = old[6];
197             newparam->u_b.kUBB    = old[7];
198             break;
199         case F_QUARTIC_ANGLES:
200             newparam->qangle.theta = old[0];
201             for (i = 0; i < 5; i++)
202             {
203                 newparam->qangle.c[i] = old[i+1];
204             }
205             break;
206         case F_LINEAR_ANGLES:
207             newparam->linangle.aA    = old[0];
208             newparam->linangle.klinA = old[1];
209             newparam->linangle.aB    = old[2];
210             newparam->linangle.klinB = old[3];
211             break;
212         case F_BONDS:
213         case F_ANGLES:
214         case F_HARMONIC:
215         case F_IDIHS:
216             newparam->harmonic.rA  = old[0];
217             newparam->harmonic.krA = old[1];
218             newparam->harmonic.rB  = old[2];
219             newparam->harmonic.krB = old[3];
220             break;
221         case F_MORSE:
222             newparam->morse.b0A    = old[0];
223             newparam->morse.cbA    = old[1];
224             newparam->morse.betaA  = old[2];
225             newparam->morse.b0B    = old[3];
226             newparam->morse.cbB    = old[4];
227             newparam->morse.betaB  = old[5];
228             break;
229         case F_CUBICBONDS:
230             newparam->cubic.b0    = old[0];
231             newparam->cubic.kb    = old[1];
232             newparam->cubic.kcub  = old[2];
233             break;
234         case F_CONNBONDS:
235             break;
236         case F_POLARIZATION:
237             newparam->polarize.alpha = old[0];
238             break;
239         case F_ANHARM_POL:
240             newparam->anharm_polarize.alpha = old[0];
241             newparam->anharm_polarize.drcut = old[1];
242             newparam->anharm_polarize.khyp  = old[2];
243             break;
244         case F_WATER_POL:
245             newparam->wpol.al_x   = old[0];
246             newparam->wpol.al_y   = old[1];
247             newparam->wpol.al_z   = old[2];
248             newparam->wpol.rOH    = old[3];
249             newparam->wpol.rHH    = old[4];
250             newparam->wpol.rOD    = old[5];
251             break;
252         case F_THOLE_POL:
253             newparam->thole.a      = old[0];
254             newparam->thole.alpha1 = old[1];
255             newparam->thole.alpha2 = old[2];
256             if ((old[1] > 0) && (old[2] > 0))
257             {
258                 newparam->thole.rfac = old[0]*pow(old[1]*old[2], -1.0/6.0);
259             }
260             else
261             {
262                 newparam->thole.rfac = 1;
263             }
264             break;
265         case F_BHAM:
266             newparam->bham.a = old[0];
267             newparam->bham.b = old[1];
268             newparam->bham.c = old[2];
269             break;
270         case F_LJ14:
271             set_ljparams(comb, reppow, old[0], old[1], &newparam->lj14.c6A, &newparam->lj14.c12A);
272             set_ljparams(comb, reppow, old[2], old[3], &newparam->lj14.c6B, &newparam->lj14.c12B);
273             break;
274         case F_LJC14_Q:
275             newparam->ljc14.fqq = old[0];
276             newparam->ljc14.qi  = old[1];
277             newparam->ljc14.qj  = old[2];
278             set_ljparams(comb, reppow, old[3], old[4], &newparam->ljc14.c6, &newparam->ljc14.c12);
279             break;
280         case F_LJC_PAIRS_NB:
281             newparam->ljcnb.qi = old[0];
282             newparam->ljcnb.qj = old[1];
283             set_ljparams(comb, reppow, old[2], old[3], &newparam->ljcnb.c6, &newparam->ljcnb.c12);
284             break;
285         case F_LJ:
286             set_ljparams(comb, reppow, old[0], old[1], &newparam->lj.c6, &newparam->lj.c12);
287             break;
288         case F_PDIHS:
289         case F_PIDIHS:
290         case F_ANGRES:
291         case F_ANGRESZ:
292             newparam->pdihs.phiA = old[0];
293             newparam->pdihs.cpA  = old[1];
294
295             /* Change 20100720: Amber occasionally uses negative multiplicities (mathematically OK),
296              * so I have changed the lower limit to -99 /EL
297              */
298             newparam->pdihs.phiB = old[3];
299             newparam->pdihs.cpB  = old[4];
300             /* If both force constants are zero there is no interaction. Return -1 to signal
301              * this entry should NOT be added.
302              */
303             if (fabs(newparam->pdihs.cpA) < GMX_REAL_MIN && fabs(newparam->pdihs.cpB) < GMX_REAL_MIN)
304             {
305                 return -1;
306             }
307
308             newparam->pdihs.mult = round_check(old[2], -99, ftype, "multiplicity");
309
310             break;
311         case F_POSRES:
312             newparam->posres.fcA[XX]   = old[0];
313             newparam->posres.fcA[YY]   = old[1];
314             newparam->posres.fcA[ZZ]   = old[2];
315             newparam->posres.fcB[XX]   = old[3];
316             newparam->posres.fcB[YY]   = old[4];
317             newparam->posres.fcB[ZZ]   = old[5];
318             newparam->posres.pos0A[XX] = old[6];
319             newparam->posres.pos0A[YY] = old[7];
320             newparam->posres.pos0A[ZZ] = old[8];
321             newparam->posres.pos0B[XX] = old[9];
322             newparam->posres.pos0B[YY] = old[10];
323             newparam->posres.pos0B[ZZ] = old[11];
324             break;
325         case F_FBPOSRES:
326             newparam->fbposres.geom     = round_check(old[0], 0, ftype, "geometry");
327             if (!(newparam->fbposres.geom > efbposresZERO && newparam->fbposres.geom < efbposresNR))
328             {
329                 gmx_fatal(FARGS, "Invalid geometry for flat-bottomed position restraint.\n"
330                           "Expected number between 1 and %d. Found %d\n", efbposresNR-1,
331                           newparam->fbposres.geom);
332             }
333             newparam->fbposres.r        = old[1];
334             newparam->fbposres.k        = old[2];
335             newparam->fbposres.pos0[XX] = old[3];
336             newparam->fbposres.pos0[YY] = old[4];
337             newparam->fbposres.pos0[ZZ] = old[5];
338             break;
339         case F_DISRES:
340             newparam->disres.label = round_check(old[0], 0, ftype, "label");
341             newparam->disres.type  = round_check(old[1], 1, ftype, "type'");
342             newparam->disres.low   = old[2];
343             newparam->disres.up1   = old[3];
344             newparam->disres.up2   = old[4];
345             newparam->disres.kfac  = old[5];
346             break;
347         case F_ORIRES:
348             newparam->orires.ex    = round_check(old[0], 1, ftype, "experiment") - 1;
349             newparam->orires.label = round_check(old[1], 1, ftype, "label");
350             newparam->orires.power = round_check(old[2], 0, ftype, "power");
351             newparam->orires.c     = old[3];
352             newparam->orires.obs   = old[4];
353             newparam->orires.kfac  = old[5];
354             break;
355         case F_DIHRES:
356             newparam->dihres.phiA   = old[0];
357             newparam->dihres.dphiA  = old[1];
358             newparam->dihres.kfacA  = old[2];
359             newparam->dihres.phiB   = old[3];
360             newparam->dihres.dphiB  = old[4];
361             newparam->dihres.kfacB  = old[5];
362             break;
363         case F_RBDIHS:
364             for (i = 0; (i < NR_RBDIHS); i++)
365             {
366                 newparam->rbdihs.rbcA[i] = old[i];
367                 newparam->rbdihs.rbcB[i] = old[NR_RBDIHS+i];
368             }
369             break;
370         case F_FOURDIHS:
371             /* Read the dihedral parameters to temporary arrays,
372              * and convert them to the computationally faster
373              * Ryckaert-Bellemans form.
374              */
375             /* Use conversion formula for OPLS to Ryckaert-Bellemans: */
376             newparam->rbdihs.rbcA[0] = old[1]+0.5*(old[0]+old[2]);
377             newparam->rbdihs.rbcA[1] = 0.5*(3.0*old[2]-old[0]);
378             newparam->rbdihs.rbcA[2] = 4.0*old[3]-old[1];
379             newparam->rbdihs.rbcA[3] = -2.0*old[2];
380             newparam->rbdihs.rbcA[4] = -4.0*old[3];
381             newparam->rbdihs.rbcA[5] = 0.0;
382
383             newparam->rbdihs.rbcB[0] = old[NR_FOURDIHS+1]+0.5*(old[NR_FOURDIHS+0]+old[NR_FOURDIHS+2]);
384             newparam->rbdihs.rbcB[1] = 0.5*(3.0*old[NR_FOURDIHS+2]-old[NR_FOURDIHS+0]);
385             newparam->rbdihs.rbcB[2] = 4.0*old[NR_FOURDIHS+3]-old[NR_FOURDIHS+1];
386             newparam->rbdihs.rbcB[3] = -2.0*old[NR_FOURDIHS+2];
387             newparam->rbdihs.rbcB[4] = -4.0*old[NR_FOURDIHS+3];
388             newparam->rbdihs.rbcB[5] = 0.0;
389             break;
390         case F_CONSTR:
391         case F_CONSTRNC:
392             newparam->constr.dA = old[0];
393             newparam->constr.dB = old[1];
394             break;
395         case F_SETTLE:
396             newparam->settle.doh = old[0];
397             newparam->settle.dhh = old[1];
398             break;
399         case F_VSITE2:
400         case F_VSITE3:
401         case F_VSITE3FD:
402         case F_VSITE3OUT:
403         case F_VSITE4FD:
404         case F_VSITE4FDN:
405             newparam->vsite.a = old[0];
406             newparam->vsite.b = old[1];
407             newparam->vsite.c = old[2];
408             newparam->vsite.d = old[3];
409             newparam->vsite.e = old[4];
410             newparam->vsite.f = old[5];
411             break;
412         case F_VSITE3FAD:
413             newparam->vsite.a = old[1] * cos(DEG2RAD * old[0]);
414             newparam->vsite.b = old[1] * sin(DEG2RAD * old[0]);
415             newparam->vsite.c = old[2];
416             newparam->vsite.d = old[3];
417             newparam->vsite.e = old[4];
418             newparam->vsite.f = old[5];
419             break;
420         case F_VSITEN:
421             newparam->vsiten.n = round_check(old[0], 1, ftype, "number of atoms");
422             newparam->vsiten.a = old[1];
423             break;
424         case F_CMAP:
425             newparam->cmap.cmapA = old[0];
426             newparam->cmap.cmapB = old[1];
427             break;
428         case F_GB12:
429         case F_GB13:
430         case F_GB14:
431             newparam->gb.sar  = old[0];
432             newparam->gb.st   = old[1];
433             newparam->gb.pi   = old[2];
434             newparam->gb.gbr  = old[3];
435             newparam->gb.bmlt = old[4];
436             break;
437         default:
438             gmx_fatal(FARGS, "unknown function type %d in %s line %d",
439                       ftype, __FILE__, __LINE__);
440     }
441     return 0;
442 }
443
444 static int enter_params(gmx_ffparams_t *ffparams, t_functype ftype,
445                         real forceparams[MAXFORCEPARAM], int comb, real reppow,
446                         int start, gmx_bool bAppend)
447 {
448     t_iparams newparam;
449     int       type;
450     int       rc;
451
452     if ( (rc = assign_param(ftype, &newparam, forceparams, comb, reppow)) < 0)
453     {
454         /* -1 means this interaction is all-zero and should not be added */
455         return rc;
456     }
457
458     if (!bAppend)
459     {
460         for (type = start; (type < ffparams->ntypes); type++)
461         {
462             if (ffparams->functype[type] == ftype)
463             {
464                 if (F_GB13 == ftype)
465                 {
466                     /* Occasionally, the way the 1-3 reference distance is
467                      * computed can lead to non-binary-identical results, but I
468                      * don't know why. */
469                     if ((gmx_within_tol(newparam.gb.sar,  ffparams->iparams[type].gb.sar,  1e-6)) &&
470                         (gmx_within_tol(newparam.gb.st,   ffparams->iparams[type].gb.st,   1e-6)) &&
471                         (gmx_within_tol(newparam.gb.pi,   ffparams->iparams[type].gb.pi,   1e-6)) &&
472                         (gmx_within_tol(newparam.gb.gbr,  ffparams->iparams[type].gb.gbr,  1e-6)) &&
473                         (gmx_within_tol(newparam.gb.bmlt, ffparams->iparams[type].gb.bmlt, 1e-6)))
474                     {
475                         return type;
476                     }
477                 }
478                 else
479                 {
480                     if (memcmp(&newparam, &ffparams->iparams[type], (size_t)sizeof(newparam)) == 0)
481                     {
482                         return type;
483                     }
484                 }
485             }
486         }
487     }
488     else
489     {
490         type = ffparams->ntypes;
491     }
492     if (debug)
493     {
494         fprintf(debug, "copying newparam to ffparams->iparams[%d] (ntypes=%d)\n",
495                 type, ffparams->ntypes);
496     }
497     memcpy(&ffparams->iparams[type], &newparam, (size_t)sizeof(newparam));
498
499     ffparams->ntypes++;
500     ffparams->functype[type] = ftype;
501
502     return type;
503 }
504
505 static void append_interaction(t_ilist *ilist,
506                                int type, int nral, atom_id a[MAXATOMLIST])
507 {
508     int i, where1;
509
510     where1     = ilist->nr;
511     ilist->nr += nral+1;
512
513     ilist->iatoms[where1++] = type;
514     for (i = 0; (i < nral); i++)
515     {
516         ilist->iatoms[where1++] = a[i];
517     }
518 }
519
520 static void enter_function(t_params *p, t_functype ftype, int comb, real reppow,
521                            gmx_ffparams_t *ffparams, t_ilist *il,
522                            int *maxtypes,
523                            gmx_bool bNB, gmx_bool bAppend)
524 {
525     int     k, type, nr, nral, delta, start;
526
527     start = ffparams->ntypes;
528     nr    = p->nr;
529
530     for (k = 0; k < nr; k++)
531     {
532         if (*maxtypes <= ffparams->ntypes)
533         {
534             *maxtypes += 1000;
535             srenew(ffparams->functype, *maxtypes);
536             srenew(ffparams->iparams, *maxtypes);
537             if (debug)
538             {
539                 fprintf(debug, "%s, line %d: srenewed idef->functype and idef->iparams to %d\n",
540                         __FILE__, __LINE__, *maxtypes);
541             }
542         }
543         type = enter_params(ffparams, ftype, p->param[k].c, comb, reppow, start, bAppend);
544         /* Type==-1 is used as a signal that this interaction is all-zero and should not be added. */
545         if (!bNB && type >= 0)
546         {
547             nral  = NRAL(ftype);
548             delta = nr*(nral+1);
549             srenew(il->iatoms, il->nr+delta);
550             append_interaction(il, type, nral, p->param[k].a);
551         }
552     }
553 }
554
555 void convert_params(int atnr, t_params nbtypes[],
556                     t_molinfo *mi, int comb, double reppow, real fudgeQQ,
557                     gmx_mtop_t *mtop)
558 {
559     int             i, j, maxtypes, mt;
560     unsigned long   flags;
561     gmx_ffparams_t *ffp;
562     gmx_moltype_t  *molt;
563     t_params       *plist;
564
565     maxtypes = 0;
566
567     ffp           = &mtop->ffparams;
568     ffp->ntypes   = 0;
569     ffp->atnr     = atnr;
570     ffp->functype = NULL;
571     ffp->iparams  = NULL;
572     ffp->reppow   = reppow;
573
574     enter_function(&(nbtypes[F_LJ]),  (t_functype)F_LJ,    comb, reppow, ffp, NULL,
575                    &maxtypes, TRUE, TRUE);
576     enter_function(&(nbtypes[F_BHAM]), (t_functype)F_BHAM,  comb, reppow, ffp, NULL,
577                    &maxtypes, TRUE, TRUE);
578
579     for (mt = 0; mt < mtop->nmoltype; mt++)
580     {
581         molt = &mtop->moltype[mt];
582         for (i = 0; (i < F_NRE); i++)
583         {
584             molt->ilist[i].nr     = 0;
585             molt->ilist[i].iatoms = NULL;
586
587             plist = mi[mt].plist;
588
589             flags = interaction_function[i].flags;
590             if ((i != F_LJ) && (i != F_BHAM) && ((flags & IF_BOND) ||
591                                                  (flags & IF_VSITE) ||
592                                                  (flags & IF_CONSTRAINT)))
593             {
594                 enter_function(&(plist[i]), (t_functype)i, comb, reppow,
595                                ffp, &molt->ilist[i],
596                                &maxtypes, FALSE, (i == F_POSRES  || i == F_FBPOSRES));
597             }
598         }
599     }
600     if (debug)
601     {
602         fprintf(debug, "%s, line %d: There are %d functypes in idef\n",
603                 __FILE__, __LINE__, ffp->ntypes);
604     }
605
606     ffp->fudgeQQ = fudgeQQ;
607 }