ParticleLayoutItem Class Reference

Description

Definition at line 28 of file ParticleLayoutItem.h.

Collaboration diagram for ParticleLayoutItem:

Public Member Functions
	ParticleLayoutItem (const MaterialItems *materials)
void	addParticle (ItemWithParticles *particle)
QVector< ItemWithParticles * >	containedItemsWithParticles () const
	Return full hierarchical contained items with particles. More...
SelectionDescriptor< InterferenceItem * >	interference () const
DoubleDescriptor	ownDensity () const
	The density value which belonging only to the layout. More...
QVector< ItemWithParticles * >	particles () const
	The particles this layout contains. More...
void	removeInterference ()
void	removeParticle (ItemWithParticles *particle)
void	serialize (Streamer &s)
void	setInterference (InterferenceItem *interference)
DoubleDescriptor	totalDensity () const
	The real density. More...
bool	totalDensityIsDefinedByInterference () const
	Returns whether total density is defined by the currently selected interference. More...
double	totalDensityValue () const
DoubleDescriptor	weight () const

Private Attributes
SelectionProperty< InterferenceItem * >	m_interference
const MaterialItems *	m_materials
DoubleProperty	m_ownDensity
QVector< ItemWithParticles * >	m_particles
DoubleProperty	m_weight

Constructor & Destructor Documentation

ParticleLayoutItem()

ParticleLayoutItem::ParticleLayoutItem

(

const MaterialItems *

materials

)

Definition at line 25 of file ParticleLayoutItem.cpp.

    : m_materials(materials)
{
    m_ownDensity.init("Total particle density",
                      "Number of particles per area (particle surface density).\n "
                      "Should be defined for disordered and 1d-ordered particle collections.",
                      0.01, Unit::nanometerMinus2, 10, RealLimits::nonnegative(), "density");
    m_weight.init("Weight",
                  "Weight of this particle layout.\nShould be used when multiple layouts define "
                  "different domains in the sample.",
                  1.0, Unit::unitless, "weight");
 
    m_interference.init<InterferenceItemCatalog>("Interference function", "", "interference");
}

References SelectionProperty< T >::init(), DoubleProperty::init(), m_interference, m_ownDensity, m_weight, nanometerMinus2, and unitless.

Here is the call graph for this function:

Member Function Documentation

addParticle()

void ParticleLayoutItem::addParticle

(

ItemWithParticles *

particle

)

Definition at line 93 of file ParticleLayoutItem.cpp.

{
    m_particles << particle;
}

References m_particles.

Referenced by SampleEditorController::addParticle(), and GUI::Transform::FromCore::itemizeSample().

containedItemsWithParticles()

QVector< ItemWithParticles * > ParticleLayoutItem::containedItemsWithParticles

(

)

const

Return full hierarchical contained items with particles.

See also

particles()

Definition at line 104 of file ParticleLayoutItem.cpp.

{
    QVector<ItemWithParticles*> result;
    for (auto* p : m_particles)
        result << p << p->containedItemsWithParticles();
    return result;
}

References m_particles.

Referenced by LayerItem::itemsWithParticles().

interference()

SelectionDescriptor< InterferenceItem * > ParticleLayoutItem::interference

(

)

const

Definition at line 112 of file ParticleLayoutItem.cpp.

{
    return m_interference;
}

References m_interference.

Referenced by InterferenceForm::InterferenceForm(), ParameterTreeBuilder::addInterference(), InterferenceForm::createInterferenceWidgets(), SampleEditorController::selectInterference(), and setInterference().

ownDensity()

DoubleDescriptor ParticleLayoutItem::ownDensity

(

)

const

The density value which belonging only to the layout.

This is the editable value. If an interference is present, this value may not be the one to be used for building the domain layout or to be presented. For the correct value-to-use, whether an interference is present or not, use totalDensity().

Definition at line 40 of file ParticleLayoutItem.cpp.

{
    return m_ownDensity;
}

References m_ownDensity.

Referenced by GUI::Transform::FromCore::itemizeSample(), and totalDensity().

particles()

QVector< ItemWithParticles * > ParticleLayoutItem::particles

(

)

const

The particles this layout contains.

Note that this is not a hierarchical search! Only the topmost particles are returned, not their contained particles. For a hierarchical search use containedItemsWithParticles

Definition at line 88 of file ParticleLayoutItem.cpp.

{
    return m_particles;
}

References m_particles.

Referenced by ParticleLayoutForm::ParticleLayoutForm(), GUI::RealSpace::BuilderUtils::computeCumulativeAbundances(), ParticleLayoutForm::onAboutToRemoveParticle(), ParticleLayoutForm::onParticleAdded(), GUI::RealSpace::BuilderUtils::particle3DContainerVector(), and RealSpaceBuilder::populateLayout().

removeInterference()

void ParticleLayoutItem::removeInterference

(

)

Definition at line 122 of file ParticleLayoutItem.cpp.

{
    m_interference.set(nullptr);
}

References m_interference, and SelectionProperty< T >::set().

Here is the call graph for this function:

removeParticle()

void ParticleLayoutItem::removeParticle

(

ItemWithParticles *

particle

)

Definition at line 98 of file ParticleLayoutItem.cpp.

{
    m_particles.removeAll(particle);
    delete particle;
}

References m_particles.

serialize()

void ParticleLayoutItem::serialize

(

Streamer &

s

)

