LayerInterface Class Reference

Description

Interface between two layers, possibly with roughness.

Definition at line 31 of file LayerInterface.h.

Inheritance diagram for LayerInterface:

Collaboration diagram for LayerInterface:

Public Member Functions
	~LayerInterface () override
const Layer *	bottomLayer () const
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...
LayerInterface *	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...
bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. 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...
virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
const LayerRoughness *	roughness () const
	Returns roughness of the interface. More...
void	setRoughness (const LayerRoughness &roughness)
	Sets roughness of the interface. More...
const Layer *	topLayer () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Static Public Member Functions
static LayerInterface *	createRoughInterface (const Layer *top_layer, const Layer *bottom_layer, const LayerRoughness &roughness)
	Creates rough interface between two layers. More...
static LayerInterface *	createSmoothInterface (const Layer *top_layer, const Layer *bottom_layer)
	Creates smooth interface between two layers. More...

Protected Attributes
std::vector< double >	m_P

Private Member Functions
	LayerInterface ()
void	setLayersTopBottom (const Layer *top_layer, const Layer *bottom_layer)
	Sets links to the layers above and below the interface. More...

Private Attributes
const Layer *	m_bottomLayer
	pointer to the layer below interface More...
std::unique_ptr< LayerRoughness >	m_roughness
	roughness of the interface More...
const Layer *	m_topLayer
	pointer to the layer above interface More...

Constructor & Destructor Documentation

~LayerInterface()

LayerInterface::~LayerInterface ( )

overridedefault

LayerInterface()

LayerInterface::LayerInterface ( )

private

Definition at line 19 of file LayerInterface.cpp.

    : m_topLayer(nullptr)
    , m_bottomLayer(nullptr)
{
}

Referenced by createSmoothInterface().

Member Function Documentation

bottomLayer()

const Layer * LayerInterface::bottomLayer ( ) const

inline

Definition at line 76 of file LayerInterface.h.

{
    return m_bottomLayer;
}

References m_bottomLayer.

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

inlinefinalvirtual

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

Implements INode.

Definition at line 36 of file LayerInterface.h.

{ return "LayerInterface"; }

clone()

LayerInterface * LayerInterface::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 27 of file LayerInterface.cpp.

{
    throw std::runtime_error("LayerInterface::clone() -> Not allowed to clone.");
}

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:

createRoughInterface()

LayerInterface * LayerInterface::createRoughInterface ( const Layer *  top_layer, const Layer *  bottom_layer, const LayerRoughness &  roughness  )

static

Creates rough interface between two layers.

Definition at line 40 of file LayerInterface.cpp.

{
    LayerInterface* result = createSmoothInterface(top_layer, bottom_layer);
    result->setRoughness(roughness);
    return result;
}

References createSmoothInterface(), roughness(), and setRoughness().

Referenced by MultiLayer::addLayerWithTopRoughness().

Here is the call graph for this function:

createSmoothInterface()

LayerInterface * LayerInterface::createSmoothInterface ( const Layer *  top_layer, const Layer *  bottom_layer  )

static

Creates smooth interface between two layers.

Definition at line 32 of file LayerInterface.cpp.

{
    auto* result = new LayerInterface();
    result->setLayersTopBottom(top_layer, bottom_layer);
    return result;
}

References LayerInterface().

Referenced by MultiLayer::addLayerWithTopRoughness(), and createRoughInterface().

Here is the call graph for this function:

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:

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

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 54 of file LayerInterface.cpp.

{
    return std::vector<const INode*>() << m_roughness;
}

References m_roughness.

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()

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().

roughness()

const LayerRoughness * LayerInterface::roughness ( ) const

inline

Returns roughness of the interface.

Definition at line 66 of file LayerInterface.h.

{
    return m_roughness.get();
}

References m_roughness.

Referenced by MultiLayer::addLayerWithTopRoughness(), createRoughInterface(), SampleToPython::defineMultiLayers(), SampleUtils::Multilayer::hasRoughness(), SampleUtils::Multilayer::LayerTopRoughness(), and setRoughness().

setLayersTopBottom()

void LayerInterface::setLayersTopBottom ( const Layer *  top_layer, const Layer *  bottom_layer  )

private

Sets links to the layers above and below the interface.

Definition at line 61 of file LayerInterface.cpp.

{
    ASSERT(top_layer && bottom_layer);
    m_topLayer = top_layer;
    m_bottomLayer = bottom_layer;
}

References ASSERT, m_bottomLayer, and m_topLayer.

setRoughness()

void LayerInterface::setRoughness

(

const LayerRoughness &

roughness

)

Sets roughness of the interface.

Definition at line 49 of file LayerInterface.cpp.

{
    m_roughness.reset(roughness.clone());
}

References LayerRoughness::clone(), m_roughness, and roughness().

Referenced by createRoughInterface().

Here is the call graph for this function:

topLayer()

const Layer * LayerInterface::topLayer ( ) const

inline

Definition at line 71 of file LayerInterface.h.

{
    return m_topLayer;
}

References m_topLayer.

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_bottomLayer

const Layer* LayerInterface::m_bottomLayer

private

pointer to the layer below interface

Definition at line 62 of file LayerInterface.h.

Referenced by bottomLayer(), and setLayersTopBottom().

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

std::unique_ptr<LayerRoughness> LayerInterface::m_roughness

private

roughness of the interface

Definition at line 63 of file LayerInterface.h.

Referenced by nodeChildren(), roughness(), and setRoughness().

m_topLayer

const Layer* LayerInterface::m_topLayer

private

pointer to the layer above interface

Definition at line 61 of file LayerInterface.h.

Referenced by setLayersTopBottom(), and topLayer().

---

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

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