MatrixRTCoefficients Class Reference

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

Inheritance diagram for MatrixRTCoefficients:

Collaboration diagram for MatrixRTCoefficients:

Public Member Functions
	MatrixRTCoefficients (const MatrixRTCoefficients &other)
	MatrixRTCoefficients (double kz_sign, Eigen::Vector2cd eigenvalues, kvector_t b, double magnetic_SLD)
	~MatrixRTCoefficients () override
MatrixRTCoefficients *	clone () const override
Eigen::Matrix2cd	computeDeltaMatrix (double thickness)
Eigen::Matrix2cd	computeInverseP () const
Eigen::Matrix2cd	computeP () const
Eigen::Vector2cd	getKz () const override
	Returns z-part of the two wavevector eigenmodes. More...
Eigen::Matrix2cd	getReflectionMatrix () const override
virtual complex_t	getScalarKz () const
virtual complex_t	getScalarR () const
virtual complex_t	getScalarT () const
	Scalar value getters; these throw errors by default as they should only be used when the derived object is really scalar. More...
double	magneticSLD () const
MatrixRTCoefficients &	operator= (const MatrixRTCoefficients &)
Eigen::Vector2cd	R1min () const override
Eigen::Vector2cd	R1plus () const override
Eigen::Vector2cd	R2min () const override
Eigen::Vector2cd	R2plus () const override
Eigen::Vector2cd	T1min () const override
Eigen::Vector2cd	T1plus () const override
	The following functions return the transmitted and reflected amplitudes for different incoming beam polarizations and eigenmodes. More...
Eigen::Vector2cd	T2min () const override
Eigen::Vector2cd	T2plus () const override

Private Member Functions
Eigen::Matrix2cd	pMatrixHelper (double sign) const
Eigen::Matrix2cd	T1Matrix () const
Eigen::Matrix2cd	T2Matrix () const
Eigen::Matrix2cd	TransformationMatrix (Eigen::Vector2d selection) const

Private Attributes
kvector_t	m_b
	unit magnetic field vector More...
double	m_kz_sign
Eigen::Vector2cd	m_lambda
	wave propagation direction (-1 for direct one, 1 for time reverse) More...
double	m_magnetic_SLD
Eigen::Matrix2cd	m_R
Eigen::Matrix2cd	m_T

Friends
class	SpecularMagneticNCStrategy
class	SpecularMagneticStrategy
class	SpecularMagneticTanhStrategy

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 31 of file MatrixRTCoefficients.h.

Constructor & Destructor Documentation

MatrixRTCoefficients() [1/2]

MatrixRTCoefficients::MatrixRTCoefficients	(	double	kz_sign,
		Eigen::Vector2cd	eigenvalues,
		kvector_t	b,
		double	magnetic_SLD
	)

Definition at line 23 of file MatrixRTCoefficients.cpp.

    : m_kz_sign(kz_sign)
    , m_lambda(std::move(eigenvalues))
    , m_b(std::move(b))
    , m_magnetic_SLD(magnetic_SLD)
{
    ASSERT(std::abs(m_b.mag() - 1) < eps || (m_b.mag() < eps && magnetic_SLD < eps));
 
    m_T << 1, 0, 0, 1;
    m_R << -1, 0, 0, -1;
}

References ASSERT, m_b, m_R, m_T, and BasicVector3D< T >::mag().

Referenced by clone().

Here is the call graph for this function:

MatrixRTCoefficients() [2/2]

MatrixRTCoefficients::MatrixRTCoefficients ( const MatrixRTCoefficients &  other )

default

~MatrixRTCoefficients()

MatrixRTCoefficients::~MatrixRTCoefficients ( )

overridedefault

Member Function Documentation

clone()

MatrixRTCoefficients * MatrixRTCoefficients::clone ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 42 of file MatrixRTCoefficients.cpp.

{
    return new MatrixRTCoefficients(*this);
}

References MatrixRTCoefficients().

