Pyramid4 Class Reference

Description

A frustum with a quadratic base.

Definition at line 23 of file Pyramid4.h.

Inheritance diagram for Pyramid4:

Collaboration diagram for Pyramid4:

Public Member Functions
	Pyramid4 (double base_edge, double height, double alpha)
	Pyramid4 (std::vector< double > P)
double	alpha () const
void	assert_platonic () const
	Assertions for Platonic solid. More...
double	baseEdge () const
double	bottomZ (const IRotation *rotation) const override
virtual bool	canSliceAnalytically (const IRotation *rot) const
	Default implementation only allows rotations along z-axis. 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...
Pyramid4 *	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...
double	height () 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...
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...
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...
double	volume () const override

Protected Member Functions
void	setPolyhedron (const ff::PolyhedralTopology &topology, double z_bottom, const std::vector< R3 > &vertices)
	Called by child classes to set faces and other internal variables. 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
const double &	m_alpha
const double &	m_base_edge
const double &	m_height
std::vector< R3 >	m_vertices
double	m_z_bottom
	for topZ, bottomZ computation only More...
std::unique_ptr< ff::Polyhedron >	pimpl

Static Private Attributes
static const ff::PolyhedralTopology	topology

Constructor & Destructor Documentation

Pyramid4() [1/2]

Pyramid4::Pyramid4	(	double	base_edge,
		double	height,
		double	alpha
	)

Definition at line 68 of file Pyramid4.cpp.

    : Pyramid4(std::vector<double>{base_edge, height, alpha})
{
}

References alpha(), and height().

Referenced by clone().

Here is the call graph for this function:

Pyramid4() [2/2]

Pyramid4::Pyramid4

(

std::vector< double >

P

)

Definition at line 29 of file Pyramid4.cpp.

    : IFormFactorPolyhedron(P)
    , m_base_edge(m_P[0])
    , m_height(m_P[1])
    , m_alpha(m_P[2])
{
    checkNodeArgs();
    double cot_alpha = Math::cot(m_alpha);
    if (!std::isfinite(cot_alpha))
        throw std::runtime_error("pyramid angle alpha out of bounds");
    double r = cot_alpha * 2 * m_height / m_base_edge; // [L(base)-L(top)]/L(base)
    if (r > 1) {
        std::ostringstream ostr;
        ostr << "Pyramid4() -> Error in class initialization with parameters";
        ostr << " base_edge:" << m_base_edge;
        ostr << " height:" << m_height;
        ostr << " alpha[rad]:" << m_alpha << "\n\n";
        ostr << "Check for 'height <= base_edge*tan(alpha)' failed.";
        throw std::runtime_error(ostr.str());
    }
 
    double a = m_base_edge / 2;
    double b = a * (1 - r);
 
    double zcom = m_height * (.5 - 2 * r / 3 + r * r / 4) / (1 - r + r * r / 3); // center of mass
 
    setPolyhedron(topology, -zcom,
                  {// base:
                   {-a, -a, -zcom},
                   {a, -a, -zcom},
                   {a, a, -zcom},
                   {-a, a, -zcom},
                   // top:
                   {-b, -b, m_height - zcom},
                   {b, -b, m_height - zcom},
                   {b, b, m_height - zcom},
                   {-b, b, m_height - zcom}});
}

References INode::checkNodeArgs(), Math::cot(), m_alpha, m_base_edge, m_height, IFormFactorPolyhedron::setPolyhedron(), and topology.

Here is the call graph for this function:

Member Function Documentation

alpha()

double Pyramid4::alpha ( ) const

inline

Definition at line 41 of file Pyramid4.h.

{ return m_alpha; }

References m_alpha.

Referenced by Pyramid4().

assert_platonic()

void IFormFactorPolyhedron::assert_platonic ( ) const

inherited

Assertions for Platonic solid.

Definition at line 79 of file IFormFactorPolyhedron.cpp.

{
    pimpl->assert_platonic();
}

References IFormFactorPolyhedron::pimpl.

Referenced by Dodecahedron::Dodecahedron(), Icosahedron::Icosahedron(), PlatonicOctahedron::PlatonicOctahedron(), and PlatonicTetrahedron::PlatonicTetrahedron().

baseEdge()

double Pyramid4::baseEdge ( ) const

inline

Definition at line 40 of file Pyramid4.h.

{ return m_base_edge; }

References m_base_edge.

bottomZ()

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

overridevirtualinherited

Reimplemented from IFormFactor.

Definition at line 53 of file IFormFactorPolyhedron.cpp.

{
    return PolyhedralUtil::BottomZ(m_vertices, rotation);
}

References PolyhedralUtil::BottomZ(), and IFormFactorPolyhedron::m_vertices.

Here is the call graph for this function:

canSliceAnalytically()

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

virtualinherited

Default implementation only allows rotations along z-axis.

Reimplemented in Sphere.

Definition at line 64 of file IFormFactor.cpp.

{
    return !rotation || rotation->zInvariant();
}

References IRotation::zInvariant().

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

{ return "Pyramid4"; }

clone()

Pyramid4* Pyramid4::clone ( ) const

inlineoverridevirtual

Returns a clone of this ISampleNode object.

Implements IFormFactor.

