Description

The form factor for a cosine ripple, with Gaussian profile in elongation direction.

Definition at line 44 of file CosineRipple.h.

Inheritance diagram for CosineRippleGauss:

Collaboration diagram for CosineRippleGauss:

Public Member Functions
	CosineRippleGauss (double length, double width, double height)

	CosineRippleGauss (std::vector< double > P)

virtual double	bottomZ (const IRotation *rotation) const

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

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

double	length () const

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

virtual double	topZ (const IRotation *rotation) const

virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

virtual double	volume () const

double	width () const

Protected Attributes
const double &	m_height

const double &	m_length

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

const double &	m_width

Private Member Functions
complex_t	factor_x (complex_t qx) const override

complex_t	factor_yz (complex_t qy, complex_t qz) const override
	Complex form factor. More...

Constructor & Destructor Documentation

◆ CosineRippleGauss() [1/2]

CosineRippleGauss::CosineRippleGauss	(	double	length,
		double	width,
		double	height
	)

Definition at line 53 of file CosineRipple.cpp.

     : CosineRippleGauss(std::vector<double>{length, width, height})
 {
 }

References IProfileRipple::height(), IProfileRipple::length(), and IProfileRipple::width().

Referenced by clone().

Here is the call graph for this function:

◆ CosineRippleGauss() [2/2]

CosineRippleGauss::CosineRippleGauss ( std::vector< double > P )

Definition at line 47 of file CosineRipple.cpp.

     : ICosineRipple(P)
 {
     checkNodeArgs();
 }

References INode::checkNodeArgs().

Here is the call graph for this function:

Member Function Documentation

◆ bottomZ()

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

virtualinherited

Reimplemented in Sphere, IFormFactorPrism, and IFormFactorPolyhedron.

Definition at line 50 of file IFormFactor.cpp.

 {
     if (!m_shape3D)
         throw std::runtime_error("Bug: Form factor has no m_shape3D, cannot compute bottom z");
     return PolyhedralUtil::BottomZ(m_shape3D->vertices(), rotation);
 }

References PolyhedralUtil::BottomZ(), and IFormFactor::m_shape3D.

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(), 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 CosineRippleGauss::className ( ) const

inlinefinalvirtual

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

Implements INode.

Definition at line 50 of file CosineRipple.h.

50 { return "CosineRippleGauss"; }

◆ clone()

CosineRippleGauss * CosineRippleGauss::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements IFormFactor.

Definition at line 58 of file CosineRipple.cpp.

 {
     return new CosineRippleGauss(m_length, m_width, m_height);
 }

References CosineRippleGauss(), IProfileRipple::m_height, IProfileRipple::m_length, and IProfileRipple::m_width.

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:

◆ factor_x()

complex_t CosineRippleGauss::factor_x ( complex_t qx ) const

overrideprivatevirtual

Implements IProfileRipple.

Definition at line 63 of file CosineRipple.cpp.

 {
     return ripples::factor_x_Gauss(qx, m_length);
 }

References ripples::factor_x_Gauss(), and IProfileRipple::m_length.

Here is the call graph for this function:

◆ factor_yz()

complex_t ICosineRipple::factor_yz	(	complex_t	qy,
		complex_t	qz
	)		const

overrideprivatevirtualinherited

Complex form factor.

Implements IProfileRipple.

Definition at line 70 of file IProfileRipple.cpp.

 {
     return ripples::profile_yz_cosine(qy, qz, m_width, m_height);
 }

References IProfileRipple::m_height, IProfileRipple::m_width, and ripples::profile_yz_cosine().

Here is the call graph for this function:

◆ formfactor_at_bottom()

complex_t IProfileRipple::formfactor_at_bottom ( C3 q ) const

overridevirtualinherited

Implements IFormFactor.

Definition at line 38 of file IProfileRipple.cpp.

 {
     return factor_x(q.x()) * factor_yz(q.y(), q.z());
 }

References IProfileRipple::factor_x(), and IProfileRipple::factor_yz().

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

double IProfileRipple::height ( ) const

inlineinherited

Definition at line 28 of file IProfileRipple.h.

28 { return m_height; }

