70c9dde017a9be9641de8e22515d5d6a223127f6
[alexxy/gromacs.git] / src / gmxlib / sfactor.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  * GROningen Mixture of Alchemy and Childrens' Stories
34  */
35 #ifdef HAVE_CONFIG_H
36 #include <config.h>
37 #endif
38
39 #include <ctype.h>
40 #include "sysstuff.h"
41 #include "smalloc.h"
42 #include "string2.h"
43 #include "futil.h"
44 #include "maths.h"
45 #include "gmx_fatal.h"
46 #include "vec.h"
47 #include "macros.h"
48 #include "index.h"
49 #include "strdb.h"
50 #include "copyrite.h"
51 #include "tpxio.h"
52 #include "typedefs.h"
53 #include "statutil.h"
54 #include "oenv.h"
55 #include "gmxfio.h"
56 #include "xvgr.h"
57 #include "matio.h"
58 #include "gmx_ana.h"
59 #include "names.h"
60 #include "sfactor.h"
61
62
63 typedef struct gmx_structurefactors {
64     int nratoms;
65     int *p;        /* proton number */
66     int *n;        /* neutron number */
67     /* Parameters for the Cromer Mann fit */
68     real **a;    /* parameter a */
69     real **b;    /* parameter b */
70     real *c;       /* parameter c */
71     char **atomnm;  /* atomname */
72
73 } gmx_structurefactors;
74
75 typedef struct reduced_atom{
76     rvec x;
77     int  t;
78 } reduced_atom;
79
80
81 typedef struct structure_factor
82 {
83   int     n_angles;
84   int     n_groups;
85   double  lambda;
86   double  energy;
87   double  momentum;
88   double  ref_k;
89   double  **F;
90   int     nSteps;
91   int     total_n_atoms;
92 } structure_factor;
93
94
95 extern int * create_indexed_atom_type (reduced_atom_t * atm, int size)
96 {
97 /*
98  * create an index of the atom types found in a  group
99  * i.e.: for water index_atp[0]=type_number_of_O and
100  *                 index_atp[1]=type_number_of_H
101  *
102  * the last element is set to 0
103  */
104     int *index_atp, i, i_tmp, j;
105
106     reduced_atom *att=(reduced_atom *)atm;
107
108     snew (index_atp, 1);
109     i_tmp = 1;
110     index_atp[0] = att[0].t;
111     for (i = 1; i < size; i++) {
112         for (j = 0; j < i_tmp; j++)
113             if (att[i].t == index_atp[j])
114                 break;
115         if (j == i_tmp) {       /* i.e. no indexed atom type is  == to atm[i].t */
116             i_tmp++;
117             srenew (index_atp, i_tmp * sizeof (int));
118             index_atp[i_tmp - 1] = att[i].t;
119         }
120     }
121     i_tmp++;
122     srenew (index_atp, i_tmp * sizeof (int));
123     index_atp[i_tmp - 1] = 0;
124     return index_atp;
125 }
126
127
128
129 extern t_complex *** rc_tensor_allocation(int x, int y, int z)
130 {
131   t_complex ***t;
132   int i,j;
133
134   snew(t,x);
135   t = (t_complex ***)calloc(x,sizeof(t_complex**));
136   if(!t) exit(fprintf(stderr,"\nallocation error"));
137   t[0] = (t_complex **)calloc(x*y,sizeof(t_complex*));
138   if(!t[0]) exit(fprintf(stderr,"\nallocation error"));
139   t[0][0] = (t_complex *)calloc(x*y*z,sizeof(t_complex));
140   if(!t[0][0]) exit(fprintf(stderr,"\nallocation error"));
141
142   for( j = 1 ; j < y ; j++)
143     t[0][j] = t[0][j-1] + z;
144   for( i = 1 ; i < x ; i++) {
145     t[i] = t[i-1] + y;
146     t[i][0] = t[i-1][0] + y*z;
147     for( j = 1 ; j < y ; j++)
148       t[i][j] = t[i][j-1] + z;
149   }
150   return t;
151 }
152
153
154 extern void compute_structure_factor (structure_factor_t * sft, matrix box,
155                                reduced_atom_t * red, int isize, real start_q,
156                                real end_q, int group,real **sf_table)
157 {
158     structure_factor *sf=(structure_factor *)sft;
159     reduced_atom *redt=(reduced_atom *)red;
160
161     t_complex ***tmpSF;
162     rvec k_factor;
163     real kdotx, asf, kx, ky, kz, krr;
164     int kr, maxkx, maxky, maxkz, i, j, k, p, *counter;
165
166
167     k_factor[XX] = 2 * M_PI / box[XX][XX];
168     k_factor[YY] = 2 * M_PI / box[YY][YY];
169     k_factor[ZZ] = 2 * M_PI / box[ZZ][ZZ];
170
171     maxkx = (int) (end_q / k_factor[XX] + 0.5);
172     maxky = (int) (end_q / k_factor[YY] + 0.5);
173     maxkz = (int) (end_q / k_factor[ZZ] + 0.5);
174
175     snew (counter, sf->n_angles);
176
177     tmpSF = rc_tensor_allocation(maxkx,maxky,maxkz);
178 /*
179  * The big loop...
180  * compute real and imaginary part of the structure factor for every
181  * (kx,ky,kz))
182  */
183     fprintf(stderr,"\n");
184     for (i = 0; i < maxkx; i++) {
185         fprintf (stderr,"\rdone %3.1f%%     ", (double)(100.0*(i+1))/maxkx);
186         kx = i * k_factor[XX];
187         for (j = 0; j < maxky; j++) {
188             ky = j * k_factor[YY];
189             for (k = 0; k < maxkz; k++)
190                 if (i != 0 || j != 0 || k != 0) {
191                     kz = k * k_factor[ZZ];
192                     krr = sqrt (sqr (kx) + sqr (ky) + sqr (kz));
193                     if (krr >= start_q && krr <= end_q) {
194                         kr = (int) (krr/sf->ref_k + 0.5);
195                         if (kr < sf->n_angles) {
196                             counter[kr]++;  /* will be used for the copmutation
197                                                of the average*/
198                             for (p = 0; p < isize; p++) {
199                                 asf = sf_table[redt[p].t][kr];
200
201                                 kdotx = kx * redt[p].x[XX] +
202                                     ky * redt[p].x[YY] + kz * redt[p].x[ZZ];
203
204                                 tmpSF[i][j][k].re += cos (kdotx) * asf;
205                                 tmpSF[i][j][k].im += sin (kdotx) * asf;
206                             }
207                         }
208                     }
209                 }
210         }
211     }                           /* end loop on i */
212 /*
213  *  compute the square modulus of the structure factor, averaging on the surface
214  *  kx*kx + ky*ky + kz*kz = krr*krr
215  *  note that this is correct only for a (on the macroscopic scale)
216  *  isotropic system.
217  */
218     for (i = 0; i < maxkx; i++) {
219         kx = i * k_factor[XX]; for (j = 0; j < maxky; j++) {
220             ky = j * k_factor[YY]; for (k = 0; k < maxkz; k++) {
221                 kz = k * k_factor[ZZ]; krr = sqrt (sqr (kx) + sqr (ky)
222                 + sqr (kz)); if (krr >= start_q && krr <= end_q) {
223                     kr = (int) (krr / sf->ref_k + 0.5);
224                         if (kr < sf->n_angles && counter[kr] != 0)
225                                 sf->F[group][kr] +=
226                             (sqr (tmpSF[i][j][k].re) +
227                              sqr (tmpSF[i][j][k].im))/ counter[kr];
228                 }
229             }
230         }
231     } sfree (counter); free(tmpSF[0][0]); free(tmpSF[0]); free(tmpSF);
232 }
233
234
235 extern gmx_structurefactors_t *gmx_structurefactors_init(const char *datfn) {
236     
237         /* Read the database for the structure factor of the different atoms */
238
239     FILE *fp;
240     char line[STRLEN];
241     gmx_structurefactors *gsf;
242     double a1,a2,a3,a4,b1,b2,b3,b4,c;
243     int p;
244     int i;
245     int nralloc=10;
246     int line_no;
247     char atomn[32];
248     fp=libopen(datfn);
249     line_no = 0;
250     snew(gsf,1);
251
252     snew(gsf->atomnm,nralloc);
253     snew(gsf->a,nralloc);
254     snew(gsf->b,nralloc);
255     snew(gsf->c,nralloc);
256     snew(gsf->p,nralloc);
257     gsf->n=NULL;
258     gsf->nratoms=line_no;
259     while(get_a_line(fp,line,STRLEN)) {
260         i=line_no;
261         if (sscanf(line,"%s %d %lf %lf %lf %lf %lf %lf %lf %lf %lf",
262                    atomn,&p,&a1,&a2,&a3,&a4,&b1,&b2,&b3,&b4,&c) == 11) {
263             gsf->atomnm[i]=strdup(atomn);
264             gsf->p[i]=p;
265             snew(gsf->a[i],4);
266             snew(gsf->b[i],4);
267             gsf->a[i][0]=a1;
268             gsf->a[i][1]=a2;
269             gsf->a[i][2]=a3;
270             gsf->a[i][3]=a4;
271             gsf->b[i][0]=b1;
272             gsf->b[i][1]=b2;
273             gsf->b[i][2]=b3;
274             gsf->b[i][3]=b4;
275             gsf->c[i]=c;
276             line_no++;            
277             gsf->nratoms=line_no;
278             if (line_no==nralloc){
279                 nralloc+=10;
280                 srenew(gsf->atomnm,nralloc);
281                 srenew(gsf->a,nralloc);
282                 srenew(gsf->b,nralloc);
283                 srenew(gsf->c,nralloc);
284                 srenew(gsf->p,nralloc);
285             }
286         }
287         else 
288             fprintf(stderr,"WARNING: Error in file %s at line %d ignored\n",
289                     datfn,line_no);
290     }
291
292     srenew(gsf->atomnm,gsf->nratoms);
293     srenew(gsf->a,gsf->nratoms);
294     srenew(gsf->b,gsf->nratoms);
295     srenew(gsf->c,gsf->nratoms);
296     srenew(gsf->p,gsf->nratoms);
297
298     fclose(fp);
299
300     return (gmx_structurefactors_t *) gsf;
301
302 }
303
304
305 extern void rearrange_atoms (reduced_atom_t * positions, t_trxframe *fr, atom_id * index,
306                       int isize, t_topology * top, gmx_bool flag,gmx_structurefactors_t *gsf)
307 /* given the group's index, return the (continuous) array of atoms */
308 {
309   int i;
310
311   reduced_atom *pos=(reduced_atom *)positions;
312
313   if (flag)
314     for (i = 0; i < isize; i++)
315       pos[i].t =
316         return_atom_type (*(top->atoms.atomname[index[i]]),gsf);
317   for (i = 0; i < isize; i++)
318     copy_rvec (fr->x[index[i]], pos[i].x);
319
320    positions=(reduced_atom_t *)pos;
321 }
322
323
324 extern int return_atom_type (const char *name,gmx_structurefactors_t *gsf)
325 {
326   typedef struct {
327     const char *name;
328     int  nh;
329   } t_united_h;
330   t_united_h uh[] = {
331     { "CH1", 1 }, { "CH2", 2 }, { "CH3", 3 },
332     { "CS1", 1 }, { "CS2", 2 }, { "CS3", 3 },
333     { "CP1", 1 }, { "CP2", 2 }, { "CP3", 3 }
334   };
335   int i,cnt=0;
336   int *tndx;
337   int nrc;
338   int fndx=0;
339   int NCMT;
340
341   gmx_structurefactors *gsft=(gmx_structurefactors *)gsf;
342
343   NCMT=gsft->nratoms;
344
345   snew(tndx,NCMT);
346
347   for(i=0; (i<asize(uh)); i++)
348     if (strcmp(name,uh[i].name) == 0)
349       return NCMT-1+uh[i].nh;
350
351   for(i=0; (i<NCMT); i++){
352     if (strncmp (name, gsft->atomnm[i],strlen(gsft->atomnm[i])) == 0){
353       tndx[cnt]=i;
354       cnt++;
355     }
356   }
357
358   if (cnt==0)
359   gmx_fatal(FARGS,"\nError: atom (%s) not in list (%d types checked)!\n",
360             name,i);
361   else{
362           nrc=0;
363           for(i=0;i<cnt;i++){
364                   if(strlen(gsft->atomnm[tndx[i]])>(size_t)nrc){
365                           nrc=strlen(gsft->atomnm[tndx[i]]);
366                       fndx=tndx[i];
367                   }
368           }
369      
370           return fndx;
371   }
372
373   return 0;
374 }
375
376 extern int gmx_structurefactors_get_sf(gmx_structurefactors_t *gsf, int elem, real a[4], real b[4], real *c){
377
378         int success;
379         int i;
380     gmx_structurefactors *gsft=(gmx_structurefactors *)gsf;
381         success=0;
382
383         for(i=0;i<4;i++){
384             a[i]=gsft->a[elem][i];
385             b[i]=gsft->b[elem][i];
386             *c=gsft->c[elem];
387         }
388
389         success+=1;
390         return success;
391 }
392
393 extern int do_scattering_intensity (const char* fnTPS, const char* fnNDX,
394                              const char* fnXVG, const char *fnTRX,
395                              const char* fnDAT,
396                              real start_q,real end_q,
397                              real energy,int ng,const output_env_t oenv)
398 {
399     int i,*isize,flags = TRX_READ_X,**index_atp;
400     t_trxstatus *status;
401     char **grpname,title[STRLEN];
402     atom_id **index;
403     t_topology top;
404     int ePBC;
405     t_trxframe fr;
406     reduced_atom_t **red;
407     structure_factor *sf;
408     rvec *xtop;
409     real **sf_table;
410     int nsftable;
411     matrix box;
412     double r_tmp;
413
414     gmx_structurefactors_t *gmx_sf;
415     real *a,*b,c;
416     int success;
417
418     snew(a,4);
419     snew(b,4);
420
421
422     gmx_sf=gmx_structurefactors_init(fnDAT);
423
424     success=gmx_structurefactors_get_sf(gmx_sf,0, a, b, &c);
425
426     snew (sf, 1);
427     sf->energy = energy;
428
429     /* Read the topology informations */
430     read_tps_conf (fnTPS, title, &top, &ePBC, &xtop, NULL, box, TRUE);
431     sfree (xtop);
432
433     /* groups stuff... */
434     snew (isize, ng);
435     snew (index, ng);
436     snew (grpname, ng);
437
438     fprintf (stderr, "\nSelect %d group%s\n", ng,
439              ng == 1 ? "" : "s");
440     if (fnTPS)
441         get_index (&top.atoms, fnNDX, ng, isize, index, grpname);
442     else
443         rd_index (fnNDX, ng, isize, index, grpname);
444
445     /* The first time we read data is a little special */
446     read_first_frame (oenv,&status, fnTRX, &fr, flags);
447
448     sf->total_n_atoms = fr.natoms;
449
450     snew (red, ng);
451     snew (index_atp, ng);
452
453     r_tmp = max (box[XX][XX], box[YY][YY]);
454     r_tmp = (double) max (box[ZZ][ZZ], r_tmp);
455
456     sf->ref_k = (2.0 * M_PI) / (r_tmp);
457     /* ref_k will be the reference momentum unit */
458     sf->n_angles = (int) (end_q / sf->ref_k + 0.5);
459
460     snew (sf->F, ng);
461     for (i = 0; i < ng; i++)
462         snew (sf->F[i], sf->n_angles);
463     for (i = 0; i < ng; i++) {
464         snew (red[i], isize[i]);
465         rearrange_atoms (red[i], &fr, index[i], isize[i], &top, TRUE,gmx_sf);
466         index_atp[i] = create_indexed_atom_type (red[i], isize[i]);
467     }
468
469     sf_table = compute_scattering_factor_table (gmx_sf,(structure_factor_t *)sf,&nsftable);
470
471
472     /* This is the main loop over frames */
473
474     do {
475         sf->nSteps++;
476         for (i = 0; i < ng; i++) {
477             rearrange_atoms (red[i], &fr, index[i], isize[i], &top,FALSE,gmx_sf);
478
479             compute_structure_factor ((structure_factor_t *)sf, box, red[i], isize[i],
480                                       start_q, end_q, i, sf_table);
481         }
482     }
483
484     while (read_next_frame (oenv,status, &fr));
485
486     save_data ((structure_factor_t *)sf, fnXVG, ng, start_q, end_q,oenv);
487
488
489     sfree(a);
490     sfree(b);
491
492     gmx_structurefactors_done(gmx_sf);
493
494     return 0;
495 }
496
497
498 extern void save_data (structure_factor_t *sft, const char *file, int ngrps,
499                 real start_q, real end_q, const output_env_t oenv)
500 {
501
502     FILE *fp;
503     int i, g = 0;
504     double *tmp, polarization_factor, A;
505
506     structure_factor *sf=(structure_factor *)sft;
507     
508     fp = xvgropen (file, "Scattering Intensity", "q (1/nm)",
509                    "Intensity (a.u.)",oenv);
510
511     snew (tmp, ngrps);
512
513     for (g = 0; g < ngrps; g++)
514         for (i = 0; i < sf->n_angles; i++) {
515             
516 /*
517  *          theta is half the angle between incoming and scattered vectors.
518  *
519  *          polar. fact. = 0.5*(1+cos^2(2*theta)) = 1 - 0.5 * sin^2(2*theta)
520  *
521  *          sin(theta) = q/(2k) := A  ->  sin^2(theta) = 4*A^2 (1-A^2) ->
522  *          -> 0.5*(1+cos^2(2*theta)) = 1 - 2 A^2 (1-A^2)
523  */
524             A = (double) (i * sf->ref_k) / (2.0 * sf->momentum);
525             polarization_factor = 1 - 2.0 * sqr (A) * (1 - sqr (A));
526             sf->F[g][i] *= polarization_factor;
527         }
528     for (i = 0; i < sf->n_angles; i++) {
529         if (i * sf->ref_k >= start_q && i * sf->ref_k <= end_q) {
530             fprintf (fp, "%10.5f  ", i * sf->ref_k);
531             for (g = 0; g < ngrps; g++)
532                fprintf (fp, "  %10.5f ", (sf->F[g][i]) /( sf->total_n_atoms*
533                                                           sf->nSteps));
534             fprintf (fp, "\n");
535         }
536     }
537
538     ffclose (fp);
539 }
540
541
542 extern double CMSF (gmx_structurefactors_t *gsf,int type,int nh,double lambda, double sin_theta)
543 /*
544  * return Cromer-Mann fit for the atomic scattering factor:
545  * sin_theta is the sine of half the angle between incoming and scattered
546  * vectors. See g_sq.h for a short description of CM fit.
547  */
548 {
549   int i,success;
550   double tmp = 0.0, k2;
551   real *a,*b;
552   real c;
553
554   snew(a,4);
555   snew(b,4);
556
557  /*
558   *
559   * f0[k] = c + [SUM a_i*EXP(-b_i*(k^2)) ]
560   *             i=1,4
561   */
562
563   /*
564    *  united atoms case
565    *  CH2 / CH3 groups
566    */
567   if (nh > 0) {
568     tmp = (CMSF (gsf,return_atom_type ("C",gsf),0,lambda, sin_theta) +
569            nh*CMSF (gsf,return_atom_type ("H",gsf),0,lambda, sin_theta));
570   }
571   /* all atom case */
572   else {
573     k2 = (sqr (sin_theta) / sqr (10.0 * lambda));
574     success=gmx_structurefactors_get_sf(gsf,type,a,b,&c);
575     tmp = c;
576     for (i = 0; (i < 4); i++)
577       tmp += a[i] * exp (-b[i] * k2);
578   }
579   return tmp;
580 }
581
582
583
584 extern real **gmx_structurefactors_table(gmx_structurefactors_t *gsf,real momentum, real ref_k, real lambda, int n_angles){
585
586         int NCMT;
587         int nsftable;
588         int i,j;
589         double q,sin_theta;
590     real **sf_table;
591     gmx_structurefactors *gsft=(gmx_structurefactors *)gsf;
592
593     NCMT=gsft->nratoms;
594         nsftable = NCMT+3;
595
596     snew (sf_table,nsftable);
597     for (i = 0; (i < nsftable); i++) {
598         snew (sf_table[i], n_angles);
599         for (j = 0; j < n_angles; j++) {
600                 q = ((double) j * ref_k);
601                 /* theta is half the angle between incoming
602                            and scattered wavevectors. */
603                 sin_theta = q / (2.0 * momentum);
604                 if (i < NCMT){
605                     sf_table[i][j] = CMSF (gsf,i,0,lambda, sin_theta);
606                 }
607                 else
608                         sf_table[i][j] = CMSF (gsf,i,i-NCMT+1,lambda, sin_theta);
609         }
610     }
611     return sf_table;
612 }
613
614 extern void gmx_structurefactors_done(gmx_structurefactors_t *gsf){
615
616         int i;
617         gmx_structurefactors *sf;
618         sf=(gmx_structurefactors *) gsf;
619
620         for(i=0;i<sf->nratoms;i++){
621         sfree(sf->a[i]);
622                 sfree(sf->b[i]);
623                 sfree(sf->atomnm[i]);
624         }
625
626         sfree(sf->a);
627         sfree(sf->b);
628         sfree(sf->atomnm);
629         sfree(sf->p);
630         sfree(sf->c);
631
632         sfree(sf);
633
634 }
635
636 extern real **compute_scattering_factor_table (gmx_structurefactors_t *gsf,structure_factor_t *sft,int *nsftable)
637 {
638 /*
639  *  this function build up a table of scattering factors for every atom
640  *  type and for every scattering angle.
641  */
642    
643     double hc=1239.842;
644     real ** sf_table;
645
646     structure_factor *sf=(structure_factor *)sft;
647
648
649     /* \hbar \omega \lambda = hc = 1239.842 eV * nm */
650     sf->momentum = ((double) (2. * 1000.0 * M_PI * sf->energy) / hc);
651     sf->lambda = hc / (1000.0 * sf->energy);
652     fprintf (stderr, "\nwavelenght = %f nm\n", sf->lambda);
653
654     sf_table=gmx_structurefactors_table(gsf,sf->momentum,sf->ref_k,sf->lambda,sf->n_angles);
655
656     return sf_table;
657 }
658
659