MultiLayer Class Reference

Inheritance diagram for MultiLayer:

Collaboration diagram for MultiLayer:

Public Member Functions
	MultiLayer ()
	~MultiLayer () override
MultiLayer *	clone () const final override
void	accept (INodeVisitor *visitor) const final override
size_t	numberOfLayers () const
void	addLayer (const Layer &layer)
void	addLayerWithTopRoughness (const Layer &layer, const LayerRoughness &roughness)
const Layer *	layer (size_t i_layer) const
const LayerInterface *	layerInterface (size_t i_interface) const
void	setCrossCorrLength (double crossCorrLength)
double	crossCorrLength () const
void	setExternalField (kvector_t ext_field)
kvector_t	externalField () const
std::vector< const INode * >	getChildren () const final override
void	setRoughnessModel (RoughnessModel roughnessModel)
RoughnessModel	roughnessModel () const
virtual const Material *	material () const
std::vector< const Material * >	containedMaterials () const
virtual void	transferToCPP ()
virtual std::string	treeToString () const
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
std::string	displayName () const
ParameterPool *	createParameterTree () const
ParameterPool *	parameterPool () const
std::string	parametersToString () const
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Static Public Member Functions
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
void	addAndRegisterLayer (Layer *child)
void	addAndRegisterInterface (LayerInterface *child)
void	handleLayerThicknessRegistration ()
size_t	check_layer_index (size_t i_layer) const
size_t	check_interface_index (size_t i_interface) const

Private Attributes
SafePointerVector< Layer >	m_layers
SafePointerVector< LayerInterface >	m_interfaces
double	m_crossCorrLength
kvector_t	m_ext_field
RoughnessModel	m_roughness_model {RoughnessModel::DEFAULT}
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

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

Example of system of 4 layers (3 interfaces):

ambience 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 41 of file MultiLayer.h.

Constructor & Destructor Documentation

MultiLayer()

MultiLayer::MultiLayer

(

)

Definition at line 27 of file MultiLayer.cpp.

                       : m_crossCorrLength(0)
{
    setName("MultiLayer");
    registerParameter("CrossCorrelationLength", &m_crossCorrLength).setUnit("nm").setNonnegative();
    registerVector("ExternalField", &m_ext_field, "");
}

References m_crossCorrLength, m_ext_field, IParameterized::registerParameter(), IParameterized::registerVector(), IParameterized::setName(), RealParameter::setNonnegative(), and RealParameter::setUnit().

Referenced by clone().

Here is the call graph for this function:

~MultiLayer()

MultiLayer::~MultiLayer ( )

overridedefault

Member Function Documentation

clone()

MultiLayer * MultiLayer::clone ( ) const

finaloverridevirtual

Returns a clone of multilayer with clones of all layers and interfaces between layers.

Implements ISample.

Definition at line 36 of file MultiLayer.cpp.

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

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

Referenced by PyImport::createFromPython(), and SampleProvider::setSample().

Here is the call graph for this function:

accept()