Here is the call graph for this function:

computeDeltaMatrix()

Eigen::Matrix2cd MatrixRTCoefficients::computeDeltaMatrix

(

double

thickness

)

Definition at line 153 of file MatrixRTCoefficients.cpp.

{
    const complex_t alpha = 0.5 * thickness * (m_lambda(1) + m_lambda(0));
 
    // Compute resulting phase matrix according to exp(i p_m d_m) = exp1 * Q * exp2 * Q.adjoint();
    if (std::abs(m_b.mag() - 1.) < eps) {
        const Eigen::Matrix2cd exp2 = Eigen::DiagonalMatrix<complex_t, 2>(
            {GetImExponential(m_kz_sign * thickness * m_lambda(1)),
             GetImExponential(m_kz_sign * thickness * m_lambda(0))});
        Eigen::Matrix2cd Q;
        const double factor1 = 2. * (1. + m_b.z());
        Q << (1. + m_b.z()), (I * m_b.y() - m_b.x()), (m_b.x() + I * m_b.y()), (m_b.z() + 1.);
 
        return Q * exp2 * Q.adjoint() / factor1;
 
    } else if (m_b.mag() < eps)
        return Eigen::Matrix2cd::Identity() * GetImExponential(m_kz_sign * alpha);
 
    throw std::runtime_error("Broken magnetic field vector");
}

References I, m_b, m_kz_sign, m_lambda, BasicVector3D< T >::mag(), BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Here is the call graph for this function:

computeInverseP()

Eigen::Matrix2cd MatrixRTCoefficients::computeInverseP

(

)

const

Definition at line 139 of file MatrixRTCoefficients.cpp.

{
    const complex_t alpha = m_lambda(1) + m_lambda(0);
    const complex_t beta = m_lambda(1) - m_lambda(0);
 
    if (std::abs(alpha * alpha - beta * beta) == 0.)
        return Eigen::Matrix2cd::Zero();
 
    Eigen::Matrix2cd result = pMatrixHelper(-1.);
    result *= 2. / (alpha * alpha - beta * beta);
 
    return result;
}

References m_lambda, and pMatrixHelper().

Referenced by SpecularMagneticNCStrategy::computeBackwardsSubmatrices(), and SpecularMagneticTanhStrategy::computeBackwardsSubmatrices().

Here is the call graph for this function:

computeP()

Eigen::Matrix2cd MatrixRTCoefficients::computeP

(

)

const

Definition at line 131 of file MatrixRTCoefficients.cpp.

{
    Eigen::Matrix2cd result = pMatrixHelper(1.);
    result *= 0.5;
 
    return result;
}

References pMatrixHelper().

Referenced by SpecularMagneticNCStrategy::computeBackwardsSubmatrices(), and SpecularMagneticTanhStrategy::computeBackwardsSubmatrices().

Here is the call graph for this function:

getKz()

Eigen::Vector2cd MatrixRTCoefficients::getKz ( ) const

overridevirtual

Returns z-part of the two wavevector eigenmodes.

Implements ILayerRTCoefficients.

Definition at line 113 of file MatrixRTCoefficients.cpp.

{
    return m_kz_sign * m_lambda;
}

References m_kz_sign, and m_lambda.

getReflectionMatrix()

Eigen::Matrix2cd MatrixRTCoefficients::getReflectionMatrix ( ) const

inlineoverridevirtual

Reimplemented from ILayerRTCoefficients.

Definition at line 64 of file MatrixRTCoefficients.h.

{ return m_R; };

References m_R.

getScalarKz()

virtual complex_t ILayerRTCoefficients::getScalarKz ( ) const

inlinevirtualinherited

Reimplemented in ScalarRTCoefficients.

Definition at line 61 of file ILayerRTCoefficients.h.

    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarKz(): coefficients are not scalar.");
    }

getScalarR()

virtual complex_t ILayerRTCoefficients::getScalarR ( ) const

