ParticleLayout Class Reference

Inheritance diagram for ParticleLayout:

Collaboration diagram for ParticleLayout:

Public Member Functions
	ParticleLayout ()
	ParticleLayout (const IAbstractParticle &particle, double abundance=-1.0)
	~ParticleLayout () override
ParticleLayout *	clone () const final override
void	accept (INodeVisitor *visitor) const final override
void	addParticle (const IAbstractParticle &particle, double abundance=-1.0, const kvector_t position={}, const IRotation &rotation=IdentityRotation())
SafePointerVector< IParticle >	particles () const final override
const IInterferenceFunction *	interferenceFunction () const final override
double	getTotalAbundance () const final override
void	setInterferenceFunction (const IInterferenceFunction &interference_function)
double	totalParticleSurfaceDensity () const final override
void	setTotalParticleSurfaceDensity (double particle_density) final override
std::vector< const INode * >	getChildren () const final override
double	weight () const
void	setWeight (double weight)
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
double	m_weight
const size_t	m_NP
std::vector< double >	m_P

Private Member Functions
void	addAndRegisterAbstractParticle (IAbstractParticle *child)
void	setAndRegisterInterferenceFunction (IInterferenceFunction *child)
void	registerParticleDensity (bool make_registered=true)
void	registerWeight ()

Private Attributes
SafePointerVector< IAbstractParticle >	m_particles
std::unique_ptr< IInterferenceFunction >	mP_interference_function
double	m_total_particle_density
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Decorator class that adds particles to ISample objects.

Definition at line 29 of file ParticleLayout.h.

Constructor & Destructor Documentation

ParticleLayout() [1/2]

ParticleLayout::ParticleLayout

(

)

Definition at line 37 of file ParticleLayout.cpp.

                               : mP_interference_function{nullptr}, m_total_particle_density{0.01}
{
    setName("ParticleLayout");
    registerParticleDensity();
    registerWeight();
}

References registerParticleDensity(), registerWeight(), and IParameterized::setName().

Referenced by clone().

Here is the call graph for this function:

ParticleLayout() [2/2]

ParticleLayout::ParticleLayout	(	const IAbstractParticle &	particle,
		double	abundance = -1.0
	)

Definition at line 44 of file ParticleLayout.cpp.

    : mP_interference_function{nullptr}, m_total_particle_density{0.01}
{
    setName("ParticleLayout");
    addParticle(particle, abundance);
    registerParticleDensity();
    registerWeight();
}

References addParticle(), registerParticleDensity(), registerWeight(), and IParameterized::setName().

Here is the call graph for this function:

~ParticleLayout()

ParticleLayout::~ParticleLayout ( )

overridedefault

Member Function Documentation

clone()

ParticleLayout * ParticleLayout::clone ( ) const

finaloverridevirtual

Returns a clone of this ISample object.

Implements ILayout.

Definition at line 55 of file ParticleLayout.cpp.

{
    ParticleLayout* p_result = new ParticleLayout();
 
    for (auto p_particle : m_particles)
        p_result->addAndRegisterAbstractParticle(p_particle->clone());
 
    if (mP_interference_function)
        p_result->setAndRegisterInterferenceFunction(mP_interference_function->clone());
 
    p_result->setTotalParticleSurfaceDensity(totalParticleSurfaceDensity());
    p_result->setWeight(weight());
 
    return p_result;
}

References addAndRegisterAbstractParticle(), m_particles, mP_interference_function, ParticleLayout(), setAndRegisterInterferenceFunction(), setTotalParticleSurfaceDensity(), ILayout::setWeight(), totalParticleSurfaceDensity(), and ILayout::weight().

Here is the call graph for this function:

accept()