void MultiLayer::accept ( INodeVisitor *  visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 51 of file MultiLayer.h.

{ visitor->visit(this); }

numberOfLayers()

size_t MultiLayer::numberOfLayers ( ) const

inline

Definition at line 53 of file MultiLayer.h.

{ return m_layers.size(); }

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

Referenced by addLayerWithTopRoughness(), anonymous_namespace{MultiLayerUtils.cpp}::BottomLayerCoordinates(), clone(), handleLayerThicknessRegistration(), MultiLayerUtils::hasRoughness(), MultiLayerUtils::IndexOfLayer(), ProcessedSample::initLayouts(), ProcessedSample::initSlices(), MultiLayerUtils::LayerBottomInterface(), and MultiLayerUtils::ParticleRegions().

Here is the call graph for this function:

addLayer()

void MultiLayer::addLayer

(

const Layer &

layer

)

Adds object to multilayer.

Adds layer with default (zero) roughness.

Definition at line 54 of file MultiLayer.cpp.

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

References addLayerWithTopRoughness(), and layer().

Referenced by BoxesSquareLatticeBuilder::buildSample(), CoreShellParticleBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), CylindersAndPrismsBuilder::buildSample(), CylindersInDWBABuilder::buildSample(), CylindersInBABuilder::buildSample(), LargeCylindersInDWBABuilder::buildSample(), RotatedCylindersBuilder::buildSample(), HomogeneousMultilayerBuilder::buildSample(), Lattice1DBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), MagneticSubstrateZeroFieldBuilder::buildSample(), SimpleMagneticLayerBuilder::buildSample(), MagneticLayerBuilder::buildSample(), MagneticRotationBuilder::buildSample(), MagneticParticleZeroFieldBuilder::buildSample(), MagneticCylindersBuilder::buildSample(), MagneticSpheresBuilder::buildSample(), MesoCrystalBuilder::buildSample(), MultiLayerWithRoughnessBuilder::buildSample(), MultipleLayoutBuilder::buildSample(), RadialParaCrystalBuilder::buildSample(), Basic2DParaCrystalBuilder::buildSample(), HexParaCrystalBuilder::buildSample(), RectParaCrystalBuilder::buildSample(), ParticleCompositionBuilder::buildSample(), CylindersWithSizeDistributionBuilder::buildSample(), TwoTypesCylindersDistributionBuilder::buildSample(), RotatedPyramidsDistributionBuilder::buildSample(), SpheresWithLimitsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), LinkedBoxDistributionBuilder::buildSample(), ParticleInVacuumBuilder::buildSample(), HardDiskBuilder::buildSample(), CosineRippleBuilder::buildSample(), TriangularRippleBuilder::buildSample(), RotatedPyramidsBuilder::buildSample(), SizeDistributionDAModelBuilder::buildSample(), SizeDistributionLMAModelBuilder::buildSample(), SizeDistributionSSCAModelBuilder::buildSample(), CylindersInSSCABuilder::buildSample(), SlicedCompositionBuilder::buildSample(), SlicedCylindersBuilder::buildSample(), SLDSlicedCylindersBuilder::buildSample(), AveragedSlicedCylindersBuilder::buildSample(), TransformBoxBuilder::buildSample(), Basic2DLatticeBuilder::buildSample(), SquareLatticeBuilder::buildSample(), CenteredSquareLatticeBuilder::buildSample(), RotatedSquareLatticeBuilder::buildSample(), FiniteSquareLatticeBuilder::buildSample(), SuperLatticeBuilder::buildSample(), TwoLayerRoughnessBuilder::buildSample(), PlainMultiLayerBySLDBuilder::buildSample(), ThickAbsorptiveSampleBuilder::buildSample(), clone(), anonymous_namespace{BoxCompositionBuilder.cpp}::finalizeMultiLayer(), and anonymous_namespace{MagneticLayersBuilder.cpp}::parametricBuild().

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 61 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.getSigma() != 0.0)
            interface = LayerInterface::createRoughInterface(last_layer, new_layer, roughness);
        else
            interface = LayerInterface::createSmoothInterface(last_layer, new_layer);
        addAndRegisterInterface(interface);
    } else {
        // the top layer
        if (new_layer->thickness() != 0.0)
            throw std::runtime_error(
                "Invalid call to MultiLayer::addLayer(): the semi-infinite top layer "
                "must have a pro forma thickness of 0");
 
        if (roughness.getSigma() != 0.0)
            throw std::runtime_error(
                "Invalid call to MultiLayer::addLayer(): the semi-infinite top layer "
                "cannot have roughness.");
    }
    addAndRegisterLayer(new_layer);
}

References addAndRegisterInterface(), addAndRegisterLayer(), SafePointerVector< T >::back(), Layer::clone(), LayerInterface::createRoughInterface(), LayerInterface::createSmoothInterface(), LayerRoughness::getSigma(), layer(), m_layers, numberOfLayers(), and Layer::thickness().

Referenced by addLayer(), MultiLayerWithRoughnessBuilder::buildSample(), TwoLayerRoughnessBuilder::buildSample(), ThickAbsorptiveSampleBuilder::buildSample(), clone(), and anonymous_namespace{MagneticLayersBuilder.cpp}::parametricBuild().

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 88 of file MultiLayer.cpp.

{
    return m_layers[check_layer_index(i_layer)];
}

References check_layer_index(), and m_layers.

