BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
MaterialBySLDImpl.cpp
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/Material/MaterialBySLDImpl.cpp
6 //! @brief Implements class MaterialBySLDImpl.
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 
16 #include "Base/Const/Units.h"
18 
19 namespace
20 {
22 
23 inline double getWlPrefactor(double wavelength)
24 {
25  return wavelength * wavelength / M_PI;
26 }
27 } // namespace
28 
29 MaterialBySLDImpl::MaterialBySLDImpl(const std::string& name, double sld_real, double sld_imag,
30  kvector_t magnetization)
31  : MagneticMaterialImpl(name, magnetization), m_sld_real(sld_real),
32  m_sld_imag(sld_imag < 0. ? throw std::runtime_error(
33  "The imaginary part of the SLD must be greater or equal zero")
34  : sld_imag)
35 {
36 }
37 
39 {
40  return new MaterialBySLDImpl(*this);
41 }
42 
44 {
45  return std::sqrt(refractiveIndex2(wavelength));
46 }
47 
49 {
50  return 1.0 - getWlPrefactor(wavelength) * sld();
51 }
52 
54 {
56 }
57 
59 {
60  double wavelength = wavevectors.getWavelength();
61  return 1.0 / getWlPrefactor(wavelength) - sld();
62 }
63 
64 void MaterialBySLDImpl::print(std::ostream& ostr) const
65 {
66  ostr << "MaterialBySLD:" << getName() << "<" << this << ">{ "
67  << "sld_real=" << m_sld_real << ", sld_imag = " << m_sld_imag << ", B=" << magnetization()
68  << "}";
69 }
70 
72 {
74 }
std::complex< double > complex_t
Definition: Complex.h:20
Defines class MaterialBySLDImpl.
#define M_PI
Definition: MathConstants.h:39
Defines some unit conversion factors and other constants in namespace Units.
Defines WavevectorInfo.
const std::string & getName() const
Returns name of the material.
Basic implementation for magnetized material.
kvector_t magnetization() const override final
Returns the magnetization (in A/m)
Material implementation based on wavelength-independent data (valid for a range of wavelengths)
void print(std::ostream &ostr) const override
Prints object data.
complex_t sld() const
Returns the scattering length density.
double m_sld_imag
imaginary part of scattering length density (negative by default)
complex_t refractiveIndex2(double wavelength) const override
Returns squared refractive index.
double m_sld_real
complex-valued scattering length density
complex_t scalarSubtrSLD(const WavevectorInfo &wavevectors) const override
Returns ( - sld), sld (in ) being the scattering length density.
complex_t refractiveIndex(double wavelength) const override
Returns refractive index.
MaterialBySLDImpl(const std::string &name, double sld_real, double sld_imag, kvector_t magnetization)
Constructs a wavelength-independent material with a given complex-valued scattering length density (S...
complex_t materialData() const override
Returns underlying material data.
MaterialBySLDImpl * clone() const override
Returns pointer to a copy of material.
Holds all wavevector information relevant for calculating form factors.
double getWavelength() const
static constexpr double angstrom
Definition: Units.h:25