ParticleLayout Class Reference

Description

Decorator class that adds particles to ISampleNode objects.

Definition at line 28 of file ParticleLayout.h.

Inheritance diagram for ParticleLayout:

Collaboration diagram for ParticleLayout:

Public Member Functions
	ParticleLayout ()
	ParticleLayout (const IParticle &particle, double abundance=-1.0)
	~ParticleLayout () override
void	addParticle (const IParticle &particle, double abundance=-1.0)
	Adds particle to the layout with abundance, position and the rotation defined. More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
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...
const IInterference *	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...
std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
std::vector< const IParticle * >	particles () const
void	setInterference (const IInterference &interparticle)
	Adds interference functions. More...
void	setTotalParticleSurfaceDensity (double particle_density)
	Sets total particle surface density. More...
void	setWeight (double weight)
	Sets the relative weight of this layout. More...
double	totalAbundance () const
double	totalParticleSurfaceDensity () const
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
double	weight () const
	Returns the relative weight of this layout. More...
double	weightedParticleSurfaceDensity () const

Protected Attributes
std::vector< double >	m_P

Private Member Functions
void	addAndRegisterAbstractParticle (IParticle *child)
	Adds particle information with simultaneous registration in parent class. More...
void	setAndRegisterInterference (IInterference *child)
	Sets interference function with simultaneous registration in parent class. More...

Private Attributes
std::unique_ptr< IInterference >	m_interparticle
OwningVector< IParticle >	m_particles
	Vector of particle types. More...
double	m_total_particle_density {.01}
double	m_weight {1}

Constructor & Destructor Documentation

ParticleLayout() [1/2]

ParticleLayout::ParticleLayout ( )

default

Referenced by clone().

ParticleLayout() [2/2]

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

Definition at line 21 of file ParticleLayout.cpp.

{
    addParticle(particle, abundance);
}

References addParticle().

Here is the call graph for this function:

~ParticleLayout()

ParticleLayout::~ParticleLayout ( )

overridedefault

Member Function Documentation

addAndRegisterAbstractParticle()

void ParticleLayout::addAndRegisterAbstractParticle ( IParticle *  child )

private

Adds particle information with simultaneous registration in parent class.

Definition at line 110 of file ParticleLayout.cpp.

{
    m_particles.emplace_back(child);
}

References OwningVector< T >::emplace_back(), and m_particles.

Referenced by addParticle().

Here is the call graph for this function:

addParticle()

void ParticleLayout::addParticle	(	const IParticle &	particle,
		double	abundance = -1.0
	)

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

Parameters

particle	to be added
abundance	Particle abundance

Definition at line 56 of file ParticleLayout.cpp.

{
    IParticle* particle_clone = particle.clone();
    if (abundance >= 0.0)
        particle_clone->setAbundance(abundance);
    addAndRegisterAbstractParticle(particle_clone);
}

References addAndRegisterAbstractParticle(), IParticle::clone(), and IParticle::setAbundance().

