ReCompound Class Reference

Description

A reprocessed ParticleComposition.

Definition at line 29 of file ReCompound.h.

Inheritance diagram for ReCompound:

Collaboration diagram for ReCompound:

Public Member Functions
	ReCompound ()=default
	~ReCompound () override
void	addFormFactor (const IReParticle &formfactor)
double	bottomZ (const IRotation *rotation) const override
	Returns the z-coordinate of the lowest point in this shape after a given rotation. More...
ReCompound *	clone () const override
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...
void	setAmbientMaterial (const Material &material) override
	Passes the material in which this particle is embedded. More...
complex_t	theFF (const WavevectorInfo &wavevectors) const override
	Returns scattering amplitude for complex wavevectors ki, kf. More...
SpinMatrix	thePolFF (const WavevectorInfo &wavevectors) const override
	Calculates and returns a polarized form factor calculation in DWBA. More...
double	topZ (const IRotation *rotation) const override
	Returns the z-coordinate of the lowest point in this shape after a given rotation. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual double	volume () const
	Returns the total volume of the particle of this form factor's shape. More...

Protected Attributes
std::vector< IReParticle * >	m_components

Constructor & Destructor Documentation

ReCompound()

ReCompound::ReCompound ( )

default

Referenced by clone().

~ReCompound()

ReCompound::~ReCompound ( )

override

Definition at line 19 of file ReCompound.cpp.

{
    for (size_t index = 0; index < m_components.size(); ++index)
        delete m_components[index];
}

References m_components.

Member Function Documentation

addFormFactor()

void ReCompound::addFormFactor

(

const IReParticle &

formfactor

)

Definition at line 60 of file ReCompound.cpp.

{
    m_components.push_back(formfactor.clone());
}

References IReParticle::clone(), and m_components.

Here is the call graph for this function:

bottomZ()

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

overridevirtual

Returns the z-coordinate of the lowest point in this shape after a given rotation.

Implements IReParticle.

Definition at line 41 of file ReCompound.cpp.

{
    if (m_components.empty())
        throw std::runtime_error("ReCompound::bottomZ() -> Error: "
                                 "'this' contains no form factors.");
    return BaseUtils::algo::min_value(
        m_components.begin(), m_components.end(),
        [&rotation](IReParticle* ff) { return ff->bottomZ(rotation); });
}

References m_components, and BaseUtils::algo::min_value().

Here is the call graph for this function:

clone()

ReCompound * ReCompound::clone ( ) const

overridevirtual

Implements IReParticle.

Definition at line 25 of file ReCompound.cpp.

{
    auto* result = new ReCompound();
    for (size_t index = 0; index < m_components.size(); ++index)
        result->addFormFactor(*m_components[index]);
    return result;
}

References ReCompound(), and m_components.

Here is the call graph for this function:

radialExtension()

double ReCompound::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 IReParticle.

Definition at line 33 of file ReCompound.cpp.

{
    double result{0.0};
    for (size_t index = 0; index < m_components.size(); ++index)
        result += m_components[index]->radialExtension();
    return result;
}

References m_components.

setAmbientMaterial()

void ReCompound::setAmbientMaterial ( const Material &  )

overridevirtual

Passes the material in which this particle is embedded.

Reimplemented from IReParticle.

Definition at line 65 of file ReCompound.cpp.

{
    for (size_t index = 0; index < m_components.size(); ++index)
        m_components[index]->setAmbientMaterial(material);
}

References m_components.

theFF()

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

overridevirtual

Returns scattering amplitude for complex wavevectors ki, kf.

Implements IReParticle.

Definition at line 71 of file ReCompound.cpp.

{
    complex_t result(0.0, 0.0);
    for (size_t index = 0; index < m_components.size(); ++index)
        result += m_components[index]->theFF(wavevectors);
    return result;
}

References m_components.

thePolFF()

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

overridevirtual

Calculates and returns a polarized form factor calculation in DWBA.

Reimplemented from IReParticle.

Definition at line 79 of file ReCompound.cpp.

{
    SpinMatrix result;
    for (size_t index = 0; index < m_components.size(); ++index)
        result += m_components[index]->thePolFF(wavevectors);
    return result;
}

References m_components.

topZ()

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

overridevirtual

Returns the z-coordinate of the lowest point in this shape after a given rotation.

Implements IReParticle.

Definition at line 51 of file ReCompound.cpp.

{
    if (m_components.empty())
        throw std::runtime_error("ReCompound::topZ() -> Error: "
                                 "'this' contains no form factors.");
    return BaseUtils::algo::max_value(m_components.begin(), m_components.end(),
                                      [&rotation](IReParticle* ff) { return ff->topZ(rotation); });
}

References m_components, and BaseUtils::algo::max_value().

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

virtualinherited

Returns the total volume of the particle of this form factor's shape.

Reimplemented in ReParticle, and ReMesocrystal.

Definition at line 26 of file IReParticle.cpp.

{
    auto zero_wavevectors = WavevectorInfo::makeZeroQ();
    return std::abs(theFF(zero_wavevectors));
}

References WavevectorInfo::makeZeroQ(), and IReParticle::theFF().

Here is the call graph for this function:

Member Data Documentation

m_components

std::vector<IReParticle*> ReCompound::m_components

protected

Definition at line 52 of file ReCompound.h.

Referenced by ~ReCompound(), addFormFactor(), bottomZ(), clone(), radialExtension(), setAmbientMaterial(), theFF(), thePolFF(), and topZ().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Particle/ReCompound.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Particle/ReCompound.cpp