Referenced by addLayer(), addLayerWithTopRoughness(), clone(), MultiLayerUtils::IndexOfLayer(), ProcessedSample::initLayouts(), ProcessedSample::initSlices(), MultiLayerUtils::LayerThickness(), and MultiLayerUtils::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 93 of file MultiLayer.cpp.

{
    return m_interfaces[check_interface_index(i_interface)];
}

References check_interface_index(), and m_interfaces.

Referenced by MultiLayerUtils::hasRoughness(), MultiLayerUtils::LayerBottomInterface(), MultiLayerUtils::LayerTopInterface(), and MultiLayerUtils::LayerTopRoughness().

Here is the call graph for this function:

setCrossCorrLength()

void MultiLayer::setCrossCorrLength

(

double

crossCorrLength

)

Sets cross correlation length of roughnesses between interfaces.

Definition at line 98 of file MultiLayer.cpp.

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

References crossCorrLength(), and m_crossCorrLength.

Referenced by MultiLayerWithRoughnessBuilder::buildSample().

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 71 of file MultiLayer.h.

{ return m_crossCorrLength; }

References m_crossCorrLength.

Referenced by clone(), and setCrossCorrLength().

setExternalField()

void MultiLayer::setExternalField

(

kvector_t

ext_field

)

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

Definition at line 105 of file MultiLayer.cpp.

{
    m_ext_field = ext_field;
}

References m_ext_field.

externalField()

kvector_t MultiLayer::externalField ( ) const

inline

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

Definition at line 77 of file MultiLayer.h.

{ return m_ext_field; }

References m_ext_field.

Referenced by clone().

getChildren()

std::vector< const INode * > MultiLayer::getChildren ( ) const

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 115 of file MultiLayer.cpp.

{
    std::vector<const INode*> ret;
    const size_t N = m_layers.size();
    ret.reserve(N + m_interfaces.size());
 
    for (size_t i = 0; i < N; ++i) {
        ret.push_back(m_layers[i]);
        const LayerInterface* interface = MultiLayerUtils::LayerBottomInterface(*this, i);
        if (interface)
            ret.push_back(interface);
    }
    return ret;
}

References MultiLayerUtils::LayerBottomInterface(), m_interfaces, m_layers, and SafePointerVector< T >::size().

Here is the call graph for this function:

setRoughnessModel()

void MultiLayer::setRoughnessModel

(

RoughnessModel

roughnessModel

)

Definition at line 110 of file MultiLayer.cpp.

{
    m_roughness_model = roughnessModel;
}

References m_roughness_model, and roughnessModel().

Referenced by anonymous_namespace{MagneticLayersBuilder.cpp}::parametricBuild().

Here is the call graph for this function:

roughnessModel()

RoughnessModel MultiLayer::roughnessModel ( ) const

inline

Definition at line 83 of file MultiLayer.h.

{ return m_roughness_model; }

References m_roughness_model.

Referenced by SpecularStrategyBuilder::build(), FeNiBilayerTanhBuilder::buildSample(), FeNiBilayerNCBuilder::buildSample(), FeNiBilayerSpinFlipTanhBuilder::buildSample(), FeNiBilayerSpinFlipNCBuilder::buildSample(), clone(), and setRoughnessModel().

addAndRegisterLayer()

void MultiLayer::addAndRegisterLayer ( Layer *  child )

private

Adds the layer with simultaneous registration in parent class.

Definition at line 130 of file MultiLayer.cpp.

{
    m_layers.push_back(child);
    handleLayerThicknessRegistration();
    registerChild(child);
}

References handleLayerThicknessRegistration(), m_layers, SafePointerVector< T >::push_back(), and INode::registerChild().

Referenced by addLayerWithTopRoughness().

Here is the call graph for this function:

addAndRegisterInterface()

void MultiLayer::addAndRegisterInterface ( LayerInterface *  child )

private

Adds the interface with simultaneous registration in parent class.

Definition at line 137 of file MultiLayer.cpp.

{
    m_interfaces.push_back(child);
    registerChild(child);
}

References m_interfaces, SafePointerVector< T >::push_back(), and INode::registerChild().

Referenced by addLayerWithTopRoughness().

Here is the call graph for this function:

handleLayerThicknessRegistration()

void MultiLayer::handleLayerThicknessRegistration ( )

private

