BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
RefractiveMaterialImpl Class Reference
Materials

Material implementation based on refractive coefficiencts (valid for one wavelength value only) More...

Inheritance diagram for RefractiveMaterialImpl:
[legend]
Collaboration diagram for RefractiveMaterialImpl:
[legend]

Public Member Functions

virtual ~RefractiveMaterialImpl ()=default
 
RefractiveMaterialImpl * clone () const override
 Returns pointer to a copy of material. More...
 
const std::string & getName () const
 Returns name of the material. More...
 
MagneticMaterialImpl * inverted () const final
 Constructs a material with inverted magnetization. More...
 
bool isMagneticMaterial () const final
 
bool isScalarMaterial () const final
 Indicates whether the interaction with the material is scalar. More...
 
kvector_t magnetization () const final
 Returns the magnetization (in A/m) More...
 
complex_t materialData () const override
 Returns underlying material data. More...
 
Eigen::Matrix2cd polarizedSubtrSLD (const WavevectorInfo &wavevectors) const final
 Returns ( $ \pi/\lambda^2 $ - sld) matrix with magnetization corrections. More...
 
void print (std::ostream &ostr) const override
 Prints object data. More...
 
complex_t refractiveIndex (double wavelength) const override
 Returns refractive index For this particular implementation returned value does not depend on passed wavelength. More...
 
complex_t refractiveIndex2 (double wavelength) const override
 Returns squared refractive index. More...
 
MagneticMaterialImpl * rotatedMaterial (const Transform3D &transform) const final
 
complex_t scalarSubtrSLD (const WavevectorInfo &wavevectors) const override
 Returns ( $ \pi/\lambda^2 $ - sld), sld (in $nm^{-2}$) being the scattering length density. More...
 
MATERIAL_TYPES typeID () const override
 Returns type of material implementation. More...
 

Private Member Functions

 RefractiveMaterialImpl (const std::string &name, double delta, double beta, kvector_t magnetization)
 
void setMagnetization (kvector_t magnetization)
 

Private Attributes

const double m_beta
 $\beta$ coefficient for refractive index $n = 1 - \delta + i \beta$ More...
 
const double m_delta
 $\delta$ coefficient for refractive index $n = 1 - \delta + i \beta$ More...
 
kvector_t m_magnetization
 magnetization More...
 
const std::string m_name
 

Friends

Material HomogeneousMaterial (const std::string &, double, double, kvector_t)
 

Detailed Description

Material implementation based on refractive coefficiencts (valid for one wavelength value only)

Definition at line 29 of file RefractiveMaterialImpl.h.

Constructor & Destructor Documentation

◆ ~RefractiveMaterialImpl()

virtual RefractiveMaterialImpl::~RefractiveMaterialImpl ( )
virtualdefault

◆ RefractiveMaterialImpl()

RefractiveMaterialImpl::RefractiveMaterialImpl ( const std::string &  name,
double  delta,
double  beta,
kvector_t  magnetization 
)
private

Definition at line 18 of file RefractiveMaterialImpl.cpp.

20  : MagneticMaterialImpl(name, magnetization)
21  , m_delta(delta)
22  , m_beta(beta < 0. ? throw std::runtime_error(
23  "The imaginary part of the refractive index must be greater or equal zero")
24  : beta)
25 {
26 }
MagneticMaterialImpl::magnetization
kvector_t magnetization() const final
Returns the magnetization (in A/m)
Definition: MagneticMaterialImpl.cpp:61
MagneticMaterialImpl::MagneticMaterialImpl
MagneticMaterialImpl(const std::string &name, kvector_t magnetization)
Constructs basic material with name and magnetization.
Definition: MagneticMaterialImpl.cpp:38
RefractiveMaterialImpl::m_delta
const double m_delta
coefficient for refractive index
Definition: RefractiveMaterialImpl.h:68
RefractiveMaterialImpl::m_beta
const double m_beta
coefficient for refractive index
Definition: RefractiveMaterialImpl.h:70
RealSpace::Particles::name
QString const & name(EShape k)
Definition: particles.cpp:21

Referenced by clone().

Member Function Documentation

◆ clone()

RefractiveMaterialImpl * RefractiveMaterialImpl::clone ( ) const
overridevirtual

Returns pointer to a copy of material.

Implements MagneticMaterialImpl.

Definition at line 28 of file RefractiveMaterialImpl.cpp.

29 {
30  return new RefractiveMaterialImpl(*this);
31 }
RefractiveMaterialImpl::RefractiveMaterialImpl
RefractiveMaterialImpl(const std::string &name, double delta, double beta, kvector_t magnetization)
Definition: RefractiveMaterialImpl.cpp:18

References RefractiveMaterialImpl().

Here is the call graph for this function:

◆ getName()

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

Returns name of the material.

Definition at line 81 of file BaseMaterialImpl.h.

81 { return m_name; }
BaseMaterialImpl::m_name
const std::string m_name
Definition: BaseMaterialImpl.h:84

References BaseMaterialImpl::m_name.

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

◆ inverted()

MagneticMaterialImpl * MagneticMaterialImpl::inverted ( ) const
finalvirtualinherited

Constructs a material with inverted magnetization.

Implements BaseMaterialImpl.

Definition at line 43 of file MagneticMaterialImpl.cpp.

44 {
45  std::string name = isScalarMaterial() ? getName() : getName() + "_inv";
46  MagneticMaterialImpl* result = this->clone();
47  result->setMagnetization(-magnetization());
48  return result;
49 }
BaseMaterialImpl::getName
const std::string & getName() const
Returns name of the material.
Definition: BaseMaterialImpl.h:81
MagneticMaterialImpl
Basic implementation for magnetized material.
Definition: MagneticMaterialImpl.h:33
MagneticMaterialImpl::setMagnetization
void setMagnetization(kvector_t magnetization)
Definition: MagneticMaterialImpl.h:61
MagneticMaterialImpl::clone
MagneticMaterialImpl * clone() const override=0
Returns pointer to a copy of material.
MagneticMaterialImpl::isScalarMaterial
bool isScalarMaterial() const final
Indicates whether the interaction with the material is scalar.
Definition: MagneticMaterialImpl.cpp:51

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

Here is the call graph for this function:

◆ isMagneticMaterial()

bool MagneticMaterialImpl::isMagneticMaterial ( ) const
finalvirtualinherited

Implements BaseMaterialImpl.

Definition at line 56 of file MagneticMaterialImpl.cpp.

57 {
58  return !isScalarMaterial();
59 }

References MagneticMaterialImpl::isScalarMaterial().

Here is the call graph for this function:

◆ isScalarMaterial()

bool MagneticMaterialImpl::isScalarMaterial ( ) const
finalvirtualinherited

Indicates whether the interaction with the material is scalar.

This means that different polarization states will be diffracted equally

Implements BaseMaterialImpl.

Definition at line 51 of file MagneticMaterialImpl.cpp.

52 {
53  return m_magnetization == kvector_t{};
54 }
MagneticMaterialImpl::m_magnetization
kvector_t m_magnetization
magnetization
Definition: MagneticMaterialImpl.h:63

References MagneticMaterialImpl::m_magnetization.

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

◆ magnetization()

kvector_t MagneticMaterialImpl::magnetization ( ) const
finalvirtualinherited

Returns the magnetization (in A/m)

Implements BaseMaterialImpl.

Definition at line 61 of file MagneticMaterialImpl.cpp.

62 {
63  return m_magnetization;
64 }

References MagneticMaterialImpl::m_magnetization.

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

◆ materialData()

complex_t RefractiveMaterialImpl::materialData ( ) const
overridevirtual

Returns underlying material data.

Implements BaseMaterialImpl.

Definition at line 44 of file RefractiveMaterialImpl.cpp.

45 {
46  return complex_t(m_delta, m_beta);
47 }
complex_t
std::complex< double > complex_t
Definition: Complex.h:20

References m_beta, and m_delta.

◆ polarizedSubtrSLD()

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

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

Implements BaseMaterialImpl.

Definition at line 66 of file MagneticMaterialImpl.cpp.

67 {
68  cvector_t mag_ortho = OrthogonalToBaseVector(wavevectors.getQ(), m_magnetization);
69  complex_t unit_factor = scalarSubtrSLD(wavevectors);
70  return MaterialUtils::MagnetizationCorrection(unit_factor, magnetization_prefactor, mag_ortho);
71 }
magnetization_prefactor
constexpr double magnetization_prefactor
Definition: MagneticMaterialImpl.cpp:26
BaseMaterialImpl::scalarSubtrSLD
virtual complex_t scalarSubtrSLD(const WavevectorInfo &wavevectors) const =0
Returns ( - sld), sld being the scattering length density.
WavevectorInfo::getQ
cvector_t getQ() const
Definition: WavevectorInfo.h:40
MaterialUtils::MagnetizationCorrection
Eigen::Matrix2cd MagnetizationCorrection(complex_t unit_factor, double magnetic_factor, BasicVector3D< T > polarization)
Definition: MaterialUtils.cpp:36

References WavevectorInfo::getQ(), MagneticMaterialImpl::m_magnetization, magnetization_prefactor, MaterialUtils::MagnetizationCorrection(), and BaseMaterialImpl::scalarSubtrSLD().

Here is the call graph for this function:

◆ print()

void RefractiveMaterialImpl::print ( std::ostream &  ostr) const
overridevirtual

Prints object data.

Implements BaseMaterialImpl.

Definition at line 55 of file RefractiveMaterialImpl.cpp.

56 {
57  ostr << "RefractiveMaterial:" << getName() << "<" << this << ">{ "
58  << "delta=" << m_delta << ", beta=" << m_beta << ", B=" << magnetization() << "}";
59 }

References BaseMaterialImpl::getName(), m_beta, m_delta, and MagneticMaterialImpl::magnetization().

Here is the call graph for this function:

◆ refractiveIndex()

complex_t RefractiveMaterialImpl::refractiveIndex ( double  wavelength) const
overridevirtual

Returns refractive index For this particular implementation returned value does not depend on passed wavelength.

Implements BaseMaterialImpl.

Definition at line 33 of file RefractiveMaterialImpl.cpp.

34 {
35  return complex_t(1.0 - m_delta, m_beta);
36 }

References m_beta, and m_delta.

◆ refractiveIndex2()

complex_t RefractiveMaterialImpl::refractiveIndex2 ( double  wavelength) const
overridevirtual

Returns squared refractive index.

For this particular implementation returned value does not depend on passed wavelength.

Implements BaseMaterialImpl.

Definition at line 38 of file RefractiveMaterialImpl.cpp.

39 {
40  complex_t result(1.0 - m_delta, m_beta);
41  return result * result;
42 }

References m_beta, and m_delta.

Referenced by scalarSubtrSLD().

◆ rotatedMaterial()

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

Implements BaseMaterialImpl.

Definition at line 73 of file MagneticMaterialImpl.cpp.

74 {
75  kvector_t transformed_field = transform.transformed(m_magnetization);
76  MagneticMaterialImpl* result = this->clone();
77  result->setMagnetization(transformed_field);
78  return result;
79 }
Transform3D::transformed
ivector_t transformed(const ivector_t &v) const
Return transformed vector v.
Definition: Transform3D.cpp:110

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

Here is the call graph for this function:

◆ scalarSubtrSLD()

complex_t RefractiveMaterialImpl::scalarSubtrSLD ( const WavevectorInfo &  wavevectors) const
overridevirtual

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

If the wavelength associated with passed wavevector is different from the one associated with refractive coefficients used during the object construction, provided result is inconsistent.

Implements BaseMaterialImpl.

Definition at line 49 of file RefractiveMaterialImpl.cpp.

50 {
51  double wavelength = wavevectors.wavelength();
52  return M_PI / wavelength / wavelength * refractiveIndex2(wavelength);
53 }
M_PI
#define M_PI
Definition: Constants.h:44
RefractiveMaterialImpl::refractiveIndex2
complex_t refractiveIndex2(double wavelength) const override
Returns squared refractive index.
Definition: RefractiveMaterialImpl.cpp:38
WavevectorInfo::wavelength
double wavelength() const
Definition: WavevectorInfo.h:41

References M_PI, refractiveIndex2(), and WavevectorInfo::wavelength().

Here is the call graph for this function:

◆ setMagnetization()

void MagneticMaterialImpl::setMagnetization ( kvector_t  magnetization)
inlineprivateinherited

Definition at line 61 of file MagneticMaterialImpl.h.

61 { 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:

◆ typeID()

MATERIAL_TYPES RefractiveMaterialImpl::typeID ( ) const
inlineoverridevirtual

Returns type of material implementation.

Implements BaseMaterialImpl.

Definition at line 52 of file RefractiveMaterialImpl.h.

52 { return MATERIAL_TYPES::RefractiveMaterial; }

References RefractiveMaterial.

Friends And Related Function Documentation

◆ HomogeneousMaterial

Material HomogeneousMaterial ( const std::string &  ,
double  ,
double  ,
kvector_t   
)
friend

Definition at line 29 of file MaterialFactoryFuncs.cpp.

31 {
32  std::unique_ptr<RefractiveMaterialImpl> mat_impl(
33  new RefractiveMaterialImpl(name, delta, beta, magnetization));
34  return Material(std::move(mat_impl));
35 }
Material
A wrapper for underlying material implementation.
Definition: Material.h:29

Member Data Documentation

◆ m_beta

const double RefractiveMaterialImpl::m_beta
private

$\beta$ coefficient for refractive index $n = 1 - \delta + i \beta$

Definition at line 70 of file RefractiveMaterialImpl.h.

Referenced by materialData(), print(), refractiveIndex(), and refractiveIndex2().

◆ m_delta

const double RefractiveMaterialImpl::m_delta
private

$\delta$ coefficient for refractive index $n = 1 - \delta + i \beta$

Definition at line 68 of file RefractiveMaterialImpl.h.

Referenced by materialData(), print(), refractiveIndex(), and refractiveIndex2().

◆ m_magnetization

kvector_t MagneticMaterialImpl::m_magnetization
privateinherited

magnetization

Definition at line 63 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 84 of file BaseMaterialImpl.h.

Referenced by BaseMaterialImpl::getName().

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