ParticleLayout Class Reference

Decorator class that adds particles to ISampleNode objects. More...

Inheritance diagram for ParticleLayout:

Collaboration diagram for ParticleLayout:

Public Member Functions
	ParticleLayout ()
	ParticleLayout (const IAbstractParticle &particle, double abundance=-1.0)
	~ParticleLayout () override
void	accept (INodeVisitor *visitor) const override
	Calls the INodeVisitor's visit method. More...
void	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. More...
ParticleLayout *	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...
int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name. More...
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number. More...
std::vector< const INode * >	getChildren () const override
	Returns a vector of children. More...
const std::string &	getName () const
double	getTotalAbundance () const
const IInterferenceFunction *	interferenceFunction () const
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...
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed. More...
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'. More...
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool. More...
std::string	parametersToString () const
	Returns multiline string representing available parameters. More...
INode *	parent ()
const INode *	parent () const
SafePointerVector< IParticle >	particles () const
	Returns information on all particles (type and abundance) and generates new particles if an IAbstractParticle denotes a collection. More...
std::vector< const INode * >	progeny () const
	Returns a vector of all descendants. More...
void	registerChild (INode *node)
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	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setInterferenceFunction (const IInterferenceFunction &interference_function)
	Adds interference functions. More...
void	setName (const std::string &name)
void	setParameterValue (const std::string &name, double value)
virtual void	setParent (const INode *newParent)
void	setTotalParticleSurfaceDensity (double particle_density)
	Sets total particle surface density. More...
void	setVectorValue (const std::string &base_name, kvector_t value)
void	setWeight (double weight)
	Sets the relative weight of this layout. More...
double	totalParticleSurfaceDensity () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node. More...
double	weight () const
	Returns the relative weight of this layout. More...

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	addAndRegisterAbstractParticle (IAbstractParticle *child)
	Adds particle information with simultaneous registration in parent class. More...
void	registerParticleDensity (bool make_registered=true)
void	registerWeight ()
void	setAndRegisterInterferenceFunction (IInterferenceFunction *child)
	Sets interference function with simultaneous registration in parent class. More...

Private Attributes
std::unique_ptr< IInterferenceFunction >	m_interference_function
std::string	m_name
const INode *	m_parent {nullptr}
SafePointerVector< IAbstractParticle >	m_particles
	Vector of particle types. More...
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...
double	m_total_particle_density
double	m_weight

Detailed Description

Decorator class that adds particles to ISampleNode objects.

Definition at line 30 of file ParticleLayout.h.

Constructor & Destructor Documentation

ParticleLayout() [1/2]

ParticleLayout::ParticleLayout

(

)

Definition at line 35 of file ParticleLayout.cpp.

    : m_weight(1.0), m_total_particle_density(0.01), m_interference_function(nullptr)
{
    setName("ParticleLayout");
    registerParticleDensity();
    registerWeight();
}

References registerParticleDensity(), registerWeight(), and IParametricComponent::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 43 of file ParticleLayout.cpp.

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

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

Here is the call graph for this function:

~ParticleLayout()

ParticleLayout::~ParticleLayout ( )

overridedefault

Member Function Documentation

accept()

void ParticleLayout::accept ( INodeVisitor *  visitor ) const

inlineoverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 38 of file ParticleLayout.h.

{ visitor->visit(this); }

References INodeVisitor::visit().

Here is the call graph for this function:

addAndRegisterAbstractParticle()

void ParticleLayout::addAndRegisterAbstractParticle ( IAbstractParticle *  child )

private

Adds particle information with simultaneous registration in parent class.

Definition at line 148 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:

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 75 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 ParticleLayout(), BoxesSquareLattice2DBuilder::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(), SquareLattice2DBuilder::buildSample(), CenteredSquareLattice2DBuilder::buildSample(), RotatedSquareLattice2DBuilder::buildSample(), FiniteSquareLattice2DBuilder::buildSample(), and SuperLatticeBuilder::buildSample().

Here is the call graph for this function:

clone()

ParticleLayout * ParticleLayout::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 54 of file ParticleLayout.cpp.

{
    ParticleLayout* result = new ParticleLayout();
 
    for (const auto* particle : m_particles)
        result->addAndRegisterAbstractParticle(particle->clone());
 
    if (m_interference_function)
        result->setAndRegisterInterferenceFunction(m_interference_function->clone());
 
    result->setTotalParticleSurfaceDensity(totalParticleSurfaceDensity());
    result->setWeight(weight());
 
    return result;
}

References ParticleLayout(), addAndRegisterAbstractParticle(), m_interference_function, m_particles, setAndRegisterInterferenceFunction(), setTotalParticleSurfaceDensity(), setWeight(), totalParticleSurfaceDensity(), and weight().

