Materials

Description

Classes and functions to describe magnetic and non-magnetic materials.

Collaboration diagram for Materials:

Classes
class	BaseMaterialImpl
	Interface for material implementation classes. Inherited by MagneticMaterialImpl, which has further children. More...
class	MagneticMaterialImpl
	Basic implementation for magnetized material. Inherited by RefractiveMaterialImpl and MaterialBySLDImpl. Incorporates data and methods required to handle material magnetization. More...
class	Material
	A wrapper for underlying material implementation. More...
class	MaterialBySLDImpl
	Material implementation based on wavelength-independent data (valid for a range of wavelengths) More...
class	RefractiveMaterialImpl
	Material implementation based on refractive coefficiencts (valid for one wavelength value only) More...

Functions
Material	MaterialBySLD ()
Material	MaterialBySLD (const std::string &name, double sld_real, double sld_imag, R3 magnetization={})
Material	RefractiveMaterial (const std::string &name, complex_t refractive_index, R3 magnetization={})
Material	RefractiveMaterial (const std::string &name, double delta, double beta, R3 magnetization={})
Material	Vacuum ()

Function Documentation

MaterialBySLD() [1/2]

Material MaterialBySLD

(

)

Definition at line 40 of file MaterialFactoryFuncs.cpp.

{
    return MaterialBySLD("vacuum", 0.0, 0.0, R3{});
}

Referenced by ExemplarySamples::createAveragedSlicedCylinders(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createPlainMultiLayerBySLD(), ExemplarySamples::createSimpleMagneticLayer(), ExemplarySamples::createSLDSlicedCylinders(), and ExemplarySamples::createThickAbsorptiveSample().

MaterialBySLD() [2/2]

Material MaterialBySLD	(	const std::string &	name,
		double	sld_real,
		double	sld_imag,
		R3	magnetization = {}
	)

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

RefractiveMaterial() [1/2]

Material RefractiveMaterial	(	const std::string &	name,
		complex_t	refractive_index,
		R3	magnetization = {}
	)

Constructs a material with name, refractive_index and magnetization (in A/m). Alternatively, and for refractive index can be passed directly. With no parameters given, constructs default (vacuum) material with and zero magnetization.

Definition at line 21 of file MaterialFactoryFuncs.cpp.

{
    const double delta = 1.0 - refractive_index.real();
    const double beta = refractive_index.imag();
    return RefractiveMaterial(name, delta, beta, magnetization);
}

References ROOT::Math::Cephes::beta().

Referenced by ExemplarySamples::createCoreShellParticle(), ExemplarySamples::createHomogeneousMultilayer(), ExemplarySamples::createMagneticCylinders(), ExemplarySamples::createMagneticLayer(), ExemplarySamples::createMagneticParticleZeroField(), ExemplarySamples::createMagneticRotation(), ExemplarySamples::createMagneticSpheres(), ExemplarySamples::createMagneticSubstrateZeroField(), ExemplarySamples::createMultiLayerWithRoughness(), ExemplarySamples::createResonator(), ExemplarySamples::createSimpleMagneticRotationWithRoughness(), ExemplarySamples::createSlicedCylinders(), and Vacuum().

Here is the call graph for this function:

RefractiveMaterial() [2/2]

Material RefractiveMaterial	(	const std::string &	name,
		double	delta,
		double	beta,
		R3	magnetization = {}
	)

Definition at line 31 of file MaterialFactoryFuncs.cpp.

{
    std::unique_ptr<RefractiveMaterialImpl> mat_impl(
        new RefractiveMaterialImpl(name, delta, beta, magnetization));
    return Material(std::move(mat_impl));
}

Vacuum()

Material Vacuum

(

)

Definition at line 35 of file MaterialFactoryFuncs.cpp.

{
    return RefractiveMaterial("vacuum", 0.0, 0.0, R3{});
}

References RefractiveMaterial().

Here is the call graph for this function: