IFormFactorPrism Class Reference

Description

A prism with a polygonal base, for form factor computation.

Definition at line 31 of file IFormFactorPrism.h.

Inheritance diagram for IFormFactorPrism:

Collaboration diagram for IFormFactorPrism:

Public Member Functions
	IFormFactorPrism (const std::vector< double > &PValues)
	~IFormFactorPrism () override
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...
virtual std::string	className () const =0
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
IFormFactor *	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...
complex_t	formfactor_at_bottom (C3 q) const override
	Returns the form factor F(q) of this polyhedron, respecting the offset height/2. More...
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...
virtual double	height () const =0
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...
virtual std::vector< ParaMeta >	parDefs () const
	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
	Returns the volume of this prism. More...

Protected Member Functions
void	setPrism (bool symmetry_Ci, const std::vector< R3 > &vertices)

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
std::vector< R3 >	m_vertices
std::unique_ptr< ff::Prism >	pimpl

Constructor & Destructor Documentation

IFormFactorPrism()

IFormFactorPrism::IFormFactorPrism

(

const std::vector< double > &

PValues

)

Definition at line 19 of file IFormFactorPrism.cpp.

    : IFormFactor(PValues)
{
}

~IFormFactorPrism()

IFormFactorPrism::~IFormFactorPrism ( )

overridedefault

Member Function Documentation

bottomZ()

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

overridevirtual

Reimplemented from IFormFactor.

Definition at line 37 of file IFormFactorPrism.cpp.

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

References PolyhedralUtil::BottomZ(), and 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::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()

IFormFactor* IFormFactor::clone ( ) const

overridepure virtualinherited

Returns a clone of this ISampleNode object.

Implements ISampleNode.

Implemented in GaussSphere, FuzzySphere, 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, and BarGauss.

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

overridevirtual

Returns the form factor F(q) of this polyhedron, respecting the offset height/2.

Implements IFormFactor.

Definition at line 60 of file IFormFactorPrism.cpp.

{
    return exp_I(height() / 2 * q.z()) * pimpl->formfactor(q);
}

References height(), and pimpl.

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:

height()

virtual double IFormFactorPrism::height ( ) const

pure virtual

Implemented in Prism6, Prism3, and Box.

Referenced by formfactor_at_bottom(), setPrism(), and volume().

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

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

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

overridevirtual

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 53 of file IFormFactorPrism.cpp.

{
    return std::sqrt(pimpl->area());
}

References pimpl.

setPrism()

void IFormFactorPrism::setPrism ( bool  symmetry_Ci, const std::vector< R3 > &  vertices  )

protected

Definition at line 26 of file IFormFactorPrism.cpp.

{
    pimpl = std::make_unique<ff::Prism>(symmetry_Ci, height(), vertices);
 
    m_vertices.clear();
    for (const R3& vertex : vertices) {
        m_vertices.push_back(vertex);
        m_vertices.push_back(vertex + R3{0, 0, height()});
    }
}

References height(), m_vertices, and pimpl.

Referenced by Box::Box(), Prism3::Prism3(), and Prism6::Prism6().

Here is the call graph for this function:

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

overridevirtual

Reimplemented from IFormFactor.

Definition at line 42 of file IFormFactorPrism.cpp.

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

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

overridevirtual

Returns the volume of this prism.

Reimplemented from IFormFactor.

Definition at line 48 of file IFormFactorPrism.cpp.

{
    return height() * pimpl->area();
}

References height(), and pimpl.

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_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> IFormFactorPrism::m_vertices

private

Definition at line 53 of file IFormFactorPrism.h.

Referenced by bottomZ(), setPrism(), and topZ().

pimpl

std::unique_ptr<ff::Prism> IFormFactorPrism::pimpl

private

Definition at line 52 of file IFormFactorPrism.h.

Referenced by formfactor_at_bottom(), radialExtension(), setPrism(), and volume().

---

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

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