Description

A particle with a form factor and refractive index.

Definition at line 25 of file Particle.h.

Inheritance diagram for Particle:

Collaboration diagram for Particle:

Public Member Functions
	Particle (Material material, const IFormFactor &formfactor)

	Particle (Material material, const IFormFactor &formfactor, const IRotation &rotation)

	~Particle () override

double	abundance () const

void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...

std::string	className () const override
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...

Particle *	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...

virtual std::vector< std::unique_ptr< IParticle > >	decompose () const
	Decompose in constituent IParticle objects. More...

const IFormFactor *	formfactor_at_bottom () const

bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. More...

const Material *	material () const override
	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

Private Attributes
std::unique_ptr< const IFormFactor >	m_formfactor

const Material	m_material

Constructor & Destructor Documentation

◆ Particle() [1/2]

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

Definition at line 20 of file Particle.cpp.

     : m_material(std::move(material))
     , m_formfactor(formfactor.clone())
 {
 }

Referenced by clone().

◆ Particle() [2/2]

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

Definition at line 26 of file Particle.cpp.

     : Particle(material, formfactor)
 {
     setRotation(rotation);
 }

References IParticle::rotation(), and IParticle::setRotation().

Here is the call graph for this function:

◆ ~Particle()

Particle::~Particle ( )

overridedefault

Member Function Documentation

◆ abundance()

double IParticle::abundance ( ) const

inlineinherited

Definition at line 38 of file IParticle.h.

38 { return m_abundance; }

IParticle::m_abundance

double m_abundance

Definition: IParticle.h:78

References IParticle::m_abundance.

Referenced by SampleToPython::defineParticleLayouts(), and IParticle::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()

std::string Particle::className ( ) const

inlineoverridevirtual

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

Implements INode.

Definition at line 32 of file Particle.h.

32 { return "Particle"; }

◆ clone()

Particle * Particle::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements IParticle.

Definition at line 34 of file Particle.cpp.

 {
     ASSERT(m_formfactor);
     auto* p_result = new Particle(m_material, *m_formfactor);
     p_result->setAbundance(m_abundance);
     if (m_rotation)
         p_result->setRotation(*m_rotation);
     p_result->setParticlePosition(m_position);
  
     return p_result;
 }

References Particle(), ASSERT, IParticle::m_abundance, m_formfactor, m_material, IParticle::m_position, and IParticle::m_rotation.

Referenced by ParticleCoreShell::ParticleCoreShell(), and Compute::Slicing::createParticleInSlice().

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:

◆ decompose()

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

virtualinherited

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

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

Here is the call graph for this function:

◆ formfactor_at_bottom()

const IFormFactor* Particle::formfactor_at_bottom ( ) const

inline

Definition at line 37 of file Particle.h.

37 { return m_formfactor.get(); }

References m_formfactor.

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

const Material* Particle::material ( ) const

inlineoverridevirtual

Returns nullptr, unless overwritten to return a specific material.

Reimplemented from ISampleNode.

Definition at line 35 of file Particle.h.

35 { return &m_material; }

References m_material.

◆ nodeChildren()

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

overridevirtual

Returns all children.

Reimplemented from IParticle.

Definition at line 46 of file Particle.cpp.

 {
     return std::vector<const INode*>() << IParticle::nodeChildren() << m_formfactor;
 }

References m_formfactor, and IParticle::nodeChildren().

Here is the call graph for this function:

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

51 { return {}; }

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

◆ particlePosition()

R3 IParticle::particlePosition ( ) const

inlineinherited

Returns particle position.

Definition at line 46 of file IParticle.h.

46 { return m_position; }

References IParticle::m_position.

Referenced by ParticleComposition::decompose().

◆ rotate()

IParticle * IParticle::rotate ( const IRotation & rotation )

inherited

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(), IParticle::m_position, IParticle::m_rotation, IParticle::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

inherited

Returns rotation object.

Definition at line 31 of file IParticle.cpp.

 {
     return m_rotation.get();
 }

References IParticle::m_rotation.

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

◆ setAbundance()

void IParticle::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 43 of file IParticle.h.

43 { m_abundance = abundance; }

IParticle::abundance

double abundance() const

Definition: IParticle.h:38

References IParticle::abundance(), and IParticle::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
	)

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

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

References IParticle::m_position.

◆ setParticlePosition() [2/2]

void IParticle::setParticlePosition ( R3 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 51 of file IParticle.h.

51 { m_position = position; }

References IParticle::m_position.

◆ setRotation()

void IParticle::setRotation ( const IRotation & rotation )

inherited

Sets transformation.

Definition at line 36 of file IParticle.cpp.

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

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

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 )

inherited

Translates the particle, and returns this.

Definition at line 25 of file IParticle.cpp.

 {
     m_position += translation;
     return this;
 }

References IParticle::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}

protectedinherited

Definition at line 78 of file IParticle.h.

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

◆ m_formfactor

std::unique_ptr<const IFormFactor> Particle::m_formfactor

private

Definition at line 41 of file Particle.h.

Referenced by clone(), formfactor_at_bottom(), and nodeChildren().

◆ m_material

const Material Particle::m_material

private

Definition at line 40 of file Particle.h.

Referenced by clone(), and material().

◆ 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

protectedinherited

Definition at line 79 of file IParticle.h.

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

◆ m_rotation

std::unique_ptr<IRotation> IParticle::m_rotation

protectedinherited

Definition at line 80 of file IParticle.h.

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

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

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

Description

Public Member Functions

Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ Particle() [1/2]

◆ Particle() [2/2]

◆ ~Particle()

Member Function Documentation

◆ abundance()

◆ checkNodeArgs()

◆ className()

◆ clone()

◆ containedMaterials()

◆ decompose()

◆ formfactor_at_bottom()

◆ isMagnetic()

◆ material()

◆ nodeChildren()

◆ nodeOffspring()

◆ parDefs()

◆ particlePosition()

◆ rotate()

◆ rotation()

◆ setAbundance()

◆ setParticlePosition() [1/2]

◆ setParticlePosition() [2/2]

◆ setRotation()

◆ transferToCPP()

◆ translate()

Member Data Documentation

◆ m_abundance

◆ m_formfactor

◆ m_material

◆ m_P

◆ m_position

◆ m_rotation