Particle Class Reference

A particle with a form factor and refractive index. More...

Inheritance diagram for Particle:

Collaboration diagram for Particle:

Public Member Functions
	Particle ()=delete
	Particle (Material material)
	Particle (Material material, const IFormFactor &form_factor)
	Particle (Material material, const IFormFactor &form_factor, const IRotation &rotation)
	~Particle ()
double	abundance () const
void	accept (INodeVisitor *visitor) const final
	Calls the INodeVisitor's visit method. More...
virtual ParticleLimits	bottomTopZ () const
	Top and bottom z-coordinate. More...
Particle *	clone () const final
	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...
virtual IFormFactor *	createFormFactor () const
	Creates a form factor for this particle. More...
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
SlicedParticle	createSlicedParticle (ZLimits limits) const final
	Creates a sliced form factor for this particle. More...
virtual SafePointerVector< IParticle >	decompose () const
	Decompose in constituent IParticle objects. 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 final
	Returns a vector of children. More...
const std::string &	getName () const
bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. More...
const Material *	material () const final
	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
kvector_t	position () const
	Returns particle position. More...
std::vector< const INode * >	progeny () const
	Returns a vector of all descendants. More...
void	registerAbundance (bool make_registered=true)
void	registerChild (INode *node)
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerPosition (bool make_registered=true)
	Registers the three components of its position. More...
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	rotate (const IRotation &rotation) final
	Rotates the particle. More...
const IRotation *	rotation () const
	Returns rotation object. More...
void	setAbundance (double abundance)
	Sets particle abundance. More...
void	setMaterial (Material material)
void	setName (const std::string &name)
void	setParameterValue (const std::string &name, double value)
virtual void	setParent (const INode *newParent)
void	setPosition (double x, double y, double z)
	Sets relative position of the particle's reference point in the coordinate system of parent. More...
void	setPosition (kvector_t position)
	Sets relative position of the particle's reference point in the coordinate system of parent. More...
void	setRotation (const IRotation &rotation)
	Sets transformation. More...
void	setVectorValue (const std::string &base_name, kvector_t value)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
void	translate (kvector_t translation) final
	Translates the particle. More...
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node. 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 Member Functions
kvector_t	composedTranslation (const IRotation *p_rotation, kvector_t translation) const
	Gets a composed translation vector. More...
IRotation *	createComposedRotation (const IRotation *p_rotation) const
	Creates a composed IRotation object. More...
void	registerParticleProperties ()
	Registers abundance and position. More...

Protected Attributes
double	m_abundance {1.0}
std::unique_ptr< IFormFactor >	m_form_factor
Material	m_material
const size_t	m_NP
std::vector< double >	m_P
kvector_t	m_position
std::unique_ptr< IRotation >	m_rotation

Private Member Functions
void	initialize ()
void	setFormFactor (const IFormFactor &form_factor)

Private Attributes
std::string	m_name
const INode *	m_parent {nullptr}
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...

Detailed Description

A particle with a form factor and refractive index.

Definition at line 24 of file Particle.h.

Constructor & Destructor Documentation

Particle() [1/4]

Particle::Particle ( )

delete

Referenced by clone().

~Particle()

Particle::~Particle ( )

default

Particle() [2/4]

Particle::Particle

(

Material

material

)

Definition at line 25 of file Particle.cpp.

                                    : m_material(std::move(material))
{
    initialize();
}

References initialize().

Here is the call graph for this function:

Particle() [3/4]

Particle::Particle	(	Material	material,
		const IFormFactor &	form_factor
	)

Definition at line 30 of file Particle.cpp.

    : m_material(std::move(material)), m_form_factor(form_factor.clone())
{
    initialize();
    registerChild(m_form_factor.get());
}

References initialize(), m_form_factor, and INode::registerChild().

Here is the call graph for this function:

Particle() [4/4]

Particle::Particle	(	Material	material,
		const IFormFactor &	form_factor,
		const IRotation &	rotation
	)