void ParticleLayout::accept ( INodeVisitor *  visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements ILayout.

Definition at line 38 of file ParticleLayout.h.

{ visitor->visit(this); }

addParticle()

void ParticleLayout::addParticle	(	const IAbstractParticle &	particle,
		double	abundance = -1.0,
		const kvector_t	position = {},
		const IRotation &	rotation = IdentityRotation()
	)

Adds particle to the layout with abundance, position and the rotation defined.

Parameters

particle	to be added
abundance	Particle abundance
position	Particle position
rotation	Particle rotation

Definition at line 76 of file ParticleLayout.cpp.

{
    IAbstractParticle* particle_clone = particle.clone();
    if (abundance >= 0.0)
        particle_clone->setAbundance(abundance);
    if (!rotation.isIdentity())
        particle_clone->rotate(rotation);
    if (position != kvector_t(0, 0, 0))
        particle_clone->translate(position);
    addAndRegisterAbstractParticle(particle_clone);
}

References addAndRegisterAbstractParticle(), IAbstractParticle::clone(), IRotation::isIdentity(), IAbstractParticle::rotate(), IAbstractParticle::setAbundance(), and IAbstractParticle::translate().

Referenced by BoxesSquareLatticeBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), CylindersAndPrismsBuilder::buildSample(), RotatedCylindersBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), MagneticSubstrateZeroFieldBuilder::buildSample(), MagneticLayerBuilder::buildSample(), MagneticRotationBuilder::buildSample(), MagneticSpheresBuilder::buildSample(), MesoCrystalBuilder::buildSample(), MultipleLayoutBuilder::buildSample(), ParticleCompositionBuilder::buildSample(), CylindersWithSizeDistributionBuilder::buildSample(), TwoTypesCylindersDistributionBuilder::buildSample(), RotatedPyramidsDistributionBuilder::buildSample(), SpheresWithLimitsDistributionBuilder::buildSample(), ConesWithLimitsDistributionBuilder::buildSample(), LinkedBoxDistributionBuilder::buildSample(), CosineRippleBuilder::buildSample(), TriangularRippleBuilder::buildSample(), RotatedPyramidsBuilder::buildSample(), SizeDistributionDAModelBuilder::buildSample(), SizeDistributionLMAModelBuilder::buildSample(), SizeDistributionSSCAModelBuilder::buildSample(), CylindersInSSCABuilder::buildSample(), SlicedCompositionBuilder::buildSample(), TransformBoxBuilder::buildSample(), Basic2DLatticeBuilder::buildSample(), SquareLatticeBuilder::buildSample(), CenteredSquareLatticeBuilder::buildSample(), RotatedSquareLatticeBuilder::buildSample(), FiniteSquareLatticeBuilder::buildSample(), SuperLatticeBuilder::buildSample(), anonymous_namespace{BoxCompositionBuilder.cpp}::finalizeMultiLayer(), and ParticleLayout().

Here is the call graph for this function:

particles()

SafePointerVector< IParticle > ParticleLayout::particles ( ) const

finaloverridevirtual

Returns information on all particles (type and abundance) and generates new particles if an IAbstractParticle denotes a collection.

Implements ILayout.

Definition at line 91 of file ParticleLayout.cpp.

{
    SafePointerVector<IParticle> particle_vector;
    for (auto particle : m_particles) {
        if (const auto* p_part_distr = dynamic_cast<const ParticleDistribution*>(particle)) {
            SafePointerVector<IParticle> generated_particles = p_part_distr->generateParticles();
            for (const IParticle* particle : generated_particles)
                particle_vector.push_back(particle->clone());
        } else if (const auto* p_iparticle = dynamic_cast<const IParticle*>(particle)) {
            particle_vector.push_back(p_iparticle->clone());
        }
    }
    return particle_vector;
}

References m_particles, and SafePointerVector< T >::push_back().

Here is the call graph for this function:

interferenceFunction()

const IInterferenceFunction * ParticleLayout::interferenceFunction ( ) const

finaloverridevirtual

Returns the interference function.

Implements ILayout.

Definition at line 106 of file ParticleLayout.cpp.

{
    return mP_interference_function.get();
}

References mP_interference_function.

getTotalAbundance()

double ParticleLayout::getTotalAbundance ( ) const

finaloverridevirtual

Get total abundance of all particles.

Implements ILayout.

Definition at line 111 of file ParticleLayout.cpp.

{
    double result = 0.0;
    for (auto p_particle : m_particles) {
        result += p_particle->abundance();
    }
    return result;
}

References m_particles.

setInterferenceFunction()

void ParticleLayout::setInterferenceFunction

(

const IInterferenceFunction &

interference_function

)

Adds interference functions.

Definition at line 121 of file ParticleLayout.cpp.

{
    setAndRegisterInterferenceFunction(interference_function.clone());
}

References IInterferenceFunction::clone(), and setAndRegisterInterferenceFunction().

Referenced by BoxesSquareLatticeBuilder::buildSample(), Lattice1DBuilder::buildSample(), RadialParaCrystalBuilder::buildSample(), Basic2DParaCrystalBuilder::buildSample(), HexParaCrystalBuilder::buildSample(), RectParaCrystalBuilder::buildSample(), ParticleCompositionBuilder::buildSample(), HardDiskBuilder::buildSample(), CosineRippleBuilder::buildSample(), TriangularRippleBuilder::buildSample(), SizeDistributionDAModelBuilder::buildSample(), SizeDistributionLMAModelBuilder::buildSample(), SizeDistributionSSCAModelBuilder::buildSample(), CylindersInSSCABuilder::buildSample(), Basic2DLatticeBuilder::buildSample(), SquareLatticeBuilder::buildSample(), CenteredSquareLatticeBuilder::buildSample(), RotatedSquareLatticeBuilder::buildSample(), FiniteSquareLatticeBuilder::buildSample(), and SuperLatticeBuilder::buildSample().

Here is the call graph for this function:

totalParticleSurfaceDensity()

double ParticleLayout::totalParticleSurfaceDensity ( ) const

finaloverridevirtual

Returns surface density of all particles.

Implements ILayout.

Definition at line 126 of file ParticleLayout.cpp.

