nucdist.h
Go to the documentation of this file.
1 /*
2  -------------------------------------------------------------------
3 
4  Copyright (C) 2006-2017, Andrew W. Steiner
5 
6  This file is part of O2scl.
7 
8  O2scl is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 3 of the License, or
11  (at your option) any later version.
12 
13  O2scl is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with O2scl. If not, see <http://www.gnu.org/licenses/>.
20 
21  -------------------------------------------------------------------
22 */
23 #ifndef O2SCL_NUCDIST_H
24 #define O2SCL_NUCDIST_H
25 
26 /** \file nucdist.h
27  \brief File defining \ref o2scl::nucdist_set().
28 */
29 
30 #include <iostream>
31 #include <o2scl/nucleus.h>
32 #include <o2scl/nucmass.h>
33 
34 #ifdef DOXYGEN
35 /** \brief Placeholder namespace for global functions in \o2p
36 
37  This namespace is created to help doxygen understand
38  functions in \o2p that are in the \c o2scl namespace.
39  Functions documented here should be called using, for example,
40  \verbatim
41  o2scl::nucdist_set(dist,nm);
42  \endverbatim
43  */
44 namespace o2scl_part {
45 #else
46  namespace o2scl {
47 #endif
48 
49  /** \brief Set a distribution of nuclei from a mass formula
50  and a function string
51 
52  Given a nuclear mass formula \c nm, this adds nuclei to a
53  <tt>std::vector</tt> object. The function \c expr, a function of
54  \c Z and \c N, determines which nuclei will be added to the
55  distribution.
56 
57  \note This function is actually in the \c o2scl namespace.
58  Unfortunately doxygen has difficulty extending namespaces
59  in separate doxyfile instances.
60  */
61  void nucdist_set(std::vector<nucleus> &dist, nucmass &nm,
62  std::string expr="1", int maxA=400,
63  bool include_neutron=false);
64 
65 #ifdef DOXYGEN
66  }
67 #else
68 }
69 #endif
70 
71 #endif
Placeholder namespace for global functions in <a href=&#39;../../part/html/index.html&#39;>O<span style=&#39;posi...
Definition: nucdist.h:44
void nucdist_set(std::vector< nucleus > &dist, nucmass &nm, std::string expr="1", int maxA=400, bool include_neutron=false)
Set a distribution of nuclei from a mass formula and a function string.

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).