Definition at line 37 of file Particle.cpp.

    : m_material(std::move(material)), m_form_factor(form_factor.clone())
{
    initialize();
    setRotation(rotation);
    registerChild(m_form_factor.get());
}

References initialize(), m_form_factor, INode::registerChild(), IParticle::rotation(), and IParticle::setRotation().

Here is the call graph for this function:

Member Function Documentation

abundance()

double IAbstractParticle::abundance ( ) const

inlineinherited

Definition at line 39 of file IAbstractParticle.h.

{ return m_abundance; }

References IAbstractParticle::m_abundance.

Referenced by SampleToPython::defineParticleLayouts(), ParticleDistribution::generateParticles(), GUIDomainSampleVisitor::InsertIParticle(), ProcessedLayout::processParticle(), IAbstractParticle::setAbundance(), and TransformFromDomain::setParticleDistributionItem().

accept()

void Particle::accept ( INodeVisitor *  visitor ) const

inlinefinalvirtual

Calls the INodeVisitor's visit method.

Reimplemented from IAbstractParticle.

Definition at line 34 of file Particle.h.

{ visitor->visit(this); }

bottomTopZ()

ParticleLimits IParticle::bottomTopZ ( ) const

virtualinherited

Top and bottom z-coordinate.

Reimplemented in ParticleComposition.

Definition at line 94 of file IParticle.cpp.

{
    std::unique_ptr<IFormFactor> P_ff(createFormFactor());
    std::unique_ptr<IRotation> P_rot(new IdentityRotation);
    return {P_ff->bottomZ(*P_rot), P_ff->topZ(*P_rot)};
}

References IParticle::createFormFactor().

Here is the call graph for this function:

clone()

Particle * Particle::clone ( ) const

finalvirtual

Returns a clone of this ISampleNode object.

Implements IParticle.

Definition at line 45 of file Particle.cpp.

{
    Particle* p_result = new Particle(m_material);
    p_result->setAbundance(m_abundance);
    if (m_form_factor)
        p_result->setFormFactor(*m_form_factor);
    if (m_rotation)
        p_result->setRotation(*m_rotation);
    p_result->setPosition(m_position);
 
    return p_result;
}

References Particle(), IAbstractParticle::m_abundance, m_form_factor, m_material, IParticle::m_position, IParticle::m_rotation, IAbstractParticle::setAbundance(), setFormFactor(), IParticle::setPosition(), and IParticle::setRotation().

Referenced by ParticleCoreShell::addAndRegisterCore(), ParticleCoreShell::addAndRegisterShell(), RealSpaceBuilderUtils::applyParticleCoreShellTransformations(), and RealSpaceBuilderUtils::singleParticle3DContainer().

Here is the call graph for this function:

composedTranslation()

kvector_t IParticle::composedTranslation ( const IRotation *  p_rotation, kvector_t  translation  ) const

protectedinherited

Gets a composed translation vector.

Definition at line 116 of file IParticle.cpp.

{
    if (p_rotation) {
        return translation + p_rotation->transformed(m_position);
    } else {
        return translation + m_position;
    }
}

References IParticle::m_position, and IRotation::transformed().

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:

createComposedRotation()

IRotation * IParticle::createComposedRotation ( const IRotation *  p_rotation ) const

protectedinherited

Creates a composed IRotation object.

Definition at line 101 of file IParticle.cpp.

{
    if (p_rotation) {
        if (m_rotation)
            return createProduct(*p_rotation, *m_rotation);
        else
            return p_rotation->clone();
    } else {
        if (m_rotation)
            return m_rotation->clone();
        else
            return nullptr;
    }
}

References IRotation::clone(), createProduct(), and IParticle::m_rotation.

Here is the call graph for this function:

createFormFactor()

IFormFactor * IParticle::createFormFactor ( ) const

virtualinherited

Creates a form factor for this particle.

Reimplemented in ParticleComposition.

Definition at line 23 of file IParticle.cpp.

{
    return createSlicedParticle(ZLimits{}).m_slicedff.release();
}

References IParticle::createSlicedParticle().

Referenced by IParticle::bottomTopZ().

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:

createSlicedParticle()

SlicedParticle Particle::createSlicedParticle ( ZLimits  limits ) const

finalvirtual

Creates a sliced form factor for this particle.

Reimplemented from IParticle.

Definition at line 58 of file Particle.cpp.

{
    if (!m_form_factor)
        return {};
    std::unique_ptr<IRotation> P_rotation(new IdentityRotation);
    if (m_rotation)
        P_rotation.reset(m_rotation->clone());
    std::unique_ptr<IFormFactor> P_tem_ff(
        m_form_factor->createSlicedFormFactor(limits, *P_rotation, m_position));
    if (!P_tem_ff)
        return {};
    std::unique_ptr<FormFactorDecoratorMaterial> P_ff(new FormFactorDecoratorMaterial(*P_tem_ff));
    double volume = P_tem_ff->volume();
    Material transformed_material(m_material.rotatedMaterial(P_rotation->getTransform3D()));
    P_ff->setMaterial(transformed_material);
    SlicedParticle result;
    result.m_regions.push_back({volume, transformed_material});
    result.m_slicedff = std::move(P_ff);
    return result;
}

References m_form_factor, m_material, IParticle::m_position, SlicedParticle::m_regions, IParticle::m_rotation, SlicedParticle::m_slicedff, and Material::rotatedMaterial().

Here is the call graph for this function:

decompose()

SafePointerVector< IParticle > IParticle::decompose ( ) const

virtualinherited

Decompose in constituent IParticle objects.

Reimplemented in ParticleComposition.

Definition at line 87 of file IParticle.cpp.

{
    SafePointerVector<IParticle> result;
    result.push_back(this->clone());
    return result;
}

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

Referenced by SlicedFormFactorList::createSlicedFormFactors().

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 * > Particle::getChildren ( ) const

finalvirtual

Returns a vector of children.

Reimplemented from IParticle.

Definition at line 92 of file Particle.cpp.

{
    return std::vector<const INode*>() << IParticle::getChildren() << m_form_factor;
}

References IParticle::getChildren(), and m_form_factor.

Here is the call graph for this function:

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

initialize()

void Particle::initialize ( )

private

Definition at line 97 of file Particle.cpp.

{
    setName("Particle");
    registerParticleProperties();
}

References IParticle::registerParticleProperties(), and IParametricComponent::setName().

Referenced by Particle().

Here is the call graph for this function:

isMagnetic()

bool ISampleNode::isMagnetic ( ) const

inherited

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

Definition at line 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()

const Material* Particle::material ( ) const

inlinefinalvirtual

Returns nullptr, unless overwritten to return a specific material.

Reimplemented from ISampleNode.

Definition at line 39 of file Particle.h.

{ return &m_material; }

References m_material.

Referenced by RealSpaceBuilderUtils::applyParticleColor(), setMaterial(), and GUIDomainSampleVisitor::visit().

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(), ParticleLayout::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().

position()

kvector_t IParticle::position ( ) const

inlineinherited

Returns particle position.

Definition at line 45 of file IParticle.h.

{ return m_position; }

References IParticle::m_position.

Referenced by ParticleComposition::addParticle(), RealSpaceBuilderUtils::applyParticleCoreShellTransformations(), RealSpaceBuilderUtils::applyParticleTransformations(), GUIDomainSampleVisitor::buildPositionInfo(), ParticleComposition::decompose(), and IParticle::setPosition().

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:

registerAbundance()

void IParticle::registerAbundance ( bool  make_registered = true )

inherited

Definition at line 66 of file IParticle.cpp.

{
    if (make_registered) {
        if (!parameter("Abundance"))
            registerParameter("Abundance", &m_abundance);
    } else {
        removeParameter("Abundance");
    }
}

References IAbstractParticle::m_abundance, IParametricComponent::parameter(), IParametricComponent::registerParameter(), and IParametricComponent::removeParameter().

