MultiLayer Class Reference

Description

Our sample model: a stack of layers one below the other.

Example of system of 4 layers (3 interfaces):

vacuum      layer 0
---------   interface 0    z=0.0
Fe, 20A     layer 1
---------   interface 1    z=-20.0
Cr, 40A     layer 2
---------   interface 2    z=-60.0
substrate   layer 3

Definition at line 43 of file MultiLayer.h.

Inheritance diagram for MultiLayer:

Collaboration diagram for MultiLayer:

Public Member Functions
	MultiLayer (std::string name="Unnamed")
	~MultiLayer () override
void	addLayer (const Layer &layer)
	Adds layer with default (zero) roughness. More...
void	addLayerWithTopRoughness (const Layer &layer, const LayerRoughness &roughness)
	Adds layer with top 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...
MultiLayer *	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	crossCorrLength () const
	Returns cross correlation length of roughnesses between interfaces. More...
R3	externalField () const
	Returns the external field applied to the sample (units: A/m) More...
bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. More...
const Layer *	layer (size_t i_layer) const
	Returns layer with given index. More...
const LayerInterface *	layerInterface (size_t i_interface) const
	Returns interface with given index. More...
virtual const Material *	material () const
	Returns nullptr, unless overwritten to return a specific material. More...
std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
size_t	numberOfLayers () const
virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
RoughnessModel	roughnessModel () const
const std::string &	sampleName () const
void	setCrossCorrLength (double crossCorrLength)
	Sets cross correlation length of roughnesses between interfaces. More...
void	setExternalField (R3 ext_field)
	Sets the external field applied to the sample (units: A/m) More...
void	setRoughnessModel (RoughnessModel roughnessModel)
void	setSampleName (const std::string &name)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Attributes
std::vector< double >	m_P

Private Member Functions
void	addInterface (LayerInterface *child)
	Adds the interface with simultaneous registration in parent class. More...
void	addLayer (Layer *child)
	Adds the layer with simultaneous registration in parent class. More...

Private Attributes
double	m_crossCorrLength
	cross correlation length (in z direction) between different layers More...
R3	m_ext_field
	external magnetic field (in A/m) More...
OwningVector< LayerInterface >	m_interfaces
	stack of layer interfaces [nlayers-1] More...
OwningVector< Layer >	m_layers
	stack of layers [nlayers] More...
RoughnessModel	m_roughness_model {RoughnessModel::DEFAULT}
std::string	m_sample_name {"Unnamed"}

Constructor & Destructor Documentation

MultiLayer()

MultiLayer::MultiLayer

(

std::string

name = "Unnamed"

)

Definition at line 27 of file MultiLayer.cpp.

    : m_crossCorrLength(0)
    , m_sample_name(std::move(name))
{
    RealLimits::nonnegative().check("CrossCorrelationLength", m_crossCorrLength);
}

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

Referenced by clone().

Here is the call graph for this function:

~MultiLayer()

MultiLayer::~MultiLayer ( )

overridedefault

Member Function Documentation

addInterface()

void MultiLayer::addInterface ( LayerInterface *  child )

private

Adds the interface with simultaneous registration in parent class.

Definition at line 138 of file MultiLayer.cpp.

{
    m_interfaces.emplace_back(child);
}

References OwningVector< T >::emplace_back(), and m_interfaces.

Referenced by addLayerWithTopRoughness().

Here is the call graph for this function:

addLayer() [1/2]

void MultiLayer::addLayer

(

const Layer &

layer

)

Adds layer with default (zero) roughness.

Definition at line 53 of file MultiLayer.cpp.

{
    LayerRoughness zero_roughness;
    addLayerWithTopRoughness(layer, zero_roughness);
}

References addLayerWithTopRoughness(), and layer().

Referenced by addLayerWithTopRoughness(), and clone().

Here is the call graph for this function:

addLayer() [2/2]

void MultiLayer::addLayer ( Layer *  child )

private

Adds the layer with simultaneous registration in parent class.

Definition at line 133 of file MultiLayer.cpp.

{
    m_layers.emplace_back(child);
}

References OwningVector< T >::emplace_back(), and m_layers.

Here is the call graph for this function:

addLayerWithTopRoughness()