Handles correct registration of layer thicknesses (not needed for top and bottom layer)

Definition at line 143 of file MultiLayer.cpp.

{
    size_t n_layers = numberOfLayers();
    for (size_t i = 0; i < numberOfLayers(); ++i)
        m_layers[i]->registerThickness(i > 0 && i < n_layers - 1);
}

References m_layers, and numberOfLayers().

Referenced by addAndRegisterLayer().

Here is the call graph for this function:

check_layer_index()

size_t MultiLayer::check_layer_index ( size_t  i_layer ) const

private

Checks index of layer w.r.t. vector length.

Definition at line 150 of file MultiLayer.cpp.

{
    if (i_layer >= m_layers.size())
        throw Exceptions::OutOfBoundsException("Layer index is out of bounds");
    return i_layer;
}

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

Referenced by layer().

Here is the call graph for this function:

check_interface_index()

size_t MultiLayer::check_interface_index ( size_t  i_interface ) const

private

Checks index of interface w.r.t. vector length.

Definition at line 157 of file MultiLayer.cpp.

{
    if (i_interface >= m_interfaces.size())
        throw Exceptions::OutOfBoundsException("Interface index is out of bounds");
    return i_interface;
}

References m_interfaces, and SafePointerVector< T >::size().

Referenced by layerInterface().

Here is the call graph for this function:

material()

virtual const Material* ISample::material ( ) const

inlinevirtualinherited

Returns nullptr, unless overwritten to return a specific material.

Reimplemented in Particle, and Layer.

Definition at line 37 of file ISample.h.

{ return nullptr; }

Referenced by ISample::containedMaterials(), FormFactorCrystal::setAmbientMaterial(), FormFactorBAPol::setAmbientMaterial(), FormFactorDecoratorMaterial::setAmbientMaterial(), FormFactorDWBA::setAmbientMaterial(), FormFactorDWBAPol::setAmbientMaterial(), IFormFactorDecorator::setAmbientMaterial(), FormFactorCoreShell::setAmbientMaterial(), FormFactorWeighted::setAmbientMaterial(), and FormFactorDecoratorMaterial::setMaterial().

containedMaterials()

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

inherited

Returns set of unique materials contained in this ISample.

Definition at line 23 of file ISample.cpp.

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

References INode::getChildren(), and ISample::material().

Referenced by MultiLayerUtils::ContainsCompatibleMaterials(), anonymous_namespace{ProcessedSample.cpp}::ContainsMagneticMaterial(), and SampleToPython::initLabels().

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 34 of file ICloneable.h.

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 53 of file INode.cpp.

{
    return NodeUtils::nodeToString(*this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 58 of file INode.cpp.

{
    ASSERT(node);
    node->setParent(this);
}

References ASSERT, and INode::setParent().

Referenced by ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), addAndRegisterInterface(), addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), Simulation::initialize(), MesoCrystal::initialize(), Instrument::Instrument(), Beam::operator=(), Instrument::operator=(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), Simulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunction2DLattice::setLattice(), InterferenceFunction2DParaCrystal::setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), IParticle::setRotation(), LayerInterface::setRoughness(), and InterferenceFunction2DSuperLattice::setSubstructureIFF().

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

parent() [1/2]

const INode * INode::parent ( ) const

inherited

Definition at line 74 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

parent() [2/2]

INode * INode::parent ( )

inherited

Definition at line 79 of file INode.cpp.

{
    return const_cast<INode*>(m_parent);
}

References INode::m_parent.

copyNumber()

int INode::copyNumber ( const INode *  node ) const

inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 84 of file INode.cpp.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

