File: SliceStack.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 (48 lines) | stat: -rw-r--r-- 1,628 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Slice/SliceStack.h
//! @brief     Defines class SliceStack.
//!
//! @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_SLICE_SLICESTACK_H
#define BORNAGAIN_RESAMPLE_SLICE_SLICESTACK_H

#include "Resample/Slice/Slice.h" // TODO move back to cpp file
#include <heinz/Vectors3D.h>
#include <vector>

class Material;
class Roughness;
class Slice;

//! A stack of Slice%s.

class SliceStack : public std::vector<Slice> {
public:
    SliceStack() = default;

    void addTopSlice(double zbottom, const Material& material);
    void addSlice(double thickness, const Material& material, const Roughness* roughness = nullptr,
                  double rms = 0);
    void addNSlices(size_t n, double thickness, const Material& material,
                    const Roughness* roughness = nullptr, double rms = 0);

    SliceStack setBField(const R3& externalField);

    // Top roughness of the slice below
    const Roughness* bottomRoughness(size_t i_slice) const;
    double bottomRMS(size_t i_slice) const;
};

#endif // BORNAGAIN_RESAMPLE_SLICE_SLICESTACK_H