Sphere Class Reference

Description

A full sphere.

Definition at line 23 of file Sphere.h.

Inheritance diagram for Sphere:

Collaboration diagram for Sphere:

Public Member Functions
	Sphere (double radius, bool position_at_center=false)
	Sphere (std::vector< double > P, bool position_at_center=false)
double	bottomZ (const IRotation *rotation) const override
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...
Sphere *	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...
complex_t	formfactor_at_bottom (C3 q) const override
virtual SpinMatrix	formfactor_pol (C3 q) const
	Returns scattering amplitude for complex scattering wavevector q=k_i-k_f in case of matrix interactions. Default implementation calls formfactor_at_bottom(q) and multiplies with the unit matrix. 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...
virtual std::vector< const INode * >	nodeChildren () const
	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...
virtual std::string	pythonConstructor () const
	Creates the Python constructor of this class (or derived classes) More...
double	radialExtension () const override
	Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations. More...
double	radius () const
std::string	shapeName () const
virtual complex_t	theFF (const WavevectorInfo &wavevectors) const
virtual SpinMatrix	thePolFF (const WavevectorInfo &wavevectors) const
double	topZ (const IRotation *rotation) const override
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual double	volume () const

Protected Member Functions
bool	canSliceAnalytically (const IRotation *) const override
	Default implementation only allows rotations along z-axis. More...

Protected Attributes
std::vector< double >	m_P
std::unique_ptr< IShape3D >	m_shape3D
	IShape3D object, used to retrieve vertices (which may be approximate in the case of round shapes). For soft particles, this will be a hard mean shape. More...

Private Attributes
bool	m_position_at_center
const double &	m_radius

Constructor & Destructor Documentation

Sphere() [1/2]

Sphere::Sphere	(	double	radius,
		bool	position_at_center = false
	)

Definition at line 29 of file Sphere.cpp.

    : Sphere(std::vector<double>{radius}, position_at_center)
{
}

References radius().

Referenced by clone().

Here is the call graph for this function:

Sphere() [2/2]

Sphere::Sphere	(	std::vector< double >	P,
		bool	position_at_center = false
	)

Definition at line 21 of file Sphere.cpp.

    : IFormFactor(P)
    , m_radius(m_P[0])
    , m_position_at_center(position_at_center)
{
    checkNodeArgs();
}

References INode::checkNodeArgs().

Here is the call graph for this function:

Member Function Documentation

bottomZ()

double Sphere::bottomZ ( const IRotation *  rotation ) const

overridevirtual

Reimplemented from IFormFactor.

Definition at line 34 of file Sphere.cpp.

{
    if (m_position_at_center)
        return -m_radius;
    if (!rotation)
        return 0;
    R3 centre(0.0, 0.0, m_radius);
    R3 new_centre = rotation->transformed(centre);
    return new_centre.z() - m_radius;
}

References m_position_at_center, m_radius, and IRotation::transformed().

Here is the call graph for this function:

canSliceAnalytically()

bool Sphere::canSliceAnalytically ( const IRotation *  rot ) const

inlineoverrideprotectedvirtual

Default implementation only allows rotations along z-axis.

Reimplemented from IFormFactor.

Definition at line 45 of file Sphere.h.