void MultiLayer::addLayerWithTopRoughness	(	const Layer &	layer,
		const LayerRoughness &	roughness
	)

Adds layer with top roughness.

Definition at line 60 of file MultiLayer.cpp.

{
    Layer* new_layer = layer.clone();
    if (numberOfLayers()) {
        // not the top layer
        const Layer* last_layer = m_layers.back();
        LayerInterface* interface(nullptr);
        if (roughness.sigma() != 0.0)
            interface = LayerInterface::createRoughInterface(last_layer, new_layer, roughness);
        else
            interface = LayerInterface::createSmoothInterface(last_layer, new_layer);
        addInterface(interface);
    } else {
        // the top layer
        if (new_layer->thickness() != 0.0) {
            delete new_layer;
            throw std::runtime_error(
                "Invalid call to MultiLayer::addLayer(): the semi-infinite top layer "
                "must have a pro forma thickness of 0");
        }
 
        if (roughness.sigma() != 0.0) {
            delete new_layer;
            throw std::runtime_error(
                "Invalid call to MultiLayer::addLayer(): the semi-infinite top layer "
                "cannot have roughness.");
        }
    }
    addLayer(new_layer);
}

References addInterface(), addLayer(), OwningVector< T >::back(), Layer::clone(), LayerInterface::createRoughInterface(), LayerInterface::createSmoothInterface(), layer(), m_layers, numberOfLayers(), LayerInterface::roughness(), LayerRoughness::sigma(), and Layer::thickness().

Referenced by addLayer(), and clone().

Here is the call graph for this function:

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 MultiLayer::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 49 of file MultiLayer.h.

{ return "MultiLayer"; }

clone()

MultiLayer * MultiLayer::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 36 of file MultiLayer.cpp.

{
    auto* result = new MultiLayer;
    result->setCrossCorrLength(crossCorrLength());
    result->setExternalField(externalField());
    result->setRoughnessModel(roughnessModel());
    for (size_t i = 0; i < numberOfLayers(); ++i) {
        const LayerInterface* interface = i > 0 ? m_interfaces[i - 1] : nullptr;
        if (i > 0 && interface->roughness())
            result->addLayerWithTopRoughness(std::as_const(*m_layers[i]), *interface->roughness());
        else
            result->addLayer(std::as_const(*m_layers[i]));
    }
    return result;
}

References MultiLayer(), addLayer(), addLayerWithTopRoughness(), crossCorrLength(), externalField(), m_interfaces, numberOfLayers(), and roughnessModel().

Referenced by Py::Import::createFromPython().

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:

crossCorrLength()

double MultiLayer::crossCorrLength ( ) const

inline

Returns cross correlation length of roughnesses between interfaces.

Definition at line 69 of file MultiLayer.h.

{ return m_crossCorrLength; }

References m_crossCorrLength.

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

externalField()

R3 MultiLayer::externalField ( ) const

inline

Returns the external field applied to the sample (units: A/m)

Definition at line 71 of file MultiLayer.h.

{ return m_ext_field; }

References m_ext_field.

Referenced by clone(), reSample::make(), and reSample::polarizing().

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:

layer()

const Layer * MultiLayer::layer

(

size_t

i_layer

)

const

Returns layer with given index.

Definition at line 91 of file MultiLayer.cpp.

{
    return m_layers.at(i_layer);
}

References OwningVector< T >::at(), and m_layers.

Referenced by addLayer(), addLayerWithTopRoughness(), SampleUtils::Multilayer::IndexOfLayer(), nodeChildren(), and Compute::Slicing::particleRegions().

Here is the call graph for this function:

layerInterface()

const LayerInterface * MultiLayer::layerInterface

(

size_t

i_interface

)

const

Returns interface with given index.

Definition at line 96 of file MultiLayer.cpp.

{
    return m_interfaces.at(i_interface);
}

References OwningVector< T >::at(), and m_interfaces.

Referenced by SampleUtils::Multilayer::hasRoughness(), SampleUtils::Multilayer::LayerTopRoughness(), and nodeChildren().

Here is the call graph for this function:

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 * > MultiLayer::nodeChildren ( ) const

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 118 of file MultiLayer.cpp.

