MaterialUtils Namespace Reference

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

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. More...
template<typename T >
Eigen::Matrix2cd	MagnetizationCorrection (complex_t unit_factor, double magnetic_factor, BasicVector3D< T > polarization)
Eigen::Matrix2cd	PolarizedReducedPotential (complex_t n, kvector_t b_field, kvector_t 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, kvector_t k, double n_ref)
	Function for calculating the reduced potential, used for obtaining the Fresnel coefficients (non-polarized material case) More...

Detailed Description

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

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 69 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 MultiLayerUtils::ContainsCompatibleMaterials(), and createAveragedMaterial().

MagnetizationCorrection()

template<typename T >

Eigen::Matrix2cd MaterialUtils::MagnetizationCorrection	(	complex_t	unit_factor,
		double	magnetic_factor,
		BasicVector3D< T >	polarization
	)

Definition at line 36 of file MaterialUtils.cpp.

{
    Eigen::Matrix2cd result =
        unit_factor * Unit_Matrix
        + magnetic_factor
              * (Pauli_X * polarization[0] + Pauli_Y * polarization[1] + Pauli_Z * polarization[2]);
    return result;
}

References Unit_Matrix().

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

Here is the call graph for this function:

PolarizedReducedPotential()

Eigen::Matrix2cd MaterialUtils::PolarizedReducedPotential	(	complex_t	n,
		kvector_t	b_field,
		kvector_t	k,
		double	n_ref
	)

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

Definition at line 60 of file MaterialUtils.cpp.

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

References BasicVector3D< T >::mag2(), 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,
		kvector_t	k,
		double	n_ref
	)

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

Definition at line 55 of file MaterialUtils.cpp.

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

References BasicVector3D< T >::sin2Theta().

Referenced by PolarizedReducedPotential(), and Slice::scalarReducedPotential().

Here is the call graph for this function: