Slice Class Reference

Description

Data structure containing the data of a single slice, for calculating the Fresnel coefficients.

Definition at line 31 of file Slice.h.

Collaboration diagram for Slice:

Public Member Functions
	Slice (const Slice &other)
	Slice (const ZLimits &zRange, Material material, const R3 &B_field, const LayerRoughness *roughness)
	Slice (Slice &&other)
	~Slice ()
R3	bField () const
void	initBField (R3 h_field, double h_z)
	Initializes the magnetic B field from a given ambient field strength H. More...
void	invertBField ()
const Material &	material () const
SpinMatrix	polarizedReducedPotential (R3 k, double n_ref) const
	Return the potential term that is used in the one-dimensional Fresnel calculations in the presence of magnetization. More...
complex_t	scalarReducedPotential (R3 k, double n_ref) const
	Return the potential term that is used in the one-dimensional Fresnel calculations. More...
void	setMaterial (const Material &material)
double	thicknessOr0 () const
const LayerRoughness *	topRoughness () const
double	zBottom () const
double	zTop () const
double	zTopOr0 () const

Private Attributes
R3	m_B_field
	cached value of magnetic induction More...
Material	m_material
const LayerRoughness *const	m_top_roughness
const ZLimits	m_zRange

Constructor & Destructor Documentation

Slice() [1/3]

Slice::Slice	(	const ZLimits &	zRange,
		Material	material,
		const R3 &	B_field,
		const LayerRoughness *	roughness
	)

Definition at line 22 of file Slice.cpp.

    : m_zRange(zRange)
    , m_material(std::move(material))
    , m_B_field(B_field)
    , m_top_roughness(roughness)
{
}

Slice() [2/3]

Slice::Slice

(

const Slice &

other

)

Definition at line 31 of file Slice.cpp.

    : Slice(other.m_zRange, other.m_material, other.m_B_field, other.m_top_roughness)
{
}

Slice() [3/3]

Slice::Slice

(

Slice &&

other

)

Definition at line 36 of file Slice.cpp.

    : m_zRange{other.m_zRange}
    , m_material{std::move(other.m_material)}
    , m_B_field{other.m_B_field}
    , m_top_roughness{other.m_top_roughness}
{
}

~Slice()

Slice::~Slice ( )

default

Member Function Documentation

bField()

R3 Slice::bField ( ) const

inline

Definition at line 57 of file Slice.h.

{ return m_B_field; }

References m_B_field.

initBField()

void Slice::initBField	(	R3	h_field,
		double	h_z
	)

Initializes the magnetic B field from a given ambient field strength H.

Definition at line 93 of file Slice.cpp.

{
    static constexpr double Magnetic_Permeability = 4e-7 * M_PI;
    m_B_field = Magnetic_Permeability * (h_field + m_material.magnetization());
    m_B_field.setZ(Magnetic_Permeability * h_z);
}

References m_B_field, m_material, M_PI, and Material::magnetization().

Referenced by SliceStack::setBField().

Here is the call graph for this function:

invertBField()

void Slice::invertBField

(

)

Definition at line 100 of file Slice.cpp.

{
    m_B_field = -m_B_field;
}

References m_B_field.

material()

const Material & Slice::material

(

)

const

Definition at line 51 of file Slice.cpp.

{
    return m_material;
}

References m_material.

Referenced by ProfileHelper::calculateProfile(), SliceStack::containsMagneticMaterial(), RoughMultiLayerContribution::get_refractive_term(), and setMaterial().

polarizedReducedPotential()

SpinMatrix Slice::polarizedReducedPotential	(	R3	k,
		double	n_ref
	)		const

Return the potential term that is used in the one-dimensional Fresnel calculations in the presence of magnetization.

Definition at line 87 of file Slice.cpp.

{
    complex_t n = m_material.refractiveIndex(2.0 * M_PI / k.mag());
    return MaterialUtils::PolarizedReducedPotential(n, m_B_field, k, n_ref);
}

References m_B_field, m_material, M_PI, MaterialUtils::PolarizedReducedPotential(), and Material::refractiveIndex().

Here is the call graph for this function:

scalarReducedPotential()

complex_t Slice::scalarReducedPotential	(	R3	k,
		double	n_ref
	)		const

Return the potential term that is used in the one-dimensional Fresnel calculations.

Definition at line 81 of file Slice.cpp.

{
    complex_t n = m_material.refractiveIndex(2.0 * M_PI / k.mag());
    return MaterialUtils::ScalarReducedPotential(n, k, n_ref);
}

References m_material, M_PI, Material::refractiveIndex(), and MaterialUtils::ScalarReducedPotential().

Here is the call graph for this function:

setMaterial()

void Slice::setMaterial

(

const Material &

material

)

Definition at line 46 of file Slice.cpp.

{
    m_material = material;
}

References m_material, and material().

Here is the call graph for this function:

thicknessOr0()

double Slice::thicknessOr0

(

)

const

Definition at line 71 of file Slice.cpp.

{
    return m_zRange.thicknessOr0();
}

References m_zRange, and ZLimits::thicknessOr0().

Referenced by RoughMultiLayerContribution::get_sum8terms().

Here is the call graph for this function:

topRoughness()

const LayerRoughness * Slice::topRoughness

(

)

const

Definition at line 76 of file Slice.cpp.

{
    return m_top_roughness;
}

References m_top_roughness.

Referenced by ProfileHelper::calculateProfile(), RoughMultiLayerContribution::compute(), and reSample::hasRoughness().

zBottom()

double Slice::zBottom

(

)

const

Definition at line 56 of file Slice.cpp.

{
    return m_zRange.zBottom();
}

References m_zRange, and ZLimits::zBottom().

Here is the call graph for this function:

zTop()

double Slice::zTop

(

)

const

Definition at line 61 of file Slice.cpp.

{
    return m_zRange.zTop();
}

References m_zRange, and ZLimits::zTop().

Referenced by ProfileHelper::calculateProfile().

Here is the call graph for this function:

zTopOr0()

double Slice::zTopOr0

(

)

const

Definition at line 66 of file Slice.cpp.

{
    return m_zRange.zTopOr0();
}

References m_zRange, and ZLimits::zTopOr0().

Here is the call graph for this function:

Member Data Documentation

m_B_field

R3 Slice::m_B_field

private

cached value of magnetic induction

Definition at line 64 of file Slice.h.

Referenced by bField(), initBField(), invertBField(), and polarizedReducedPotential().

m_material

Material Slice::m_material

private

Definition at line 63 of file Slice.h.

Referenced by initBField(), material(), polarizedReducedPotential(), scalarReducedPotential(), and setMaterial().

m_top_roughness

const LayerRoughness* const Slice::m_top_roughness

private

Definition at line 65 of file Slice.h.

Referenced by topRoughness().

m_zRange

const ZLimits Slice::m_zRange

private

Definition at line 62 of file Slice.h.

Referenced by thicknessOr0(), zBottom(), zTop(), and zTopOr0().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/Slice.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/Slice.cpp