File: MesocrystalItem.cpp

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (161 lines) | stat: -rw-r--r-- 6,211 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Sample/MesocrystalItem.cpp
//! @brief     Implements class MesocrystalItem.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2021
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#include "GUI/Model/Sample/MesocrystalItem.h"
#include "Base/Util/Vec.h"
#include "GUI/Model/Sample/CompoundItem.h"
#include "GUI/Model/Sample/CoreAndShellItem.h"
#include "GUI/Model/Sample/ParticleItem.h"
#include "Sample/Particle/Compound.h"
#include "Sample/Particle/CoreAndShell.h"
#include "Sample/Particle/Crystal.h"
#include "Sample/Particle/IFormfactor.h"
#include "Sample/Particle/Mesocrystal.h"
#include "Sample/Particle/Particle.h"
#include "Sample/Scattering/Rotations.h"

namespace {

namespace Tag {

const QString VectorA("VectorA");
const QString VectorB("VectorB");
const QString VectorC("VectorC");
const QString OuterShape("OuterShape");
const QString BasisParticle("BasisParticle");
const QString BaseData("BaseData");
const QString ExpandMesocrystalGroupbox("ExpandMesocrystalGroupbox");

} // namespace Tag

const QString abundance_tooltip = "Proportion of this type of mesocrystal normalized to the \n"
                                  "total number of particles in the layout";

const QString position_tooltip = "Relative position of the mesocrystal's reference point \n"
                                 "in the coordinate system of the parent (nm)";

} // namespace

MesocrystalItem::MesocrystalItem(const MaterialsSet* materials)
    : ItemWithParticles(abundance_tooltip, position_tooltip)
    , m_basis_particle(materials)
    , m_materials(materials)
{
    m_vectorA.init("First lattice vector", "nm", "Coordinates of the first lattice vector",
                   R3(5, 0, 0), 3, true, 0.01, RealLimits::limitless(), "vectorA");
    m_vectorB.init("Second lattice vector", "nm", "Coordinates of the second lattice vector",
                   R3(0, 5, 0), 3, true, 0.01, RealLimits::limitless(), "vectorB");
    m_vectorC.init("Third lattice vector", "nm", "Coordinates of the third lattice vector",
                   R3(0, 0, 5), 3, true, 0.01, RealLimits::limitless(), "vectorC");

    m_outer_shape.simpleInit("Outer Shape", "", FormfactorCatalog::Type::Box);
    m_basis_particle.simpleInit("Basis", "", ParticleCatalog::Type::Particle);
}

void MesocrystalItem::writeTo(QXmlStreamWriter* w) const
{
    XML::writeBaseElement<ItemWithParticles>(w, XML::Tag::BaseData, this);
    XML::writeTaggedElement(w, Tag::VectorA, m_vectorA);
    XML::writeTaggedElement(w, Tag::VectorB, m_vectorB);
    XML::writeTaggedElement(w, Tag::VectorC, m_vectorC);
    XML::writeTaggedElement(w, Tag::OuterShape, m_outer_shape);
    XML::writeTaggedElement(w, Tag::BasisParticle, m_basis_particle);
    XML::writeTaggedValue(w, Tag::ExpandMesocrystalGroupbox, expandMesocrystal);
}

void MesocrystalItem::readFrom(QXmlStreamReader* r)
{
    while (r->readNextStartElement()) {
        QString tag = r->name().toString();
        if (tag == Tag::BaseData)
            XML::readBaseElement<ItemWithParticles>(r, tag, this);
        else if (tag == Tag::VectorA)
            XML::readTaggedElement(r, tag, m_vectorA);
        else if (tag == Tag::VectorB)
            XML::readTaggedElement(r, tag, m_vectorB);
        else if (tag == Tag::VectorC)
            XML::readTaggedElement(r, tag, m_vectorC);
        else if (tag == Tag::OuterShape)
            XML::readTaggedElement(r, tag, m_outer_shape);
        else if (tag == Tag::BasisParticle) {
            m_basis_particle.readFrom(r, m_materials);
            XML::gotoEndElementOfTag(r, tag);
        } else if (tag == Tag::ExpandMesocrystalGroupbox)
            expandMesocrystal = XML::readTaggedBool(r, tag);
        else
            r->skipCurrentElement();
    }
}

std::unique_ptr<Mesocrystal> MesocrystalItem::createMesocrystal() const
{
    const Lattice3D& lattice = getLattice();
    if (!(lattice.unitCellVolume() > 0.0))
        throw std::runtime_error("MesocrystalItem::createMesocrystal(): "
                                 "Lattice volume not strictly positive");
    std::unique_ptr<IParticle> basis = getBasis();
    if (!basis)
        throw std::runtime_error("MesocrystalItem::createMesocrystal(): "
                                 "No basis particle defined");
    Crystal crystal(*basis, lattice);

    std::unique_ptr<IFormfactor> ff = getOuterShape();
    if (!ff)
        throw std::runtime_error("MesocrystalItem::createMesocrystal(): "
                                 "No outer shape defined");

    auto result = std::make_unique<Mesocrystal>(crystal, *ff);
    if (auto r = createRotation(); r && !r->isIdentity())
        result->rotate(*r);
    result->translate(position());

    return result;
}

Lattice3D MesocrystalItem::getLattice() const
{
    return Lattice3D(m_vectorA, m_vectorB, m_vectorC);
}

std::unique_ptr<IParticle> MesocrystalItem::getBasis() const
{
    if (auto* p = dynamic_cast<ParticleItem*>(m_basis_particle.certainItem()))
        return p->createParticle();

    if (auto* p = dynamic_cast<CoreAndShellItem*>(m_basis_particle.certainItem()))
        return p->createCoreAndShell();

    if (auto* p = dynamic_cast<CompoundItem*>(m_basis_particle.certainItem()))
        return p->createCompound();

    if (auto* p = dynamic_cast<MesocrystalItem*>(m_basis_particle.certainItem()))
        return p->createMesocrystal();

    return {};
}

std::unique_ptr<IFormfactor> MesocrystalItem::getOuterShape() const
{
    return m_outer_shape.certainItem()->createFormfactor();
}

std::vector<ItemWithParticles*> MesocrystalItem::containedItemsWithParticles() const
{
    std::vector<ItemWithParticles*> result;
    if (basisItem()) {
        result.push_back(basisItem());
        Vec::concat(result, basisItem()->containedItemsWithParticles());
    }
    return result;
}