MatrixRTCoefficients_v2 Class Reference

Inheritance diagram for MatrixRTCoefficients_v2:

Collaboration diagram for MatrixRTCoefficients_v2:

Public Member Functions
	MatrixRTCoefficients_v2 (double kz_sign, Eigen::Vector2cd eigenvalues, kvector_t b)
	MatrixRTCoefficients_v2 (const MatrixRTCoefficients_v2 &other)
	~MatrixRTCoefficients_v2 () override
MatrixRTCoefficients_v2 *	clone () const override
Eigen::Vector2cd	T1plus () const override
Eigen::Vector2cd	R1plus () const override
Eigen::Vector2cd	T2plus () const override
Eigen::Vector2cd	R2plus () const override
Eigen::Vector2cd	T1min () const override
Eigen::Vector2cd	R1min () const override
Eigen::Vector2cd	T2min () const override
Eigen::Vector2cd	R2min () const override
Eigen::Vector2cd	getKz () const override
Eigen::Matrix2cd	getReflectionMatrix () const override
virtual complex_t	getScalarT () const
virtual complex_t	getScalarR () const
virtual complex_t	getScalarKz () const

Private Attributes
double	m_kz_sign
Eigen::Vector2cd	m_lambda
kvector_t	m_b
Eigen::Vector4cd	m_w_plus
Eigen::Vector4cd	m_w_min
Eigen::Matrix4cd	T1
Eigen::Matrix4cd	R1
Eigen::Matrix4cd	T2
Eigen::Matrix4cd	R2

Friends
class	SpecularMagneticStrategy

Detailed Description

Specular reflection and transmission coefficients in a layer in case of magnetic interactions between the scattered particle and the layer.

Definition at line 26 of file MatrixRTCoefficients_v2.h.

Constructor & Destructor Documentation

MatrixRTCoefficients_v2() [1/2]

MatrixRTCoefficients_v2::MatrixRTCoefficients_v2	(	double	kz_sign,
		Eigen::Vector2cd	eigenvalues,
		kvector_t	b
	)

Definition at line 23 of file MatrixRTCoefficients_v2.cpp.

    : m_kz_sign(kz_sign), m_lambda(std::move(eigenvalues)), m_b(std::move(b))
{
}

Referenced by clone().

MatrixRTCoefficients_v2() [2/2]

MatrixRTCoefficients_v2::MatrixRTCoefficients_v2 ( const MatrixRTCoefficients_v2 &  other )

default

~MatrixRTCoefficients_v2()

MatrixRTCoefficients_v2::~MatrixRTCoefficients_v2 ( )

overridedefault

Member Function Documentation

clone()

MatrixRTCoefficients_v2 * MatrixRTCoefficients_v2::clone ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 33 of file MatrixRTCoefficients_v2.cpp.

{
    return new MatrixRTCoefficients_v2(*this);
}

References MatrixRTCoefficients_v2().

Here is the call graph for this function:

T1plus()

Eigen::Vector2cd MatrixRTCoefficients_v2::T1plus ( ) const

overridevirtual

The following functions return the transmitted and reflected amplitudes for different incoming beam polarizations and eigenmodes.

Implements ILayerRTCoefficients.

Definition at line 38 of file MatrixRTCoefficients_v2.cpp.

{
    const Eigen::Vector2cd result = waveVector(T1, m_w_plus);
    if (m_lambda(0) == 0.0 && result == Eigen::Vector2cd::Zero())
        return {0.5, 0.0};
    return result;
}

References m_lambda, m_w_plus, T1, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by SpecularMagneticStrategy::findNormalizationCoefficients().

Here is the call graph for this function:

R1plus()

Eigen::Vector2cd MatrixRTCoefficients_v2::R1plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 46 of file MatrixRTCoefficients_v2.cpp.

{
    if (m_lambda(0) == 0.0 && waveVector(T1, m_w_plus) == Eigen::Vector2cd::Zero())
        return {-0.5, 0.0};
    return waveVector(R1, m_w_plus);
}

References m_lambda, m_w_plus, R1, T1, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by getReflectionMatrix().

Here is the call graph for this function:

T2plus()

Eigen::Vector2cd MatrixRTCoefficients_v2::T2plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 53 of file MatrixRTCoefficients_v2.cpp.

