File: ParticleLayout.h

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 (64 lines) | stat: -rw-r--r-- 2,242 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Aggregate/ParticleLayout.h
//! @brief     Defines class ParticleLayout.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#ifndef BORNAGAIN_SAMPLE_AGGREGATE_PARTICLELAYOUT_H
#define BORNAGAIN_SAMPLE_AGGREGATE_PARTICLELAYOUT_H

#include "Base/Type/CloneableVector.h"
#include "Sample/Scattering/ISampleNode.h"
#include <memory>

class IInterference;
class IParticle;

//! Decorator class that adds particles to ISampleNode objects.

class ParticleLayout : public ISampleNode {
public:
    ParticleLayout();
    ParticleLayout(const IParticle& particle);
    ~ParticleLayout() override;

    std::string className() const final { return "ParticleLayout"; }

    void addParticle(const IParticle& particle, double abundance = -1.0);
    void setInterference(const IInterference& interparticle);
    void setTotalParticleSurfaceDensity(double particle_density);
    void setAbsoluteWeight(double weight) { m_abs_weight = weight; }

#ifndef SWIG
    ParticleLayout* clone() const override;

    std::string validate() const override;

    std::vector<const INode*> nodeChildren() const override;

    std::vector<ParaMeta> parDefs() const final { return {{"Abundance", ""}}; }

    double totalAbundance() const;
    double totalParticleSurfaceDensity() const;
    double absoluteWeight() const { return m_abs_weight; }

    std::vector<const IParticle*> particles() const;
    const IInterference* interferenceFunction() const;

private:
    double m_abs_weight = 1; //!< Weight factor, independent of particle density
    double m_total_particle_density{.01};
    CloneableVector<IParticle> m_particles; //!< Vector of particle types
    std::unique_ptr<IInterference> m_interparticle;
#endif // SWIG
};

#endif // BORNAGAIN_SAMPLE_AGGREGATE_PARTICLELAYOUT_H