Make help texts refer to gmx-something
[alexxy/gromacs.git] / src / gromacs / gmxana / gmx_saxs.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  * Green Red Orange Magenta Azure Cyan Skyblue
34  */
35
36 #ifdef HAVE_CONFIG_H
37 #include <config.h>
38 #endif
39
40 #include <math.h>
41 #include <ctype.h>
42 #include "string2.h"
43 #include "sysstuff.h"
44 #include "typedefs.h"
45 #include "macros.h"
46 #include "vec.h"
47 #include "pbc.h"
48 #include "xvgr.h"
49 #include "copyrite.h"
50 #include "gromacs/fileio/futil.h"
51 #include "statutil.h"
52 #include "gromacs/fileio/tpxio.h"
53 #include "physics.h"
54 #include "index.h"
55 #include "smalloc.h"
56 #include "calcgrid.h"
57 #include "nrnb.h"
58 #include "coulomb.h"
59 #include "gstat.h"
60 #include "gromacs/fileio/matio.h"
61 #include "gmx_ana.h"
62 #include "names.h"
63 #include "sfactor.h"
64
65 int gmx_saxs(int argc, char *argv[])
66 {
67     const char  *desc[] = {
68         "[THISMODULE] calculates SAXS structure factors for given index",
69         "groups based on Cromer's method.",
70         "Both topology and trajectory files are required."
71     };
72
73     static real  start_q = 0.0, end_q = 60.0, energy = 12.0;
74     static int   ngroups = 1;
75
76     t_pargs      pa[] = {
77         { "-ng",       FALSE, etINT, {&ngroups},
78           "Number of groups to compute SAXS" },
79         {"-startq", FALSE, etREAL, {&start_q},
80          "Starting q (1/nm) "},
81         {"-endq", FALSE, etREAL, {&end_q},
82          "Ending q (1/nm)"},
83         {"-energy", FALSE, etREAL, {&energy},
84          "Energy of the incoming X-ray (keV) "}
85     };
86 #define NPA asize(pa)
87     const char  *fnTPS, *fnTRX, *fnNDX, *fnDAT = NULL;
88     output_env_t oenv;
89
90     t_filenm     fnm[] = {
91         { efTRX, "-f",  NULL,      ffREAD },
92         { efTPS, NULL,  NULL,      ffREAD },
93         { efNDX, NULL,  NULL,      ffOPTRD },
94         { efDAT, "-d",  "sfactor", ffOPTRD },
95         { efXVG, "-sq", "sq",      ffWRITE },
96     };
97 #define NFILE asize(fnm)
98     if (!parse_common_args(&argc, argv, PCA_CAN_TIME | PCA_BE_NICE,
99                            NFILE, fnm, NPA, pa, asize(desc), desc, 0, NULL, &oenv))
100     {
101         return 0;
102     }
103
104     fnTPS = ftp2fn(efTPS, NFILE, fnm);
105     fnTRX = ftp2fn(efTRX, NFILE, fnm);
106     fnDAT = ftp2fn(efDAT, NFILE, fnm);
107     fnNDX = ftp2fn_null(efNDX, NFILE, fnm);
108
109     do_scattering_intensity(fnTPS, fnNDX, opt2fn("-sq", NFILE, fnm),
110                             fnTRX, fnDAT,
111                             start_q, end_q, energy, ngroups, oenv);
112
113     please_cite(stdout, "Cromer1968a");
114
115     return 0;
116 }