Layer Class Reference

Description

A layer in a MultiLayer sample.

Definition at line 26 of file Layer.h.

Inheritance diagram for Layer:

Collaboration diagram for Layer:

Public Member Functions
	Layer (Material material, double thickness=0)
	Constructor of a layer with thickness and material. More...
	~Layer () override
void	addLayout (const ParticleLayout &layout)
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...
Layer *	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...
std::vector< const ParticleLayout * >	layouts () const
const Material *	material () const override
	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	numberOfLayouts () const
unsigned int	numberOfSlices () const
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
void	setNumberOfSlices (unsigned int n_slices)
double	thickness () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Attributes
std::vector< double >	m_P

Private Attributes
R3	m_B_field
	cached value of magnetic induction More...
std::vector< std::unique_ptr< ParticleLayout > >	m_layouts
	independent layouts in this layer More...
Material	m_material
	material More...
unsigned int	m_n_slices = 1
	number of slices to create for graded layer approach More...
double	m_thickness
	layer thickness in nanometers More...

Constructor & Destructor Documentation

Layer()

Layer::Layer	(	Material	material,
		double	thickness = 0
	)

Constructor of a layer with thickness and material.

Parameters

material	material the layer is made of
thickness	thickness of a layer in nanometers

Definition at line 21 of file Layer.cpp.

    : m_material(std::move(material))
    , m_thickness(thickness)
{
    if (thickness < 0.)
        throw std::runtime_error("Layer thickness cannot be negative");
}

References thickness().

Referenced by clone().

Here is the call graph for this function:

~Layer()

Layer::~Layer ( )

overridedefault

Member Function Documentation

addLayout()

void Layer::addLayout

(

const ParticleLayout &

layout

)

Definition at line 49 of file Layer.cpp.

{
    m_layouts.emplace_back(layout.clone());
}

References ParticleLayout::clone(), and m_layouts.

Referenced by ExemplarySamples::createBasic2DLattice(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), ExemplarySamples::createBoxesSquareLattice2D(), ExemplarySamples::createCenteredSquareLattice2D(), ExemplarySamples::createCoreShellBoxRotateZandY(), ExemplarySamples::createCoreShellParticle(), ExemplarySamples::createCosineRipple(), ExemplarySamples::createCustomMorphology(), ExemplarySamples::createCylindersAndPrisms(), ExemplarySamples::createCylindersInBA(), ExemplarySamples::createCylindersInDWBA(), ExemplarySamples::createFiniteSquareLattice2D(), ExemplarySamples::createHardDisk(), ExemplarySamples::createHexParaCrystal(), ExemplarySamples::createLargeCylindersInDWBA(), ExemplarySamples::createLattice1D(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createLayersWithAbsorptionWithFF(), ExemplarySamples::createMagneticCylinders(), ExemplarySamples::createMagneticLayer(), ExemplarySamples::createMagneticParticleZeroField(), ExemplarySamples::createMagneticRotation(), ExemplarySamples::createMagneticSpheres(), ExemplarySamples::createMagneticSubstrateZeroField(), ExemplarySamples::createMesoCrystal(), ExemplarySamples::createMultipleLayout(), ExemplarySamples::createParticleComposition(), ExemplarySamples::createParticleInVacuumWithFF(), ExemplarySamples::createRadialParaCrystal(), ExemplarySamples::createRectParaCrystal(), ExemplarySamples::createRotatedPyramids(), ExemplarySamples::createRotatedSquareLattice2D(), ExemplarySamples::createSizeDistributionDAModel(), ExemplarySamples::createSizeDistributionLMAModel(), ExemplarySamples::createSizeDistributionSSCAModel(), ExemplarySamples::createSLDSlicedCylinders(), ExemplarySamples::createSlicedComposition(), ExemplarySamples::createSlicedCylinders(), ExemplarySamples::createSquareLattice2D(), ExemplarySamples::createSuperLattice(), ExemplarySamples::createTransformBox(), and ExemplarySamples::createTriangularRipple().

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

inlinefinalvirtual

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

Implements INode.

Definition at line 32 of file Layer.h.

{ return "Layer"; }

clone()

Layer * Layer::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 31 of file Layer.cpp.

{
    auto* result = new Layer(m_material, m_thickness);
    result->m_B_field = m_B_field;
    result->m_n_slices = m_n_slices;
    for (const auto* layout : layouts())
        result->addLayout(*layout);
    return result;
}

References Layer(), layouts(), m_B_field, m_material, m_n_slices, and m_thickness.

Referenced by MultiLayer::addLayerWithTopRoughness().

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:

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:

layouts()

std::vector< const ParticleLayout * > Layer::layouts

(

)

const

Definition at line 54 of file Layer.cpp.

{
    std::vector<const ParticleLayout*> result;
    for (const auto& layout : m_layouts)
        result.push_back(layout.get());
    return result;
}

References m_layouts.

Referenced by clone(), and Compute::Slicing::particleRegions().

material()

const Material* Layer::material ( ) const

inlineoverridevirtual

Returns nullptr, unless overwritten to return a specific material.

Reimplemented from ISampleNode.

Definition at line 39 of file Layer.h.

{ return &m_material; }

References m_material.

nodeChildren()

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

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 41 of file Layer.cpp.

{
    std::vector<const INode*> result;
    for (const auto& layout : m_layouts)
        result.push_back(layout.get());
    return result;
}

References m_layouts.

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:

numberOfLayouts()

size_t Layer::numberOfLayouts ( ) const

inline

Definition at line 44 of file Layer.h.

{ return m_layouts.size(); }

References m_layouts.

numberOfSlices()

unsigned int Layer::numberOfSlices ( ) const

inline

Definition at line 48 of file Layer.h.

{ return m_n_slices; }

References m_n_slices.

parDefs()

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

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 33 of file Layer.h.

    {
        return {{"Thickness", "nm", "thickness", 0, +INF, 0}};
    }

References INF.

setNumberOfSlices()

void Layer::setNumberOfSlices ( unsigned int  n_slices )

inline

Definition at line 47 of file Layer.h.

{ m_n_slices = n_slices; }

References m_n_slices.

Referenced by ExemplarySamples::createSLDSlicedCylinders(), and ExemplarySamples::createSlicedCylinders().

thickness()

double Layer::thickness ( ) const

inline

Definition at line 41 of file Layer.h.

{ return m_thickness; }

References m_thickness.

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

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_B_field

R3 Layer::m_B_field

private

cached value of magnetic induction

Definition at line 52 of file Layer.h.

Referenced by clone().

m_layouts

std::vector<std::unique_ptr<ParticleLayout> > Layer::m_layouts

private

independent layouts in this layer

Definition at line 54 of file Layer.h.

Referenced by addLayout(), layouts(), nodeChildren(), and numberOfLayouts().

m_material

Material Layer::m_material

private

material

Definition at line 51 of file Layer.h.

Referenced by clone(), and material().

m_n_slices

unsigned int Layer::m_n_slices = 1

private

number of slices to create for graded layer approach

Definition at line 55 of file Layer.h.

Referenced by clone(), numberOfSlices(), and setNumberOfSlices().

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_thickness

double Layer::m_thickness

private

layer thickness in nanometers

Definition at line 53 of file Layer.h.

Referenced by clone(), and thickness().

---

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

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