References INode::getChildren(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

displayName()

std::string INode::displayName ( ) const

inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 105 of file INode.cpp.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

References INode::copyNumber(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

Here is the call graph for this function:

createParameterTree()

ParameterPool * INode::createParameterTree ( ) const

virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented from IParameterized.

Definition at line 116 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), Simulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

{ return m_pool.get(); } // has non-const usages!

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParameterized::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References IParameterized::createParameterTree().

Here is the call graph for this function:

registerParameter()

RealParameter & IParameterized::registerParameter ( const std::string &  name, double *  parpointer  )

inherited

Definition at line 48 of file IParameterized.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice::HexagonalLattice(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), ParticleLayout::registerWeight(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), Lattice2D::setRotationEnabled(), SquareLattice::SquareLattice(), and TriangularRippleBuilder::TriangularRippleBuilder().

Here is the call graph for this function:

registerVector()

void IParameterized::registerVector ( const std::string &  base_name, kvector_t *  p_vec, const std::string &  units = "nm"  )

inherited

Definition at line 54 of file IParameterized.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

void IParameterized::setParameterValue ( const std::string &  name, double  value  )

inherited

Definition at line 62 of file IParameterized.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParameterized::setVectorValue().

Here is the call graph for this function:

setVectorValue()

void IParameterized::setVectorValue ( const std::string &  base_name, kvector_t  value  )

inherited

Definition at line 75 of file IParameterized.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

parameter()

RealParameter * IParameterized::parameter ( const std::string &  name ) const

inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References IParameterized::m_pool.

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), IParticle::registerAbundance(), Lattice::registerBasisVectors(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

onChange()

virtual void IParameterized::onChange ( )

inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

Referenced by Lattice2D::onChange(), and IParameterized::registerParameter().

removeParameter()

void IParameterized::removeParameter ( const std::string &  name )

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References IParameterized::m_pool.

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParameterized::removeVector(), and Lattice2D::setRotationEnabled().

removeVector()

void IParameterized::removeVector ( const std::string &  base_name )

inherited

Definition at line 93 of file IParameterized.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

std::string IParameterized::XComponentName ( const std::string &  base_name )

staticinherited

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

YComponentName()

std::string IParameterized::YComponentName ( const std::string &  base_name )

staticinherited

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

ZComponentName()

std::string IParameterized::ZComponentName ( const std::string &  base_name )

staticinherited

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

setName()

void IParameterized::setName ( const std::string &  name )

inlineinherited

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References IParameterized::m_name.

Referenced by BasicLattice::BasicLattice(), Beam::Beam(), Layer::clone(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorBAPol::FormFactorBAPol(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorDWBA::FormFactorDWBA(), FormFactorDWBAPol::FormFactorDWBAPol(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice::HexagonalLattice(), IDetector::IDetector(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice::Lattice(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), SampleBuilderNode::reset(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SampleBuilderNode::setSBN(), SphericalDetector::SphericalDetector(), and SquareLattice::SquareLattice().

getName()

const std::string& IParameterized::getName ( ) const

inlineinherited

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_layers

SafePointerVector<Layer> MultiLayer::m_layers

private

stack of layers [nlayers]

Definition at line 102 of file MultiLayer.h.

Referenced by addAndRegisterLayer(), addLayerWithTopRoughness(), check_layer_index(), clone(), getChildren(), handleLayerThicknessRegistration(), layer(), and numberOfLayers().

m_interfaces

SafePointerVector<LayerInterface> MultiLayer::m_interfaces

private

stack of layer interfaces [nlayers-1]

Definition at line 104 of file MultiLayer.h.

Referenced by addAndRegisterInterface(), check_interface_index(), clone(), getChildren(), and layerInterface().

m_crossCorrLength

double MultiLayer::m_crossCorrLength

private

cross correlation length (in z direction) between different layers

Definition at line 106 of file MultiLayer.h.

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

m_ext_field

kvector_t MultiLayer::m_ext_field

private

external magnetic field (in A/m)

Definition at line 108 of file MultiLayer.h.

Referenced by externalField(), MultiLayer(), and setExternalField().

m_roughness_model

RoughnessModel MultiLayer::m_roughness_model {RoughnessModel::DEFAULT}

private

Definition at line 110 of file MultiLayer.h.

Referenced by roughnessModel(), and setRoughnessModel().

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 81 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 87 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

m_name

std::string IParameterized::m_name

privateinherited

Definition at line 72 of file IParameterized.h.

Referenced by IParameterized::getName(), and IParameterized::setName().

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

Referenced by IParameterized::createParameterTree(), IParameterized::parameter(), IParameterized::parameterPool(), IParameterized::registerParameter(), IParameterized::removeParameter(), and IParameterized::setParameterValue().

---

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

• /home/www/ba/Sample/Multilayer/MultiLayer.h
• /home/www/ba/Sample/Multilayer/MultiLayer.cpp