Inheritance diagram for MaterialBySLDImpl:

Collaboration diagram for MaterialBySLDImpl:

Public Member Functions
virtual	~MaterialBySLDImpl ()=default

MaterialBySLDImpl *	clone () const override

complex_t	refractiveIndex (double wavelength) const override

complex_t	refractiveIndex2 (double wavelength) const override

complex_t	materialData () const override

MATERIAL_TYPES	typeID () const override

complex_t	scalarSubtrSLD (const WavevectorInfo &wavevectors) const override

void	print (std::ostream &ostr) const override

MagneticMaterialImpl *	inverted () const override final

bool	isScalarMaterial () const override final

bool	isMagneticMaterial () const override final

kvector_t	magnetization () const override final

Eigen::Matrix2cd	polarizedSubtrSLD (const WavevectorInfo &wavevectors) const override final

MagneticMaterialImpl *	rotatedMaterial (const Transform3D &transform) const override final

const std::string &	getName () const

Private Member Functions
	MaterialBySLDImpl (const std::string &name, double sld_real, double sld_imag, kvector_t magnetization)

complex_t	sld () const

void	setMagnetization (kvector_t magnetization)

Private Attributes
double	m_sld_real

double	m_sld_imag

kvector_t	m_magnetization

const std::string	m_name

Friends
Material	MaterialBySLD (const std::string &name, double sld_real, double sld_imag, kvector_t magnetization)

Detailed Description

Material implementation based on wavelength-independent data (valid for a range of wavelengths)

Definition at line 24 of file MaterialBySLDImpl.h.

Constructor & Destructor Documentation

◆ ~MaterialBySLDImpl()

virtual MaterialBySLDImpl::~MaterialBySLDImpl ( )

virtualdefault

◆ MaterialBySLDImpl()

MaterialBySLDImpl::MaterialBySLDImpl	(	const std::string &	name,
		double	sld_real,
		double	sld_imag,
		kvector_t	magnetization
	)

private

Constructs a wavelength-independent material with a given complex-valued scattering length density (SLD).

SLD units are $nm^{-2}$ .

Definition at line 29 of file MaterialBySLDImpl.cpp.

     : MagneticMaterialImpl(name, magnetization), m_sld_real(sld_real),
       m_sld_imag(sld_imag < 0. ? throw std::runtime_error(
                      "The imaginary part of the SLD must be greater or equal zero")
                                : sld_imag)
 {
 }

Referenced by clone().

Member Function Documentation

◆ clone()

MaterialBySLDImpl * MaterialBySLDImpl::clone ( ) const

overridevirtual

Returns pointer to a copy of material.

Implements MagneticMaterialImpl.

Definition at line 38 of file MaterialBySLDImpl.cpp.

 {
     return new MaterialBySLDImpl(*this);
 }

References MaterialBySLDImpl().

Here is the call graph for this function:

◆ refractiveIndex()

complex_t MaterialBySLDImpl::refractiveIndex ( double wavelength ) const

overridevirtual

Returns refractive index.

Implements BaseMaterialImpl.

Definition at line 43 of file MaterialBySLDImpl.cpp.

 {
     return std::sqrt(refractiveIndex2(wavelength));
 }

References refractiveIndex2(), and anonymous_namespace{SlicedCylindersBuilder.cpp}::wavelength().

Here is the call graph for this function:

◆ refractiveIndex2()

complex_t MaterialBySLDImpl::refractiveIndex2 ( double wavelength ) const

overridevirtual

Returns squared refractive index.

Implements BaseMaterialImpl.

Definition at line 48 of file MaterialBySLDImpl.cpp.

 {
     return 1.0 - getWlPrefactor(wavelength) * sld();
 }

References anonymous_namespace{MaterialBySLDImpl.cpp}::getWlPrefactor(), sld(), and anonymous_namespace{SlicedCylindersBuilder.cpp}::wavelength().

Referenced by refractiveIndex().

Here is the call graph for this function:

◆ materialData()

complex_t MaterialBySLDImpl::materialData ( ) const

overridevirtual

Returns underlying material data.

Implements BaseMaterialImpl.

Definition at line 53 of file MaterialBySLDImpl.cpp.

 {
     return complex_t(m_sld_real * square_angstroms, m_sld_imag * square_angstroms);
 }

References m_sld_imag, m_sld_real, and anonymous_namespace{MaterialBySLDImpl.cpp}::square_angstroms.

◆ typeID()

MATERIAL_TYPES MaterialBySLDImpl::typeID ( ) const

inlineoverridevirtual

Returns type of material implementation.

Implements BaseMaterialImpl.

Definition at line 45 of file MaterialBySLDImpl.h.

45 { return MATERIAL_TYPES::MaterialBySLD; }

MATERIAL_TYPES::MaterialBySLD

@ MaterialBySLD

References MaterialBySLD.

◆ scalarSubtrSLD()

