File: InterferenceHardDisk.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 (56 lines) | stat: -rw-r--r-- 1,964 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Aggregate/InterferenceHardDisk.h
//! @brief     Defines class InterferenceHardDisk.
//!
//! @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_INTERFERENCEHARDDISK_H
#define BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCEHARDDISK_H

#include "Sample/Aggregate/IInterference.h"

//! Percus-Yevick hard disk interference function.
//!
//! M.S. Ripoll & C.F. Tejero (1995) Approximate analytical expression for the direct correlation
//! function of hard discs within the Percus-Yevick equation, Molecular Physics, 85:2, 423-428,
//! DOI: 10.1080/00268979500101211

class InterferenceHardDisk : public IInterference {
public:
    InterferenceHardDisk(double radius, double density, double position_var = 0);
    ~InterferenceHardDisk() override = default;
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Radius", "nm"}, {"Density", "nm^-2"}, {"Variance", "nm?"}};
    }

#ifndef SWIG
    InterferenceHardDisk* clone() const override;
#endif // SWIG

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

    double particleDensity() const override { return m_density; }

    double radius() const { return m_radius; }
    double density() const { return m_density; }

    std::string validate() const override;

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

    double m_radius;
    double m_density;
};

#endif // BORNAGAIN_SAMPLE_AGGREGATE_INTERFERENCEHARDDISK_H