Referenced by ParticleComposition::addParticlePointer(), and IParticle::registerParticleProperties().

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(), ParticleDistribution::ParticleDistribution(), ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), ISimulation::initialize(), MesoCrystal::initialize(), Beam::operator=(), Instrument::operator=(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), ISimulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), 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(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParametricComponent::registerVector(), ParticleLayout::registerWeight(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

registerParticleProperties()

void IParticle::registerParticleProperties ( )

protectedinherited

Registers abundance and position.

Definition at line 125 of file IParticle.cpp.

{
    registerAbundance();
    registerPosition();
}

References IParticle::registerAbundance(), and IParticle::registerPosition().

Referenced by ParticleCoreShell::ParticleCoreShell(), MesoCrystal::initialize(), initialize(), and ParticleComposition::initialize().

Here is the call graph for this function:

registerPosition()

void IParticle::registerPosition ( bool  make_registered = true )

inherited

Registers the three components of its position.

Definition at line 76 of file IParticle.cpp.

{
    if (make_registered) {
        if (!parameter(XComponentName("Position"))) {
            registerVector("Position", &m_position, "nm");
        }
    } else {
        removeVector("Position");
    }
}

References IParticle::m_position, IParametricComponent::parameter(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), and IParametricComponent::XComponentName().

Referenced by IParticle::registerParticleProperties().

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:

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(), ParticleLayout::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:

rotate()

void IParticle::rotate ( const IRotation &  rotation )

finalvirtualinherited

Rotates the particle.

Implements IAbstractParticle.

Definition at line 50 of file IParticle.cpp.

{
    if (m_rotation) {
        m_rotation.reset(createProduct(rotation, *m_rotation));
    } else {
        m_rotation.reset(rotation.clone());
    }
    m_position = rotation.transformed(m_position);
    registerChild(m_rotation.get());
}

References IRotation::clone(), createProduct(), IParticle::m_position, IParticle::m_rotation, INode::registerChild(), IParticle::rotation(), and IRotation::transformed().

Referenced by BoxCompositionRotateZandYBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), and TransformBoxBuilder::buildSample().

Here is the call graph for this function:

rotation()

const IRotation * IParticle::rotation ( ) const

inherited

Returns rotation object.

Definition at line 39 of file IParticle.cpp.

{
    return m_rotation.get();
}

References IParticle::m_rotation.

Referenced by Particle(), RealSpaceBuilderUtils::applyParticleCoreShellTransformations(), RealSpaceBuilderUtils::applyParticleTransformations(), MesoCrystal::createSlicedParticle(), ParticleComposition::decompose(), IParticle::rotate(), and IParticle::setRotation().

setAbundance()

void IAbstractParticle::setAbundance ( double  abundance )

inlineinherited

Sets particle abundance.

Parameters

abundance

proportion of this type of particles normalized to the total number of particles in the layout.

Definition at line 44 of file IAbstractParticle.h.

{ m_abundance = abundance; }

References IAbstractParticle::abundance(), and IAbstractParticle::m_abundance.

Referenced by ParticleLayout::addParticle(), MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), ParticleDistribution::clone(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

setFormFactor()

void Particle::setFormFactor ( const IFormFactor &  form_factor )

private

Definition at line 84 of file Particle.cpp.

{
    if (&form_factor != m_form_factor.get()) {
        m_form_factor.reset(form_factor.clone());
        registerChild(m_form_factor.get());
    }
}

References IFormFactor::clone(), m_form_factor, and INode::registerChild().

Referenced by clone().

Here is the call graph for this function:

setMaterial()

void Particle::setMaterial

(

Material

material

)

Definition at line 79 of file Particle.cpp.

{
    m_material = std::move(material);
}

References m_material, and material().

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

setPosition() [1/2]

void IParticle::setPosition ( double  x, double  y, double  z  )

inlineinherited

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters

x	x-coordinate in nanometers
y	y-coordinate in nanometers
z	z-coordinate in nanometers

Definition at line 57 of file IParticle.h.

{ m_position = kvector_t(x, y, z); }

References IParticle::m_position.

setPosition() [2/2]

void IParticle::setPosition ( kvector_t  position )

inlineinherited

Sets relative position of the particle's reference point in the coordinate system of parent.

Parameters

position

relative position vector (components are in nanometers)

Definition at line 50 of file IParticle.h.

{ m_position = position; }

References IParticle::m_position, and IParticle::position().

Referenced by BoxCompositionRotateXBuilder::buildSample(), BoxCompositionRotateYBuilder::buildSample(), BoxCompositionRotateZBuilder::buildSample(), BoxCompositionRotateZandYBuilder::buildSample(), BoxStackCompositionBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), CustomMorphologyBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), SlicedCompositionBuilder::buildSample(), TransformBoxBuilder::buildSample(), RotatedSquareLattice2DBuilder::buildSample(), MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), and TransformToDomain::setPositionInfo().