{
    const Eigen::Vector2cd result = waveVector(T2, m_w_plus);
    if (m_lambda(1) == 0.0 && result == Eigen::Vector2cd::Zero())
        return {0.5, 0.0};
    return result;
}

References m_lambda, m_w_plus, T2, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by SpecularMagneticStrategy::findNormalizationCoefficients().

Here is the call graph for this function:

R2plus()

Eigen::Vector2cd MatrixRTCoefficients_v2::R2plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 61 of file MatrixRTCoefficients_v2.cpp.

{
    if (m_lambda(1) == 0.0 && waveVector(T2, m_w_plus) == Eigen::Vector2cd::Zero())
        return {-0.5, 0.0};
    return waveVector(R2, m_w_plus);
}

References m_lambda, m_w_plus, R2, T2, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by getReflectionMatrix().

Here is the call graph for this function:

T1min()

Eigen::Vector2cd MatrixRTCoefficients_v2::T1min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 68 of file MatrixRTCoefficients_v2.cpp.

{
    const Eigen::Vector2cd result = waveVector(T1, m_w_min);
    if (m_lambda(0) == 0.0 && result == Eigen::Vector2cd::Zero())
        return {0.0, 0.5};
    return result;
}

References m_lambda, m_w_min, T1, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by SpecularMagneticStrategy::findNormalizationCoefficients().

Here is the call graph for this function:

R1min()

Eigen::Vector2cd MatrixRTCoefficients_v2::R1min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 76 of file MatrixRTCoefficients_v2.cpp.

{
    if (m_lambda(0) == 0.0 && waveVector(T1, m_w_min) == Eigen::Vector2cd::Zero())
        return {0.0, -0.5};
    return waveVector(R1, m_w_min);
}

References m_lambda, m_w_min, R1, T1, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by getReflectionMatrix().

Here is the call graph for this function:

T2min()

Eigen::Vector2cd MatrixRTCoefficients_v2::T2min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 83 of file MatrixRTCoefficients_v2.cpp.

{
    const Eigen::Vector2cd result = waveVector(T2, m_w_min);
    if (m_lambda(1) == 0.0 && result == Eigen::Vector2cd::Zero())
        return {0.0, 0.5};
    return result;
}

References m_lambda, m_w_min, T2, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by SpecularMagneticStrategy::findNormalizationCoefficients().

Here is the call graph for this function:

R2min()

Eigen::Vector2cd MatrixRTCoefficients_v2::R2min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 91 of file MatrixRTCoefficients_v2.cpp.

{
    if (m_lambda(1) == 0.0 && waveVector(T2, m_w_min) == Eigen::Vector2cd::Zero())
        return {0.0, -0.5};
    return waveVector(R2, m_w_min);
}

References m_lambda, m_w_min, R2, T2, and anonymous_namespace{MatrixRTCoefficients_v2.cpp}::waveVector().

Referenced by getReflectionMatrix().

Here is the call graph for this function:

getKz()

Eigen::Vector2cd MatrixRTCoefficients_v2::getKz ( ) const

overridevirtual

Returns z-part of the two wavevector eigenmodes.

Implements ILayerRTCoefficients.

Definition at line 98 of file MatrixRTCoefficients_v2.cpp.

{
    return -I * m_kz_sign * m_lambda;
}

References I, m_kz_sign, and m_lambda.

getReflectionMatrix()

Eigen::Matrix2cd MatrixRTCoefficients_v2::getReflectionMatrix ( ) const

overridevirtual

Reimplemented from ILayerRTCoefficients.

Definition at line 103 of file MatrixRTCoefficients_v2.cpp.

{
    Eigen::Matrix2cd R;
    R.col(0) = R1plus() + R2plus();
    R.col(1) = R1min() + R2min();
 
    return R;
}

References R1min(), R1plus(), R2min(), and R2plus().

Here is the call graph for this function:

getScalarT()

virtual complex_t ILayerRTCoefficients::getScalarT ( ) const

inlinevirtualinherited

Scalar value getters; these throw errors by default as they should only be used when the derived object is really scalar.

Reimplemented in ScalarRTCoefficients.