Definition at line 133 of file ParticleLayoutItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_ownDensity);
    Serialize::rwProperty(s, m_weight);
    Serialize::rwSelected<InterferenceItemCatalog>(s, m_interference);
    Serialize::rwCatalogized<ItemWithParticlesCatalog>(s, "Particles", m_particles, m_materials);
}

References Streamer::assertVersion(), m_interference, m_materials, m_ownDensity, m_particles, m_weight, and Serialize::rwProperty().

Here is the call graph for this function:

setInterference()

void ParticleLayoutItem::setInterference

(

InterferenceItem *

interference

)

Definition at line 117 of file ParticleLayoutItem.cpp.

{
    m_interference.set(interference);
}

References interference(), m_interference, and SelectionProperty< T >::set().

Here is the call graph for this function:

totalDensity()

DoubleDescriptor ParticleLayoutItem::totalDensity

(

)

const

The real density.

Returns ownDensity() if the interference is not influencing the density. If the interference is defining the density, this is the interference-calculated density.

Definition at line 45 of file ParticleLayoutItem.cpp.

{
    // create descriptor with same value as own density, then change the getter and setter
    DoubleDescriptor d = ownDensity();
    d.set = [=](double d) {
        if (!totalDensityIsDefinedByInterference())
            const_cast<DoubleProperty*>(&m_ownDensity)->set(d);
    };
    d.get = [=]() { return totalDensityValue(); };
    d.path = [=]() { return m_ownDensity.uid() + "/totalDensity"; };
    return d;
}

References DoubleDescriptor::get, m_ownDensity, ownDensity(), DoubleDescriptor::path, DoubleDescriptor::set, DoubleProperty::set(), totalDensityIsDefinedByInterference(), totalDensityValue(), and DoubleProperty::uid().

Referenced by ParticleLayoutForm::ParticleLayoutForm(), and RealSpaceBuilder::populateLayout().

Here is the call graph for this function:

totalDensityIsDefinedByInterference()

bool ParticleLayoutItem::totalDensityIsDefinedByInterference

(

)

const

Returns whether total density is defined by the currently selected interference.

Two dimensional interference calculates density automatically; in these cases the "own" total density value should not be edited but set by the one from the interference.

Definition at line 127 of file ParticleLayoutItem.cpp.

{
    return dynamic_cast<const Interference2DAbstractLatticeItem*>(m_interference.get())
           || dynamic_cast<const InterferenceHardDiskItem*>(m_interference.get());
}

References SelectionProperty< T >::get(), and m_interference.

Referenced by totalDensity(), totalDensityValue(), and ParticleLayoutForm::updateDensityEnabling().

Here is the call graph for this function:

totalDensityValue()

double ParticleLayoutItem::totalDensityValue

(

)

const

Definition at line 58 of file ParticleLayoutItem.cpp.

{
    if (!totalDensityIsDefinedByInterference())
        return m_ownDensity;
 
    ASSERT(m_interference.get());
 
    if (const auto* interLatticeItem =
            dynamic_cast<const Interference2DAbstractLatticeItem*>(m_interference.get())) {
        Lattice2DItem* latticeItem = interLatticeItem->latticeType().currentItem();
        try {
            const double area = latticeItem->unitCellArea();
            return area == 0.0 ? 0.0 : 1.0 / area;
        } catch (const std::exception&) {
            // nothing to do here; new exception will be caught during job execution
            return 0.0;
        }
    }
 
    if (const auto* hd = dynamic_cast<const InterferenceHardDiskItem*>(m_interference.get()))
        return hd->density();
 
    ASSERT(false);
}

References SelectionProperty< T >::get(), m_interference, m_ownDensity, totalDensityIsDefinedByInterference(), and Lattice2DItem::unitCellArea().

Referenced by totalDensity().

Here is the call graph for this function:

weight()

DoubleDescriptor ParticleLayoutItem::weight

(

)

const

Definition at line 83 of file ParticleLayoutItem.cpp.

{
    return m_weight;
}

References m_weight.

Referenced by ParticleLayoutForm::ParticleLayoutForm(), and GUI::Transform::FromCore::itemizeSample().

Member Data Documentation

m_interference

SelectionProperty<InterferenceItem*> ParticleLayoutItem::m_interference

private

Definition at line 75 of file ParticleLayoutItem.h.

Referenced by ParticleLayoutItem(), interference(), removeInterference(), serialize(), setInterference(), totalDensityIsDefinedByInterference(), and totalDensityValue().

m_materials

const MaterialItems* ParticleLayoutItem::m_materials

private

Definition at line 77 of file ParticleLayoutItem.h.

Referenced by serialize().

m_ownDensity

DoubleProperty ParticleLayoutItem::m_ownDensity

private

Definition at line 73 of file ParticleLayoutItem.h.

Referenced by ParticleLayoutItem(), ownDensity(), serialize(), totalDensity(), and totalDensityValue().

m_particles

QVector<ItemWithParticles*> ParticleLayoutItem::m_particles

private

Definition at line 76 of file ParticleLayoutItem.h.

Referenced by addParticle(), containedItemsWithParticles(), particles(), removeParticle(), and serialize().

m_weight

DoubleProperty ParticleLayoutItem::m_weight

private

Definition at line 74 of file ParticleLayoutItem.h.

Referenced by ParticleLayoutItem(), serialize(), and weight().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ParticleLayoutItem.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ParticleLayoutItem.cpp