Merge release-4-6 into master
[alexxy/gromacs.git] / src / programs / grompp / convparm.c
1 /*
2  * 
3  *                This source code is part of
4  * 
5  *                 G   R   O   M   A   C   S
6  * 
7  *          GROningen MAchine for Chemical Simulations
8  * 
9  *                        VERSION 3.2.0
10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
12  * Copyright (c) 2001-2004, The GROMACS development team,
13  * check out http://www.gromacs.org for more information.
14
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * as published by the Free Software Foundation; either version 2
18  * of the License, or (at your option) any later version.
19  * 
20  * If you want to redistribute modifications, please consider that
21  * scientific software is very special. Version control is crucial -
22  * bugs must be traceable. We will be happy to consider code for
23  * inclusion in the official distribution, but derived work must not
24  * be called official GROMACS. Details are found in the README & COPYING
25  * files - if they are missing, get the official version at www.gromacs.org.
26  * 
27  * To help us fund GROMACS development, we humbly ask that you cite
28  * the papers on the package - you can find them in the top README file.
29  * 
30  * For more info, check our website at http://www.gromacs.org
31  * 
32  * And Hey:
33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
34  */
35 /* This file is completely threadsafe - keep it that way! */
36 #ifdef HAVE_CONFIG_H
37 #include <config.h>
38 #endif
39
40 #include <math.h>
41 #include "sysstuff.h"
42 #include "physics.h"
43 #include "vec.h"
44 #include "smalloc.h"
45 #include "typedefs.h"
46 #include "gmx_fatal.h"
47 #include "topio.h"
48 #include "toputil.h"
49 #include "convparm.h"
50 #include "names.h"
51 #include "gpp_atomtype.h"
52 #include "maths.h"
53
54 static int round_check(real r,int limit,int ftype,const char *name)
55 {
56   int i;
57
58   if (r >= 0)
59     i = (int)(r + 0.5);
60   else
61     i = (int)(r - 0.5);
62
63   if (r-i > 0.01 || r-i < -0.01)
64     gmx_fatal(FARGS,"A non-integer value (%f) was supplied for '%s' in %s",
65               r,name,interaction_function[ftype].longname);
66
67   if (i < limit)
68     gmx_fatal(FARGS,"Value of '%s' in %s is %d, which is smaller than the minimum of %d",
69               name,interaction_function[ftype].longname,i,limit);
70
71   return i;
72 }
73
74 static void set_ljparams(int comb,double reppow,real v,real w,
75                          real *c6,real *c12)
76 {
77   if (comb == eCOMB_ARITHMETIC || comb == eCOMB_GEOM_SIG_EPS) {
78     if (v >= 0) {
79       *c6  = 4*w*pow(v,6.0);
80       *c12 = 4*w*pow(v,reppow);
81     } else {
82       /* Interpret negative sigma as c6=0 and c12 with -sigma */
83       *c6  = 0;
84       *c12 = 4*w*pow(-v,reppow);
85     }
86   } else {
87     *c6  = v;
88     *c12 = w;
89   }
90 }
91
92 static void assign_param(t_functype ftype,t_iparams *newparam,
93                          real old[MAXFORCEPARAM],int comb,double reppow)
94 {
95   int  i,j;
96   real tmp;
97
98   /* Set to zero */
99   for(j=0; (j<MAXFORCEPARAM); j++) 
100     {
101       newparam->generic.buf[j]=0.0;
102     }
103   switch (ftype) {
104   case F_G96ANGLES:
105     /* Post processing of input data: store cosine iso angle itself */
106     newparam->harmonic.rA =cos(old[0]*DEG2RAD);
107     newparam->harmonic.krA=old[1];
108     newparam->harmonic.rB =cos(old[2]*DEG2RAD);
109     newparam->harmonic.krB=old[3];
110     break;
111   case F_G96BONDS:
112     /* Post processing of input data: store square of length itself */
113     newparam->harmonic.rA =sqr(old[0]);
114     newparam->harmonic.krA=old[1];
115     newparam->harmonic.rB =sqr(old[2]);
116     newparam->harmonic.krB=old[3];
117     break;
118   case F_FENEBONDS:
119     newparam->fene.bm=old[0];
120     newparam->fene.kb=old[1];
121     break;
122   case F_RESTRBONDS:
123     newparam->restraint.lowA = old[0];
124     newparam->restraint.up1A = old[1];
125     newparam->restraint.up2A = old[2];
126     newparam->restraint.kA   = old[3];
127     newparam->restraint.lowB = old[4];
128     newparam->restraint.up1B = old[5];
129     newparam->restraint.up2B = old[6];
130     newparam->restraint.kB   = old[7];
131     break;
132   case F_TABBONDS:
133   case F_TABBONDSNC:
134   case F_TABANGLES:
135   case F_TABDIHS:
136     newparam->tab.table = round_check(old[0],0,ftype,"table index");
137     newparam->tab.kA    = old[1];
138     newparam->tab.kB    = old[3];
139     break;
140   case F_CROSS_BOND_BONDS:
141     newparam->cross_bb.r1e=old[0];
142     newparam->cross_bb.r2e=old[1];
143     newparam->cross_bb.krr=old[2];
144     break;
145   case F_CROSS_BOND_ANGLES:
146     newparam->cross_ba.r1e=old[0];
147     newparam->cross_ba.r2e=old[1];
148     newparam->cross_ba.r3e=old[2];
149     newparam->cross_ba.krt=old[3];
150     break;
151   case F_UREY_BRADLEY:
152     newparam->u_b.thetaA=old[0];
153     newparam->u_b.kthetaA=old[1];
154     newparam->u_b.r13A=old[2];
155     newparam->u_b.kUBA=old[3];
156     newparam->u_b.thetaB=old[4];
157     newparam->u_b.kthetaB=old[5];
158     newparam->u_b.r13B=old[6];
159     newparam->u_b.kUBB=old[7];
160     break;
161   case F_QUARTIC_ANGLES:
162     newparam->qangle.theta=old[0];
163     for(i=0; i<5; i++)
164       newparam->qangle.c[i]=old[i+1];
165     break;
166   case F_LINEAR_ANGLES:
167     newparam->linangle.aA    = old[0];
168     newparam->linangle.klinA = old[1];
169     newparam->linangle.aB    = old[2];
170     newparam->linangle.klinB = old[3];
171     break;
172   case F_BONDS:
173   case F_ANGLES:
174   case F_HARMONIC:
175   case F_IDIHS:
176     newparam->harmonic.rA =old[0];
177     newparam->harmonic.krA=old[1];
178     newparam->harmonic.rB =old[2];
179     newparam->harmonic.krB=old[3];
180     break;
181   case F_MORSE:
182     newparam->morse.b0A    =old[0];
183     newparam->morse.cbA    =old[1];
184     newparam->morse.betaA  =old[2];
185     newparam->morse.b0B    =old[3];
186     newparam->morse.cbB    =old[4];
187     newparam->morse.betaB  =old[5];
188     break;
189   case F_CUBICBONDS:
190     newparam->cubic.b0    =old[0];
191     newparam->cubic.kb    =old[1];
192     newparam->cubic.kcub  =old[2];
193     break;
194   case F_CONNBONDS:
195     break;
196   case F_POLARIZATION:
197     newparam->polarize.alpha = old[0];
198     break;
199   case F_ANHARM_POL:
200     newparam->anharm_polarize.alpha = old[0];
201     newparam->anharm_polarize.drcut = old[1];
202     newparam->anharm_polarize.khyp  = old[2];
203     break;
204   case F_WATER_POL:
205     newparam->wpol.al_x   =old[0];
206     newparam->wpol.al_y   =old[1];
207     newparam->wpol.al_z   =old[2];
208     newparam->wpol.rOH    =old[3];
209     newparam->wpol.rHH    =old[4];
210     newparam->wpol.rOD    =old[5];
211     break;
212   case F_THOLE_POL:
213     newparam->thole.a      = old[0];
214     newparam->thole.alpha1 = old[1];
215     newparam->thole.alpha2 = old[2];
216     if ((old[1] > 0) && (old[2] > 0))
217       newparam->thole.rfac = old[0]*pow(old[1]*old[2],-1.0/6.0);
218     else
219       newparam->thole.rfac = 1;
220     break;
221   case F_BHAM:
222     newparam->bham.a = old[0];
223     newparam->bham.b = old[1];
224     newparam->bham.c = old[2];
225     break;
226   case F_LJ14:
227     set_ljparams(comb,reppow,old[0],old[1],&newparam->lj14.c6A,&newparam->lj14.c12A);
228     set_ljparams(comb,reppow,old[2],old[3],&newparam->lj14.c6B,&newparam->lj14.c12B);
229     break;
230   case F_LJC14_Q:
231     newparam->ljc14.fqq = old[0];
232     newparam->ljc14.qi  = old[1];
233     newparam->ljc14.qj  = old[2];
234     set_ljparams(comb,reppow,old[3],old[4],&newparam->ljc14.c6,&newparam->ljc14.c12);
235     break;
236   case F_LJC_PAIRS_NB:
237     newparam->ljcnb.qi = old[0];
238     newparam->ljcnb.qj = old[1];
239     set_ljparams(comb,reppow,old[2],old[3],&newparam->ljcnb.c6,&newparam->ljcnb.c12);
240     break;
241   case F_LJ:
242     set_ljparams(comb,reppow,old[0],old[1],&newparam->lj.c6,&newparam->lj.c12);
243     break;
244   case F_PDIHS:
245   case F_PIDIHS:
246   case F_ANGRES:
247   case F_ANGRESZ:
248     newparam->pdihs.phiA = old[0];
249     newparam->pdihs.cpA  = old[1];
250                   
251     /* Dont do any checks if all parameters are zero (such interactions will be removed).
252      * Change 20100720: Amber occasionally uses negative multiplicities (mathematically OK),
253      * so I have changed the lower limit to -99 /EL
254      *
255      * Second, if the force constant is zero in both A and B states, we set the phase
256      * and multiplicity to zero too so the interaction gets removed during clean-up.
257      */ 
258     newparam->pdihs.phiB = old[3];
259     newparam->pdihs.cpB  = old[4];
260           
261     if( fabs(newparam->pdihs.cpA) < GMX_REAL_MIN && fabs(newparam->pdihs.cpB) < GMX_REAL_MIN )
262     {
263         newparam->pdihs.phiA = 0.0; 
264         newparam->pdihs.phiB = 0.0; 
265         newparam->pdihs.mult = 0; 
266     } 
267     else
268     {
269         newparam->pdihs.mult = round_check(old[2],-99,ftype,"multiplicity");
270     }
271           
272     break;
273   case F_POSRES:
274     newparam->posres.fcA[XX]   = old[0];
275     newparam->posres.fcA[YY]   = old[1];
276     newparam->posres.fcA[ZZ]   = old[2];
277     newparam->posres.fcB[XX]   = old[3];
278     newparam->posres.fcB[YY]   = old[4];
279     newparam->posres.fcB[ZZ]   = old[5];
280     newparam->posres.pos0A[XX] = old[6];
281     newparam->posres.pos0A[YY] = old[7];
282     newparam->posres.pos0A[ZZ] = old[8];
283     newparam->posres.pos0B[XX] = old[9];
284     newparam->posres.pos0B[YY] = old[10];
285     newparam->posres.pos0B[ZZ] = old[11];
286     break;
287   case F_FBPOSRES:
288     newparam->fbposres.geom     = round_check(old[0],0,ftype,"geometry");
289     if ( ! (newparam->fbposres.geom > efbposresZERO && newparam->fbposres.geom < efbposresNR))
290     {
291       gmx_fatal(FARGS,"Invalid geometry for flat-bottomed position restraint.\n"
292                 "Expected number between 1 and %d. Found %d\n", efbposresNR-1,
293                 newparam->fbposres.geom);
294     }
295     newparam->fbposres.r        = old[1];
296     newparam->fbposres.k        = old[2];
297     newparam->fbposres.pos0[XX] = old[3];
298     newparam->fbposres.pos0[YY] = old[4];
299     newparam->fbposres.pos0[ZZ] = old[5];
300     break;
301   case F_DISRES:
302     newparam->disres.label = round_check(old[0],0,ftype,"label");
303     newparam->disres.type  = round_check(old[1],1,ftype,"type'");
304     newparam->disres.low   = old[2];
305     newparam->disres.up1   = old[3];
306     newparam->disres.up2   = old[4];
307     newparam->disres.kfac  = old[5];
308     break;
309   case F_ORIRES:
310     newparam->orires.ex    = round_check(old[0],1,ftype,"experiment") - 1;
311     newparam->orires.label = round_check(old[1],1,ftype,"label");
312     newparam->orires.power = round_check(old[2],0,ftype,"power");
313     newparam->orires.c     = old[3];
314     newparam->orires.obs   = old[4];
315     newparam->orires.kfac  = old[5];
316     break;
317   case F_DIHRES:
318     newparam->dihres.phiA  = old[0];
319     newparam->dihres.dphiA = old[1];
320     newparam->dihres.kfacA = old[2];
321     newparam->dihres.phiB   = old[3];
322     newparam->dihres.dphiB  = old[4];
323     newparam->dihres.kfacB  = old[5];
324     break;
325   case F_RBDIHS:
326     for (i=0; (i<NR_RBDIHS); i++) {
327       newparam->rbdihs.rbcA[i]=old[i]; 
328       newparam->rbdihs.rbcB[i]=old[NR_RBDIHS+i]; 
329     }
330     break;
331   case F_FOURDIHS:
332     /* Read the dihedral parameters to temporary arrays,
333      * and convert them to the computationally faster
334      * Ryckaert-Bellemans form.
335      */   
336     /* Use conversion formula for OPLS to Ryckaert-Bellemans: */
337     newparam->rbdihs.rbcA[0]=old[1]+0.5*(old[0]+old[2]);
338     newparam->rbdihs.rbcA[1]=0.5*(3.0*old[2]-old[0]);
339     newparam->rbdihs.rbcA[2]=4.0*old[3]-old[1];
340     newparam->rbdihs.rbcA[3]=-2.0*old[2];
341     newparam->rbdihs.rbcA[4]=-4.0*old[3];
342     newparam->rbdihs.rbcA[5]=0.0;
343
344     newparam->rbdihs.rbcB[0]=old[NR_FOURDIHS+1]+0.5*(old[NR_FOURDIHS+0]+old[NR_FOURDIHS+2]);
345     newparam->rbdihs.rbcB[1]=0.5*(3.0*old[NR_FOURDIHS+2]-old[NR_FOURDIHS+0]);
346     newparam->rbdihs.rbcB[2]=4.0*old[NR_FOURDIHS+3]-old[NR_FOURDIHS+1];
347     newparam->rbdihs.rbcB[3]=-2.0*old[NR_FOURDIHS+2];
348     newparam->rbdihs.rbcB[4]=-4.0*old[NR_FOURDIHS+3];
349     newparam->rbdihs.rbcB[5]=0.0;
350     break;    
351   case F_CONSTR:
352   case F_CONSTRNC:
353     newparam->constr.dA = old[0];
354     newparam->constr.dB = old[1];
355     break;
356   case F_SETTLE:
357     newparam->settle.doh=old[0];
358     newparam->settle.dhh=old[1];
359     break;
360   case F_VSITE2:
361   case F_VSITE3:
362   case F_VSITE3FD:
363   case F_VSITE3OUT:
364   case F_VSITE4FD:
365   case F_VSITE4FDN:
366     newparam->vsite.a=old[0];
367     newparam->vsite.b=old[1];
368     newparam->vsite.c=old[2];
369     newparam->vsite.d=old[3];
370     newparam->vsite.e=old[4];
371     newparam->vsite.f=old[5];
372     break;
373   case F_VSITE3FAD:
374     newparam->vsite.a=old[1] * cos(DEG2RAD * old[0]);
375     newparam->vsite.b=old[1] * sin(DEG2RAD * old[0]);
376     newparam->vsite.c=old[2];
377     newparam->vsite.d=old[3];
378     newparam->vsite.e=old[4];
379     newparam->vsite.f=old[5];
380     break;
381   case F_VSITEN:
382     newparam->vsiten.n = round_check(old[0],1,ftype,"number of atoms");
383     newparam->vsiten.a = old[1];
384     break;
385   case F_CMAP:
386     newparam->cmap.cmapA=old[0];
387     newparam->cmap.cmapB=old[1];
388     break;
389   case F_GB12:
390   case F_GB13:
391   case F_GB14:
392     newparam->gb.sar  = old[0];
393     newparam->gb.st   = old[1];
394     newparam->gb.pi   = old[2];
395     newparam->gb.gbr  = old[3];
396     newparam->gb.bmlt = old[4];
397     break;
398   default:
399     gmx_fatal(FARGS,"unknown function type %d in %s line %d",
400               ftype,__FILE__,__LINE__);
401   }
402 }
403
404 static int enter_params(gmx_ffparams_t *ffparams, t_functype ftype,
405                         real forceparams[MAXFORCEPARAM],int comb,real reppow,
406                         int start,gmx_bool bAppend)
407 {
408   t_iparams newparam;
409   int       type;
410   
411   assign_param(ftype,&newparam,forceparams,comb,reppow);
412   if (!bAppend) {
413     for (type=start; (type<ffparams->ntypes); type++) {
414       if (ffparams->functype[type]==ftype) {
415         if (F_GB13 == ftype) {
416           /* Occasionally, the way the 1-3 reference distance is
417            * computed can lead to non-binary-identical results, but I
418            * don't know why. */
419           if ((gmx_within_tol(newparam.gb.sar,  ffparams->iparams[type].gb.sar,  1e-6)) &&
420               (gmx_within_tol(newparam.gb.st,   ffparams->iparams[type].gb.st,   1e-6)) &&
421               (gmx_within_tol(newparam.gb.pi,   ffparams->iparams[type].gb.pi,   1e-6)) &&
422               (gmx_within_tol(newparam.gb.gbr,  ffparams->iparams[type].gb.gbr,  1e-6)) &&
423               (gmx_within_tol(newparam.gb.bmlt, ffparams->iparams[type].gb.bmlt, 1e-6))) {
424             return type;
425           }
426         }
427         else {
428         if (memcmp(&newparam,&ffparams->iparams[type],(size_t)sizeof(newparam)) == 0)
429           return type;
430         }
431       }
432     }
433   }
434   else {
435     type = ffparams->ntypes;
436   }
437   if (debug)
438     fprintf(debug,"copying newparam to ffparams->iparams[%d] (ntypes=%d)\n",
439             type,ffparams->ntypes);
440   memcpy(&ffparams->iparams[type],&newparam,(size_t)sizeof(newparam));
441   
442   ffparams->ntypes++;
443   ffparams->functype[type]=ftype;
444
445   return type;
446 }
447
448 static void append_interaction(t_ilist *ilist,
449                                int type,int nral,atom_id a[MAXATOMLIST])
450 {
451   int i,where1;
452   
453   where1     = ilist->nr;
454   ilist->nr += nral+1;
455
456   ilist->iatoms[where1++]=type;
457   for (i=0; (i<nral); i++) 
458     ilist->iatoms[where1++]=a[i];
459 }
460
461 static void enter_function(t_params *p,t_functype ftype,int comb,real reppow,
462                            gmx_ffparams_t *ffparams,t_ilist *il,
463                            int *maxtypes,
464                            gmx_bool bNB,gmx_bool bAppend)
465 {
466   int     k,type,nr,nral,delta,start;
467   
468   start = ffparams->ntypes;
469   nr    = p->nr;
470   
471   for (k=0; k<nr; k++) {
472     if (*maxtypes <= ffparams->ntypes) {
473       *maxtypes += 1000;
474       srenew(ffparams->functype,*maxtypes);
475       srenew(ffparams->iparams, *maxtypes);
476       if (debug) 
477         fprintf(debug,"%s, line %d: srenewed idef->functype and idef->iparams to %d\n",
478                 __FILE__,__LINE__,*maxtypes);
479     }
480     type = enter_params(ffparams,ftype,p->param[k].c,comb,reppow,start,bAppend);
481     if (!bNB) {
482       nral  = NRAL(ftype);
483       delta = nr*(nral+1);
484       srenew(il->iatoms,il->nr+delta);
485       append_interaction(il,type,nral,p->param[k].a);
486     }
487   }
488 }
489
490 void convert_params(int atnr,t_params nbtypes[],
491                     t_molinfo *mi,int comb,double reppow,real fudgeQQ,
492                     gmx_mtop_t *mtop)
493 {
494   int    i,j,maxtypes,mt;
495   unsigned long  flags;
496   gmx_ffparams_t *ffp;
497   gmx_moltype_t *molt;
498   t_params *plist;
499
500   maxtypes=0;
501   
502   ffp = &mtop->ffparams;
503   ffp->ntypes   = 0;
504   ffp->atnr     = atnr;
505   ffp->functype = NULL;
506   ffp->iparams  = NULL;
507   ffp->reppow   = reppow;
508
509   enter_function(&(nbtypes[F_LJ]),  (t_functype)F_LJ,    comb,reppow,ffp,NULL,
510                  &maxtypes,TRUE,TRUE);
511   enter_function(&(nbtypes[F_BHAM]),(t_functype)F_BHAM,  comb,reppow,ffp,NULL,
512                  &maxtypes,TRUE,TRUE);
513
514   for(mt=0; mt<mtop->nmoltype; mt++) {
515     molt = &mtop->moltype[mt];
516     for(i=0; (i<F_NRE); i++) {
517       molt->ilist[i].nr     = 0;
518       molt->ilist[i].iatoms = NULL;
519       
520       plist = mi[mt].plist;
521
522       flags = interaction_function[i].flags;
523       if ((i != F_LJ) && (i != F_BHAM) && ((flags & IF_BOND) ||
524                                            (flags & IF_VSITE) ||
525                                            (flags & IF_CONSTRAINT))) {
526         enter_function(&(plist[i]),(t_functype)i,comb,reppow,
527                        ffp,&molt->ilist[i],
528                        &maxtypes,FALSE,(i == F_POSRES  || i == F_FBPOSRES));
529       }
530     }
531   }
532   if (debug) {
533     fprintf(debug,"%s, line %d: There are %d functypes in idef\n",
534             __FILE__,__LINE__,ffp->ntypes);
535   }
536
537   ffp->fudgeQQ = fudgeQQ;
538 }