Definition at line 48 of file ILayerRTCoefficients.h.

    {
        throw Exceptions::NotImplementedException("ILayerRTCoefficients::"
                                                  "getScalarT(): coefficients are not scalar.");
    }

getScalarR()

virtual complex_t ILayerRTCoefficients::getScalarR ( ) const

inlinevirtualinherited

Reimplemented in ScalarRTCoefficients.

Definition at line 53 of file ILayerRTCoefficients.h.

    {
        throw Exceptions::NotImplementedException("ILayerRTCoefficients::"
                                                  "getScalarR(): coefficients are not scalar.");
    }

getScalarKz()

virtual complex_t ILayerRTCoefficients::getScalarKz ( ) const

inlinevirtualinherited

Reimplemented in ScalarRTCoefficients.

Definition at line 58 of file ILayerRTCoefficients.h.

    {
        throw Exceptions::NotImplementedException("ILayerRTCoefficients::"
                                                  "getScalarKz(): coefficients are not scalar.");
    }

Friends And Related Function Documentation

SpecularMagneticStrategy

friend class SpecularMagneticStrategy

friend

Definition at line 29 of file MatrixRTCoefficients_v2.h.

Member Data Documentation

m_kz_sign

double MatrixRTCoefficients_v2::m_kz_sign

private

Definition at line 53 of file MatrixRTCoefficients_v2.h.

Referenced by getKz().

m_lambda

Eigen::Vector2cd MatrixRTCoefficients_v2::m_lambda

private

wave propagation direction (-1 for direct one, 1 for time reverse)

eigenvalues for wave propagation

Definition at line 54 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), SpecularMagneticStrategy::calculateZeroFieldTR(), getKz(), SpecularMagneticStrategy::nullifyBottomReflection(), R1min(), R1plus(), R2min(), R2plus(), T1min(), T1plus(), T2min(), and T2plus().

m_b

kvector_t MatrixRTCoefficients_v2::m_b

private

normalized magnetic field impact (with correction for external mag. field)

Definition at line 55 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), and SpecularMagneticStrategy::nullifyBottomReflection().

m_w_plus

Eigen::Vector4cd MatrixRTCoefficients_v2::m_w_plus

private

boundary values for up-polarization

Definition at line 57 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::nullifyBottomReflection(), R1plus(), R2plus(), SpecularMagneticStrategy::setNoTransmission(), T1plus(), and T2plus().

m_w_min

Eigen::Vector4cd MatrixRTCoefficients_v2::m_w_min

private

boundary values for down-polarization

Definition at line 58 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::nullifyBottomReflection(), R1min(), R2min(), SpecularMagneticStrategy::setNoTransmission(), T1min(), and T2min().

T1

Eigen::Matrix4cd MatrixRTCoefficients_v2::T1

private

matrix selecting the transmitted part of the first eigenmode

Definition at line 60 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), SpecularMagneticStrategy::calculateZeroFieldTR(), R1min(), R1plus(), SpecularMagneticStrategy::setNoTransmission(), T1min(), and T1plus().

R1

Eigen::Matrix4cd MatrixRTCoefficients_v2::R1

private

matrix selecting the reflected part of the first eigenmode

Definition at line 62 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), SpecularMagneticStrategy::calculateZeroFieldTR(), R1min(), R1plus(), and SpecularMagneticStrategy::setNoTransmission().

T2

Eigen::Matrix4cd MatrixRTCoefficients_v2::T2

private

matrix selecting the transmitted part of the second eigenmode

Definition at line 64 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), SpecularMagneticStrategy::calculateZeroFieldTR(), R2min(), R2plus(), SpecularMagneticStrategy::setNoTransmission(), T2min(), and T2plus().

R2

Eigen::Matrix4cd MatrixRTCoefficients_v2::R2

private

matrix selecting the reflected part of the second eigenmode

Definition at line 66 of file MatrixRTCoefficients_v2.h.

Referenced by SpecularMagneticStrategy::calculateTR(), SpecularMagneticStrategy::calculateZeroFieldTR(), R2min(), R2plus(), and SpecularMagneticStrategy::setNoTransmission().

---

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

• /home/www/ba/Sample/RT/MatrixRTCoefficients_v2.h
• /home/www/ba/Sample/RT/MatrixRTCoefficients_v2.cpp