{ return true; }

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(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string Sphere::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 30 of file Sphere.h.

{ return "Sphere"; }

clone()

Sphere* Sphere::clone ( ) const

inlineoverridevirtual

Returns a clone of this ISampleNode object.

Implements IFormFactor.

Definition at line 29 of file Sphere.h.

{ return new Sphere(m_radius, m_position_at_center); }

References Sphere(), m_position_at_center, and m_radius.

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:

formfactor_at_bottom()

complex_t Sphere::formfactor_at_bottom ( C3  q ) const

overridevirtual

Implements IFormFactor.

Definition at line 56 of file Sphere.cpp.

{
    complex_t result = SampleUtils::someff::ffSphere(q, m_radius);
    if (!m_position_at_center)
        result *= exp_I(q.z() * m_radius);
    return result;
}

References SampleUtils::someff::ffSphere(), m_position_at_center, and m_radius.

Here is the call graph for this function:

formfactor_pol()

SpinMatrix IFormFactor::formfactor_pol ( C3  q ) const

virtualinherited

Returns scattering amplitude for complex scattering wavevector q=k_i-k_f in case of matrix interactions. Default implementation calls formfactor_at_bottom(q) and multiplies with the unit matrix.

Definition at line 78 of file IFormFactor.cpp.

{
    return formfactor_at_bottom(q) * SpinMatrix::One();
}

References IFormFactor::formfactor_at_bottom(), and SpinMatrix::One().

Referenced by IFormFactor::thePolFF().

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

virtualinherited

Returns all children.

Reimplemented in ISimulation2D, ISimulation, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, IParticle, Crystal, MultiLayer, Layer, LayerInterface, ParticleLayout, InterferenceRadialParaCrystal, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, ConvolutionDetectorResolution, IDetector, and Beam.

Definition at line 56 of file INode.cpp.

{
    return {};
}

Referenced by NodeUtils::AllDescendantsOfType(), NodeUtils::ChildNodesOfType(), ISampleNode::containedMaterials(), and INode::nodeOffspring().

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> Sphere::parDefs ( ) const

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 32 of file Sphere.h.

{ return {{"Radius", "nm", "radius", 0, +INF, 0}}; }

References INF.

pythonConstructor()

std::string IFormFactor::pythonConstructor ( ) const

virtualinherited

Creates the Python constructor of this class (or derived classes)

Definition at line 69 of file IFormFactor.cpp.

{
    std::vector<std::pair<double, std::string>> arguments;
    for (size_t i = 0; i < parDefs().size(); i++)
        arguments.emplace_back(m_P[i], parDefs()[i].unit);
 
    return Py::Fmt::printFunction(className(), arguments);
}

References INode::className(), INode::m_P, INode::parDefs(), and Py::Fmt::printFunction().

Here is the call graph for this function:

radialExtension()

double Sphere::radialExtension ( ) const

inlineoverridevirtual

Returns the (approximate in some cases) radial size of the particle of this form factor's shape. This is used for SSCA calculations.

Implements IFormFactor.

Definition at line 36 of file Sphere.h.

{ return m_radius; }

References m_radius.

radius()

double Sphere::radius ( ) const

inline

Definition at line 34 of file Sphere.h.

{ return m_radius; }

References m_radius.

Referenced by Sphere().

shapeName()

std::string IFormFactor::shapeName ( ) const

inherited

Definition at line 33 of file IFormFactor.cpp.

{
    if (className().substr(0, 10) == "FormFactor")
        return className().substr(10);
    return className();
}

References INode::className().

Here is the call graph for this function:

theFF()

complex_t IFormFactor::theFF ( const WavevectorInfo &  wavevectors ) const

virtualinherited

Definition at line 40 of file IFormFactor.cpp.

{
    return formfactor_at_bottom(wavevectors.getQ());
}

References IFormFactor::formfactor_at_bottom(), and WavevectorInfo::getQ().

Here is the call graph for this function:

thePolFF()

SpinMatrix IFormFactor::thePolFF ( const WavevectorInfo &  wavevectors ) const

virtualinherited

Definition at line 45 of file IFormFactor.cpp.

{
    return formfactor_pol(wavevectors.getQ());
}

References IFormFactor::formfactor_pol(), and WavevectorInfo::getQ().

Here is the call graph for this function:

topZ()

double Sphere::topZ ( const IRotation *  rotation ) const

overridevirtual

Reimplemented from IFormFactor.

Definition at line 45 of file Sphere.cpp.

{
    if (m_position_at_center)
        return m_radius;
    if (!rotation)
        return 2 * m_radius;
    R3 centre(0.0, 0.0, m_radius);
    R3 new_centre = rotation->transformed(centre);
    return new_centre.z() + m_radius;
}

References m_position_at_center, m_radius, and IRotation::transformed().

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.

volume()

double IFormFactor::volume ( ) const

virtualinherited

Reimplemented in IFormFactorPrism, IFormFactorPolyhedron, and Box.

Definition at line 83 of file IFormFactor.cpp.

{
    return std::abs(formfactor_at_bottom(C3()));
}

References IFormFactor::formfactor_at_bottom().

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

Here is the call graph for this function:

Member Data Documentation

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_at_center

bool Sphere::m_position_at_center

private

Definition at line 49 of file Sphere.h.

Referenced by bottomZ(), clone(), formfactor_at_bottom(), and topZ().

m_radius

const double& Sphere::m_radius

private

Definition at line 48 of file Sphere.h.

Referenced by bottomZ(), clone(), formfactor_at_bottom(), radialExtension(), radius(), and topZ().

m_shape3D

std::unique_ptr<IShape3D> IFormFactor::m_shape3D

protectedinherited

IShape3D object, used to retrieve vertices (which may be approximate in the case of round shapes). For soft particles, this will be a hard mean shape.

Definition at line 74 of file IFormFactor.h.

Referenced by Cone::Cone(), Cylinder::Cylinder(), EllipsoidalCylinder::EllipsoidalCylinder(), FuzzySphere::FuzzySphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), ICosineRipple::ICosineRipple(), IProfileRectangularRipple::IProfileRectangularRipple(), ISawtoothRipple::ISawtoothRipple(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), Spheroid::Spheroid(), TruncatedSphere::TruncatedSphere(), TruncatedSpheroid::TruncatedSpheroid(), IFormFactor::bottomZ(), and IFormFactor::topZ().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/HardParticle/Sphere.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/HardParticle/Sphere.cpp