File: Interference1DLattice.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 (54 lines) | stat: -rw-r--r-- 1,786 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Aggregate/Interference1DLattice.h
//! @brief     Defines class Interference1DLattice.
//!
//! @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_INTERFERENCE1DLATTICE_H
#define BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCE1DLATTICE_H

#include "Sample/Aggregate/IInterference.h"

class IProfile1D;

//! Interference function of a 1D lattice.

class Interference1DLattice : public IInterference {
public:
    Interference1DLattice(double length, double xi);
    ~Interference1DLattice() override;

#ifndef SWIG
    Interference1DLattice* clone() const override;

    std::vector<const INode*> nodeChildren() const override;
#endif // SWIG

    std::string className() const final { return "Interference1DLattice"; }
    std::vector<ParaMeta> parDefs() const final { return {{"Length", "nm"}, {"Xi", "rad"}}; }

    void setDecayFunction(const IProfile1D& decay);

    double length() const { return m_length; }
    double xi() const { return m_xi; }

    std::string validate() const override;

private:
    double iff_without_dw(const R3& q) const override;

    double m_length;
    double m_xi;
    std::unique_ptr<IProfile1D> m_decay;
    int m_na; //!< determines the number of reciprocal lattice points to use
};

#endif // BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCE1DLATTICE_H