Referenced by Layer::addLayout().

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 26 of file ISampleNode.cpp.

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

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

Referenced by MultiLayerUtils::ContainsCompatibleMaterials(), SampleToPython::initLabels(), and ISampleNode::isMagnetic().

Here is the call graph for this function:

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 94 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(), IParametricComponent::getName(), and INode::parent().

Referenced by INode::displayName().

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 IParametricComponent.

Definition at line 126 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    for (const INode* child : progeny()) {
        const std::string path = NodeUtils::nodePath(child, parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
    }
 
    return result.release();
}

References NodeUtils::nodePath(), INode::parent(), and INode::progeny().

Referenced by ISimulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecularSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

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 115 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(), IParametricComponent::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath().

Here is the call graph for this function:

getChildren()

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

overridevirtual

Returns a vector of children.

Reimplemented from INode.

Definition at line 138 of file ParticleLayout.cpp.

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

References m_interference_function, and m_particles.

getName()

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

inlineinherited

Definition at line 70 of file IParametricComponent.h.

{ return m_name; }

References IParametricComponent::m_name.

Referenced by Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent::IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), IParametricComponent::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), Beam::operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), IParametricComponent::registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

getTotalAbundance()

double ParticleLayout::getTotalAbundance

(

)

const

Definition at line 110 of file ParticleLayout.cpp.

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

References m_particles.

Referenced by ProcessedLayout::collectFormFactors().

interferenceFunction()

const IInterferenceFunction * ParticleLayout::interferenceFunction

(

)

const

Definition at line 105 of file ParticleLayout.cpp.

{
    return m_interference_function.get();
}

References m_interference_function.

Referenced by ProcessedLayout::ProcessedLayout().

isMagnetic()

bool ISampleNode::isMagnetic ( ) const

inherited

Returns true if there is any magnetic material in this ISampleNode.

Definition at line 40 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 ProcessedSample::initLayouts().

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 37 of file ISampleNode.h.

{ return nullptr; }

Referenced by ISampleNode::containedMaterials(), FormFactorCoreShell::setAmbientMaterial(), FormFactorCrystal::setAmbientMaterial(), FormFactorWeighted::setAmbientMaterial(), FormFactorDecoratorMaterial::setAmbientMaterial(), IFormFactorDecorator::setAmbientMaterial(), and FormFactorDecoratorMaterial::setMaterial().

onChange()

virtual void IParametricComponent::onChange ( )

inlinevirtualinherited

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

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, 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, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

{}

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

parameter()

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

inherited

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

