src/tools/nsfactor.h

   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  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * 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 #ifndef _nsfactor_h
  40 #define _nsfactor_h
  41
  42 #include "index.h"
  43 #include "types/simple.h"
  44 #include "gmxcomplex.h"
  45 #include "oenv.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 typedef struct gmx_nentron_atomic_structurefactors_t {
  52     int     nratoms;
  53     int     *p; /* proton number */
  54     int     *n; /* neuton number */
  55     double  *slength; /* scattering length in fm */
  56     char    **atomnm; /* atom symbol */
  57 } gmx_nentron_atomic_structurefactors_t;
  58
  59 typedef struct gmx_sans_t {
  60     t_topology *top; /* topology */
  61     double *slength; /* scattering length for this topology */
  62 } gmx_sans_t;
  63
  64 typedef struct gmx_radial_distribution_histogram_t {
  65     int     grn; /* number of bins */
  66     double binwidth; /* bin size */
  67     double *r; /* Distances */
  68     double *gr; /* Probability */
  69 } gmx_radial_distribution_histogram_t;
  70
  71 typedef struct gmx_static_structurefator_t {
  72     int     qn; /* number of items */
  73     double  *s; /* scattering */
  74     double  *q; /* q vectors */
  75     double  qstep; /* q increment */
  76 } gmx_static_structurefator_t;
  77
  78 void check_binwidth(real binwidth);
  79
  80 void check_mcover(real mcover);
  81
  82 void normalize_probability(int n, double *a);
  83
  84 gmx_nentron_atomic_structurefactors_t *gmx_neutronstructurefactors_init(const char *datfn);
  85
  86 gmx_sans_t *gmx_sans_init(t_topology *top, gmx_nentron_atomic_structurefactors_t *gnsf);
  87
  88 gmx_radial_distribution_histogram_t *calc_radial_distribution_histogram  (gmx_sans_t *gsans,
  89                             rvec *x,
  90                             matrix box,
  91                             atom_id *index,
  92                             int isize,
  93                             double binwidth,
  94                             gmx_bool bMC,
  95                             real mcover,
  96                             unsigned int seed);
  97
  98 gmx_static_structurefator_t *convert_histogram_to_intensity_curve (gmx_radial_distribution_histogram_t *pr, double start_q, double end_q, double q_step);
  99
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104 #endif