Slice Class Reference

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

Collaboration diagram for Slice:

Public Member Functions
	Slice (const Slice &other)
	Slice (double thickness, const Material &material)
	Slice (double thickness, const Material &material, const LayerRoughness &top_roughness)
	Slice (Slice &&other)
	~Slice ()
kvector_t	bField () const
void	initBField (kvector_t h_field, double b_z)
	Initializes the magnetic B field from a given ambient field strength H. More...
void	invertBField ()
const Material &	material () const
Slice &	operator= (const Slice &other)
Eigen::Matrix2cd	polarizedReducedPotential (kvector_t 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 (kvector_t 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	thickness () const
const LayerRoughness *	topRoughness () const

Static Public Attributes
static constexpr double	Magnetic_Permeability = 4e-7 * M_PI

Private Attributes
kvector_t	m_B_field
	cached value of magnetic induction More...
Material	m_material
double	m_thickness
std::unique_ptr< LayerRoughness >	m_top_roughness

Detailed Description

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

Definition at line 32 of file Slice.h.

Constructor & Destructor Documentation

Slice() [1/4]

Slice::Slice	(	double	thickness,
		const Material &	material
	)

Definition at line 19 of file Slice.cpp.

    : m_thickness{thickness}, m_material{material}, m_B_field{}, m_top_roughness{nullptr}
{
}

Slice() [2/4]

Slice::Slice	(	double	thickness,
		const Material &	material,
		const LayerRoughness &	top_roughness
	)

Definition at line 24 of file Slice.cpp.

    : m_thickness{thickness}
    , m_material{material}
    , m_B_field{}
    , m_top_roughness{top_roughness.clone()}
{
}

Slice() [3/4]

Slice::Slice

(

const Slice &

other

)

Definition at line 32 of file Slice.cpp.

    : m_thickness{other.m_thickness}
    , m_material{other.m_material}
    , m_B_field{other.m_B_field}
    , m_top_roughness{}
{
    if (other.m_top_roughness) {
        m_top_roughness.reset(other.m_top_roughness->clone());
    }
}

References m_top_roughness.

Slice() [4/4]

Slice::Slice

(

Slice &&

other

)

Definition at line 43 of file Slice.cpp.

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

~Slice()

Slice::~Slice ( )

default

Member Function Documentation

bField()

kvector_t Slice::bField ( ) const

inline

Definition at line 58 of file Slice.h.

{ return m_B_field; }

References m_B_field.

initBField()

void Slice::initBField	(	kvector_t	h_field,
		double	b_z
	)

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

Definition at line 96 of file Slice.cpp.

{
    m_B_field = Magnetic_Permeability * (h_field + m_material.magnetization());
    m_B_field.setZ(b_z);
}

References m_B_field, m_material, Magnetic_Permeability, Material::magnetization(), and BasicVector3D< T >::setZ().

Here is the call graph for this function:

invertBField()

void Slice::invertBField

(

)

Definition at line 102 of file Slice.cpp.

{
    m_B_field = -m_B_field;
}

References m_B_field.

material()

const Material & Slice::material

(

)

const

Definition at line 69 of file Slice.cpp.

{
    return m_material;
}

References m_material.

Referenced by setMaterial().

operator=()

Slice & Slice::operator=

(

const Slice &

other

)

Definition at line 51 of file Slice.cpp.

{
    m_thickness = other.m_thickness;
    m_material = other.m_material;
    m_B_field = other.m_B_field;
    if (other.m_top_roughness) {
        m_top_roughness.reset(other.m_top_roughness->clone());
    }
    return *this;
}

References m_B_field, m_material, m_thickness, and m_top_roughness.

polarizedReducedPotential()

Eigen::Matrix2cd Slice::polarizedReducedPotential	(	kvector_t	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 90 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, BasicVector3D< T >::mag(), MaterialUtils::PolarizedReducedPotential(), and Material::refractiveIndex().

Here is the call graph for this function:

scalarReducedPotential()

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

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

Definition at line 84 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, BasicVector3D< T >::mag(), Material::refractiveIndex(), and MaterialUtils::ScalarReducedPotential().

Here is the call graph for this function:

setMaterial()

void Slice::setMaterial

(

const Material &

material

)

Definition at line 64 of file Slice.cpp.

{
    m_material = material;
}

References m_material, and material().

Here is the call graph for this function:

thickness()

double Slice::thickness

(

)

const

Definition at line 74 of file Slice.cpp.

{
    return m_thickness;
}

References m_thickness.

topRoughness()

const LayerRoughness * Slice::topRoughness

(

)

const

Definition at line 79 of file Slice.cpp.

{
    return m_top_roughness.get();
}

References m_top_roughness.

Member Data Documentation

m_B_field

kvector_t Slice::m_B_field

private

cached value of magnetic induction

Definition at line 67 of file Slice.h.

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

m_material

Material Slice::m_material

private

Definition at line 66 of file Slice.h.

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

m_thickness

double Slice::m_thickness

private

Definition at line 65 of file Slice.h.

Referenced by operator=(), and thickness().

m_top_roughness

std::unique_ptr<LayerRoughness> Slice::m_top_roughness

private

Definition at line 68 of file Slice.h.

Referenced by Slice(), operator=(), and topRoughness().

Magnetic_Permeability

constexpr double Slice::Magnetic_Permeability = 4e-7 * M_PI

staticconstexpr

Definition at line 62 of file Slice.h.

Referenced by initBField(), and ProcessedSample::initBFields().

---

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

• /home/www/ba/Sample/Slice/Slice.h
• /home/www/ba/Sample/Slice/Slice.cpp