BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ParameterUtils.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Param/Varia/ParameterUtils.h
6 //! @brief Defines namespace ParameterUtils
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************** //
14 
15 #ifndef BORNAGAIN_CORE_PARAMETRIZATION_PARAMETERUTILS_H
16 #define BORNAGAIN_CORE_PARAMETRIZATION_PARAMETERUTILS_H
17 
18 #include <string>
19 
20 class IParameterized;
21 
22 namespace ParameterUtils
23 {
24 
25 //! Returns true if given parameter name is related to angles.
26 bool isAngleRelated(const std::string& par_name);
27 
28 //! Returns units of main parameter.
29 std::string poolParameterUnits(const IParameterized& node, const std::string& parName);
30 
31 } // namespace ParameterUtils
32 
33 #endif // BORNAGAIN_CORE_PARAMETRIZATION_PARAMETERUTILS_H
Manages a local parameter pool, and a tree of child pools.
bool isAngleRelated(const std::string &par_name)
Returns true if given parameter name is related to angles.
std::string poolParameterUnits(const IParameterized &node, const std::string &parName)
Returns units of main parameter.