src/gromacs/gmxana/gmx_saxs.cpp

   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) 2012,2013,2014,2015,2017 by the GROMACS development team.
   7  * Copyright (c) 2019,2020, by the GROMACS development team, led by
   8  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   9  * and including many others, as listed in the AUTHORS file in the
  10  * top-level source directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #include "gmxpre.h"
  40
  41 #include <cmath>
  42
  43 #include "gromacs/commandline/pargs.h"
  44 #include "gromacs/gmxana/gmx_ana.h"
  45 #include "gromacs/gmxana/sfactor.h"
  46 #include "gromacs/utility/arraysize.h"
  47 #include "gromacs/utility/pleasecite.h"
  48 #include "gromacs/utility/smalloc.h"
  49
  50 int gmx_saxs(int argc, char* argv[])
  51 {
  52     const char* desc[] = { "[THISMODULE] calculates SAXS structure factors for given index",
  53                            "groups based on Cromer's method.",
  54                            "Both topology and trajectory files are required." };
  55
  56     static real start_q = 0.0, end_q = 60.0, energy = 12.0;
  57     static int  ngroups = 1;
  58
  59     t_pargs pa[] = {
  60         { "-ng", FALSE, etINT, { &ngroups }, "Number of groups to compute SAXS" },
  61         { "-startq", FALSE, etREAL, { &start_q }, "Starting q (1/nm) " },
  62         { "-endq", FALSE, etREAL, { &end_q }, "Ending q (1/nm)" },
  63         { "-energy", FALSE, etREAL, { &energy }, "Energy of the incoming X-ray (keV) " }
  64     };
  65 #define NPA asize(pa)
  66     const char *      fnTPS, *fnTRX, *fnNDX, *fnDAT = nullptr;
  67     gmx_output_env_t* oenv;
  68
  69     t_filenm fnm[] = {
  70         { efTRX, "-f", nullptr, ffREAD },     { efTPS, nullptr, nullptr, ffREAD },
  71         { efNDX, nullptr, nullptr, ffOPTRD }, { efDAT, "-d", "sfactor", ffOPTRD },
  72         { efXVG, "-sq", "sq", ffWRITE },
  73     };
  74 #define NFILE asize(fnm)
  75     if (!parse_common_args(&argc, argv, PCA_CAN_TIME, NFILE, fnm, NPA, pa, asize(desc), desc, 0,
  76                            nullptr, &oenv))
  77     {
  78         return 0;
  79     }
  80
  81     fnTPS = ftp2fn(efTPS, NFILE, fnm);
  82     fnTRX = ftp2fn(efTRX, NFILE, fnm);
  83     fnDAT = ftp2fn(efDAT, NFILE, fnm);
  84     fnNDX = ftp2fn_null(efNDX, NFILE, fnm);
  85
  86     do_scattering_intensity(fnTPS, fnNDX, opt2fn("-sq", NFILE, fnm), fnTRX, fnDAT, start_q, end_q,
  87                             energy, ngroups, oenv);
  88
  89     please_cite(stdout, "Cromer1968a");
  90
  91     return 0;
  92 }