Referenced by ParticleLayout(), ExemplarySamples::createBasic2DLattice(), ExemplarySamples::createBoxesSquareLattice2D(), ExemplarySamples::createCenteredSquareLattice2D(), ExemplarySamples::createCoreShellBoxRotateZandY(), ExemplarySamples::createCosineRipple(), ExemplarySamples::createCustomMorphology(), ExemplarySamples::createCylindersAndPrisms(), ExemplarySamples::createFiniteSquareLattice2D(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createLayersWithAbsorptionWithFF(), ExemplarySamples::createMagneticLayer(), ExemplarySamples::createMagneticRotation(), ExemplarySamples::createMagneticSpheres(), ExemplarySamples::createMagneticSubstrateZeroField(), ExemplarySamples::createMesoCrystal(), ExemplarySamples::createMultipleLayout(), ExemplarySamples::createParticleComposition(), ExemplarySamples::createRotatedPyramids(), ExemplarySamples::createRotatedSquareLattice2D(), ExemplarySamples::createSizeDistributionDAModel(), ExemplarySamples::createSizeDistributionLMAModel(), ExemplarySamples::createSizeDistributionSSCAModel(), ExemplarySamples::createSlicedComposition(), ExemplarySamples::createSquareLattice2D(), ExemplarySamples::createSuperLattice(), ExemplarySamples::createTransformBox(), and ExemplarySamples::createTriangularRipple().

Here is the call graph for this function:

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string ParticleLayout::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 35 of file ParticleLayout.h.

{ return "ParticleLayout"; }

clone()

ParticleLayout * ParticleLayout::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Definition at line 28 of file ParticleLayout.cpp.

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

References ParticleLayout(), m_interparticle, m_particles, 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 25 of file ISampleNode.cpp.

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

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

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

Here is the call graph for this function:

interferenceFunction()

const IInterference * ParticleLayout::interferenceFunction

(

)

const

Definition at line 72 of file ParticleLayout.cpp.

{
    return m_interparticle.get();
}

References m_interparticle.

isMagnetic()

bool ISampleNode::isMagnetic ( ) const

inherited

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

Definition at line 39 of file ISampleNode.cpp.

{
    const auto materials = containedMaterials();
    return std::any_of(materials.cbegin(), materials.cend(),
                       [](const Material* mat) { return mat->isMagneticMaterial(); });
}

References ISampleNode::containedMaterials().

Referenced by reSample::make().

Here is the call graph for this function:

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

{ return nullptr; }

Referenced by ISampleNode::containedMaterials().

nodeChildren()

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

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 44 of file ParticleLayout.cpp.

{
    std::vector<const INode*> result;
    for (const IParticle* p : m_particles)
        result.emplace_back(p);
    result << m_interparticle;
    return result;
}

References m_interparticle, and m_particles.

nodeOffspring()

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

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

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

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

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

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 36 of file ParticleLayout.h.

    {
        return {{"Abundance", "", "e.g. surface fraction covered by this layout", 0, +INF, -1}};
    }

References INF.

particles()

std::vector< const IParticle * > ParticleLayout::particles

(

)

const

Definition at line 64 of file ParticleLayout.cpp.

{
    std::vector<const IParticle*> result;
    for (const IParticle* p : m_particles)
        result.emplace_back(p);
    return result;
}

References m_particles.

setAndRegisterInterference()

void ParticleLayout::setAndRegisterInterference ( IInterference *  child )

private

Sets interference function with simultaneous registration in parent class.

Definition at line 116 of file ParticleLayout.cpp.

{
    m_interparticle.reset(child);
}

References m_interparticle.

Referenced by setInterference().

setInterference()

void ParticleLayout::setInterference

(

const IInterference &

interparticle

)

Adds interference functions.

Definition at line 86 of file ParticleLayout.cpp.

{
    setAndRegisterInterference(interparticle.clone());
}

References IInterference::clone(), and setAndRegisterInterference().

Referenced by ExemplarySamples::createBasic2DLattice(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), ExemplarySamples::createBoxesSquareLattice2D(), ExemplarySamples::createCenteredSquareLattice2D(), ExemplarySamples::createCosineRipple(), ExemplarySamples::createFiniteSquareLattice2D(), ExemplarySamples::createHardDisk(), ExemplarySamples::createHexParaCrystal(), ExemplarySamples::createLattice1D(), ExemplarySamples::createParticleComposition(), ExemplarySamples::createRadialParaCrystal(), ExemplarySamples::createRectParaCrystal(), ExemplarySamples::createRotatedSquareLattice2D(), ExemplarySamples::createSizeDistributionDAModel(), ExemplarySamples::createSizeDistributionLMAModel(), ExemplarySamples::createSizeDistributionSSCAModel(), ExemplarySamples::createSquareLattice2D(), ExemplarySamples::createSuperLattice(), and ExemplarySamples::createTriangularRipple().

Here is the call graph for this function:

setTotalParticleSurfaceDensity()

void ParticleLayout::setTotalParticleSurfaceDensity

(

double

particle_density

)

Sets total particle surface density.

Parameters

particle_density

number of particles per square nanometer

Definition at line 104 of file ParticleLayout.cpp.

{
    m_total_particle_density = particle_density;
}

References m_total_particle_density.

Referenced by ExemplarySamples::createSuperLattice().

setWeight()

void ParticleLayout::setWeight ( double  weight )

inline

Sets the relative weight of this layout.

Definition at line 59 of file ParticleLayout.h.

{ m_weight = weight; }

References m_weight, and weight().

Here is the call graph for this function:

totalAbundance()

double ParticleLayout::totalAbundance

(

)

const

Definition at line 77 of file ParticleLayout.cpp.

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

References m_particles.

totalParticleSurfaceDensity()

double ParticleLayout::totalParticleSurfaceDensity

(

)

const

Definition at line 91 of file ParticleLayout.cpp.

{
    double iff_density = m_interparticle ? m_interparticle->particleDensity() : 0.0;
    return iff_density > 0.0 ? iff_density : m_total_particle_density;
}

References m_interparticle, and m_total_particle_density.

Referenced by clone(), ExemplarySamples::createAveragedSlicedCylinders(), and weightedParticleSurfaceDensity().

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 32 of file ICloneable.h.

weight()

double ParticleLayout::weight ( ) const

inline

Returns the relative weight of this layout.

Definition at line 56 of file ParticleLayout.h.

{ return m_weight; }

References m_weight.

Referenced by clone(), setWeight(), and weightedParticleSurfaceDensity().

weightedParticleSurfaceDensity()

double ParticleLayout::weightedParticleSurfaceDensity

(

)

const

Definition at line 97 of file ParticleLayout.cpp.

{
    return weight() * totalParticleSurfaceDensity();
}

References totalParticleSurfaceDensity(), and weight().

Here is the call graph for this function:

Member Data Documentation

m_interparticle

std::unique_ptr<IInterference> ParticleLayout::m_interparticle

private

Definition at line 70 of file ParticleLayout.h.

Referenced by clone(), interferenceFunction(), nodeChildren(), setAndRegisterInterference(), and totalParticleSurfaceDensity().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_particles

OwningVector<IParticle> ParticleLayout::m_particles

private

Vector of particle types.

Definition at line 69 of file ParticleLayout.h.

Referenced by addAndRegisterAbstractParticle(), clone(), nodeChildren(), particles(), and totalAbundance().

m_total_particle_density

double ParticleLayout::m_total_particle_density {.01}

private

Definition at line 68 of file ParticleLayout.h.

Referenced by setTotalParticleSurfaceDensity(), and totalParticleSurfaceDensity().

m_weight

double ParticleLayout::m_weight {1}

private

Definition at line 67 of file ParticleLayout.h.

Referenced by setWeight(), and weight().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Aggregate/ParticleLayout.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Aggregate/ParticleLayout.cpp