Here is the call graph for this function:

setRotation()

void IParticle::setRotation ( const IRotation &  rotation )

inherited

Sets transformation.

Definition at line 44 of file IParticle.cpp.

{
    m_rotation.reset(rotation.clone());
    registerChild(m_rotation.get());
}

References IRotation::clone(), IParticle::m_rotation, INode::registerChild(), and IParticle::rotation().

Referenced by Particle(), BoxCompositionRotateXBuilder::buildSample(), BoxCompositionRotateYBuilder::buildSample(), BoxCompositionRotateZBuilder::buildSample(), BoxCompositionRotateZandYBuilder::buildSample(), BoxStackCompositionBuilder::buildSample(), CoreShellBoxRotateZandYBuilder::buildSample(), LayersWithAbsorptionBuilder::buildSample(), LayersWithAbsorptionBySLDBuilder::buildSample(), RotatedPyramidsDistributionBuilder::buildSample(), SlicedCompositionBuilder::buildSample(), TransformBoxBuilder::buildSample(), MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), and TransformToDomain::setRotationInfo().

Here is the call graph for this function:

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:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 34 of file ICloneable.h.

translate()

void IParticle::translate ( kvector_t  translation )

finalvirtualinherited

Translates the particle.

Implements IAbstractParticle.

Definition at line 34 of file IParticle.cpp.

{
    m_position += translation;
}

References IParticle::m_position.

Referenced by ParticleComposition::addParticle(), and SlicedFormFactorList::addParticle().

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:

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_abundance

double IAbstractParticle::m_abundance {1.0}

protectedinherited

Definition at line 53 of file IAbstractParticle.h.

Referenced by ParticleDistribution::ParticleDistribution(), IAbstractParticle::abundance(), MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), ParticleDistribution::clone(), IParticle::registerAbundance(), and IAbstractParticle::setAbundance().

m_form_factor

std::unique_ptr<IFormFactor> Particle::m_form_factor

protected

Definition at line 45 of file Particle.h.

Referenced by Particle(), clone(), createSlicedParticle(), getChildren(), and setFormFactor().

m_material

Material Particle::m_material

protected

Definition at line 44 of file Particle.h.

Referenced by clone(), createSlicedParticle(), material(), and setMaterial().

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_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_position

kvector_t IParticle::m_position

protectedinherited

Definition at line 94 of file IParticle.h.

Referenced by MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), IParticle::composedTranslation(), MesoCrystal::createSlicedParticle(), createSlicedParticle(), ParticleCoreShell::createSlicedParticle(), IParticle::position(), IParticle::registerPosition(), IParticle::rotate(), IParticle::setPosition(), and IParticle::translate().

m_rotation

std::unique_ptr<IRotation> IParticle::m_rotation

protectedinherited

Definition at line 95 of file IParticle.h.

Referenced by MesoCrystal::clone(), clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), IParticle::createComposedRotation(), MesoCrystal::createSlicedParticle(), createSlicedParticle(), ParticleCoreShell::createSlicedParticle(), IParticle::getChildren(), IParticle::rotate(), IParticle::rotation(), and IParticle::setRotation().

---

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

• /home/www/ba/Sample/Particle/Particle.h
• /home/www/ba/Sample/Particle/Particle.cpp