BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
MaterialFactoryFuncs.cpp
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/Material/MaterialFactoryFuncs.cpp
6 //! @brief Factory functions used to create material instances.
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 #include "Base/Const/Units.h"
19 #include <functional>
20 
21 Material HomogeneousMaterial(const std::string& name, complex_t refractive_index,
22  kvector_t magnetization)
23 {
24  const double delta = 1.0 - refractive_index.real();
25  const double beta = refractive_index.imag();
26  return HomogeneousMaterial(name, delta, beta, magnetization);
27 }
28 
29 Material HomogeneousMaterial(const std::string& name, double delta, double beta,
30  kvector_t magnetization)
31 {
32  std::unique_ptr<RefractiveMaterialImpl> mat_impl(
33  new RefractiveMaterialImpl(name, delta, beta, magnetization));
34  return Material(std::move(mat_impl));
35 }
36 
38 {
39  return HomogeneousMaterial("vacuum", 0.0, 0.0, kvector_t{});
40 }
41 
43 {
44  return MaterialBySLD("vacuum", 0.0, 0.0, kvector_t{});
45 }
46 
47 Material MaterialBySLD(const std::string& name, double sld_real, double sld_imag,
48  kvector_t magnetization)
49 {
50  constexpr double inv_sq_angstroms = 1.0 / (Units::angstrom * Units::angstrom);
51  std::unique_ptr<MaterialBySLDImpl> mat_impl(new MaterialBySLDImpl(
52  name, sld_real * inv_sq_angstroms, sld_imag * inv_sq_angstroms, magnetization));
53  return Material(std::move(mat_impl));
54 }
std::complex< double > complex_t
Definition: Complex.h:20
Defines class MaterialBySLDImpl.
Declares functions in namespace MaterialUtils.
Defines class RefractiveMaterialImpl.
Defines some unit conversion factors and other constants in namespace Units.
Material implementation based on wavelength-independent data (valid for a range of wavelengths)
A wrapper for underlying material implementation.
Definition: Material.h:29
Material implementation based on refractive coefficiencts (valid for one wavelength value only)
Material HomogeneousMaterial(const std::string &name, complex_t refractive_index, kvector_t magnetization)
Constructs a material with name, refractive_index and magnetization (in A/m).
Material MaterialBySLD()
static constexpr double angstrom
Definition: Units.h:25