inlinevirtualinherited

Reimplemented in ScalarRTCoefficients.

Definition at line 56 of file ILayerRTCoefficients.h.

    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarR(): coefficients are not scalar.");
    }

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 51 of file ILayerRTCoefficients.h.

    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarT(): coefficients are not scalar.");
    }

magneticSLD()

double MatrixRTCoefficients::magneticSLD ( ) const

inline

Definition at line 57 of file MatrixRTCoefficients.h.

{ return m_magnetic_SLD; }

References m_magnetic_SLD.

operator=()

MatrixRTCoefficients & MatrixRTCoefficients::operator= ( const MatrixRTCoefficients &  )

default

pMatrixHelper()

Eigen::Matrix2cd MatrixRTCoefficients::pMatrixHelper ( double  sign ) const

private

Definition at line 118 of file MatrixRTCoefficients.cpp.

{
    const complex_t alpha = m_lambda(1) + m_lambda(0);
    const complex_t beta = m_lambda(1) - m_lambda(0);
 
    Eigen::Matrix2cd result;
 
    result << alpha + sign * beta * m_b.z(), sign * beta * (m_b.x() - I * m_b.y()),
        sign * beta * (m_b.x() + I * m_b.y()), alpha - sign * beta * m_b.z();
 
    return m_kz_sign * result;
}

References I, m_b, m_kz_sign, m_lambda, BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Referenced by computeInverseP(), and computeP().

Here is the call graph for this function:

R1min()

Eigen::Vector2cd MatrixRTCoefficients::R1min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 98 of file MatrixRTCoefficients.cpp.

{
    return T1Matrix() * m_R.col(1);
}

References m_R, and T1Matrix().

Here is the call graph for this function:

R1plus()

Eigen::Vector2cd MatrixRTCoefficients::R1plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 78 of file MatrixRTCoefficients.cpp.

{
    return T1Matrix() * m_R.col(0);
}

References m_R, and T1Matrix().

Here is the call graph for this function:

R2min()

Eigen::Vector2cd MatrixRTCoefficients::R2min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 108 of file MatrixRTCoefficients.cpp.

{
    return T2Matrix() * m_R.col(1);
}

References m_R, and T2Matrix().

Here is the call graph for this function:

R2plus()

Eigen::Vector2cd MatrixRTCoefficients::R2plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 88 of file MatrixRTCoefficients.cpp.

{
    return T2Matrix() * m_R.col(0);
}

References m_R, and T2Matrix().

Here is the call graph for this function:

T1Matrix()

Eigen::Matrix2cd MatrixRTCoefficients::T1Matrix ( ) const

private

Definition at line 63 of file MatrixRTCoefficients.cpp.

{
    return TransformationMatrix({0., 1.});
}

References TransformationMatrix().

Referenced by R1min(), R1plus(), T1min(), and T1plus().

Here is the call graph for this function:

T1min()

Eigen::Vector2cd MatrixRTCoefficients::T1min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 93 of file MatrixRTCoefficients.cpp.

{
    return T1Matrix() * m_T.col(1);
}

References m_T, and T1Matrix().

Here is the call graph for this function:

T1plus()

Eigen::Vector2cd MatrixRTCoefficients::T1plus ( ) const

overridevirtual

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

Implements ILayerRTCoefficients.

Definition at line 73 of file MatrixRTCoefficients.cpp.

{
    return T1Matrix() * m_T.col(0);
}

References m_T, and T1Matrix().

Here is the call graph for this function:

T2Matrix()

Eigen::Matrix2cd MatrixRTCoefficients::T2Matrix ( ) const

private

Definition at line 68 of file MatrixRTCoefficients.cpp.

{
    return TransformationMatrix({1., 0.});
}

References TransformationMatrix().

Referenced by R2min(), R2plus(), T2min(), and T2plus().

Here is the call graph for this function:

T2min()