Definition at line 29 of file Pyramid4.h.

{ return new Pyramid4(m_base_edge, m_height, m_alpha); }

References Pyramid4(), m_alpha, m_base_edge, and m_height.

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 IFormFactorPolyhedron::formfactor_at_bottom ( C3  q ) const

overridevirtualinherited

Implements IFormFactor.

Definition at line 63 of file IFormFactorPolyhedron.cpp.

{
    return exp_I(-m_z_bottom * q.z()) * pimpl->formfactor(q);
}

References IFormFactorPolyhedron::m_z_bottom, and IFormFactorPolyhedron::pimpl.

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:

height()

double Pyramid4::height ( ) const

inline

Definition at line 39 of file Pyramid4.h.

{ return m_height; }

References m_height.

Referenced by Pyramid4().

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

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 32 of file Pyramid4.h.

    {
        return {{"BaseEdge", "nm", "base edge length", 0, +INF, 0},
                {"Height", "nm", "height", 0, +INF, 0},
                {"Alpha", "rad", "angle between base and a side face", 0., M_PI, 0}};
    }

References INF, and M_PI.

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 IFormFactorPolyhedron::radialExtension ( ) const

overridevirtualinherited

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 72 of file IFormFactorPolyhedron.cpp.

{
    return pimpl->radius();
}

References IFormFactorPolyhedron::pimpl.

setPolyhedron()

void IFormFactorPolyhedron::setPolyhedron ( const ff::PolyhedralTopology &  topology, double  z_bottom, const std::vector< R3 > &  vertices  )

protectedinherited

Called by child classes to set faces and other internal variables.

Definition at line 41 of file IFormFactorPolyhedron.cpp.

{
    m_z_bottom = z_bottom;
 
    m_vertices.clear();
    for (const R3& vertex : vertices)
        m_vertices.push_back(vertex - R3{0, 0, z_bottom});
 
    pimpl = std::make_unique<ff::Polyhedron>(topology, vertices);
}

References IFormFactorPolyhedron::m_vertices, IFormFactorPolyhedron::m_z_bottom, and IFormFactorPolyhedron::pimpl.

Referenced by Bipyramid4::Bipyramid4(), CantellatedCube::CantellatedCube(), Dodecahedron::Dodecahedron(), Icosahedron::Icosahedron(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4(), Pyramid6::Pyramid6(), and TruncatedCube::TruncatedCube().

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 IFormFactorPolyhedron::topZ ( const IRotation *  rotation ) const

overridevirtualinherited

Reimplemented from IFormFactor.

Definition at line 58 of file IFormFactorPolyhedron.cpp.

{
    return PolyhedralUtil::TopZ(m_vertices, rotation);
}

References IFormFactorPolyhedron::m_vertices, and PolyhedralUtil::TopZ().

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 IFormFactorPolyhedron::volume ( ) const

overridevirtualinherited

Reimplemented from IFormFactor.

Definition at line 68 of file IFormFactorPolyhedron.cpp.

{
    return pimpl->volume();
}

References IFormFactorPolyhedron::pimpl.

Member Data Documentation

m_alpha

const double& Pyramid4::m_alpha

private

Definition at line 48 of file Pyramid4.h.

Referenced by Pyramid4(), alpha(), and clone().

m_base_edge

const double& Pyramid4::m_base_edge

private

Definition at line 46 of file Pyramid4.h.

Referenced by Pyramid4(), baseEdge(), and clone().

m_height

const double& Pyramid4::m_height

private

Definition at line 47 of file Pyramid4.h.

Referenced by Pyramid4(), clone(), and height().

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

m_vertices

std::vector<R3> IFormFactorPolyhedron::m_vertices

privateinherited

Definition at line 54 of file IFormFactorPolyhedron.h.

Referenced by IFormFactorPolyhedron::bottomZ(), IFormFactorPolyhedron::setPolyhedron(), and IFormFactorPolyhedron::topZ().

m_z_bottom

double IFormFactorPolyhedron::m_z_bottom

privateinherited

for topZ, bottomZ computation only

Definition at line 55 of file IFormFactorPolyhedron.h.

Referenced by IFormFactorPolyhedron::formfactor_at_bottom(), and IFormFactorPolyhedron::setPolyhedron().

pimpl

std::unique_ptr<ff::Polyhedron> IFormFactorPolyhedron::pimpl

privateinherited

Definition at line 53 of file IFormFactorPolyhedron.h.

Referenced by IFormFactorPolyhedron::assert_platonic(), IFormFactorPolyhedron::formfactor_at_bottom(), IFormFactorPolyhedron::radialExtension(), IFormFactorPolyhedron::setPolyhedron(), and IFormFactorPolyhedron::volume().

topology

const ff::PolyhedralTopology Pyramid4::topology

staticprivate

Initial value:

= {{
                                                       {{3, 2, 1, 0}, true}, 
                                                       {{0, 1, 5, 4}, false},
                                                       {{1, 2, 6, 5}, false},
                                                       {{2, 3, 7, 6}, false},
                                                       {{3, 0, 4, 7}, false},
                                                       {{4, 5, 6, 7}, true} 
                                                   },
                                                   false}

Definition at line 44 of file Pyramid4.h.

Referenced by Pyramid4().

---

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

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