{
    std::vector<const INode*> result;
    const size_t N = m_layers.size();
    result.reserve(N + m_interfaces.size());
 
    for (size_t i = 0; i < N; ++i) {
        result.push_back(layer(i));
        if (i == N - 1)
            break;
        result.push_back(layerInterface(i));
    }
    return result;
}

References layer(), layerInterface(), m_interfaces, m_layers, N, and OwningVector< T >::size().

Here is the call graph for this function:

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:

numberOfLayers()

size_t MultiLayer::numberOfLayers ( ) const

inline

Definition at line 51 of file MultiLayer.h.

{ return m_layers.size(); }

References m_layers, and OwningVector< T >::size().

Referenced by addLayerWithTopRoughness(), clone(), SampleUtils::Multilayer::hasRoughness(), SampleUtils::Multilayer::IndexOfLayer(), and Compute::Slicing::particleRegions().

Here is the call graph for this function:

parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

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

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

{ return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

roughnessModel()

RoughnessModel MultiLayer::roughnessModel ( ) const

inline

Definition at line 67 of file MultiLayer.h.

{ return m_roughness_model; }

References m_roughness_model.

Referenced by clone(), ExemplarySamples::createFeNiBilayerNC(), ExemplarySamples::createFeNiBilayerSpinFlipNC(), ExemplarySamples::createFeNiBilayerSpinFlipTanh(), ExemplarySamples::createFeNiBilayerTanh(), and setRoughnessModel().

sampleName()

const std::string& MultiLayer::sampleName ( ) const

inline

Definition at line 76 of file MultiLayer.h.

{ return m_sample_name; }

References m_sample_name.

setCrossCorrLength()

void MultiLayer::setCrossCorrLength

(

double

crossCorrLength

)

Sets cross correlation length of roughnesses between interfaces.

Definition at line 101 of file MultiLayer.cpp.

{
    if (crossCorrLength < 0.0)
        throw std::runtime_error("Attempt to set crossCorrLength to negative value");
    m_crossCorrLength = crossCorrLength;
}

References crossCorrLength(), and m_crossCorrLength.

Here is the call graph for this function:

setExternalField()

void MultiLayer::setExternalField

(

R3

ext_field

)

Sets the external field applied to the sample (units: A/m)

Definition at line 108 of file MultiLayer.cpp.

{
    m_ext_field = ext_field;
}

References m_ext_field.

setRoughnessModel()

void MultiLayer::setRoughnessModel

(

RoughnessModel

roughnessModel

)

Definition at line 113 of file MultiLayer.cpp.

{
    m_roughness_model = roughnessModel;
}

References m_roughness_model, and roughnessModel().

Here is the call graph for this function:

setSampleName()

void MultiLayer::setSampleName ( const std::string &  name )

inline

Definition at line 75 of file MultiLayer.h.

{ m_sample_name = name; }

References m_sample_name.

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_crossCorrLength

double MultiLayer::m_crossCorrLength

private

cross correlation length (in z direction) between different layers

Definition at line 90 of file MultiLayer.h.

Referenced by MultiLayer(), crossCorrLength(), and setCrossCorrLength().

m_ext_field

R3 MultiLayer::m_ext_field

private

external magnetic field (in A/m)

Definition at line 92 of file MultiLayer.h.

Referenced by externalField(), and setExternalField().

m_interfaces

OwningVector<LayerInterface> MultiLayer::m_interfaces

private

stack of layer interfaces [nlayers-1]

Definition at line 88 of file MultiLayer.h.

Referenced by addInterface(), clone(), layerInterface(), and nodeChildren().

m_layers

OwningVector<Layer> MultiLayer::m_layers

private

stack of layers [nlayers]

Definition at line 86 of file MultiLayer.h.

Referenced by addLayer(), addLayerWithTopRoughness(), layer(), nodeChildren(), and numberOfLayers().

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_roughness_model

RoughnessModel MultiLayer::m_roughness_model {RoughnessModel::DEFAULT}

private

Definition at line 95 of file MultiLayer.h.

Referenced by roughnessModel(), and setRoughnessModel().

m_sample_name

std::string MultiLayer::m_sample_name {"Unnamed"}

private

Definition at line 94 of file MultiLayer.h.

Referenced by sampleName(), and setSampleName().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Multilayer/MultiLayer.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Multilayer/MultiLayer.cpp