File: ReLayout.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 (55 lines) | stat: -rw-r--r-- 1,938 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Processed/ReLayout.h
//! @brief     Defines class ReLayout.
//!
//! @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)
//
//  ************************************************************************************************

#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_RESAMPLE_PROCESSED_RELAYOUT_H
#define BORNAGAIN_RESAMPLE_PROCESSED_RELAYOUT_H

#include "Base/Type/OwningVector.h"
#include <memory>

class CoheringSubparticles;
class IInterference;
class IInterparticleStrategy;
class SimulationOptions;

//! Data structure that contains preprocessed data for a single layout.
//!
//! It is set by the preprocessor makeReLayout in ReSample.cpp.

class ReLayout {
public:
    ReLayout(double surface_density, OwningVector<const CoheringSubparticles>&& particles,
             const IInterference* iff, const SimulationOptions& options, bool polarized);

    ~ReLayout();

    double surfaceDensity() const { return m_surface_density; }
    const OwningVector<const CoheringSubparticles>& subparticles() const { return m_particles; }
    const IInterference* interferenceFunction() const { return m_iff.get(); }
    const IInterparticleStrategy* interparticle_strategy() const
    {
        return m_interparticle_strategy.get();
    }

private:
    const double m_surface_density;
    OwningVector<const CoheringSubparticles> m_particles;
    std::unique_ptr<const IInterference> m_iff;
    std::unique_ptr<const IInterparticleStrategy> m_interparticle_strategy;
};

#endif // BORNAGAIN_RESAMPLE_PROCESSED_RELAYOUT_H