Description

A number of materials-related helper functions for internal use.

Functions
MATERIAL_TYPES	checkMaterialTypes (const std::vector< const Material * > &materials)
	Checks if all non-default materials in materials are of the same type and returns this type. If several types of materials are involved, InvalidMaterialType identifier is returned. More...

template<typename T >
SpinMatrix	MagnetizationCorrection (complex_t unit_factor, double magnetic_factor, Vec3< T > polarization)

SpinMatrix	PolarizedReducedPotential (complex_t n, R3 b_field, R3 k, double n_ref)
	Function for calculating the reduced potential, used for obtaining the Fresnel coefficients (polarized material case) More...

complex_t	ScalarReducedPotential (complex_t n, R3 k, double n_ref)
	Function for calculating the reduced potential, used for obtaining the Fresnel coefficients (non-polarized material case) More...

Function Documentation

◆ checkMaterialTypes()

MATERIAL_TYPES MaterialUtils::checkMaterialTypes ( const std::vector< const Material * > & materials )

Checks if all non-default materials in materials are of the same type and returns this type. If several types of materials are involved, InvalidMaterialType identifier is returned.

Definition at line 64 of file MaterialUtils.cpp.

 {
     MATERIAL_TYPES result = MATERIAL_TYPES::RefractiveMaterial;
     bool isDefault = true;
     for (const Material* mat : materials) {
         if (isDefault) {
             result = mat->typeID();
             isDefault = mat->isDefaultMaterial();
             continue;
         }
         if (mat->typeID() != result && !mat->isDefaultMaterial())
             return MATERIAL_TYPES::InvalidMaterialType;
     }
     return result;
 }

References InvalidMaterialType, and RefractiveMaterial.

Referenced by SampleUtils::Multilayer::ContainsCompatibleMaterials().

◆ MagnetizationCorrection()

template<typename T >

SpinMatrix MaterialUtils::MagnetizationCorrection	(	complex_t	unit_factor,
		double	magnetic_factor,
		Vec3< T >	polarization
	)

Definition at line 36 of file MaterialUtils.cpp.

 {
     SpinMatrix result = unit_factor * SpinMatrix::One()
                         + magnetic_factor
                               * (Pauli_X * polarization.x() + Pauli_Y * polarization.y()
                                  + Pauli_Z * polarization.z());
     return result;
 }

References SpinMatrix::One().

Referenced by PolarizedReducedPotential(), and MagneticMaterialImpl::polarizedSubtrSLD().

Here is the call graph for this function:

◆ PolarizedReducedPotential()

SpinMatrix MaterialUtils::PolarizedReducedPotential	(	complex_t	n,
		R3	b_field,
		R3	k,
		double	n_ref
	)

Function for calculating the reduced potential, used for obtaining the Fresnel coefficients (polarized material case)

Definition at line 57 of file MaterialUtils.cpp.

 {
     double factor = magnetic_prefactor / k.mag2();
     complex_t unit_factor = ScalarReducedPotential(n, k, n_ref);
     return MagnetizationCorrection(unit_factor, factor, b_field);
 }

References magnetic_prefactor, MagnetizationCorrection(), and ScalarReducedPotential().

Referenced by Slice::polarizedReducedPotential().

Here is the call graph for this function:

◆ ScalarReducedPotential()

complex_t MaterialUtils::ScalarReducedPotential	(	complex_t	n,
		R3	k,
		double	n_ref
	)

Function for calculating the reduced potential, used for obtaining the Fresnel coefficients (non-polarized material case)

Definition at line 52 of file MaterialUtils.cpp.

 {
     return n * n - n_ref * n_ref * R3Util::sin2Theta(k);
 }