complex_t MaterialBySLDImpl::scalarSubtrSLD ( const WavevectorInfo & wavevectors ) const

overridevirtual

Returns ( $\pi/\lambda^2$ - sld), sld (in $nm^{-2}$ ) being the scattering length density.

Implements BaseMaterialImpl.

Definition at line 58 of file MaterialBySLDImpl.cpp.

 {
     double wavelength = wavevectors.getWavelength();
     return 1.0 / getWlPrefactor(wavelength) - sld();
 }

References WavevectorInfo::getWavelength(), anonymous_namespace{MaterialBySLDImpl.cpp}::getWlPrefactor(), sld(), and anonymous_namespace{SlicedCylindersBuilder.cpp}::wavelength().

Here is the call graph for this function:

◆ print()

void MaterialBySLDImpl::print ( std::ostream & ostr ) const

overridevirtual

Prints object data.

Implements BaseMaterialImpl.

Definition at line 64 of file MaterialBySLDImpl.cpp.

 {
     ostr << "MaterialBySLD:" << getName() << "<" << this << ">{ "
          << "sld_real=" << m_sld_real << ", sld_imag = " << m_sld_imag << ", B=" << magnetization()
          << "}";
 }

References BaseMaterialImpl::getName(), m_sld_imag, m_sld_real, and MagneticMaterialImpl::magnetization().

Here is the call graph for this function:

◆ sld()

complex_t MaterialBySLDImpl::sld ( ) const

private

Returns the scattering length density.

Definition at line 71 of file MaterialBySLDImpl.cpp.

 {
     return complex_t(m_sld_real, -m_sld_imag);
 }

References m_sld_imag, and m_sld_real.

Referenced by refractiveIndex2(), and scalarSubtrSLD().

◆ inverted()

MagneticMaterialImpl * MagneticMaterialImpl::inverted ( ) const

finaloverridevirtualinherited

Constructs a material with inverted magnetization.

Implements BaseMaterialImpl.

Definition at line 44 of file MagneticMaterialImpl.cpp.

 {
     std::string name = isScalarMaterial() ? getName() : getName() + "_inv";
     MagneticMaterialImpl* result = this->clone();
     result->setMagnetization(-magnetization());
     return result;
 }

References MagneticMaterialImpl::clone(), BaseMaterialImpl::getName(), MagneticMaterialImpl::isScalarMaterial(), MagneticMaterialImpl::magnetization(), and MagneticMaterialImpl::setMagnetization().

Here is the call graph for this function:

◆ isScalarMaterial()

bool MagneticMaterialImpl::isScalarMaterial ( ) const

finaloverridevirtualinherited

Indicates whether the interaction with the material is scalar.

This means that different polarization states will be diffracted equally

Implements BaseMaterialImpl.

Definition at line 52 of file MagneticMaterialImpl.cpp.

 {
     return m_magnetization == kvector_t{};
 }

References MagneticMaterialImpl::m_magnetization.

Referenced by MagneticMaterialImpl::inverted(), and MagneticMaterialImpl::isMagneticMaterial().

◆ isMagneticMaterial()

bool MagneticMaterialImpl::isMagneticMaterial ( ) const

finaloverridevirtualinherited

Implements BaseMaterialImpl.

Definition at line 57 of file MagneticMaterialImpl.cpp.

 {
     return !isScalarMaterial();
 }

References MagneticMaterialImpl::isScalarMaterial().

Here is the call graph for this function:

◆ magnetization()

kvector_t MagneticMaterialImpl::magnetization ( ) const

finaloverridevirtualinherited

Returns the magnetization (in A/m)

Implements BaseMaterialImpl.

Definition at line 62 of file MagneticMaterialImpl.cpp.

 {
     return m_magnetization;
 }

References MagneticMaterialImpl::m_magnetization.

Referenced by MagneticMaterialImpl::inverted(), print(), RefractiveMaterialImpl::print(), and MagneticMaterialImpl::setMagnetization().

◆ polarizedSubtrSLD()

Eigen::Matrix2cd MagneticMaterialImpl::polarizedSubtrSLD ( const WavevectorInfo & wavevectors ) const

finaloverridevirtualinherited

Returns ( $\pi/\lambda^2$ - sld) matrix with magnetization corrections.

Implements BaseMaterialImpl.

Definition at line 67 of file MagneticMaterialImpl.cpp.

 {
     cvector_t mag_ortho = OrthogonalToBaseVector(wavevectors.getQ(), m_magnetization);
     complex_t unit_factor = scalarSubtrSLD(wavevectors);
     return MaterialUtils::MagnetizationCorrection(unit_factor, magnetization_prefactor, mag_ortho);
 }

References WavevectorInfo::getQ(), MagneticMaterialImpl::m_magnetization, magnetization_prefactor, MaterialUtils::MagnetizationCorrection(), anonymous_namespace{MagneticMaterialImpl.cpp}::OrthogonalToBaseVector(), and BaseMaterialImpl::scalarSubtrSLD().