{
    return m_pool->parameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

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

References IParametricComponent::m_pool.

Referenced by INode::INode(), IParametricComponent::IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParametricComponent::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

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

References IParametricComponent::createParameterTree().

Here is the call graph for this function:

parent() [1/2]

INode * INode::parent ( )

inherited

Definition at line 89 of file INode.cpp.

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

References INode::m_parent.

parent() [2/2]

const INode * INode::parent ( ) const

inherited

Definition at line 84 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

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

particles()

SafePointerVector< IParticle > ParticleLayout::particles

(

)

const

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

Definition at line 90 of file ParticleLayout.cpp.

{
    SafePointerVector<IParticle> particle_vector;
    for (const 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().

Referenced by ProcessedLayout::collectFormFactors().

Here is the call graph for this function:

progeny()

std::vector< const INode * > INode::progeny ( ) const

inherited

Returns a vector of all descendants.

Definition at line 68 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : getChildren()) {
        for (const auto* p : child->progeny())
            result.push_back(p);
    }
    return result;
}

References INode::getChildren().

Referenced by INode::createParameterTree(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 57 of file INode.cpp.

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

References ASSERT, and INode::setParent().

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

Here is the call graph for this function:

registerParameter()

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

inherited

Definition at line 51 of file IParametricComponent.cpp.

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

References IParametricComponent::getName(), IParametricComponent::m_pool, RealSpace::Particles::name(), and IParametricComponent::onChange().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice2D::HexagonalLattice2D(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), SquareLattice2D::SquareLattice2D(), TriangularRippleBuilder::TriangularRippleBuilder(), IParticle::registerAbundance(), registerParticleDensity(), Layer::registerThickness(), IParametricComponent::registerVector(), registerWeight(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

registerParticleDensity()

void ParticleLayout::registerParticleDensity ( bool  make_registered = true )

private

Definition at line 166 of file ParticleLayout.cpp.

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

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

Referenced by ParticleLayout(), and setAndRegisterInterferenceFunction().

Here is the call graph for this function:

registerVector()

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

inherited

Definition at line 57 of file IParametricComponent.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 ModelView::Utils::base_name(), IParametricComponent::registerParameter(), RealParameter::setUnit(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

registerWeight()

void ParticleLayout::registerWeight ( )

private

Definition at line 176 of file ParticleLayout.cpp.

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

References m_weight, and IParametricComponent::registerParameter().

Referenced by ParticleLayout().

Here is the call graph for this function:

removeParameter()

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

inherited

Definition at line 91 of file IParametricComponent.cpp.

{
    m_pool->removeParameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

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

Here is the call graph for this function:

removeVector()

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

inherited

Definition at line 96 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::removeParameter(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by IParticle::registerPosition().

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 155 of file ParticleLayout.cpp.

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

References m_interference_function, INode::registerChild(), and registerParticleDensity().

Referenced by clone(), and setInterferenceFunction().

Here is the call graph for this function:

setInterferenceFunction()

void ParticleLayout::setInterferenceFunction

(

const IInterferenceFunction &

interference_function

)

Adds interference functions.

Definition at line 119 of file ParticleLayout.cpp.

{
    setAndRegisterInterferenceFunction(interference_function.clone());
}

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

Referenced by BoxesSquareLattice2DBuilder::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(), SquareLattice2DBuilder::buildSample(), CenteredSquareLattice2DBuilder::buildSample(), RotatedSquareLattice2DBuilder::buildSample(), FiniteSquareLattice2DBuilder::buildSample(), and SuperLatticeBuilder::buildSample().

Here is the call graph for this function:

setName()

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

inlineinherited

Definition at line 69 of file IParametricComponent.h.

{ m_name = name; }

References IParametricComponent::m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), 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(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), Beam::operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

setParameterValue()

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

inherited

Definition at line 65 of file IParametricComponent.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 IParametricComponent::createParameterTree(), IParametricComponent::m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 79 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

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

setTotalParticleSurfaceDensity()

void ParticleLayout::setTotalParticleSurfaceDensity

(

double

particle_density

)

Sets total particle surface density.

Parameters

particle_density

number of particles per square nanometer

Definition at line 133 of file ParticleLayout.cpp.

{
    m_total_particle_density = particle_density;
}

References m_total_particle_density.

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

setVectorValue()

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

inherited

Definition at line 78 of file IParametricComponent.cpp.

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

References ModelView::Utils::base_name(), IParametricComponent::setParameterValue(), BasicVector3D< T >::x(), IParametricComponent::XComponentName(), BasicVector3D< T >::y(), IParametricComponent::YComponentName(), BasicVector3D< T >::z(), and IParametricComponent::ZComponentName().

Here is the call graph for this function:

setWeight()

void ParticleLayout::setWeight ( double  weight )

inline

Sets the relative weight of this layout.

Definition at line 60 of file ParticleLayout.h.

{ m_weight = weight; }

References m_weight, and weight().

Referenced by clone().

Here is the call graph for this function:

totalParticleSurfaceDensity()

double ParticleLayout::totalParticleSurfaceDensity

(

)

const

Definition at line 124 of file ParticleLayout.cpp.

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

References m_interference_function, and m_total_particle_density.

Referenced by AveragedSlicedCylindersBuilder::buildSample(), clone(), ProcessedLayout::collectFormFactors(), and GUIDomainSampleVisitor::visit().

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 52 of file INode.cpp.

{
    return NodeUtils::nodeToString(this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

weight()

double ParticleLayout::weight ( ) const

inline

Returns the relative weight of this layout.

Definition at line 57 of file ParticleLayout.h.

{ return m_weight; }

References m_weight.

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

XComponentName()

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

staticinherited

Definition at line 103 of file IParametricComponent.cpp.

{
    return base_name + "X";
}

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

YComponentName()

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

staticinherited

Definition at line 108 of file IParametricComponent.cpp.

{
    return base_name + "Y";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

ZComponentName()

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

staticinherited

Definition at line 113 of file IParametricComponent.cpp.

{
    return base_name + "Z";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Member Data Documentation

m_interference_function

std::unique_ptr<IInterferenceFunction> ParticleLayout::m_interference_function

private

Definition at line 72 of file ParticleLayout.h.

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

m_name

std::string IParametricComponent::m_name

privateinherited

Definition at line 73 of file IParametricComponent.h.

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

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 88 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 89 of file INode.h.

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

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 83 of file INode.h.

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

m_particles

SafePointerVector<IAbstractParticle> ParticleLayout::m_particles

private

Vector of particle types.

Definition at line 71 of file ParticleLayout.h.

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

m_pool

std::unique_ptr<ParameterPool> IParametricComponent::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

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

m_total_particle_density

double ParticleLayout::m_total_particle_density

private

Definition at line 70 of file ParticleLayout.h.

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

m_weight

double ParticleLayout::m_weight

private

Definition at line 69 of file ParticleLayout.h.

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

---

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