Inheritance diagram for MagneticMaterialImpl:

Collaboration diagram for MagneticMaterialImpl:

Public Member Functions
	MagneticMaterialImpl (const std::string &name, kvector_t magnetization)

virtual	~MagneticMaterialImpl ()=default

MagneticMaterialImpl *	clone () const override=0

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

virtual complex_t	refractiveIndex (double wavelength) const =0

virtual complex_t	refractiveIndex2 (double wavelength) const =0

virtual complex_t	materialData () const =0

virtual MATERIAL_TYPES	typeID () const =0

virtual complex_t	scalarSubtrSLD (const WavevectorInfo &wavevectors) const =0

virtual void	print (std::ostream &ostr) const =0

const std::string &	getName () const

Private Member Functions
void	setMagnetization (kvector_t magnetization)

Private Attributes
kvector_t	m_magnetization

const std::string	m_name

Detailed Description

Basic implementation for magnetized material.

Inherited by RefractiveMaterialImpl and MaterialBySLDImpl. Incorporates data and methods required to handle material magnetization.

Definition at line 28 of file MagneticMaterialImpl.h.

Constructor & Destructor Documentation

◆ MagneticMaterialImpl()

MagneticMaterialImpl::MagneticMaterialImpl	(	const std::string &	name,
		kvector_t	magnetization
	)

Constructs basic material with name and magnetization.

Definition at line 39 of file MagneticMaterialImpl.cpp.

     : BaseMaterialImpl(name), m_magnetization(magnetization)
 {
 }

◆ ~MagneticMaterialImpl()

virtual MagneticMaterialImpl::~MagneticMaterialImpl ( )

virtualdefault

Member Function Documentation

◆ clone()

MagneticMaterialImpl* MagneticMaterialImpl::clone ( ) const

overridepure virtual

Returns pointer to a copy of material.

Implements BaseMaterialImpl.

Implemented in RefractiveMaterialImpl, and MaterialBySLDImpl.

Referenced by inverted(), and rotatedMaterial().

◆ inverted()

MagneticMaterialImpl * MagneticMaterialImpl::inverted ( ) const

finaloverridevirtual

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 clone(), BaseMaterialImpl::getName(), isScalarMaterial(), magnetization(), and setMagnetization().

Here is the call graph for this function:

◆ isScalarMaterial()

bool MagneticMaterialImpl::isScalarMaterial ( ) const

finaloverridevirtual

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 m_magnetization.

Referenced by inverted(), and isMagneticMaterial().

◆ isMagneticMaterial()

bool MagneticMaterialImpl::isMagneticMaterial ( ) const

finaloverridevirtual

Implements BaseMaterialImpl.

Definition at line 57 of file MagneticMaterialImpl.cpp.

 {
     return !isScalarMaterial();
 }

References isScalarMaterial().

Here is the call graph for this function:

◆ magnetization()

kvector_t MagneticMaterialImpl::magnetization ( ) const

finaloverridevirtual

Returns the magnetization (in A/m)

Implements BaseMaterialImpl.

Definition at line 62 of file MagneticMaterialImpl.cpp.

 {
     return m_magnetization;
 }

References m_magnetization.

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

◆ polarizedSubtrSLD()

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

finaloverridevirtual

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(), 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

finaloverridevirtual

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;
 }