ReParticle Class Reference

Description

A reprocessed simple particle, with shape m_ff.

Definition at line 33 of file ReParticle.h.

Inheritance diagram for ReParticle:

Collaboration diagram for ReParticle:

Public Member Functions
	ReParticle (const IFormFactor &ff)
	~ReParticle () override
double	bottomZ (const IRotation *rotation) const override
	Returns the z-coordinate of the lowest point in this shape after a given rotation. More...
ReParticle *	clone () const override
const IFormFactor *	formfactor_at_bottom () const
virtual complex_t	formfactor_at_bottom (C3 q) const
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 &ambient_material) override
	Sets the ambient material. More...
void	setMaterial (const Material &material)
	Sets the material of the scatterer. More...
void	setPosition (const R3 &position)
void	setRotMatrix (const RotMatrix &rotMatrix)
complex_t	theFF (const WavevectorInfo &wavevectors) const override
	Returns scattering amplitude for complex wavevectors ki, kf. More...
SpinMatrix	thePolFF (const WavevectorInfo &wavevectors) const override
	Returns scattering amplitude for matrix interactions. 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...
double	volume () const override
	Returns the total volume of the particle of this form factor's shape. More...

Static Public Member Functions
static ReParticle *	createTransformedFormFactor (const IFormFactor &formfactor, const IRotation *rot, R3 translation)

Protected Member Functions
	ReParticle (IFormFactor *ff, const Material *material, const Material *ambient_material, const R3 *position, const RotMatrix *rotMatrix)

Protected Attributes
std::unique_ptr< const Material >	m_ambient_material
std::unique_ptr< const IFormFactor >	m_ff
std::unique_ptr< const Material >	m_material
std::unique_ptr< const R3 >	m_position
std::unique_ptr< const RotMatrix >	m_rotMatrix

Constructor & Destructor Documentation

ReParticle() [1/2]

ReParticle::ReParticle

(

const IFormFactor &

ff

)

Definition at line 33 of file ReParticle.cpp.

    : ReParticle(ff.clone(), nullptr, nullptr, nullptr, nullptr)
{
}

Referenced by clone(), and createTransformedFormFactor().

~ReParticle()

ReParticle::~ReParticle ( )

overridedefault

ReParticle() [2/2]

ReParticle::ReParticle ( IFormFactor *  ff, const Material *  material, const Material *  ambient_material, const R3 *  position, const RotMatrix *  rotMatrix  )

protected

Definition at line 23 of file ReParticle.cpp.

    : m_ff(std::move(ff))
    , m_material(std::move(material))
    , m_ambient_material(std::move(ambient_material))
    , m_position(std::move(position))
    , m_rotMatrix(std::move(rotMatrix))
{
}

Member Function Documentation

bottomZ()

double ReParticle::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 134 of file ReParticle.cpp.

{
    RotMatrix transform = rotation ? rotation->rotMatrix() : RotMatrix();
    if (m_rotMatrix)
        transform = transform * *m_rotMatrix;
    std::unique_ptr<const IRotation> total_rotation(IRotation::createRotation(transform));
    double result = m_ff->bottomZ(total_rotation.get());
    if (m_position)
        result += (rotation ? rotation->transformed(*m_position) : *m_position).z();
    return result;
}

References IRotation::createRotation(), m_ff, m_position, m_rotMatrix, IRotation::rotMatrix(), and IRotation::transformed().

Referenced by ReMesocrystal::bottomZ().

Here is the call graph for this function:

clone()

ReParticle * ReParticle::clone ( ) const

overridevirtual

Implements IReParticle.

Definition at line 40 of file ReParticle.cpp.

{
    return new ReParticle(m_ff->clone(), m_material ? new Material(*m_material) : nullptr,
                          m_ambient_material ? new Material(*m_ambient_material) : nullptr,
                          m_position ? new R3(*m_position) : nullptr,
                          m_rotMatrix ? new RotMatrix(*m_rotMatrix) : nullptr);
}

References ReParticle(), m_ambient_material, m_ff, m_material, m_position, and m_rotMatrix.

Here is the call graph for this function:

createTransformedFormFactor()

ReParticle * ReParticle::createTransformedFormFactor ( const IFormFactor &  formfactor, const IRotation *  rot, R3  translation  )

static

Definition at line 49 of file ReParticle.cpp.

{
    auto* result = new ReParticle(formfactor);
    if (rot && !rot->isIdentity())
        result->setRotMatrix(rot->rotMatrix());
    if (translation != R3())
        result->setPosition(translation);
    return result;
}

References ReParticle(), IRotation::isIdentity(), and IRotation::rotMatrix().

Here is the call graph for this function:

formfactor_at_bottom() [1/2]

const IFormFactor * ReParticle::formfactor_at_bottom

(

)

const

Definition at line 90 of file ReParticle.cpp.

{
    return m_ff.get();
}

References m_ff.

formfactor_at_bottom() [2/2]

complex_t ReParticle::formfactor_at_bottom ( C3  q ) const

virtual

Definition at line 95 of file ReParticle.cpp.

{
    return m_ff->formfactor_at_bottom(q);
}

References m_ff.

radialExtension()

double ReParticle::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 85 of file ReParticle.cpp.

{
    return m_ff->radialExtension();
}

References m_ff.

Referenced by ReMesocrystal::radialExtension().

setAmbientMaterial()

