IParticle Class Reference

Description

Abstract base class for Particle, ParticleComposition, ParticleCoreShell, MesoCrystal. Provides position/rotation and form factor. Abundance is inherited from IParticle.

Definition at line 31 of file IParticle.h.

Inheritance diagram for IParticle:

Collaboration diagram for IParticle:

Public Member Functions
	~IParticle () override
double	abundance () const
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
virtual std::string	className () const =0
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
IParticle *	clone () const override=0
	Returns a clone of this ISampleNode object. More...
std::vector< const Material * >	containedMaterials () const
	Returns set of unique materials contained in this ISampleNode. More...
virtual std::vector< std::unique_ptr< IParticle > >	decompose () const
	Decompose in constituent IParticle objects. More...
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...
virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
R3	particlePosition () const
	Returns particle position. More...
IParticle *	rotate (const IRotation &rotation)
	Rotates the particle, and returns this. More...
const IRotation *	rotation () const
	Returns rotation object. More...
void	setAbundance (double abundance)
	Sets particle abundance. More...
void	setParticlePosition (double x, double y, double z)
	Sets relative position of the particle's reference point in the coordinate system of parent. More...
void	setParticlePosition (R3 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...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
IParticle *	translate (R3 translation)
	Translates the particle, and returns this. More...

Protected Attributes
double	m_abundance {1.0}
std::vector< double >	m_P
R3	m_position
std::unique_ptr< IRotation >	m_rotation

Constructor & Destructor Documentation

~IParticle()

IParticle::~IParticle ( )

overridedefault

Member Function Documentation

abundance()

double IParticle::abundance ( ) const

inline

Definition at line 38 of file IParticle.h.

{ return m_abundance; }

References m_abundance.

Referenced by SampleToPython::defineParticleLayouts(), and setAbundance().

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

virtual std::string INode::className ( ) const

pure virtualinherited

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

Implemented in Particle, SphericalDetector, SpecularSimulation, ScatteringSimulation, OffspecSimulation, DepthProbeSimulation, PoissonBackground, ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, IdentityRotation, ParticleCoreShell, ParticleComposition, MesoCrystal, Crystal, MultiLayer, Layer, Lattice3D, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, LayerInterface, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceNone, InterferenceHardDisk, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, ConvolutionDetectorResolution, PolFilter, RectangularDetector, FootprintSquare, FootprintGauss, and Beam.

Referenced by INode::checkNodeArgs(), ExemplarySamples::createBasic2DParaCrystalWithFTDis(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), and IFormFactor::shapeName().

clone()

IParticle* IParticle::clone ( ) const

overridepure virtual

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Implemented in ParticleCoreShell, ParticleComposition, Particle, and MesoCrystal.

Referenced by ParticleComposition::addParticle(), ParticleLayout::addParticle(), decompose(), and ParticleComposition::decompose().

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:

decompose()

std::vector< std::unique_ptr< IParticle > > IParticle::decompose ( ) const

virtual

Decompose in constituent IParticle objects.

Reimplemented in ParticleComposition.

Definition at line 52 of file IParticle.cpp.

{
    std::vector<std::unique_ptr<IParticle>> result;
    result.emplace_back(this->clone());
    return result;
}

References clone().

Referenced by Compute::Slicing::createParticleInSlice().

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 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 * > IParticle::nodeChildren ( ) const

overridevirtual

Returns all children.

Reimplemented from INode.

Reimplemented in ParticleCoreShell, ParticleComposition, Particle, and MesoCrystal.

Definition at line 20 of file IParticle.cpp.

{
    return std::vector<const INode*>() << m_rotation;
}

References m_rotation.

Referenced by MesoCrystal::nodeChildren(), Particle::nodeChildren(), ParticleComposition::nodeChildren(), and ParticleCoreShell::nodeChildren().

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

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

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

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

{ return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

particlePosition()

R3 IParticle::particlePosition ( ) const

inline

Returns particle position.

Definition at line 46 of file IParticle.h.

{ return m_position; }

References m_position.

Referenced by ParticleComposition::decompose().

rotate()

IParticle * IParticle::rotate

(

const IRotation &

rotation

)

Rotates the particle, and returns this.

Definition at line 41 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);
    return this;
}

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

Referenced by ExemplarySamples::createBoxCompositionRotateZandY(), ExemplarySamples::createCoreShellBoxRotateZandY(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createLayersWithAbsorptionWithFF(), ExemplarySamples::createMagneticRotation(), ExemplarySamples::createRotatedPyramids(), ExemplarySamples::createTransformBox(), and ParticleComposition::decompose().

Here is the call graph for this function:

rotation()

const IRotation * IParticle::rotation

(

)

const

Returns rotation object.

Definition at line 31 of file IParticle.cpp.

{
    return m_rotation.get();
}

References m_rotation.

Referenced by Particle::Particle(), ParticleComposition::decompose(), rotate(), and setRotation().

setAbundance()

void IParticle::setAbundance ( double  abundance )

inline

Sets particle abundance.

Parameters

abundance

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

Definition at line 43 of file IParticle.h.

{ m_abundance = abundance; }

References abundance(), and m_abundance.

Referenced by ParticleLayout::addParticle().

Here is the call graph for this function:

setParticlePosition() [1/2]

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

inline

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 58 of file IParticle.h.

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

References m_position.

setParticlePosition() [2/2]

void IParticle::setParticlePosition ( R3  position )

inline

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 51 of file IParticle.h.

{ m_position = position; }

References m_position.

Referenced by ExemplarySamples::createBoxCompositionRotateX(), ExemplarySamples::createBoxCompositionRotateY(), ExemplarySamples::createBoxCompositionRotateZ(), ExemplarySamples::createBoxCompositionRotateZandY(), ExemplarySamples::createBoxStackComposition(), ExemplarySamples::createCoreShellBoxRotateZandY(), ExemplarySamples::createCustomMorphology(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createLayersWithAbsorptionWithFF(), ExemplarySamples::createRotatedSquareLattice2D(), ExemplarySamples::createSlicedComposition(), and ExemplarySamples::createTransformBox().

setRotation()

void IParticle::setRotation

(

const IRotation &

rotation

)

Sets transformation.

Definition at line 36 of file IParticle.cpp.

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

References IRotation::clone(), m_rotation, and rotation().

Referenced by Particle::Particle(), ExemplarySamples::createBoxCompositionRotateX(), ExemplarySamples::createBoxCompositionRotateY(), ExemplarySamples::createBoxCompositionRotateZ(), ExemplarySamples::createBoxCompositionRotateZandY(), ExemplarySamples::createBoxStackComposition(), ExemplarySamples::createCoreShellBoxRotateZandY(), ExemplarySamples::createLayersWithAbsorptionBySLD(), ExemplarySamples::createLayersWithAbsorptionWithFF(), ExemplarySamples::createSlicedComposition(), and ExemplarySamples::createTransformBox().

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

translate()

IParticle * IParticle::translate

(

R3

translation

)

Translates the particle, and returns this.

Definition at line 25 of file IParticle.cpp.

{
    m_position += translation;
    return this;
}

References m_position.

Referenced by ParticleComposition::addParticle(), ExemplarySamples::createMagneticRotation(), ExemplarySamples::createMagneticSpheres(), ExemplarySamples::createMagneticSubstrateZeroField(), ExemplarySamples::createSuperLattice(), and ParticleComposition::decompose().

Member Data Documentation

m_abundance

double IParticle::m_abundance {1.0}

protected

Definition at line 78 of file IParticle.h.

Referenced by abundance(), MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), and setAbundance().

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_position

R3 IParticle::m_position

protected

Definition at line 79 of file IParticle.h.

Referenced by MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), particlePosition(), rotate(), setParticlePosition(), and translate().

m_rotation

std::unique_ptr<IRotation> IParticle::m_rotation

protected

Definition at line 80 of file IParticle.h.

Referenced by MesoCrystal::clone(), Particle::clone(), ParticleComposition::clone(), ParticleCoreShell::clone(), nodeChildren(), rotate(), rotation(), and setRotation().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Particle/IParticle.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Particle/IParticle.cpp