LayerRoughness Class Reference

Description

A roughness of interface between two layers.

Based on the article "X-ray reflection and transmission by rough surfaces" by D. K. G. de Boer, Physical Review B 51, 5297 (1995)

Definition at line 29 of file LayerRoughness.h.

Inheritance diagram for LayerRoughness:

Collaboration diagram for LayerRoughness:

Public Member Functions
	LayerRoughness ()
	LayerRoughness (double sigma, double hurstParameter=0, double lateralCorrLength=0)
	Constructor of layer roughness. More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
LayerRoughness *	clone () const override
	Returns a clone of this ISampleNode object. More...
std::vector< const Material * >	containedMaterials () const
	Returns set of unique materials contained in this ISampleNode. More...
double	corrFunction (R3 k) const
	Correlation function of the roughness profile. More...
double	hurst () const
	Returns hurst parameter. More...
bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. More...
double	lateralCorrLength () const
	Returns lateral correlation length. More...
virtual const Material *	material () const
	Returns nullptr, unless overwritten to return a specific material. More...
virtual std::vector< const INode * >	nodeChildren () const
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
std::string	pythonConstructor () const
	Creates the Python constructor of this class. More...
void	setHurstParameter (double hurstParameter)
	Sets hurst parameter. It describes how jagged the surface is. More...
void	setLatteralCorrLength (double lateralCorrLength)
	Sets lateral correlation length. More...
void	setSigma (double sigma)
	Sets rms of roughness. More...
double	sigma () const
	Returns rms of roughness. More...
double	spectralFunction (R3 kvec) const
	Returns power spectral density of the surface roughness. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Attributes
std::vector< double >	m_P

Private Attributes
double	m_hurstParameter
	Hurst parameter which describes how jagged the interface, 0<H<=1. More...
double	m_lateralCorrLength
	lateral correlation length of the roughness More...
double	m_sigma
	rms of roughness More...

Constructor & Destructor Documentation

LayerRoughness() [1/2]

LayerRoughness::LayerRoughness	(	double	sigma,
		double	hurstParameter = 0,
		double	lateralCorrLength = 0
	)

Constructor of layer roughness.

Parameters

sigma	rms of the roughness in nanometers
hurstParameter	hurst parameter which describes how jagged the interface, dimensionless [0.0, 1.0], where 0.0 gives more spikes, 1.0 more smoothness
lateralCorrLength	lateral correlation length of the roughness in nanometers

Definition at line 25 of file LayerRoughness.cpp.

    : m_sigma(sigma)
    , m_hurstParameter(hurstParameter)
    , m_lateralCorrLength(lateralCorrLength)
{
    RealLimits::nonnegative().check("CorrelationLength", m_lateralCorrLength);
}

References RealLimits::check(), m_lateralCorrLength, and RealLimits::nonnegative().

Here is the call graph for this function:

LayerRoughness() [2/2]

LayerRoughness::LayerRoughness

(

)

Definition at line 33 of file LayerRoughness.cpp.

    : LayerRoughness(0, 0, 0)
{
}

Referenced by clone().

Member Function Documentation

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string LayerRoughness::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 38 of file LayerRoughness.h.

{ return "LayerRoughness"; }

clone()

LayerRoughness* LayerRoughness::clone ( ) const

inlineoverridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 34 of file LayerRoughness.h.

    {
        return new LayerRoughness(m_sigma, m_hurstParameter, m_lateralCorrLength);
    }

References LayerRoughness(), m_hurstParameter, m_lateralCorrLength, and m_sigma.

Referenced by LayerInterface::setRoughness().

Here is the call graph for this function:

containedMaterials()

std::vector< const Material * > ISampleNode::containedMaterials ( ) const

inherited

Returns set of unique materials contained in this ISampleNode.

Definition at line 25 of file ISampleNode.cpp.

{
    std::vector<const Material*> result;
    if (const Material* p_material = material())
        result.push_back(p_material);
    for (const auto* child : nodeChildren()) {
        if (const auto* sample = dynamic_cast<const ISampleNode*>(child)) {
            for (const Material* p_material : sample->containedMaterials())
                result.push_back(p_material);
        }
    }
    return result;
}

References ISampleNode::material(), and INode::nodeChildren().

Referenced by SampleUtils::Multilayer::ContainsCompatibleMaterials(), SampleToPython::initLabels(), and ISampleNode::isMagnetic().

Here is the call graph for this function:

corrFunction()

double LayerRoughness::corrFunction

(

R3

k

)

const

Correlation function of the roughness profile.

Definition at line 57 of file LayerRoughness.cpp.

{
    double H = m_hurstParameter;
    double clength = m_lateralCorrLength;
    double R = sqrt(k.x() * k.x() + k.y() * k.y());
    return m_sigma * m_sigma * std::exp(-1.0 * std::pow(R / clength, 2. * H));
}

References TMath::H(), m_hurstParameter, m_lateralCorrLength, m_sigma, and TMath::R().

Here is the call graph for this function:

hurst()

double LayerRoughness::hurst ( ) const

inline

Returns hurst parameter.

Definition at line 59 of file LayerRoughness.h.

{ return m_hurstParameter; }

References m_hurstParameter.

isMagnetic()

bool ISampleNode::isMagnetic ( ) const

inherited

Returns true if there is any magnetic material in this ISampleNode.

Definition at line 39 of file ISampleNode.cpp.

{
    const auto materials = containedMaterials();
    return std::any_of(materials.cbegin(), materials.cend(),
                       [](const Material* mat) { return mat->isMagneticMaterial(); });
}

References ISampleNode::containedMaterials().

Referenced by reSample::make().

Here is the call graph for this function:

lateralCorrLength()

double LayerRoughness::lateralCorrLength ( ) const

inline

Returns lateral correlation length.

Definition at line 67 of file LayerRoughness.h.

{ return m_lateralCorrLength; }

References m_lateralCorrLength.

Referenced by setLatteralCorrLength().

material()

virtual const Material* ISampleNode::material ( ) const

inlinevirtualinherited

Returns nullptr, unless overwritten to return a specific material.

Reimplemented in Particle, and Layer.

Definition at line 36 of file ISampleNode.h.

{ return nullptr; }

Referenced by ISampleNode::containedMaterials().

nodeChildren()

std::vector< const INode * > INode::nodeChildren ( ) const

virtualinherited

Returns all children.

Reimplemented in ISimulation2D, ISimulation, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, IParticle, Crystal, MultiLayer, Layer, LayerInterface, ParticleLayout, InterferenceRadialParaCrystal, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, ConvolutionDetectorResolution, IDetector, and Beam.

Definition at line 56 of file INode.cpp.

{
    return {};
}

Referenced by NodeUtils::AllDescendantsOfType(), NodeUtils::ChildNodesOfType(), ISampleNode::containedMaterials(), and INode::nodeOffspring().

nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : nodeChildren()) {
        for (const auto* p : child->nodeOffspring())
            result.push_back(p);
    }
    return result;
}

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

std::vector<ParaMeta> LayerRoughness::parDefs ( ) const

inlinefinalvirtual

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented from INode.

Definition at line 39 of file LayerRoughness.h.

    {
        return {{"Sigma", "", "roughness amplitude", 0, +INF, 0},
                {"Hurst", "", "Power law exponent??", 0, +INF, 0},
                {"CorrLength", "nm", "lateral correlation length", 0, +INF, 0}};
    }

References INF.

pythonConstructor()

std::string LayerRoughness::pythonConstructor

(

)

const

Creates the Python constructor of this class.

Definition at line 65 of file LayerRoughness.cpp.

{
    return Py::Fmt::printFunction(
        "LayerRoughness", {{m_sigma, ""}, {m_hurstParameter, ""}, {m_lateralCorrLength, "nm"}});
}

References m_hurstParameter, m_lateralCorrLength, m_sigma, and Py::Fmt::printFunction().

Here is the call graph for this function:

setHurstParameter()

void LayerRoughness::setHurstParameter ( double  hurstParameter )

inline

Sets hurst parameter. It describes how jagged the surface is.

Definition at line 57 of file LayerRoughness.h.

{ m_hurstParameter = hurstParameter; }

References m_hurstParameter.

setLatteralCorrLength()

void LayerRoughness::setLatteralCorrLength ( double  lateralCorrLength )

inline

Sets lateral correlation length.

Definition at line 62 of file LayerRoughness.h.

    {
        m_lateralCorrLength = lateralCorrLength;
    }

References lateralCorrLength(), and m_lateralCorrLength.

Here is the call graph for this function:

setSigma()

void LayerRoughness::setSigma ( double  sigma )

inline

Sets rms of roughness.

Definition at line 52 of file LayerRoughness.h.

{ m_sigma = sigma; }

References m_sigma, and sigma().

Here is the call graph for this function:

sigma()

double LayerRoughness::sigma ( ) const

inline

Returns rms of roughness.

Definition at line 54 of file LayerRoughness.h.

{ return m_sigma; }

References m_sigma.

Referenced by MultiLayer::addLayerWithTopRoughness(), ProfileHelper::calculateProfile(), reSample::crossCorrSpectralFun(), ProfileHelper::defaultLimits(), RoughMultiLayerContribution::get_sum8terms(), and setSigma().

spectralFunction()

double LayerRoughness::spectralFunction

(

R3

kvec

)

const

Returns power spectral density of the surface roughness.

Power spectral density of the surface roughness is a result of two-dimensional Fourier transform of the correlation function of the roughness profile.

Based on the article D.K.G. de Boer, Physical review B, Volume 51, Number 8, 15 February 1995 "X-ray reflection and transmission by rough surfaces"

Definition at line 46 of file LayerRoughness.cpp.

{
    double H = m_hurstParameter;
    double clength2 = m_lateralCorrLength * m_lateralCorrLength;
    double Qpar2 = kvec.x() * kvec.x() + kvec.y() * kvec.y();
    return 4.0 * M_PI * H * m_sigma * m_sigma * clength2
           * std::pow((1.0 + Qpar2 * clength2), (-1 - H));
}

References TMath::H(), m_hurstParameter, m_lateralCorrLength, M_PI, and m_sigma.

Referenced by RoughMultiLayerContribution::compute(), and reSample::crossCorrSpectralFun().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_hurstParameter

double LayerRoughness::m_hurstParameter

private

Hurst parameter which describes how jagged the interface, 0<H<=1.

Definition at line 76 of file LayerRoughness.h.

Referenced by clone(), corrFunction(), hurst(), pythonConstructor(), setHurstParameter(), and spectralFunction().

m_lateralCorrLength

double LayerRoughness::m_lateralCorrLength

private

lateral correlation length of the roughness

Definition at line 77 of file LayerRoughness.h.

Referenced by LayerRoughness(), clone(), corrFunction(), lateralCorrLength(), pythonConstructor(), setLatteralCorrLength(), and spectralFunction().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_sigma

double LayerRoughness::m_sigma

private

rms of roughness

Definition at line 75 of file LayerRoughness.h.

Referenced by clone(), corrFunction(), pythonConstructor(), setSigma(), sigma(), and spectralFunction().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Interface/LayerRoughness.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Interface/LayerRoughness.cpp