Here is the call graph for this function:

◆ rotatedMaterial()

MagneticMaterialImpl * MagneticMaterialImpl::rotatedMaterial ( const Transform3D & transform ) const

finaloverridevirtualinherited

Implements BaseMaterialImpl.

Definition at line 74 of file MagneticMaterialImpl.cpp.

 {
     kvector_t transformed_field = transform.transformed(m_magnetization);
     MagneticMaterialImpl* result = this->clone();
     result->setMagnetization(transformed_field);
     return result;
 }

References MagneticMaterialImpl::clone(), MagneticMaterialImpl::m_magnetization, MagneticMaterialImpl::setMagnetization(), and Transform3D::transformed().

Here is the call graph for this function:

◆ setMagnetization()

void MagneticMaterialImpl::setMagnetization ( kvector_t magnetization )

inlineprivateinherited

Definition at line 57 of file MagneticMaterialImpl.h.

57 { m_magnetization = magnetization; }

References MagneticMaterialImpl::m_magnetization, and MagneticMaterialImpl::magnetization().

Referenced by MagneticMaterialImpl::inverted(), and MagneticMaterialImpl::rotatedMaterial().

Here is the call graph for this function:

◆ getName()

const std::string& BaseMaterialImpl::getName ( ) const

inlineinherited

Returns name of the material.

Definition at line 78 of file BaseMaterialImpl.h.

78 { return m_name; }

BaseMaterialImpl::m_name

const std::string m_name

Definition: BaseMaterialImpl.h:81

References BaseMaterialImpl::m_name.

Referenced by MagneticMaterialImpl::inverted(), print(), and RefractiveMaterialImpl::print().

Friends And Related Function Documentation

◆ MaterialBySLD

Material MaterialBySLD	(	const std::string &	name,
		double	sld_real,
		double	sld_imag,
		kvector_t	magnetization
	)

friend

Constructs a wavelength-independent material with a given complex-valued scattering length density (SLD).

SLD values for a wide variety of materials can be found on https://sld-calculator.appspot.com/ and https://www.ncnr.nist.gov/resources/activation/ By convention, SLD imaginary part is treated as negative by default, which corresponds to attenuation of the signal. With no parameters given, MaterialBySLD constructs default (vacuum) material with zero sld and zero magnetization.

Parameters

name	material name
sld_real	real part of the scattering length density, inverse square angstroms
sld_imag	imaginary part of the scattering length density, inverse square angstroms
magnetization	magnetization (in A/m)

Definition at line 47 of file MaterialFactoryFuncs.cpp.

 {
     constexpr double inv_sq_angstroms = 1.0 / (Units::angstrom * Units::angstrom);
     std::unique_ptr<MaterialBySLDImpl> mat_impl(new MaterialBySLDImpl(
         name, sld_real * inv_sq_angstroms, sld_imag * inv_sq_angstroms, magnetization));
     return Material(std::move(mat_impl));
 }

Member Data Documentation

◆ m_sld_real

double MaterialBySLDImpl::m_sld_real

private

complex-valued scattering length density

Definition at line 62 of file MaterialBySLDImpl.h.

Referenced by materialData(), print(), and sld().

◆ m_sld_imag

double MaterialBySLDImpl::m_sld_imag

private

imaginary part of scattering length density (negative by default)

Definition at line 63 of file MaterialBySLDImpl.h.

Referenced by materialData(), print(), and sld().

◆ m_magnetization

kvector_t MagneticMaterialImpl::m_magnetization

privateinherited

magnetization

Definition at line 59 of file MagneticMaterialImpl.h.

Referenced by MagneticMaterialImpl::isScalarMaterial(), MagneticMaterialImpl::magnetization(), MagneticMaterialImpl::polarizedSubtrSLD(), MagneticMaterialImpl::rotatedMaterial(), and MagneticMaterialImpl::setMagnetization().

◆ m_name

const std::string BaseMaterialImpl::m_name

privateinherited

Definition at line 81 of file BaseMaterialImpl.h.

Referenced by BaseMaterialImpl::getName().

The documentation for this class was generated from the following files:

/home/www/ba/Sample/Material/MaterialBySLDImpl.h
/home/www/ba/Sample/Material/MaterialBySLDImpl.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~MaterialBySLDImpl()

◆ MaterialBySLDImpl()

Member Function Documentation

◆ clone()

◆ refractiveIndex()

◆ refractiveIndex2()

◆ materialData()

◆ typeID()

◆ scalarSubtrSLD()

◆ print()

◆ sld()

◆ inverted()

◆ isScalarMaterial()

◆ isMagneticMaterial()

◆ magnetization()

◆ polarizedSubtrSLD()

◆ rotatedMaterial()

◆ setMagnetization()

◆ getName()

Friends And Related Function Documentation

◆ MaterialBySLD

Member Data Documentation

◆ m_sld_real

◆ m_sld_imag

◆ m_magnetization

◆ m_name