References IProfileRipple::m_height.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), and SawtoothRippleLorentz::SawtoothRippleLorentz().

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

◆ length()

double IProfileRipple::length ( ) const

inlineinherited

Definition at line 27 of file IProfileRipple.h.

27 { return m_length; }

References IProfileRipple::m_length.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), and SawtoothRippleLorentz::SawtoothRippleLorentz().

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

36 { 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> CosineRippleGauss::parDefs ( ) const

inlinefinalvirtual

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

Reimplemented from INode.

Definition at line 52 of file CosineRipple.h.

     {
         return {{"Length", "nm", "Characteristic length", 0, INF, 1.},
                 {"Width", "nm", "Width", 0, INF, 1.},
                 {"Height", "nm", "Height", 0, INF, 1.}};
     }

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 IProfileRipple::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 33 of file IProfileRipple.cpp.

 {
     return (m_width + m_length) / 4.0;
 }

References IProfileRipple::m_length, and IProfileRipple::m_width.

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

virtualinherited

Reimplemented in Sphere, IFormFactorPrism, and IFormFactorPolyhedron.

Definition at line 57 of file IFormFactor.cpp.

 {
     if (!m_shape3D)
         throw std::runtime_error("Bug: Form factor has no m_shape3D, cannot compute top z");
     return PolyhedralUtil::TopZ(m_shape3D->vertices(), rotation);
 }

References IFormFactor::m_shape3D, 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 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:

◆ width()

double IProfileRipple::width ( ) const

inlineinherited

Definition at line 29 of file IProfileRipple.h.

29 { return m_width; }

References IProfileRipple::m_width.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), and SawtoothRippleLorentz::SawtoothRippleLorentz().

Member Data Documentation

◆ m_height

const double& IProfileRipple::m_height

protectedinherited

Definition at line 38 of file IProfileRipple.h.

Referenced by ICosineRipple::ICosineRipple(), IProfileRectangularRipple::IProfileRectangularRipple(), ISawtoothRipple::ISawtoothRipple(), BarGauss::clone(), BarLorentz::clone(), CosineRippleBox::clone(), clone(), CosineRippleLorentz::clone(), SawtoothRippleBox::clone(), SawtoothRippleGauss::clone(), SawtoothRippleLorentz::clone(), IProfileRectangularRipple::factor_yz(), ICosineRipple::factor_yz(), ISawtoothRipple::factor_yz(), and IProfileRipple::height().

◆ m_length

const double& IProfileRipple::m_length

protectedinherited

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

const double& IProfileRipple::m_width

protectedinherited

Definition at line 37 of file IProfileRipple.h.

Referenced by ICosineRipple::ICosineRipple(), IProfileRectangularRipple::IProfileRectangularRipple(), ISawtoothRipple::ISawtoothRipple(), BarGauss::clone(), BarLorentz::clone(), CosineRippleBox::clone(), clone(), CosineRippleLorentz::clone(), SawtoothRippleBox::clone(), SawtoothRippleGauss::clone(), SawtoothRippleLorentz::clone(), IProfileRectangularRipple::factor_yz(), ICosineRipple::factor_yz(), ISawtoothRipple::factor_yz(), IProfileRipple::radialExtension(), and IProfileRipple::width().

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

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

Description

Public Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ CosineRippleGauss() [1/2]

◆ CosineRippleGauss() [2/2]

Member Function Documentation

◆ bottomZ()

◆ canSliceAnalytically()

◆ checkNodeArgs()

◆ className()

◆ clone()

◆ containedMaterials()

◆ factor_x()

◆ factor_yz()

◆ formfactor_at_bottom()

◆ formfactor_pol()

◆ height()

◆ isMagnetic()

◆ length()

◆ material()

◆ nodeChildren()

◆ nodeOffspring()

◆ parDefs()

◆ pythonConstructor()

◆ radialExtension()

◆ shapeName()

◆ theFF()

◆ thePolFF()

◆ topZ()

◆ transferToCPP()

◆ volume()

◆ width()

Member Data Documentation

◆ m_height

◆ m_length

◆ m_P

◆ m_shape3D

◆ m_width