{
    double iff_density =
        mP_interference_function ? mP_interference_function->getParticleDensity() : 0.0;
    return iff_density > 0.0 ? iff_density : m_total_particle_density;
}

References m_total_particle_density, and mP_interference_function.

Referenced by AveragedSlicedCylindersBuilder::buildSample(), and clone().

setTotalParticleSurfaceDensity()

void ParticleLayout::setTotalParticleSurfaceDensity ( double  particle_density )

finaloverridevirtual

Sets total particle surface density.

Parameters

particle_density

number of particles per square nanometer

Implements ILayout.

Definition at line 135 of file ParticleLayout.cpp.

{
    m_total_particle_density = particle_density;
}

References m_total_particle_density.

Referenced by LinkedBoxDistributionBuilder::buildSample(), SuperLatticeBuilder::buildSample(), and clone().

getChildren()

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

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 140 of file ParticleLayout.cpp.

{
    std::vector<const INode*> result;
    for (auto particle : m_particles)
        result.push_back(particle);
    result << mP_interference_function;
    return result;
}

References m_particles, and mP_interference_function.

addAndRegisterAbstractParticle()

void ParticleLayout::addAndRegisterAbstractParticle ( IAbstractParticle *  child )

private

Adds particle information with simultaneous registration in parent class.

Definition at line 150 of file ParticleLayout.cpp.

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

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

Referenced by addParticle(), and clone().

Here is the call graph for this function:

setAndRegisterInterferenceFunction()

void ParticleLayout::setAndRegisterInterferenceFunction ( IInterferenceFunction *  child )

private

Sets interference function with simultaneous registration in parent class.

Definition at line 157 of file ParticleLayout.cpp.

{
    mP_interference_function.reset(child);
    registerChild(child);
 
    if (particleDensityIsProvidedByInterference(*mP_interference_function))
        registerParticleDensity(false);
    else
        registerParticleDensity(true);
}

References mP_interference_function, anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), INode::registerChild(), and registerParticleDensity().

Referenced by clone(), and setInterferenceFunction().

Here is the call graph for this function:

registerParticleDensity()

void ParticleLayout::registerParticleDensity ( bool  make_registered = true )

private

Definition at line 168 of file ParticleLayout.cpp.

{
    if (make_registered) {
        if (!parameter("TotalParticleDensity"))
            registerParameter("TotalParticleDensity", &m_total_particle_density);
    } else {
        removeParameter("TotalParticleDensity");
    }
}

References m_total_particle_density, IParameterized::parameter(), IParameterized::registerParameter(), and IParameterized::removeParameter().

Referenced by ParticleLayout(), and setAndRegisterInterferenceFunction().

Here is the call graph for this function:

registerWeight()

void ParticleLayout::registerWeight ( )

private

Definition at line 178 of file ParticleLayout.cpp.

{
    registerParameter("Weight", &m_weight);
}

References ILayout::m_weight, and IParameterized::registerParameter().

Referenced by ParticleLayout().

Here is the call graph for this function:

weight()

double ILayout::weight ( ) const

inlineinherited

Returns the relative weight of this layout.

Definition at line 57 of file ILayout.h.

{ return m_weight; }

References ILayout::m_weight.

Referenced by clone(), ProcessedLayout::collectFormFactors(), and ILayout::setWeight().

setWeight()

void ILayout::setWeight ( double  weight )

inlineinherited

Sets the relative weight of this layout.

Definition at line 60 of file ILayout.h.

{ m_weight = weight; }

References ILayout::m_weight, and ILayout::weight().

Referenced by clone().

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 addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::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(), 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::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), IParticle::registerAbundance(), registerParticleDensity(), Layer::registerThickness(), IParameterized::registerVector(), 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::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(), 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(), 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::MultiLayer(), Beam::operator=(), SampleBuilderNode::operator=(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), 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_particles

SafePointerVector<IAbstractParticle> ParticleLayout::m_particles

private

Vector of particle types.

Definition at line 63 of file ParticleLayout.h.

Referenced by addAndRegisterAbstractParticle(), clone(), getChildren(), getTotalAbundance(), and particles().

mP_interference_function

std::unique_ptr<IInterferenceFunction> ParticleLayout::mP_interference_function

private

Definition at line 64 of file ParticleLayout.h.

Referenced by clone(), getChildren(), interferenceFunction(), setAndRegisterInterferenceFunction(), and totalParticleSurfaceDensity().

m_total_particle_density

double ParticleLayout::m_total_particle_density

private

Definition at line 65 of file ParticleLayout.h.

Referenced by registerParticleDensity(), setTotalParticleSurfaceDensity(), and totalParticleSurfaceDensity().

m_weight

double ILayout::m_weight

protectedinherited

Definition at line 63 of file ILayout.h.

Referenced by registerWeight(), ILayout::setWeight(), and ILayout::weight().

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/Aggregate/ParticleLayout.h
• /home/www/ba/Sample/Aggregate/ParticleLayout.cpp