File: ProfileHelper.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 (47 lines) | stat: -rw-r--r-- 1,742 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Slice/ProfileHelper.h
//! @brief     Defines class ProfileHelper.
//!
//! @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_PROFILEHELPER_H
#define BORNAGAIN_RESAMPLE_SLICE_PROFILEHELPER_H

#include "Resample/Slice/SliceStack.h"
#include <utility>
#include <vector>

//! Object that can generate the material profile of a sample as a function of depth.
//!
//! The generated profile contains the complex SLD for SLD materials and the parameters
//! delta and beta for refractive index materials

class ProfileHelper {
public:
    ProfileHelper(const SliceStack& stack);
    ~ProfileHelper() = default;

    std::vector<complex_t> calculateSLDProfile(const std::vector<double>& z_values) const;
    std::vector<double> calculateMagnetizationProfile(const std::vector<double>& z_values,
                                                      std::string xyz) const;
    std::pair<double, double> defaultLimits() const;

private:
    std::vector<complex_t> profile(const std::vector<double>& z_values,
                                   std::string component) const;

    const SliceStack m_stack; // copy
};

#endif // BORNAGAIN_RESAMPLE_SLICE_PROFILEHELPER_H