Eigen::Vector2cd MatrixRTCoefficients::T2min ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 103 of file MatrixRTCoefficients.cpp.

{
    return T2Matrix() * m_T.col(1);
}

References m_T, and T2Matrix().

Here is the call graph for this function:

T2plus()

Eigen::Vector2cd MatrixRTCoefficients::T2plus ( ) const

overridevirtual

Implements ILayerRTCoefficients.

Definition at line 83 of file MatrixRTCoefficients.cpp.

{
    return T2Matrix() * m_T.col(0);
}

References m_T, and T2Matrix().

Here is the call graph for this function:

TransformationMatrix()

Eigen::Matrix2cd MatrixRTCoefficients::TransformationMatrix ( Eigen::Vector2d  selection ) const

private

Definition at line 47 of file MatrixRTCoefficients.cpp.

{
    const Eigen::Matrix2cd exp2 = Eigen::DiagonalMatrix<complex_t, 2>(selection);
 
    if (std::abs(m_b.mag() - 1.) < eps) {
        Eigen::Matrix2cd Q;
        const double factor1 = 2. * (1. + m_b.z());
        Q << (1. + m_b.z()), (I * m_b.y() - m_b.x()), (m_b.x() + I * m_b.y()), (m_b.z() + 1.);
        return Q * exp2 * Q.adjoint() / factor1;
 
    } else if (m_b.mag() < eps)
        return exp2;
 
    throw std::runtime_error("Broken magnetic field vector");
}

References I, m_b, BasicVector3D< T >::mag(), BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Referenced by T1Matrix(), and T2Matrix().

Here is the call graph for this function:

Friends And Related Function Documentation

SpecularMagneticNCStrategy

friend class SpecularMagneticNCStrategy

friend

Definition at line 34 of file MatrixRTCoefficients.h.

SpecularMagneticStrategy

friend class SpecularMagneticStrategy

friend

Definition at line 33 of file MatrixRTCoefficients.h.

SpecularMagneticTanhStrategy

friend class SpecularMagneticTanhStrategy

friend

Definition at line 35 of file MatrixRTCoefficients.h.

Member Data Documentation

m_b

kvector_t MatrixRTCoefficients::m_b

private

unit magnetic field vector

Definition at line 69 of file MatrixRTCoefficients.h.

Referenced by MatrixRTCoefficients(), computeDeltaMatrix(), SpecularMagneticNCStrategy::computeRoughnessMatrices(), SpecularMagneticTanhStrategy::computeRoughnessMatrix(), pMatrixHelper(), and TransformationMatrix().

m_kz_sign

double MatrixRTCoefficients::m_kz_sign

private

Definition at line 67 of file MatrixRTCoefficients.h.

Referenced by computeDeltaMatrix(), getKz(), and pMatrixHelper().

m_lambda

Eigen::Vector2cd MatrixRTCoefficients::m_lambda

private

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

eigenvalues for wave propagation

Definition at line 68 of file MatrixRTCoefficients.h.

Referenced by computeDeltaMatrix(), computeInverseP(), SpecularMagneticNCStrategy::computeRoughnessMatrices(), SpecularMagneticTanhStrategy::computeRoughnessMatrix(), getKz(), and pMatrixHelper().

m_magnetic_SLD

double MatrixRTCoefficients::m_magnetic_SLD

private

Definition at line 70 of file MatrixRTCoefficients.h.

Referenced by magneticSLD().

m_R

Eigen::Matrix2cd MatrixRTCoefficients::m_R

private

Definition at line 73 of file MatrixRTCoefficients.h.

Referenced by MatrixRTCoefficients(), getReflectionMatrix(), R1min(), R1plus(), R2min(), and R2plus().

m_T

Eigen::Matrix2cd MatrixRTCoefficients::m_T

private

Definition at line 72 of file MatrixRTCoefficients.h.

Referenced by MatrixRTCoefficients(), T1min(), T1plus(), T2min(), and T2plus().

---

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

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