void ReParticle::setAmbientMaterial ( const Material &  ambient_material )

overridevirtual

Sets the ambient material.

Reimplemented from IReParticle.

Definition at line 65 of file ReParticle.cpp.

{
    m_ambient_material = std::make_unique<Material>(ambient_material);
}

References m_ambient_material.

setMaterial()

void ReParticle::setMaterial

(

const Material &

material

)

Sets the material of the scatterer.

Definition at line 60 of file ReParticle.cpp.

{
    m_material = std::make_unique<Material>(material);
}

References m_material.

setPosition()

void ReParticle::setPosition

(

const R3 &

position

)

Definition at line 70 of file ReParticle.cpp.

{
    m_position = std::make_unique<R3>(position);
}

References m_position.

setRotMatrix()

void ReParticle::setRotMatrix

(

const RotMatrix &

rotMatrix

)

Definition at line 75 of file ReParticle.cpp.

{
    m_rotMatrix = std::make_unique<RotMatrix>(rotMatrix);
}

References m_rotMatrix.

theFF()

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

overridevirtual

Returns scattering amplitude for complex wavevectors ki, kf.

Implements IReParticle.

Definition at line 100 of file ReParticle.cpp.

{
    WavevectorInfo wavevectors2 =
        m_rotMatrix ? wavevectors.transformed(m_rotMatrix->Inverse()) : wavevectors;
    complex_t result = m_ff->theFF(wavevectors2);
    if (m_material && m_ambient_material)
        result = (m_material->scalarSubtrSLD(wavevectors2)
                  - m_ambient_material->scalarSubtrSLD(wavevectors2))
                 * result;
    if (m_position)
        result *= exp_I(m_position->dot(wavevectors.getQ()));
    return result;
}

References WavevectorInfo::getQ(), m_ambient_material, m_ff, m_material, m_position, m_rotMatrix, and WavevectorInfo::transformed().

Referenced by ReMesocrystal::theFF(), and ReMesocrystal::thePolFF().

Here is the call graph for this function:

thePolFF()

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

overridevirtual

Returns scattering amplitude for matrix interactions.

Reimplemented from IReParticle.

Definition at line 114 of file ReParticle.cpp.

{
    WavevectorInfo wavevectors2 =
        m_rotMatrix ? wavevectors.transformed(m_rotMatrix->Inverse()) : wavevectors;
    SpinMatrix result = m_ff->thePolFF(wavevectors2);
    if (m_material && m_ambient_material) {
        // the conjugated linear part of time reversal operator T
        // (T=UK with K complex conjugate operator and U is linear)
        SpinMatrix time_reverse_conj(0, 1, -1, 0);
        // the interaction and time reversal taken together:
        SpinMatrix V_eff = time_reverse_conj
                           * (m_material->polarizedSubtrSLD(wavevectors2)
                              - m_ambient_material->polarizedSubtrSLD(wavevectors2));
        result *= V_eff;
    }
    if (m_position)
        return result *= exp_I(m_position->dot(wavevectors.getQ()));
    return result;
}

References WavevectorInfo::getQ(), m_ambient_material, m_ff, m_material, m_position, m_rotMatrix, and WavevectorInfo::transformed().

Here is the call graph for this function:

topZ()

double ReParticle::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 146 of file ReParticle.cpp.

{
    RotMatrix transform = rotation ? rotation->rotMatrix() : RotMatrix();
    if (m_rotMatrix)
        transform = transform * *m_rotMatrix;
    std::unique_ptr<const IRotation> total_rotation(IRotation::createRotation(transform));
    double result = m_ff->topZ(total_rotation.get());
    if (m_position)
        result += (rotation ? rotation->transformed(*m_position) : *m_position).z();
    return result;
}

References IRotation::createRotation(), m_ff, m_position, m_rotMatrix, IRotation::rotMatrix(), and IRotation::transformed().

Referenced by ReMesocrystal::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 ReParticle::volume ( ) const

overridevirtual

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

Reimplemented from IReParticle.

Definition at line 80 of file ReParticle.cpp.

{
    return m_ff->volume();
}

References m_ff.

Referenced by ReMesocrystal::volume().

Member Data Documentation

m_ambient_material

std::unique_ptr<const Material> ReParticle::m_ambient_material

protected

Definition at line 75 of file ReParticle.h.

Referenced by clone(), setAmbientMaterial(), theFF(), and thePolFF().

m_ff

std::unique_ptr<const IFormFactor> ReParticle::m_ff

protected

Definition at line 68 of file ReParticle.h.

Referenced by bottomZ(), clone(), formfactor_at_bottom(), radialExtension(), theFF(), thePolFF(), topZ(), and volume().

m_material

std::unique_ptr<const Material> ReParticle::m_material

protected

Definition at line 74 of file ReParticle.h.

Referenced by clone(), setMaterial(), theFF(), and thePolFF().

m_position

std::unique_ptr<const R3> ReParticle::m_position

protected

Definition at line 76 of file ReParticle.h.

Referenced by bottomZ(), clone(), setPosition(), theFF(), thePolFF(), and topZ().

m_rotMatrix

std::unique_ptr<const RotMatrix> ReParticle::m_rotMatrix

protected

Definition at line 77 of file ReParticle.h.

Referenced by bottomZ(), clone(), setRotMatrix(), theFF(), thePolFF(), and topZ().

---

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

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